orb-billing 1.10.0 → 1.11.1

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 (52) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -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 +139 -100
  8. data/lib/orb/models/customer_update_params.rb +139 -100
  9. data/lib/orb/models/dimensional_price_group_update_params.rb +38 -0
  10. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +44 -0
  11. data/lib/orb/models/invoice.rb +141 -102
  12. data/lib/orb/models/invoice_fetch_upcoming_response.rb +141 -102
  13. data/lib/orb/models/invoice_line_item_create_response.rb +2 -2
  14. data/lib/orb/models/per_price_cost.rb +2 -2
  15. data/lib/orb/models/plan.rb +2 -2
  16. data/lib/orb/models/plan_version.rb +2 -2
  17. data/lib/orb/models/price.rb +245 -1
  18. data/lib/orb/models/price_interval.rb +2 -2
  19. data/lib/orb/models.rb +2 -0
  20. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +36 -0
  21. data/lib/orb/resources/dimensional_price_groups.rb +31 -0
  22. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  23. data/lib/orb/resources/prices.rb +4 -4
  24. data/lib/orb/version.rb +1 -1
  25. data/lib/orb.rb +2 -0
  26. data/rbi/orb/models/customer.rbi +278 -200
  27. data/rbi/orb/models/customer_create_params.rbi +278 -200
  28. data/rbi/orb/models/customer_tax_id.rbi +214 -102
  29. data/rbi/orb/models/customer_update_by_external_id_params.rbi +278 -200
  30. data/rbi/orb/models/customer_update_params.rbi +278 -200
  31. data/rbi/orb/models/dimensional_price_group_update_params.rbi +61 -0
  32. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +66 -0
  33. data/rbi/orb/models/invoice.rbi +280 -201
  34. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +280 -201
  35. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -1
  36. data/rbi/orb/models/per_price_cost.rbi +2 -1
  37. data/rbi/orb/models/plan.rbi +2 -1
  38. data/rbi/orb/models/plan_version.rbi +2 -1
  39. data/rbi/orb/models/price.rbi +384 -1
  40. data/rbi/orb/models/price_interval.rbi +2 -1
  41. data/rbi/orb/models.rbi +3 -0
  42. data/rbi/orb/resources/customers.rbi +417 -300
  43. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +26 -0
  44. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -0
  45. data/sig/orb/models/customer_tax_id.rbs +150 -4
  46. data/sig/orb/models/dimensional_price_group_update_params.rbs +31 -0
  47. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +33 -0
  48. data/sig/orb/models/price.rbs +179 -0
  49. data/sig/orb/models.rbs +2 -0
  50. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +7 -0
  51. data/sig/orb/resources/dimensional_price_groups.rbs +7 -0
  52. metadata +8 -2
@@ -14,6 +14,32 @@ module Orb
14
14
  def retrieve(external_dimensional_price_group_id, request_options: {})
15
15
  end
16
16
 
17
+ # This endpoint can be used to update the `external_dimensional_price_group_id`
18
+ # and `metadata` of an existing dimensional price group. Other fields on a
19
+ # dimensional price group are currently immutable.
20
+ sig do
21
+ params(
22
+ path_external_dimensional_price_group_id: String,
23
+ body_external_dimensional_price_group_id: T.nilable(String),
24
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
25
+ request_options: Orb::RequestOptions::OrHash
26
+ ).returns(Orb::DimensionalPriceGroup)
27
+ end
28
+ def update(
29
+ path_external_dimensional_price_group_id,
30
+ # An optional user-defined ID for this dimensional price group resource, used
31
+ # throughout the system as an alias for this dimensional price group. Use this
32
+ # field to identify a dimensional price group by an existing identifier in your
33
+ # system.
34
+ body_external_dimensional_price_group_id: nil,
35
+ # User-specified key/value pairs for the resource. Individual keys can be removed
36
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
37
+ # by setting `metadata` to `null`.
38
+ metadata: nil,
39
+ request_options: {}
40
+ )
41
+ end
42
+
17
43
  # @api private
18
44
  sig { params(client: Orb::Client).returns(T.attached_class) }
19
45
  def self.new(client:)
@@ -52,6 +52,32 @@ module Orb
52
52
  def retrieve(dimensional_price_group_id, request_options: {})
53
53
  end
54
54
 
