orb-billing 1.0.1 → 1.2.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 (160) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +1 -1
  4. data/lib/orb/errors.rb +22 -0
  5. data/lib/orb/internal/type/array_of.rb +6 -1
  6. data/lib/orb/internal/type/base_model.rb +79 -25
  7. data/lib/orb/internal/type/boolean.rb +7 -1
  8. data/lib/orb/internal/type/converter.rb +42 -34
  9. data/lib/orb/internal/type/enum.rb +10 -2
  10. data/lib/orb/internal/type/file_input.rb +6 -1
  11. data/lib/orb/internal/type/hash_of.rb +6 -1
  12. data/lib/orb/internal/type/union.rb +12 -7
  13. data/lib/orb/internal/type/unknown.rb +7 -1
  14. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +4 -4
  15. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +4 -4
  16. data/lib/orb/models/invoice.rb +4 -1
  17. data/lib/orb/models/invoice_fetch_upcoming_response.rb +4 -1
  18. data/lib/orb/models/invoice_line_item_create_response.rb +4 -1
  19. data/lib/orb/models/monetary_amount_discount_adjustment.rb +10 -1
  20. data/lib/orb/models/monetary_maximum_adjustment.rb +10 -1
  21. data/lib/orb/models/monetary_minimum_adjustment.rb +10 -1
  22. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +10 -1
  23. data/lib/orb/models/monetary_usage_discount_adjustment.rb +10 -1
  24. data/lib/orb/models/new_plan_bps_price.rb +10 -1
  25. data/lib/orb/models/new_plan_bulk_bps_price.rb +10 -1
  26. data/lib/orb/models/new_plan_bulk_price.rb +10 -1
  27. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +10 -1
  28. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +10 -1
  29. data/lib/orb/models/new_plan_grouped_allocation_price.rb +10 -1
  30. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +10 -1
  31. data/lib/orb/models/new_plan_grouped_tiered_price.rb +10 -1
  32. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +10 -1
  33. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +10 -1
  34. data/lib/orb/models/new_plan_matrix_price.rb +10 -1
  35. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +10 -1
  36. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +10 -1
  37. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +10 -1
  38. data/lib/orb/models/new_plan_package_price.rb +10 -1
  39. data/lib/orb/models/new_plan_package_with_allocation_price.rb +10 -1
  40. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +10 -1
  41. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +10 -1
  42. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +10 -1
  43. data/lib/orb/models/new_plan_tier_with_proration_price.rb +10 -1
  44. data/lib/orb/models/new_plan_tiered_bps_price.rb +10 -1
  45. data/lib/orb/models/new_plan_tiered_package_price.rb +10 -1
  46. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +10 -1
  47. data/lib/orb/models/new_plan_tiered_price.rb +10 -1
  48. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +10 -1
  49. data/lib/orb/models/new_plan_unit_price.rb +10 -1
  50. data/lib/orb/models/new_plan_unit_with_percent_price.rb +10 -1
  51. data/lib/orb/models/new_plan_unit_with_proration_price.rb +10 -1
  52. data/lib/orb/models/plan_create_params.rb +185 -37
  53. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +10 -1
  54. data/lib/orb/models/plan_phase_maximum_adjustment.rb +10 -1
  55. data/lib/orb/models/plan_phase_minimum_adjustment.rb +10 -1
  56. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +10 -1
  57. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +10 -1
  58. data/lib/orb/models/price.rb +280 -28
  59. data/lib/orb/resources/customers/credits/ledger.rb +6 -6
  60. data/lib/orb/resources/plans.rb +6 -2
  61. data/lib/orb/version.rb +1 -1
  62. data/rbi/orb/errors.rbi +16 -0
  63. data/rbi/orb/internal/type/boolean.rbi +2 -0
  64. data/rbi/orb/internal/type/converter.rbi +15 -15
  65. data/rbi/orb/internal/type/union.rbi +5 -0
  66. data/rbi/orb/internal/type/unknown.rbi +2 -0
  67. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +3 -3
  68. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +3 -3
  69. data/rbi/orb/models/invoice.rbi +2 -0
  70. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2 -0
  71. data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -0
  72. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +13 -3
  73. data/rbi/orb/models/monetary_maximum_adjustment.rbi +13 -3
  74. data/rbi/orb/models/monetary_minimum_adjustment.rbi +13 -3
  75. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +13 -3
  76. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +10 -0
  77. data/rbi/orb/models/new_plan_bps_price.rbi +13 -3
  78. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +13 -3
  79. data/rbi/orb/models/new_plan_bulk_price.rbi +13 -3
  80. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +13 -3
  81. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +13 -3
  82. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +13 -3
  83. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +13 -3
  84. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +13 -3
  85. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +13 -3
  86. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +13 -3
  87. data/rbi/orb/models/new_plan_matrix_price.rbi +13 -3
  88. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +13 -3
  89. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +13 -3
  90. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +13 -3
  91. data/rbi/orb/models/new_plan_package_price.rbi +13 -3
  92. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +13 -3
  93. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +13 -3
  94. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +13 -3
  95. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +13 -3
  96. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +13 -3
  97. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +13 -3
  98. data/rbi/orb/models/new_plan_tiered_package_price.rbi +13 -3
  99. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +13 -3
  100. data/rbi/orb/models/new_plan_tiered_price.rbi +13 -3
  101. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +13 -3
  102. data/rbi/orb/models/new_plan_unit_price.rbi +13 -3
  103. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +13 -3
  104. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +13 -3
  105. data/rbi/orb/models/plan_create_params.rbi +415 -135
  106. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +13 -3
  107. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +13 -3
  108. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +13 -3
  109. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +13 -3
  110. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +10 -0
  111. data/rbi/orb/models/price.rbi +280 -0
  112. data/rbi/orb/resources/customers/credits/ledger.rbi +6 -6
  113. data/rbi/orb/resources/plans.rbi +11 -33
  114. data/sig/orb/errors.rbs +9 -0
  115. data/sig/orb/internal/type/converter.rbs +7 -1
  116. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +1 -1
  117. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +1 -1
  118. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +8 -3
  119. data/sig/orb/models/monetary_maximum_adjustment.rbs +8 -3
  120. data/sig/orb/models/monetary_minimum_adjustment.rbs +8 -3
  121. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +8 -3
  122. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +5 -0
  123. data/sig/orb/models/new_plan_bps_price.rbs +8 -3
  124. data/sig/orb/models/new_plan_bulk_bps_price.rbs +8 -3
  125. data/sig/orb/models/new_plan_bulk_price.rbs +8 -3
  126. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +8 -3
  127. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +8 -3
  128. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +8 -3
  129. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +8 -3
  130. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +8 -3
  131. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +8 -3
  132. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +8 -3
  133. data/sig/orb/models/new_plan_matrix_price.rbs +8 -3
  134. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +8 -3
  135. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +8 -3
  136. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +8 -3
  137. data/sig/orb/models/new_plan_package_price.rbs +8 -3
  138. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +8 -3
  139. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +8 -3
  140. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +8 -3
  141. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +8 -3
  142. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +8 -3
  143. data/sig/orb/models/new_plan_tiered_bps_price.rbs +8 -3
  144. data/sig/orb/models/new_plan_tiered_package_price.rbs +8 -3
  145. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +8 -3
  146. data/sig/orb/models/new_plan_tiered_price.rbs +8 -3
  147. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +8 -3
  148. data/sig/orb/models/new_plan_unit_price.rbs +8 -3
  149. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +8 -3
  150. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +8 -3
  151. data/sig/orb/models/plan_create_params.rbs +156 -37
  152. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +8 -3
  153. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +8 -3
  154. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +8 -3
  155. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +8 -3
  156. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +5 -0
  157. data/sig/orb/models/price.rbs +140 -0
  158. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  159. data/sig/orb/resources/plans.rbs +3 -1
  160. metadata +2 -2
