orb-billing 1.9.0 → 1.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/customer.rb +139 -100
  5. data/lib/orb/models/customer_create_params.rb +139 -100
  6. data/lib/orb/models/customer_tax_id.rb +214 -102
  7. data/lib/orb/models/customer_update_by_external_id_params.rb +145 -103
  8. data/lib/orb/models/customer_update_params.rb +145 -103
  9. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  10. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  11. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +3 -3
  12. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +3 -3
  13. data/lib/orb/models/dimensional_price_group_update_params.rb +38 -0
  14. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +44 -0
  15. data/lib/orb/models/invoice.rb +141 -102
  16. data/lib/orb/models/invoice_fetch_upcoming_response.rb +141 -102
  17. data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
  18. data/lib/orb/models/per_price_cost.rb +2 -2
  19. data/lib/orb/models/plan.rb +2 -2
  20. data/lib/orb/models/plan_version.rb +2 -2
  21. data/lib/orb/models/price.rb +245 -1
  22. data/lib/orb/models/price_interval.rb +2 -2
  23. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  24. data/lib/orb/models.rb +2 -0
  25. data/lib/orb/resources/customers/costs.rb +2 -2
  26. data/lib/orb/resources/customers.rb +2 -2
  27. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +36 -0
  28. data/lib/orb/resources/dimensional_price_groups.rb +31 -0
  29. data/lib/orb/resources/invoices.rb +5 -4
  30. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  31. data/lib/orb/resources/prices.rb +4 -4
  32. data/lib/orb/resources/subscriptions.rb +1 -1
  33. data/lib/orb/version.rb +1 -1
  34. data/lib/orb.rb +2 -0
  35. data/rbi/orb/models/customer.rbi +278 -200
  36. data/rbi/orb/models/customer_create_params.rbi +278 -200
  37. data/rbi/orb/models/customer_tax_id.rbi +214 -102
  38. data/rbi/orb/models/customer_update_by_external_id_params.rbi +288 -204
  39. data/rbi/orb/models/customer_update_params.rbi +288 -204
  40. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +2 -2
  41. data/rbi/orb/models/customers/cost_list_params.rbi +2 -2
  42. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +3 -3
  43. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +3 -3
  44. data/rbi/orb/models/dimensional_price_group_update_params.rbi +61 -0
  45. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +66 -0
  46. data/rbi/orb/models/invoice.rbi +280 -201
  47. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +280 -201
  48. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
  49. data/rbi/orb/models/per_price_cost.rbi +2 -1
  50. data/rbi/orb/models/plan.rbi +2 -1
  51. data/rbi/orb/models/plan_version.rbi +2 -1
  52. data/rbi/orb/models/price.rbi +384 -1
  53. data/rbi/orb/models/price_interval.rbi +2 -1
  54. data/rbi/orb/models/subscription_fetch_costs_params.rbi +2 -2
  55. data/rbi/orb/models.rbi +3 -0
  56. data/rbi/orb/resources/customers/costs.rbi +2 -2
  57. data/rbi/orb/resources/customers.rbi +427 -304
  58. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +26 -0
  59. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -0
  60. data/rbi/orb/resources/invoices.rbi +5 -4
  61. data/rbi/orb/resources/subscriptions.rbi +1 -1
  62. data/sig/orb/models/customer_tax_id.rbs +150 -4
  63. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +4 -4
  64. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +4 -4
  65. data/sig/orb/models/dimensional_price_group_update_params.rbs +31 -0
  66. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +33 -0
  67. data/sig/orb/models/price.rbs +179 -0
  68. data/sig/orb/models.rbs +2 -0
  69. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +7 -0
  70. data/sig/orb/resources/dimensional_price_groups.rbs +7 -0
  71. metadata +8 -2
data/lib/orb/models/customer_update_params.rb CHANGED
@@ -51,8 +51,11 @@ module Orb
51
51
  optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
52
52
 
53
53
  # @!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.
56
59
  #
