Skip to content

Commit d29d009

Browse files
feat(api): api update
1 parent ee4d38b commit d29d009

25 files changed

+94
-68
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 116
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-a44cccd16bb58080f7cc0669999403f6ed3f77287fad901caa6fd2523f2fbafd.yml
3-
openapi_spec_hash: af6444648d0b2a70b7f7ad234bd37541
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-1aabbd8715a871e993abf67f0bf9c1d6793b4f197c4b2f11fc7a76453590cd6c.yml
3+
openapi_spec_hash: 3e5878f87e74881d882a69e1ccdc25a3
44
config_hash: 1f535c1fa222aacf28b636eed21bec72

lib/orb/models/customer_update_by_external_id_params.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel
5151
optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
5252

5353
# @!attribute external_customer_id
54-
# The external customer ID. This can only be set if empty and the customer has no
55-
# past or current subscriptions.
54+
# The external customer ID. This can only be set if the customer has no existing
55+
# external customer ID. Since this action may change usage quantities for all
56+
# existing subscriptions, it is disallowed if the customer has issued invoices
57+
# with usage line items and subject to the same restrictions as backdated
58+
# subscription creation.
5659
#
5760
# @return [String, nil]
5861
optional :external_customer_id, String, nil?: true
@@ -243,7 +246,7 @@ class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel
243246
#
244247
# @param email_delivery [Boolean, nil]
245248
#
246-
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
249+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if the customer has no existing e
247250
#
248251
# @param hierarchy [Orb::Models::CustomerHierarchyConfig, nil] The hierarchical relationships for this customer.
249252
#

lib/orb/models/customer_update_params.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel
5151
optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
5252

5353
# @!attribute external_customer_id
54-
# The external customer ID. This can only be set if empty and the customer has no
55-
# past or current subscriptions.
54+
# The external customer ID. This can only be set if the customer has no existing
55+
# external customer ID. Since this action may change usage quantities for all
56+
# existing subscriptions, it is disallowed if the customer has issued invoices
57+
# with usage line items and subject to the same restrictions as backdated
58+
# subscription creation.
5659
#
5760
# @return [String, nil]
5861
optional :external_customer_id, String, nil?: true
@@ -239,7 +242,7 @@ class CustomerUpdateParams < Orb::Internal::Type::BaseModel
239242
#
240243
# @param email_delivery [Boolean, nil]
241244
#
242-
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
245+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if the customer has no existing e
243246
#
244247
# @param hierarchy [Orb::Models::CustomerHierarchyConfig, nil] The hierarchical relationships for this customer.
245248
#

lib/orb/models/customers/cost_list_by_external_id_params.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class CostListByExternalIDParams < Orb::Internal::Type::BaseModel
99
include Orb::Internal::Type::RequestParameters
1010

1111
# @!attribute currency
12-
# The currency to use.
12+
# The currency or custom pricing unit to use.
1313
#
1414
# @return [String, nil]
1515
optional :currency, String, nil?: true
@@ -39,7 +39,7 @@ class CostListByExternalIDParams < Orb::Internal::Type::BaseModel
3939
# Some parameter documentations has been truncated, see
4040
# {Orb::Models::Customers::CostListByExternalIDParams} for more details.
4141
#
42-
# @param currency [String, nil] The currency to use.
42+
# @param currency [String, nil] The currency or custom pricing unit to use.
4343
#
4444
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
4545
#

lib/orb/models/customers/cost_list_params.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class CostListParams < Orb::Internal::Type::BaseModel
99
include Orb::Internal::Type::RequestParameters
1010

1111
# @!attribute currency
12-
# The currency to use.
12+
# The currency or custom pricing unit to use.
1313
#
1414
# @return [String, nil]
1515
optional :currency, String, nil?: true
@@ -39,7 +39,7 @@ class CostListParams < Orb::Internal::Type::BaseModel
3939
# Some parameter documentations has been truncated, see
4040
# {Orb::Models::Customers::CostListParams} for more details.
4141
#
42-
# @param currency [String, nil] The currency to use.
42+
# @param currency [String, nil] The currency or custom pricing unit to use.
4343
#
4444
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
4545
#

lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
153153
# date for the invoice. If you intend the invoice to be due on issue, set this
154154
# to 0.
155155
#
156-
# @return [Integer]
157-
required :net_terms, Integer
156+
# @return [Integer, nil]
157+
required :net_terms, Integer, nil?: true
158158

159159
# @!attribute invoice_date
160160
# An ISO 8601 format date that denotes when this invoice should be dated in the
@@ -193,7 +193,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
193193
#
194194
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
195195
#
196-
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
196+
# @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
197197
#
198198
# @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
199199
#

lib/orb/models/customers/credits/ledger_create_entry_params.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,8 +149,8 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
149149
# date for the invoice. If you intend the invoice to be due on issue, set this
150150
# to 0.
151151
#
152-
# @return [Integer]
153-
required :net_terms, Integer
152+
# @return [Integer, nil]
153+
required :net_terms, Integer, nil?: true
154154

155155
# @!attribute invoice_date
156156
# An ISO 8601 format date that denotes when this invoice should be dated in the
@@ -189,7 +189,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
189189
#
190190
# @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
191191
#
192-
# @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
192+
# @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
193193
#
194194
# @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
195195
#

lib/orb/models/subscription_fetch_costs_params.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel
88
include Orb::Internal::Type::RequestParameters
99

1010
# @!attribute currency
11-
# The currency to use.
11+
# The currency or custom pricing unit to use.
1212
#
1313
# @return [String, nil]
1414
optional :currency, String, nil?: true
@@ -38,7 +38,7 @@ class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel
3838
# Some parameter documentations has been truncated, see
3939
# {Orb::Models::SubscriptionFetchCostsParams} for more details.
4040
#
41-
# @param currency [String, nil] The currency to use.
41+
# @param currency [String, nil] The currency or custom pricing unit to use.
4242
#
4343
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
4444
#

lib/orb/resources/customers.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ def create(params)
109109
#
110110
# @param email_delivery [Boolean, nil]
111111
#
112-
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
112+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if the customer has no existing e
113113
#
114114
# @param hierarchy [Orb::Models::CustomerHierarchyConfig, nil] The hierarchical relationships for this customer.
115115
#
@@ -345,7 +345,7 @@ def sync_payment_methods_from_gateway_by_external_customer_id(external_customer_
345345
#
346346
# @param email_delivery [Boolean, nil]
347347
#
348-
# @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
348+
# @param external_customer_id [String, nil] The external customer ID. This can only be set if the customer has no existing e
349349
#
350350
# @param hierarchy [Orb::Models::CustomerHierarchyConfig, nil] The hierarchical relationships for this customer.
351351
#

lib/orb/resources/customers/costs.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ class Costs
129129
#
130130
# @param customer_id [String]
131131
#
132-
# @param currency [String, nil] The currency to use.
132+
# @param currency [String, nil] The currency or custom pricing unit to use.
133133
#
134134
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
135135
#
@@ -278,7 +278,7 @@ def list(customer_id, params = {})
278278
#
279279
# @param external_customer_id [String]
280280
#
281-
# @param currency [String, nil] The currency to use.
281+
# @param currency [String, nil] The currency or custom pricing unit to use.
282282
#
283283
# @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
284284
#

0 commit comments

Comments
 (0)