@@ -115,6 +115,11 @@ module Orb
115
115
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
116
116
  attr_accessor :metadata
117
117
 
118
+ # A transient ID that can be used to reference this price when adding adjustments
119
+ # in the same API call.
120
+ sig { returns(T.nilable(String)) }
121
+ attr_accessor :reference_id
122
+
118
123
  sig do
119
124
  params(
120
125
  bulk_with_proration_config: T::Hash[Symbol, T.anything],
@@ -142,7 +147,8 @@ module Orb
142
147
  invoice_grouping_key: T.nilable(String),
143
148
  invoicing_cycle_configuration:
144
149
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
145
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
150
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
151
+ reference_id: T.nilable(String)
146
152
  ).returns(T.attached_class)
147
153
  end
148
154
  def self.new(
@@ -185,7 +191,10 @@ module Orb
185
191
  # User-specified key/value pairs for the resource. Individual keys can be removed
186
192
  # by setting the value to `null`, and the entire metadata mapping can be cleared
187
193
  # by setting `metadata` to `null`.
188
- metadata: nil
194
+ metadata: nil,
195
+ # A transient ID that can be used to reference this price when adding adjustments
196
+ # in the same API call.
197
+ reference_id: nil
189
198
  )
190
199
  end
191
200
 
@@ -217,7 +226,8 @@ module Orb
217
226
  invoice_grouping_key: T.nilable(String),