57
60
  # @return [String, nil]
58
61
  optional :external_customer_id, String, nil?: true
@@ -117,106 +120,145 @@ module Orb
117
120
  #
118
121
  # ### Supported Tax ID Countries and Types
119
122
  #
120
- # | Country | Type | Description |
121
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
122
- # | Andorra | `ad_nrt` | Andorran NRT Number |
123
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
124
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
125
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
126
- # | Austria | `eu_vat` | European VAT Number |
127
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
128
- # | Belgium | `eu_vat` | European VAT Number |
129
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
130
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
131
- # | Brazil | `br_cpf` | Brazilian CPF Number |
132
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
133
- # | Bulgaria | `eu_vat` | European VAT Number |
134
- # | Canada | `ca_bn` | Canadian BN |
135
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
136
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
137
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
138
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
139
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
140
- # | Chile | `cl_tin` | Chilean TIN |
141
- # | China | `cn_tin` | Chinese Tax ID |
142
- # | Colombia | `co_nit` | Colombian NIT Number |
143
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
144
- # | Croatia | `eu_vat` | European VAT Number |
145
- # | Cyprus | `eu_vat` | European VAT Number |
146
- # | Czech Republic | `eu_vat` | European VAT Number |
147
- # | Denmark | `eu_vat` | European VAT Number |
148
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
149
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
150
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
151
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
152
- # | Estonia | `eu_vat` | European VAT Number |
153
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
154
- # | Finland | `eu_vat` | European VAT Number |
155
- # | France | `eu_vat` | European VAT Number |
156
- # | Georgia | `ge_vat` | Georgian VAT |
157
- # | Germany | `eu_vat` | European VAT Number |
158
- # | Greece | `eu_vat` | European VAT Number |
159
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
160
- # | Hungary | `eu_vat` | European VAT Number |
161
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
162
- # | Iceland | `is_vat` | Icelandic VAT |
163
- # | India | `in_gst` | Indian GST Number |
164
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
165
- # | Ireland | `eu_vat` | European VAT Number |
166
- # | Israel | `il_vat` | Israel VAT |
167
- # | Italy | `eu_vat` | European VAT Number |
168
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
169
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
170
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
171
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
172
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
173
- # | Latvia | `eu_vat` | European VAT Number |
174
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
175
- # | Lithuania | `eu_vat` | European VAT Number |
176
- # | Luxembourg | `eu_vat` | European VAT Number |
177
- # | Malaysia | `my_frp` | Malaysian FRP Number |
178
- # | Malaysia | `my_itn` | Malaysian ITN |
179
- # | Malaysia | `my_sst` | Malaysian SST Number |
180
- # | Malta | `eu_vat ` | European VAT Number |
181
- # | Mexico | `mx_rfc` | Mexican RFC Number |
182
- # | Netherlands | `eu_vat` | European VAT Number |
183
- # | New Zealand | `nz_gst` | New Zealand GST Number |
184
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
185
- # | Norway | `no_vat` | Norwegian VAT Number |
186
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
187
- # | Oman | `om_vat` | Omani VAT Number |
188
- # | Peru | `pe_ruc` | Peruvian RUC Number |
189
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
190
- # | Poland | `eu_vat` | European VAT Number |
191
- # | Portugal | `eu_vat` | European VAT Number |
192
- # | Romania | `eu_vat` | European VAT Number |
193
- # | Romania | `ro_tin` | Romanian Tax ID Number |
194
- # | Russia | `ru_inn` | Russian INN |
195
- # | Russia | `ru_kpp` | Russian KPP |
196
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
197
- # | Serbia | `rs_pib` | Serbian PIB Number |
198
- # | Singapore | `sg_gst` | Singaporean GST |
199
- # | Singapore | `sg_uen` | Singaporean UEN |
200
- # | Slovakia | `eu_vat` | European VAT Number |
201
- # | Slovenia | `eu_vat` | European VAT Number |
202
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
203
- # | South Africa | `za_vat` | South African VAT Number |
204
- # | South Korea | `kr_brn` | Korean BRN |
205
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
206
- # | Spain | `eu_vat` | European VAT Number |
207
- # | Sweden | `eu_vat` | European VAT Number |
208
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
209
- # | Taiwan | `tw_vat` | Taiwanese VAT |
210
- # | Thailand | `th_vat` | Thai VAT |
211
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
212
- # | Ukraine | `ua_vat` | Ukrainian VAT |
213
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
214
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
215
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
216
- # | United States | `us_ein` | United States EIN |
217
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
218
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
219
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
123
+ # | Country | Type | Description |
124
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
125
+ # | Albania | `al_tin` | Albania Tax Identification Number |
126
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
127
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
128
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
129
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
130
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
131
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
132
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
133
+ # | Austria | `eu_vat` | European VAT Number |
134
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
135
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
136
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
137
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
138
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
139
+ # | Belarus | `by_tin` | Belarus TIN Number |
140
+ # | Belgium | `eu_vat` | European VAT Number |
141
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
142
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
143
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
144
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
145
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
146
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
147
+ # | Bulgaria | `eu_vat` | European VAT Number |
148
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
149
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
150
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
151
+ # | Canada | `ca_bn` | Canadian BN |
152
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
153
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
154
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
155
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
156
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
157
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
158
+ # | Chile | `cl_tin` | Chilean TIN |
159
+ # | China | `cn_tin` | Chinese Tax ID |
160
+ # | Colombia | `co_nit` | Colombian NIT Number |
161
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
162
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
163
+ # | Croatia | `eu_vat` | European VAT Number |
164
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
165
+ # | Cyprus | `eu_vat` | European VAT Number |
166
+ # | Czech Republic | `eu_vat` | European VAT Number |
167
+ # | Denmark | `eu_vat` | European VAT Number |
168
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
169
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
170
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
171
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
172
+ # | Estonia | `eu_vat` | European VAT Number |
173
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
174
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
175
+ # | Finland | `eu_vat` | European VAT Number |
176
+ # | France | `eu_vat` | European VAT Number |
177
+ # | Georgia | `ge_vat` | Georgian VAT |
178
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
179
+ # | Germany | `eu_vat` | European VAT Number |
180
+ # | Greece | `eu_vat` | European VAT Number |
181
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
182
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
183
+ # | Hungary | `eu_vat` | European VAT Number |
184
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
185
+ # | Iceland | `is_vat` | Icelandic VAT |
186
+ # | India | `in_gst` | Indian GST Number |
187
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
188
+ # | Ireland | `eu_vat` | European VAT Number |
189
+ # | Israel | `il_vat` | Israel VAT |
190
+ # | Italy | `eu_vat` | European VAT Number |
191
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
192
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
193
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
194
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
195
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
196
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
197
+ # | Laos | `la_tin` | Laos Tax Identification Number |
198
+ # | Latvia | `eu_vat` | European VAT Number |
199
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
200
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
201
+ # | Lithuania | `eu_vat` | European VAT Number |
202
+ # | Luxembourg | `eu_vat` | European VAT Number |
203
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
204
+ # | Malaysia | `my_itn` | Malaysian ITN |
205
+ # | Malaysia | `my_sst` | Malaysian SST Number |
206
+ # | Malta | `eu_vat` | European VAT Number |
207
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
208
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
209
+ # | Moldova | `md_vat` | Moldova VAT Number |
210
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
211
+ # | Morocco | `ma_vat` | Morocco VAT Number |
212
+ # | Nepal | `np_pan` | Nepal PAN Number |
213
+ # | Netherlands | `eu_vat` | European VAT Number |
214
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
215
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
216
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
217
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
218
+ # | Norway | `no_vat` | Norwegian VAT Number |
219
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
220
+ # | Oman | `om_vat` | Omani VAT Number |
221
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
222
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
223
+ # | Poland | `eu_vat` | European VAT Number |
224
+ # | Portugal | `eu_vat` | European VAT Number |
225
+ # | Romania | `eu_vat` | European VAT Number |
226
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
227
+ # | Russia | `ru_inn` | Russian INN |
228
+ # | Russia | `ru_kpp` | Russian KPP |
229
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
230
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
231
+ # | Serbia | `rs_pib` | Serbian PIB Number |
232
+ # | Singapore | `sg_gst` | Singaporean GST |
233
+ # | Singapore | `sg_uen` | Singaporean UEN |
234
+ # | Slovakia | `eu_vat` | European VAT Number |
235
+ # | Slovenia | `eu_vat` | European VAT Number |
236
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
237
+ # | South Africa | `za_vat` | South African VAT Number |
238
+ # | South Korea | `kr_brn` | Korean BRN |
239
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
240
+ # | Spain | `eu_vat` | European VAT Number |
241
+ # | Suriname | `sr_fin` | Suriname FIN Number |
242
+ # | Sweden | `eu_vat` | European VAT Number |
243
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
244
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
245
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
246
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
247
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
248
+ # | Thailand | `th_vat` | Thai VAT |
249
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
250
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
251
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
252
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
253
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
254
+ # | United States | `us_ein` | United States EIN |
255
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
256
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
257
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
258
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
259
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
260
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
261
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
220
262
  #
