orb-billing 1.0.1 → 1.1.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/README.md +1 -1
- data/lib/orb/errors.rb +22 -0
- data/lib/orb/internal/type/array_of.rb +6 -1
- data/lib/orb/internal/type/base_model.rb +79 -25
- data/lib/orb/internal/type/boolean.rb +7 -1
- data/lib/orb/internal/type/converter.rb +42 -34
- data/lib/orb/internal/type/enum.rb +10 -2
- data/lib/orb/internal/type/file_input.rb +6 -1
- data/lib/orb/internal/type/hash_of.rb +6 -1
- data/lib/orb/internal/type/union.rb +12 -7
- data/lib/orb/internal/type/unknown.rb +7 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +4 -4
- data/lib/orb/models/invoice.rb +4 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +4 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -1
- data/lib/orb/models/new_plan_bps_price.rb +10 -1
- data/lib/orb/models/new_plan_bulk_bps_price.rb +10 -1
- data/lib/orb/models/new_plan_bulk_price.rb +10 -1
- data/lib/orb/models/new_plan_bulk_with_proration_price.rb +10 -1
- data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_allocation_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_tiered_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_matrix_price.rb +10 -1
- data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +10 -1
- data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +10 -1
- data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +10 -1
- data/lib/orb/models/new_plan_package_price.rb +10 -1
- data/lib/orb/models/new_plan_package_with_allocation_price.rb +10 -1
- data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +10 -1
- data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +10 -1
- data/lib/orb/models/new_plan_threshold_total_amount_price.rb +10 -1
- data/lib/orb/models/new_plan_tier_with_proration_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_bps_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_package_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_price.rb +10 -1
- data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +10 -1
- data/lib/orb/models/new_plan_unit_price.rb +10 -1
- data/lib/orb/models/new_plan_unit_with_percent_price.rb +10 -1
- data/lib/orb/models/new_plan_unit_with_proration_price.rb +10 -1
- data/lib/orb/models/plan_create_params.rb +185 -37
- data/lib/orb/resources/customers/credits/ledger.rb +6 -6
- data/lib/orb/resources/plans.rb +6 -2
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/errors.rbi +16 -0
- data/rbi/orb/internal/type/boolean.rbi +2 -0
- data/rbi/orb/internal/type/converter.rbi +15 -15
- data/rbi/orb/internal/type/union.rbi +5 -0
- data/rbi/orb/internal/type/unknown.rbi +2 -0
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +3 -3
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +3 -3
- data/rbi/orb/models/invoice.rbi +2 -0
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2 -0
- data/rbi/orb/models/invoice_line_item_create_response.rbi +2 -0
- data/rbi/orb/models/new_plan_bps_price.rbi +13 -3
- data/rbi/orb/models/new_plan_bulk_bps_price.rbi +13 -3
- data/rbi/orb/models/new_plan_bulk_price.rbi +13 -3
- data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +13 -3
- data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_matrix_price.rbi +13 -3
- data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +13 -3
- data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +13 -3
- data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +13 -3
- data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +13 -3
- data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +13 -3
- data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_bps_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_package_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_price.rbi +13 -3
- data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +13 -3
- data/rbi/orb/models/new_plan_unit_price.rbi +13 -3
- data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +13 -3
- data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +13 -3
- data/rbi/orb/models/plan_create_params.rbi +415 -135
- data/rbi/orb/resources/customers/credits/ledger.rbi +6 -6
- data/rbi/orb/resources/plans.rbi +11 -33
- data/sig/orb/errors.rbs +9 -0
- data/sig/orb/internal/type/converter.rbs +7 -1
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +1 -1
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +1 -1
- data/sig/orb/models/new_plan_bps_price.rbs +8 -3
- data/sig/orb/models/new_plan_bulk_bps_price.rbs +8 -3
- data/sig/orb/models/new_plan_bulk_price.rbs +8 -3
- data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +8 -3
- data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_allocation_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_tiered_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_matrix_price.rbs +8 -3
- data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +8 -3
- data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +8 -3
- data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_package_with_allocation_price.rbs +8 -3
- data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +8 -3
- data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +8 -3
- data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +8 -3
- data/sig/orb/models/new_plan_tier_with_proration_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_bps_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_package_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_price.rbs +8 -3
- data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +8 -3
- data/sig/orb/models/new_plan_unit_price.rbs +8 -3
- data/sig/orb/models/new_plan_unit_with_percent_price.rbs +8 -3
- data/sig/orb/models/new_plan_unit_with_proration_price.rbs +8 -3
- data/sig/orb/models/plan_create_params.rbs +156 -37
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/plans.rbs +3 -1
- metadata +2 -2
@@ -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::NewPlanUnitPrice::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
|
@@ -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::NewPlanUnitWithPercentPrice::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
|
@@ -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::NewPlanUnitWithProrationPrice::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
|