218
227
  invoicing_cycle_configuration:
219
228
  T.nilable(Orb::NewBillingCycleConfiguration),
220
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
229
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
230
+ reference_id: T.nilable(String)
221
231
  }
222
232
  )
223
233
  end
@@ -117,6 +117,11 @@ module Orb
117
117
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
118
118
  attr_accessor :metadata
119
119
 
120
+ # A transient ID that can be used to reference this price when adding adjustments
121
+ # in the same API call.
122
+ sig { returns(T.nilable(String)) }
123
+ attr_accessor :reference_id
124
+
120
125
  sig do
121
126
  params(
122
127
  cadence: Orb::NewPlanCumulativeGroupedBulkPrice::Cadence::OrSymbol,
@@ -145,7 +150,8 @@ module Orb
145
150
  invoice_grouping_key: T.nilable(String),
146
151
  invoicing_cycle_configuration:
147
152
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
148
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
153
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
154
+ reference_id: T.nilable(String)
149
155
  ).returns(T.attached_class)
150
156
  end
151
157
  def self.new(
@@ -188,7 +194,10 @@ module Orb
188
194
  # User-specified key/value pairs for the resource. Individual keys can be removed
189
195
  # by setting the value to `null`, and the entire metadata mapping can be cleared
190
196
  # by setting `metadata` to `null`.
191
- metadata: nil
197
+ metadata: nil,
198
+ # A transient ID that can be used to reference this price when adding adjustments
199
+ # in the same API call.
200
+ reference_id: nil
192
201
  )
193
202
  end
194
203
 
@@ -221,7 +230,8 @@ module Orb
221
230
  invoice_grouping_key: T.nilable(String),
222
231
  invoicing_cycle_configuration:
223
232
  T.nilable(Orb::NewBillingCycleConfiguration),
224
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
233
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
234
+ reference_id: T.nilable(String)
225
235
  }
226
236
  )
227
237
  end
@@ -115,6 +115,11 @@ module Orb
115
115
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
116
116
  attr_accessor :metadata
117
117
 
118
+ # A transient ID that can be used to reference this price when adding adjustments
119
+ # in the same API call.
120
+ sig { returns(T.nilable(String)) }
121
+ attr_accessor :reference_id
122
+
118
123
  sig do
119
124
  params(
120
125
  cadence: Orb::NewPlanGroupedAllocationPrice::Cadence::OrSymbol,
@@ -142,7 +147,8 @@ module Orb
142
147
  invoice_grouping_key: T.nilable(String),
143
148
  invoicing_cycle_configuration:
144
149
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
145
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
150
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
151
+ reference_id: T.nilable(String)
146
152
  ).returns(T.attached_class)
147
153
  end