221
263
  # @return [Orb::Models::CustomerTaxID, nil]
222
264
  optional :tax_id, -> { Orb::CustomerTaxID }, nil?: true
@@ -239,7 +281,7 @@ module Orb
239
281
  #
240
282
  # @param email_delivery [Boolean, nil]
241
283
  #
242
- # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
284
+ # @param external_customer_id [String, nil] The external customer ID. This can only be set if the customer has no existing e
243
285
  #
244
286
  # @param hierarchy [Orb::Models::CustomerHierarchyConfig, nil] The hierarchical relationships for this customer.
245
287
  #
data/lib/orb/models/customers/cost_list_by_external_id_params.rb CHANGED
@@ -9,7 +9,7 @@ module Orb
9
9
  include Orb::Internal::Type::RequestParameters
10
10
 
11
11
  # @!attribute currency
12
- # The currency to use.
12
+ # The currency or custom pricing unit to use.
13
13
  #
14
14
  # @return [String, nil]
15
15
  optional :currency, String, nil?: true
@@ -39,7 +39,7 @@ module Orb
39
39
  # Some parameter documentations has been truncated, see
40
40
  # {Orb::Models::Customers::CostListByExternalIDParams} for more details.
41
41
  #
42
- # @param currency [String, nil] The currency to use.
42
+ # @param currency [String, nil] The currency or custom pricing unit to use.
43
43
  #