55
+ # This endpoint can be used to update the `external_dimensional_price_group_id`
56
+ # and `metadata` of an existing dimensional price group. Other fields on a
57
+ # dimensional price group are currently immutable.
58
+ sig do
59
+ params(
60
+ dimensional_price_group_id: String,
61
+ external_dimensional_price_group_id: T.nilable(String),
62
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
63
+ request_options: Orb::RequestOptions::OrHash
64
+ ).returns(Orb::DimensionalPriceGroup)
65
+ end
66
+ def update(
67
+ dimensional_price_group_id,
68
+ # An optional user-defined ID for this dimensional price group resource, used
69
+ # throughout the system as an alias for this dimensional price group. Use this
70
+ # field to identify a dimensional price group by an existing identifier in your
71
+ # system.
72
+ external_dimensional_price_group_id: nil,
73
+ # User-specified key/value pairs for the resource. Individual keys can be removed
74
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
75
+ # by setting `metadata` to `null`.
76
+ metadata: nil,
77
+ request_options: {}
78
+ )
79
+ end
80
+
55
81
  # List dimensional price groups
56
82
  sig do
57
83
  params(
@@ -29,34 +29,51 @@ module Orb
29
29
  type country =
30
30
  :AD
31
31
  | :AE
32
+ | :AL
33
+ | :AM
34
+ | :AO
32
35
  | :AR
33
36
  | :AT
34
37
  | :AU
38
+ | :AW
39
+ | :AZ
40
+ | :BA
41
+ | :BB
42
+ | :BD
35
43
  | :BE
44
+ | :BF
36
45
  | :BG
37
46
  | :BH
47
+ | :BJ
38
48
  | :BO
39
49
  | :BR
50
+ | :BS
51
+ | :BY
40
52
  | :CA
53
+ | :CD
41
54
  | :CH
42
55
  | :CL
56
+ | :CM
43
57
  | :CN
44
58
  | :CO
45
59
  | :CR
60
+ | :CV
61
+ | :DE
46
62
  | :CY
47
63
  | :CZ
48
- | :DE
49
64
  | :DK
50
- | :EE
51
65
  | :DO
52
66
  | :EC
67
+ | :EE
53
68
  | :EG
54
69
  | :ES
70
+ | :ET
55
71
  | :EU
56
72
  | :FI
57
73
  | :FR
58
74
  | :GB
59
75
  | :GE
76
+ | :GN
60
77
  | :GR
61
78
  | :HK
62
79
  | :HR
@@ -69,18 +86,27 @@ module Orb
69
86
  | :IT
70
87
  | :JP
71
88
  | :KE
89
+ | :KG
90
+ | :KH
72
91
  | :KR
73
92
  | :KZ
93
+ | :LA
74
94
  | :LI
75
95
  | :LT
76
96
  | :LU
77
97
  | :LV
98
+ | :MA
99
+ | :MD
100
+ | :ME
101
+ | :MK
102
+ | :MR
78
103
  | :MT
79
104
  | :MX
80
105
  | :MY
81
106
  | :NG
82
107
  | :NL
83
108
  | :NO
109
+ | :NP
84
110
  | :NZ
85
111
  | :OM
86
112
  | :PE
@@ -95,50 +121,75 @@ module Orb
95
121
  | :SG
96
122
  | :SI
97
123
  | :SK
124
+ | :SN
125
+ | :SR
98
126
  | :SV
99
127
  | :TH
128
+ | :TJ
100
129
  | :TR
101
130
  | :TW
131
+ | :TZ
102
132
  | :UA
133
+ | :UG
103
134
  | :US
104
135
  | :UY
136
+ | :UZ
105
137
  | :VE
106
138
  | :VN
107
139
  | :ZA
140
+ | :ZM
141
+ | :ZW
108
142
 
109
143
  module Country
110
144
  extend Orb::Internal::Type::Enum
111
145
 
112
146
  AD: :AD
113
147
  AE: :AE
148
+ AL: :AL
149
+ AM: :AM
150
+ AO: :AO
114
151
  AR: :AR
115
152
  AT: :AT
116
153
  AU: :AU
154
+ AW: :AW
155
+ AZ: :AZ
156
+ BA: :BA
157
+ BB: :BB
158
+ BD: :BD
117
159
  BE: :BE
160
+ BF: :BF
118
161
  BG: :BG
119
162
  BH: :BH
163
+ BJ: :BJ
120
164
  BO: :BO
121
165
  BR: :BR
166
+ BS: :BS
167
+ BY: :BY
122
168
  CA: :CA
169
+ CD: :CD
123
170
  CH: :CH
124
171
  CL: :CL
172
+ CM: :CM
125
173
  CN: :CN
126
174
  CO: :CO
127
175
  CR: :CR
176
+ CV: :CV
177
+ DE: :DE
128
178
  CY: :CY
129
179
  CZ: :CZ
130
- DE: :DE
131
180
  DK: :DK
132
- EE: :EE
133
181
  DO: :DO
134
182
  EC: :EC
183
+ EE: :EE
135
184
  EG: :EG
136
185
  ES: :ES
186
+ ET: :ET
137
187
  EU: :EU
138
188
  FI: :FI
139
189
  FR: :FR
140
190
  GB: :GB
141
191
  GE: :GE
192
+ GN: :GN
142
193
  GR: :GR
143
194
  HK: :HK
144
195
  HR: :HR
@@ -151,18 +202,27 @@ module Orb
151
202
  IT: :IT
152
203
  JP: :JP
153
204
  KE: :KE
205
+ KG: :KG
206
+ KH: :KH
154
207
  KR: :KR
155
208
  KZ: :KZ
209
+ LA: :LA
156
210
  LI: :LI
157
211
  LT: :LT
158
212
  LU: :LU
159
213
  LV: :LV
214
+ MA: :MA
215
+ MD: :MD
216
+ ME: :ME
217
+ MK: :MK
218
+ MR: :MR
160
219
  MT: :MT
161
220
  MX: :MX
162
221
  MY: :MY
163
222
  NG: :NG
164
223
  NL: :NL
165
224
  NO: :NO
225
+ NP: :NP
166
226
  NZ: :NZ
167
227
  OM: :OM
168
228
  PE: :PE
@@ -177,16 +237,24 @@ module Orb
177
237
  SG: :SG
178
238
  SI: :SI
179
239
  SK: :SK
240
+ SN: :SN
241
+ SR: :SR
180
242
  SV: :SV
181
243
  TH: :TH
244
+ TJ: :TJ
182
245
  TR: :TR
183
246
  TW: :TW
247
+ TZ: :TZ
184
248
  UA: :UA
249
+ UG: :UG
185
250
  US: :US
186
251
  UY: :UY
252
+ UZ: :UZ
187
253
  VE: :VE
188
254
  VN: :VN
189
255
  ZA: :ZA
256
+ ZM: :ZM
257
+ ZW: :ZW
190
258
 
191
259
  def self?.values: -> ::Array[Orb::Models::CustomerTaxID::country]
192
260
  end
@@ -194,34 +262,54 @@ module Orb
194
262
  type type_ =
195
263
  :ad_nrt
196
264
  | :ae_trn
265
+ | :al_tin
266
+ | :am_tin
267
+ | :ao_tin
197
268
  | :ar_cuit
198
269
  | :eu_vat
199
270
  | :au_abn
200
271
  | :au_arn
272
+ | :aw_tin
273
+ | :az_tin
274
+ | :ba_tin
275
+ | :bb_tin
276
+ | :bd_bin
277
+ | :bf_ifu
201
278
  | :bg_uic
202
279
  | :bh_vat
280
+ | :bj_ifu
203
281
  | :bo_tin
204
282
  | :br_cnpj
205
283
  | :br_cpf
284
+ | :bs_tin
285
+ | :by_tin
206
286
  | :ca_bn
207
287
  | :ca_gst_hst
208
288
  | :ca_pst_bc
209
289
  | :ca_pst_mb
210
290
  | :ca_pst_sk
211
291
  | :ca_qst
292
+ | :cd_nif
293
+ | :ch_uid
212
294
  | :ch_vat
213
295
  | :cl_tin
296
+ | :cm_niu
214
297
  | :cn_tin
215
298
  | :co_nit
216
299
  | :cr_tin
300
+ | :cv_nif
301
+ | :de_stn
217
302
  | :do_rcn
218
303
  | :ec_ruc
219
304
  | :eg_tin
220
305
  | :es_cif
306
+ | :et_tin
221
307
  | :eu_oss_vat
222
308
  | :gb_vat
223
309
  | :ge_vat
310
+ | :gn_nif
224
311
  | :hk_br
312
+ | :hr_oib
225
313
  | :hu_tin
226
314
  | :id_npwp
227
315
  | :il_vat
@@ -231,9 +319,18 @@ module Orb
231
319
  | :jp_rn
232
320
  | :jp_trn
233
321
  | :ke_pin
322
+ | :kg_tin
323
+ | :kh_tin
234
324
  | :kr_brn
235
325
  | :kz_bin
326
+ | :la_tin
236
327
  | :li_uid
328
+ | :li_vat
329
+ | :ma_vat
330
+ | :md_vat
331
+ | :me_pib
332
+ | :mk_vat
333
+ | :mr_nif
237
334
  | :mx_rfc
238
335
  | :my_frp
239
336
  | :my_itn
@@ -241,6 +338,7 @@ module Orb
241
338
  | :ng_tin
242
339
  | :no_vat
243
340
  | :no_voec
341
+ | :np_pan
244
342
  | :nz_gst
245
343
  | :om_vat
246
344
  | :pe_ruc
@@ -253,50 +351,79 @@ module Orb
253
351
  | :sg_gst
254
352
  | :sg_uen
255
353
  | :si_tin
354
+ | :sn_ninea
355
+ | :sr_fin
256
356
  | :sv_nit
257
357
  | :th_vat
358
+ | :tj_tin
258
359
  | :tr_tin
259
360
  | :tw_vat
361
+ | :tz_vat
260
362
  | :ua_vat
363
+ | :ug_tin
261
364
  | :us_ein
262
365
  | :uy_ruc
366
+ | :uz_tin
367
+ | :uz_vat
263
368
  | :ve_rif
264
369
  | :vn_tin
265
370
  | :za_vat
371
+ | :zm_tin
372
+ | :zw_tin
266
373
 
267
374
  module Type
268
375
  extend Orb::Internal::Type::Enum
269
376
 
270
377
  AD_NRT: :ad_nrt
271
378
  AE_TRN: :ae_trn
379
+ AL_TIN: :al_tin
380
+ AM_TIN: :am_tin
381
+ AO_TIN: :ao_tin
272
382
  AR_CUIT: :ar_cuit
273
383
  EU_VAT: :eu_vat
274
384
  AU_ABN: :au_abn
275
385
  AU_ARN: :au_arn
386
+ AW_TIN: :aw_tin
387
+ AZ_TIN: :az_tin
388
+ BA_TIN: :ba_tin
389
+ BB_TIN: :bb_tin
390
+ BD_BIN: :bd_bin
391
+ BF_IFU: :bf_ifu
276
392
  BG_UIC: :bg_uic
277
393
  BH_VAT: :bh_vat
394
+ BJ_IFU: :bj_ifu
278
395
  BO_TIN: :bo_tin
279
396
  BR_CNPJ: :br_cnpj
280
397
  BR_CPF: :br_cpf
398
+ BS_TIN: :bs_tin
399
+ BY_TIN: :by_tin
281
400
  CA_BN: :ca_bn
282
401
  CA_GST_HST: :ca_gst_hst
283
402
  CA_PST_BC: :ca_pst_bc
284
403
  CA_PST_MB: :ca_pst_mb
285
404
  CA_PST_SK: :ca_pst_sk
286
405
  CA_QST: :ca_qst
406
+ CD_NIF: :cd_nif
407
+ CH_UID: :ch_uid
287
408
  CH_VAT: :ch_vat
288
409
  CL_TIN: :cl_tin
410
+ CM_NIU: :cm_niu
289
411
  CN_TIN: :cn_tin
290
412
  CO_NIT: :co_nit
291
413
  CR_TIN: :cr_tin
414
+ CV_NIF: :cv_nif
415
+ DE_STN: :de_stn
292
416
  DO_RCN: :do_rcn
293
417
  EC_RUC: :ec_ruc
294
418
  EG_TIN: :eg_tin
295
419
  ES_CIF: :es_cif
420
+ ET_TIN: :et_tin
296
421
  EU_OSS_VAT: :eu_oss_vat
297
422
  GB_VAT: :gb_vat
298
423
  GE_VAT: :ge_vat
424
+ GN_NIF: :gn_nif
299
425
  HK_BR: :hk_br
426
+ HR_OIB: :hr_oib
300
427
  HU_TIN: :hu_tin
301
428
  ID_NPWP: :id_npwp
302
429
  IL_VAT: :il_vat
@@ -306,9 +433,18 @@ module Orb
306
433
  JP_RN: :jp_rn
307
434
  JP_TRN: :jp_trn
308
435
  KE_PIN: :ke_pin
436
+ KG_TIN: :kg_tin
437
+ KH_TIN: :kh_tin
309
438
  KR_BRN: :kr_brn
310
439
  KZ_BIN: :kz_bin
440
+ LA_TIN: :la_tin
311
441
  LI_UID: :li_uid
442
+ LI_VAT: :li_vat
443
+ MA_VAT: :ma_vat
444
+ MD_VAT: :md_vat
445
+ ME_PIB: :me_pib
446
+ MK_VAT: :mk_vat
447
+ MR_NIF: :mr_nif
312
448
  MX_RFC: :mx_rfc
313
449
  MY_FRP: :my_frp
314
450
  MY_ITN: :my_itn
@@ -316,6 +452,7 @@ module Orb
316
452
  NG_TIN: :ng_tin
317
453
  NO_VAT: :no_vat
318
454
  NO_VOEC: :no_voec
455
+ NP_PAN: :np_pan
319
456
  NZ_GST: :nz_gst
320
457
  OM_VAT: :om_vat
321
458
  PE_RUC: :pe_ruc
@@ -328,16 +465,25 @@ module Orb
328
465
  SG_GST: :sg_gst
329
466
  SG_UEN: :sg_uen
330
467
  SI_TIN: :si_tin
468
+ SN_NINEA: :sn_ninea
469
+ SR_FIN: :sr_fin
331
470
  SV_NIT: :sv_nit
332
471
  TH_VAT: :th_vat
472
+ TJ_TIN: :tj_tin
333
473
  TR_TIN: :tr_tin
334
474
  TW_VAT: :tw_vat
475
+ TZ_VAT: :tz_vat
335
476
  UA_VAT: :ua_vat
477
+ UG_TIN: :ug_tin
336
478
  US_EIN: :us_ein
337
479
  UY_RUC: :uy_ruc
480
+ UZ_TIN: :uz_tin
481
+ UZ_VAT: :uz_vat
338
482
  VE_RIF: :ve_rif
339
483
  VN_TIN: :vn_tin
340
484
  ZA_VAT: :za_vat
485
+ ZM_TIN: :zm_tin
486
+ ZW_TIN: :zw_tin
341
487
 
342
488
  def self?.values: -> ::Array[Orb::Models::CustomerTaxID::type_]
343
489
  end
@@ -0,0 +1,31 @@
1
+ module Orb
2
+ module Models
3
+ type dimensional_price_group_update_params =
4
+ {
5
+ external_dimensional_price_group_id: String?,
6
+ metadata: ::Hash[Symbol, String?]?
7
+ }
8
+ & Orb::Internal::Type::request_parameters
9
+
10
+ class DimensionalPriceGroupUpdateParams < Orb::Internal::Type::BaseModel
11
+ extend Orb::Internal::Type::RequestParameters::Converter
12
+ include Orb::Internal::Type::RequestParameters
13
+
14
+ attr_accessor external_dimensional_price_group_id: String?
15
+
16
+ attr_accessor metadata: ::Hash[Symbol, String?]?
17
+
18
+ def initialize: (
19
+ ?external_dimensional_price_group_id: String?,
20
+ ?metadata: ::Hash[Symbol, String?]?,
21
+ ?request_options: Orb::request_opts
22
+ ) -> void
23
+
24
+ def to_hash: -> {
25
+ external_dimensional_price_group_id: String?,
26
+ metadata: ::Hash[Symbol, String?]?,
27
+ request_options: Orb::RequestOptions
28
+ }
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,33 @@
1
+ module Orb
2
+ module Models
3
+ module DimensionalPriceGroups
4
+ type external_dimensional_price_group_id_update_params =
5
+ {
6
+ body_external_dimensional_price_group_id: String?,
7
+ metadata: ::Hash[Symbol, String?]?
8
+ }
9
+ & Orb::Internal::Type::request_parameters
10
+
11
+ class ExternalDimensionalPriceGroupIDUpdateParams < Orb::Internal::Type::BaseModel
12
+ extend Orb::Internal::Type::RequestParameters::Converter
13
+ include Orb::Internal::Type::RequestParameters
14
+
15
+ attr_accessor body_external_dimensional_price_group_id: String?
16
+
17
+ attr_accessor metadata: ::Hash[Symbol, String?]?
18
+
19
+ def initialize: (
20
+ ?body_external_dimensional_price_group_id: String?,
21
+ ?metadata: ::Hash[Symbol, String?]?,
22
+ ?request_options: Orb::request_opts
23
+ ) -> void
24
+
25
+ def to_hash: -> {
26
+ body_external_dimensional_price_group_id: String?,
27
+ metadata: ::Hash[Symbol, String?]?,
28
+ request_options: Orb::RequestOptions
29
+ }
30
+ end
31
+ end
32
+ end
33
+ end