148
154
  def self.new(
@@ -185,7 +191,10 @@ module Orb
185
191
  # User-specified key/value pairs for the resource. Individual keys can be removed
186
192
  # by setting the value to `null`, and the entire metadata mapping can be cleared
187
193
  # by setting `metadata` to `null`.
188
- metadata: nil
194
+ metadata: nil,
195
+ # A transient ID that can be used to reference this price when adding adjustments
196
+ # in the same API call.
197
+ reference_id: nil
189
198
  )
190
199
  end
191
200
 
@@ -217,7 +226,8 @@ module Orb
217
226
  invoice_grouping_key: T.nilable(String),
218
227
  invoicing_cycle_configuration:
219
228
  T.nilable(Orb::NewBillingCycleConfiguration),
220
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
229
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
230
+ reference_id: T.nilable(String)
221
231
  }
222
232
  )
223
233
  end
@@ -117,6 +117,11 @@ module Orb
117
117
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
118
118
  attr_accessor :metadata
119
119
 
120
+ # A transient ID that can be used to reference this price when adding adjustments
121
+ # in the same API call.
122
+ sig { returns(T.nilable(String)) }
123
+ attr_accessor :reference_id
124
+
120
125
  sig do
121
126
  params(
122
127
  cadence: Orb::NewPlanGroupedTieredPackagePrice::Cadence::OrSymbol,
@@ -145,7 +150,8 @@ module Orb
145
150
  invoice_grouping_key: T.nilable(String),
146
151
  invoicing_cycle_configuration:
147
152
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
148
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
153
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
154
+ reference_id: T.nilable(String)
149
155
  ).returns(T.attached_class)
150
156
  end
151
157
  def self.new(
@@ -188,7 +194,10 @@ module Orb
188
194
  # User-specified key/value pairs for the resource. Individual keys can be removed
189
195
  # by setting the value to `null`, and the entire metadata mapping can be cleared
190
196
  # by setting `metadata` to `null`.
191
- metadata: nil
197
+ metadata: nil,
198
+ # A transient ID that can be used to reference this price when adding adjustments
199
+ # in the same API call.
200
+ reference_id: nil
192
201
  )
193
202
  end
194
203
 
@@ -221,7 +230,8 @@ module Orb
221
230
  invoice_grouping_key: T.nilable(String),
222
231
  invoicing_cycle_configuration:
223
232
  T.nilable(Orb::NewBillingCycleConfiguration),
224
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
233
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
234
+ reference_id: T.nilable(String)
225
235
  }
226
236
  )
227
237
  end
@@ -115,6 +115,11 @@ module Orb
115
115
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
116
116
  attr_accessor :metadata
117
117
 
118
+ # A transient ID that can be used to reference this price when adding adjustments
119
+ # in the same API call.
120
+ sig { returns(T.nilable(String)) }
121
+ attr_accessor :reference_id
122
+
118
123
  sig do
119
124
  params(
120
125
  cadence: Orb::NewPlanGroupedTieredPrice::Cadence::OrSymbol,
@@ -142,7 +147,8 @@ module Orb
142
147
  invoice_grouping_key: T.nilable(String),
143
148
  invoicing_cycle_configuration:
144
149
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
145
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
150
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
151
+ reference_id: T.nilable(String)
146
152
  ).returns(T.attached_class)
147
153
  end
148
154
  def self.new(
@@ -185,7 +191,10 @@ module Orb
185
191
  # User-specified key/value pairs for the resource. Individual keys can be removed
186
192
  # by setting the value to `null`, and the entire metadata mapping can be cleared
187
193
  # by setting `metadata` to `null`.
188
- metadata: nil
194
+ metadata: nil,
195
+ # A transient ID that can be used to reference this price when adding adjustments
196
+ # in the same API call.
197
+ reference_id: nil
189
198
  )
190
199
  end
191
200
 
@@ -217,7 +226,8 @@ module Orb
217
226
  invoice_grouping_key: T.nilable(String),
218
227
  invoicing_cycle_configuration:
219
228
  T.nilable(Orb::NewBillingCycleConfiguration),
220
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
229
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
230
+ reference_id: T.nilable(String)
221
231
  }
222
232
  )
223
233
  end