44
44
  # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
45
45
  #
data/lib/orb/models/customers/cost_list_params.rb CHANGED
@@ -9,7 +9,7 @@ module Orb
9
9
  include Orb::Internal::Type::RequestParameters
10
10
 
11
11
  # @!attribute currency
12
- # The currency to use.
12
+ # The currency or custom pricing unit to use.
13
13
  #
14
14
  # @return [String, nil]
15
15
  optional :currency, String, nil?: true
@@ -39,7 +39,7 @@ module Orb
39
39
  # Some parameter documentations has been truncated, see
40
40
  # {Orb::Models::Customers::CostListParams} for more details.
41
41
  #
42
- # @param currency [String, nil] The currency to use.
42
+ # @param currency [String, nil] The currency or custom pricing unit to use.
43
43
  #
44
44
  # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
45
45
  #
data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb CHANGED
@@ -153,8 +153,8 @@ module Orb
153
153
  # date for the invoice. If you intend the invoice to be due on issue, set this
154
154
  # to 0.
155
155
  #
156
- # @return [Integer]
157
- required :net_terms, Integer
156
+ # @return [Integer, nil]
157
+ required :net_terms, Integer, nil?: true
158
158
 
159
159
  # @!attribute invoice_date
160
160
  # An ISO 8601 format date that denotes when this invoice should be dated in the