@@ -122,6 +122,11 @@ module Orb
122
122
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
123
123
  attr_accessor :metadata
124
124
 
125
+ # A transient ID that can be used to reference this price when adding adjustments
126
+ # in the same API call.
127
+ sig { returns(T.nilable(String)) }
128
+ attr_accessor :reference_id
129
+
125
130
  sig do
126
131
  params(
127
132
  cadence:
@@ -151,7 +156,8 @@ module Orb
151
156
  invoice_grouping_key: T.nilable(String),
152
157
  invoicing_cycle_configuration:
153
158
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
154
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
159
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
160
+ reference_id: T.nilable(String)
155
161
  ).returns(T.attached_class)
156
162
  end
157
163
  def self.new(
@@ -194,7 +200,10 @@ module Orb
194
200
  # User-specified key/value pairs for the resource. Individual keys can be removed
195
201
  # by setting the value to `null`, and the entire metadata mapping can be cleared
196
202
  # by setting `metadata` to `null`.
197
- metadata: nil
203
+ metadata: nil,
204
+ # A transient ID that can be used to reference this price when adding adjustments
205
+ # in the same API call.
206
+ reference_id: nil
198
207
  )
199
208
  end
200
209
 
@@ -228,7 +237,8 @@ module Orb
228
237
  invoice_grouping_key: T.nilable(String),
229
238
  invoicing_cycle_configuration:
230
239
  T.nilable(Orb::NewBillingCycleConfiguration),
231
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
240
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
241
+ reference_id: T.nilable(String)
232
242
  }
233
243
  )
234
244
  end
@@ -124,6 +124,11 @@ module Orb
124
124
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
125
125
  attr_accessor :metadata
126
126
 
127
+ # A transient ID that can be used to reference this price when adding adjustments
128
+ # in the same API call.
129
+ sig { returns(T.nilable(String)) }
130
+ attr_accessor :reference_id
131
+
127
132
  sig do
128
133
  params(
129
134
  cadence:
@@ -153,7 +158,8 @@ module Orb
153
158
  invoice_grouping_key: T.nilable(String),
154
159
  invoicing_cycle_configuration:
155
160
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
156
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
161
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
162
+ reference_id: T.nilable(String)
157
163
  ).returns(T.attached_class)
158
164
  end
159
165
  def self.new(
@@ -196,7 +202,10 @@ module Orb
196
202
  # User-specified key/value pairs for the resource. Individual keys can be removed
197
203
  # by setting the value to `null`, and the entire metadata mapping can be cleared
198
204
  # by setting `metadata` to `null`.
199
- metadata: nil
205
+ metadata: nil,
206
+ # A transient ID that can be used to reference this price when adding adjustments
207
+ # in the same API call.
208
+ reference_id: nil
200
209
  )
201
210
  end
202
211
 
@@ -230,7 +239,8 @@ module Orb
230
239
  invoice_grouping_key: T.nilable(String),
231
240
  invoicing_cycle_configuration:
232
241
  T.nilable(Orb::NewBillingCycleConfiguration),
233
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
242
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
243
+ reference_id: T.nilable(String)
234
244
  }
235
245
  )
236
246
  end
@@ -116,6 +116,11 @@ module Orb
116
116
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
117
117
  attr_accessor :metadata
118
118
 
119
+ # A transient ID that can be used to reference this price when adding adjustments
120
+ # in the same API call.
121
+ sig { returns(T.nilable(String)) }
122
+ attr_accessor :reference_id
123
+
119
124
  sig do
120
125
  params(
121
126
  cadence: Orb::NewPlanMatrixPrice::Cadence::OrSymbol,
@@ -143,7 +148,8 @@ module Orb
143
148
  invoice_grouping_key: T.nilable(String),
144
149
  invoicing_cycle_configuration:
145
150
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
146
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
151
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
152
+ reference_id: T.nilable(String)
147
153
  ).returns(T.attached_class)
148
154
  end
149
155
  def self.new(
@@ -186,7 +192,10 @@ module Orb
186
192
  # User-specified key/value pairs for the resource. Individual keys can be removed
187
193
  # by setting the value to `null`, and the entire metadata mapping can be cleared
188
194
  # by setting `metadata` to `null`.
189
- metadata: nil
195
+ metadata: nil,
196
+ # A transient ID that can be used to reference this price when adding adjustments
197
+ # in the same API call.
198
+ reference_id: nil
190
199
  )
191
200
  end
192
201
 
@@ -218,7 +227,8 @@ module Orb
218
227
  invoice_grouping_key: T.nilable(String),
219
228
  invoicing_cycle_configuration:
220
229
  T.nilable(Orb::NewBillingCycleConfiguration),
221
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
230
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
231
+ reference_id: T.nilable(String)
222
232
  }
223
233
  )
224
234
  end
@@ -124,6 +124,11 @@ module Orb
124
124
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
125
125
  attr_accessor :metadata
126
126
 
127
+ # A transient ID that can be used to reference this price when adding adjustments
128
+ # in the same API call.
129
+ sig { returns(T.nilable(String)) }
130
+ attr_accessor :reference_id
131
+
127
132
  sig do
128
133
  params(
129
134
  cadence: Orb::NewPlanMatrixWithAllocationPrice::Cadence::OrSymbol,
@@ -153,7 +158,8 @@ module Orb
153
158
  invoice_grouping_key: T.nilable(String),
154
159
  invoicing_cycle_configuration:
155
160
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
156
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
161
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
162
+ reference_id: T.nilable(String)
157
163
  ).returns(T.attached_class)
158
164
  end
159
165
  def self.new(
@@ -196,7 +202,10 @@ module Orb
196
202
  # User-specified key/value pairs for the resource. Individual keys can be removed
197
203
  # by setting the value to `null`, and the entire metadata mapping can be cleared
198
204
  # by setting `metadata` to `null`.
199
- metadata: nil
205
+ metadata: nil,
206
+ # A transient ID that can be used to reference this price when adding adjustments
207
+ # in the same API call.
208
+ reference_id: nil
200
209
  )
201
210
  end
202
211
 
@@ -229,7 +238,8 @@ module Orb
229
238
  invoice_grouping_key: T.nilable(String),
230
239
  invoicing_cycle_configuration:
231
240
  T.nilable(Orb::NewBillingCycleConfiguration),
232
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
241
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
242
+ reference_id: T.nilable(String)
233
243
  }
234
244
  )
235
245
  end
@@ -117,6 +117,11 @@ module Orb
117
117
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
118
118
  attr_accessor :metadata
119
119
 
120
+ # A transient ID that can be used to reference this price when adding adjustments
121
+ # in the same API call.
122
+ sig { returns(T.nilable(String)) }
123
+ attr_accessor :reference_id
124
+
120
125
  sig do
121
126
  params(
122
127
  cadence: Orb::NewPlanMatrixWithDisplayNamePrice::Cadence::OrSymbol,
@@ -145,7 +150,8 @@ module Orb
145
150
  invoice_grouping_key: T.nilable(String),
146
151
  invoicing_cycle_configuration:
147
152
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
148
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
153
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
154
+ reference_id: T.nilable(String)
149
155
  ).returns(T.attached_class)
150
156
  end
151
157
  def self.new(
@@ -188,7 +194,10 @@ module Orb
188
194
  # User-specified key/value pairs for the resource. Individual keys can be removed
189
195
  # by setting the value to `null`, and the entire metadata mapping can be cleared
190
196
  # by setting `metadata` to `null`.
191
- metadata: nil
197
+ metadata: nil,
198
+ # A transient ID that can be used to reference this price when adding adjustments
199
+ # in the same API call.
200
+ reference_id: nil
192
201
  )
193
202
  end
194
203
 
@@ -221,7 +230,8 @@ module Orb
221
230
  invoice_grouping_key: T.nilable(String),
222
231
  invoicing_cycle_configuration:
223
232
  T.nilable(Orb::NewBillingCycleConfiguration),
224
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
233
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
234
+ reference_id: T.nilable(String)
225
235
  }
226
236
  )
227
237
  end