@@ -193,7 +193,7 @@ module Orb
193
193
  #
194
194
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
195
195
  #
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
197
197
  #
198
198
  # @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
199
199
  #
data/lib/orb/models/customers/credits/ledger_create_entry_params.rb CHANGED
@@ -149,8 +149,8 @@ module Orb
149
149
  # date for the invoice. If you intend the invoice to be due on issue, set this
150
150
  # to 0.
151
151
  #
152
- # @return [Integer]
153
- required :net_terms, Integer
152
+ # @return [Integer, nil]
153
+ required :net_terms, Integer, nil?: true
154
154
 
155
155
  # @!attribute invoice_date
156
156
  # An ISO 8601 format date that denotes when this invoice should be dated in the
@@ -189,7 +189,7 @@ module Orb
189
189
  #
190
190
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
191
191
  #
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
193
193
  #
194
194
  # @param invoice_date [Date, Time, nil] An ISO 8601 format date that denotes when this invoice should be dated in the cu
195
195
  #
data/lib/orb/models/dimensional_price_group_update_params.rb ADDED
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::DimensionalPriceGroups#update
6
+ class DimensionalPriceGroupUpdateParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute external_dimensional_price_group_id
11
+ # An optional user-defined ID for this dimensional price group resource, used
12
+ # throughout the system as an alias for this dimensional price group. Use this
13
+ # field to identify a dimensional price group by an existing identifier in your
14
+ # system.
15
+ #
16
+ # @return [String, nil]
17
+ optional :external_dimensional_price_group_id, String, nil?: true
18
+
19
+ # @!attribute metadata
20
+ # User-specified key/value pairs for the resource. Individual keys can be removed
21
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
22
+ # by setting `metadata` to `null`.
23
+ #
24
+ # @return [Hash{Symbol=>String, nil}, nil]
25
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
26
+
27
+ # @!method initialize(external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
28
+ # Some parameter documentations has been truncated, see
29
+ # {Orb::Models::DimensionalPriceGroupUpdateParams} for more details.
30
+ #
31
+ # @param external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
32
+ #
33
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
34
+ #
35
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
36
+ end
37
+ end
38
+ end
data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb ADDED
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module DimensionalPriceGroups
6
+ # @see Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID#update
7
+ class ExternalDimensionalPriceGroupIDUpdateParams < Orb::Internal::Type::BaseModel
8
+ extend Orb::Internal::Type::RequestParameters::Converter
9
+ include Orb::Internal::Type::RequestParameters
10
+
11
+ # @!attribute body_external_dimensional_price_group_id
12
+ # An optional user-defined ID for this dimensional price group resource, used
13
+ # throughout the system as an alias for this dimensional price group. Use this
14
+ # field to identify a dimensional price group by an existing identifier in your
15
+ # system.
16
+ #
17
+ # @return [String, nil]
18
+ optional :body_external_dimensional_price_group_id,
19
+ String,
20
+ api_name: :external_dimensional_price_group_id,
21
+ nil?: true
22
+
23
+ # @!attribute metadata
24
+ # User-specified key/value pairs for the resource. Individual keys can be removed
25
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
26
+ # by setting `metadata` to `null`.
27
+ #
28
+ # @return [Hash{Symbol=>String, nil}, nil]
29
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
30
+
31
+ # @!method initialize(body_external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
32
+ # Some parameter documentations has been truncated, see
33
+ # {Orb::Models::DimensionalPriceGroups::ExternalDimensionalPriceGroupIDUpdateParams}
34
+ # for more details.
35
+ #
36
+ # @param body_external_dimensional_price_group_id [String, nil] An optional user-defined ID for this dimensional price group resource, used thro
37
+ #
38
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
39
+ #
40
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
41
+ end
42
+ end
43
+ end
44
+ end