@@ -117,6 +117,11 @@ module Orb
117
117
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
118
118
  attr_accessor :metadata
119
119
 
120
+ # A transient ID that can be used to reference this price when adding adjustments
121
+ # in the same API call.
122
+ sig { returns(T.nilable(String)) }
123
+ attr_accessor :reference_id
124
+
120
125
  sig do
121
126
  params(
122
127
  cadence: Orb::NewPlanMaxGroupTieredPackagePrice::Cadence::OrSymbol,
@@ -145,7 +150,8 @@ module Orb
145
150
  invoice_grouping_key: T.nilable(String),
146
151
  invoicing_cycle_configuration:
147
152
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
148
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
153
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
154
+ reference_id: T.nilable(String)
149
155
  ).returns(T.attached_class)
150
156
  end
151
157
  def self.new(
@@ -188,7 +194,10 @@ module Orb
188
194
  # User-specified key/value pairs for the resource. Individual keys can be removed
189
195
  # by setting the value to `null`, and the entire metadata mapping can be cleared
190
196
  # by setting `metadata` to `null`.
191
- metadata: nil
197
+ metadata: nil,
198
+ # A transient ID that can be used to reference this price when adding adjustments
199
+ # in the same API call.
200
+ reference_id: nil
192
201
  )
193
202
  end
194
203
 
@@ -221,7 +230,8 @@ module Orb
221
230
  invoice_grouping_key: T.nilable(String),
222
231
  invoicing_cycle_configuration:
223
232
  T.nilable(Orb::NewBillingCycleConfiguration),
224
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
233
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
234
+ reference_id: T.nilable(String)
225
235
  }
226
236
  )
227
237
  end
@@ -116,6 +116,11 @@ module Orb
116
116
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
117
117
  attr_accessor :metadata
118
118
 
119
+ # A transient ID that can be used to reference this price when adding adjustments
120
+ # in the same API call.
121
+ sig { returns(T.nilable(String)) }
122
+ attr_accessor :reference_id
123
+
119
124
  sig do
120
125
  params(
121
126
  cadence: Orb::NewPlanPackagePrice::Cadence::OrSymbol,
@@ -143,7 +148,8 @@ module Orb
143
148
  invoice_grouping_key: T.nilable(String),
144
149
  invoicing_cycle_configuration:
145
150
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
146
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
151
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
152
+ reference_id: T.nilable(String)
147
153
  ).returns(T.attached_class)
148
154
  end
149
155
  def self.new(
@@ -186,7 +192,10 @@ module Orb
186
192
  # User-specified key/value pairs for the resource. Individual keys can be removed
187
193
  # by setting the value to `null`, and the entire metadata mapping can be cleared
188
194
  # by setting `metadata` to `null`.
189
- metadata: nil
195
+ metadata: nil,
196
+ # A transient ID that can be used to reference this price when adding adjustments
197
+ # in the same API call.
198
+ reference_id: nil
190
199
  )
191
200
  end
192
201
 
@@ -218,7 +227,8 @@ module Orb
218
227
  invoice_grouping_key: T.nilable(String),
219
228
  invoicing_cycle_configuration:
220
229
  T.nilable(Orb::NewBillingCycleConfiguration),
221
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
230
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
231
+ reference_id: T.nilable(String)
222
232
  }
223
233
  )
224
234
  end
@@ -117,6 +117,11 @@ module Orb
117
117
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
118
118
  attr_accessor :metadata
119
119
 
120
+ # A transient ID that can be used to reference this price when adding adjustments
121
+ # in the same API call.
122
+ sig { returns(T.nilable(String)) }
123
+ attr_accessor :reference_id
124
+
120
125
  sig do
121
126
  params(
122
127
  cadence: Orb::NewPlanPackageWithAllocationPrice::Cadence::OrSymbol,
@@ -145,7 +150,8 @@ module Orb
145
150
  invoice_grouping_key: T.nilable(String),
146
151
  invoicing_cycle_configuration:
147
152
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
148
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
153
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
154
+ reference_id: T.nilable(String)
149
155
  ).returns(T.attached_class)
150
156
  end
151
157
  def self.new(
@@ -188,7 +194,10 @@ module Orb
188
194
  # User-specified key/value pairs for the resource. Individual keys can be removed
189
195
  # by setting the value to `null`, and the entire metadata mapping can be cleared
190
196
  # by setting `metadata` to `null`.
191
- metadata: nil
197
+ metadata: nil,
198
+ # A transient ID that can be used to reference this price when adding adjustments
199
+ # in the same API call.
200
+ reference_id: nil
192
201
  )
193
202
  end
194
203
 
@@ -221,7 +230,8 @@ module Orb
221
230
  invoice_grouping_key: T.nilable(String),
222
231
  invoicing_cycle_configuration:
223
232
  T.nilable(Orb::NewBillingCycleConfiguration),
224
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
233
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
234
+ reference_id: T.nilable(String)
225
235
  }
226
236
  )
227
237
  end
@@ -126,6 +126,11 @@ module Orb
126
126
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
127
127
  attr_accessor :metadata
128
128
 
129
+ # A transient ID that can be used to reference this price when adding adjustments
130
+ # in the same API call.
131
+ sig { returns(T.nilable(String)) }
132
+ attr_accessor :reference_id
133
+
129
134
  sig do
130
135
  params(
131
136
  cadence:
@@ -156,7 +161,8 @@ module Orb
156
161
  invoice_grouping_key: T.nilable(String),
157
162
  invoicing_cycle_configuration:
158
163
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
159
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
164
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
165
+ reference_id: T.nilable(String)
160
166
  ).returns(T.attached_class)
161
167
  end
162
168
  def self.new(
@@ -199,7 +205,10 @@ module Orb
199
205
  # User-specified key/value pairs for the resource. Individual keys can be removed
200
206
  # by setting the value to `null`, and the entire metadata mapping can be cleared
201
207
  # by setting `metadata` to `null`.
202
- metadata: nil
208
+ metadata: nil,
209
+ # A transient ID that can be used to reference this price when adding adjustments
210
+ # in the same API call.
211
+ reference_id: nil
203
212
  )
204
213
  end
205
214
 
@@ -234,7 +243,8 @@ module Orb
234
243
  invoice_grouping_key: T.nilable(String),
235
244
  invoicing_cycle_configuration:
236
245
  T.nilable(Orb::NewBillingCycleConfiguration),
237
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
246
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
247
+ reference_id: T.nilable(String)
238
248
  }
239
249
  )
240
250
  end
@@ -126,6 +126,11 @@ module Orb
126
126
  sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
127
127
  attr_accessor :metadata
128
128
 
129
+ # A transient ID that can be used to reference this price when adding adjustments
130
+ # in the same API call.
131
+ sig { returns(T.nilable(String)) }
132
+ attr_accessor :reference_id
133
+
129
134
  sig do
130
135
  params(
131
136
  cadence:
@@ -155,7 +160,8 @@ module Orb
155
160
  invoice_grouping_key: T.nilable(String),
156
161
  invoicing_cycle_configuration:
157
162
  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
158
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
163
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
164
+ reference_id: T.nilable(String)
159
165
  ).returns(T.attached_class)
160
166
  end
161
167
  def self.new(
@@ -198,7 +204,10 @@ module Orb
198
204
  # User-specified key/value pairs for the resource. Individual keys can be removed
199
205
  # by setting the value to `null`, and the entire metadata mapping can be cleared
200
206
  # by setting `metadata` to `null`.
201
- metadata: nil
207
+ metadata: nil,
208
+ # A transient ID that can be used to reference this price when adding adjustments
209
+ # in the same API call.
210
+ reference_id: nil
202
211
  )
203
212
  end
204
213
 
@@ -233,7 +242,8 @@ module Orb
233
242
  invoice_grouping_key: T.nilable(String),
234
243
  invoicing_cycle_configuration:
235
244
  T.nilable(Orb::NewBillingCycleConfiguration),
236
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)])
245
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
246
+ reference_id: T.nilable(String)
237
247
  }
238
248
  )
239
249
  end