orb-billing 0.7.0 → 0.9.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 (50) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +100 -10
  5. data/lib/orb/models/beta_create_plan_version_params.rb +96 -10
  6. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +5 -3
  7. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +5 -3
  8. data/lib/orb/models/customers/credits/top_up_create_params.rb +5 -3
  9. data/lib/orb/models/customers/credits/top_up_create_response.rb +5 -3
  10. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +5 -3
  11. data/lib/orb/models/customers/credits/top_up_list_response.rb +5 -3
  12. data/lib/orb/models/event_ingest_params.rb +3 -3
  13. data/lib/orb/models/event_search_response.rb +3 -3
  14. data/lib/orb/models/event_update_params.rb +3 -3
  15. data/lib/orb/models/price.rb +1114 -28
  16. data/lib/orb/models/price_evaluate_multiple_params.rb +3 -3
  17. data/lib/orb/models/subscription_create_params.rb +96 -10
  18. data/lib/orb/models/subscription_price_intervals_params.rb +48 -5
  19. data/lib/orb/models/subscription_schedule_plan_change_params.rb +100 -10
  20. data/lib/orb/resources/events.rb +1 -1
  21. data/lib/orb/version.rb +1 -1
  22. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +226 -12
  23. data/rbi/orb/models/beta_create_plan_version_params.rbi +226 -12
  24. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +8 -4
  25. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +8 -4
  26. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +8 -4
  27. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +8 -4
  28. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +8 -4
  29. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +8 -4
  30. data/rbi/orb/models/event_ingest_params.rbi +3 -3
  31. data/rbi/orb/models/event_search_response.rbi +3 -3
  32. data/rbi/orb/models/event_update_params.rbi +3 -3
  33. data/rbi/orb/models/price.rbi +3220 -184
  34. data/rbi/orb/models/price_evaluate_multiple_params.rbi +3 -3
  35. data/rbi/orb/models/subscription_create_params.rbi +226 -12
  36. data/rbi/orb/models/subscription_price_intervals_params.rbi +113 -6
  37. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +226 -12
  38. data/rbi/orb/resources/events.rbi +1 -1
  39. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +84 -8
  40. data/sig/orb/models/beta_create_plan_version_params.rbs +84 -8
  41. data/sig/orb/models/event_ingest_params.rbs +4 -4
  42. data/sig/orb/models/event_search_response.rbs +4 -4
  43. data/sig/orb/models/event_update_params.rbs +4 -4
  44. data/sig/orb/models/price.rbs +1430 -86
  45. data/sig/orb/models/price_evaluate_multiple_params.rbs +4 -4
  46. data/sig/orb/models/subscription_create_params.rbs +84 -8
  47. data/sig/orb/models/subscription_price_intervals_params.rbs +42 -4
  48. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +84 -8
  49. data/sig/orb/resources/events.rbs +1 -1
  50. metadata +2 -2
@@ -156,8 +156,10 @@ module Orb
156
156
  sig { returns(T.nilable(String)) }
157
157
  attr_accessor :memo
158
158
 
159
- # If true, new credit blocks created by this top-up will require that the
160
- # corresponding invoice is paid before they can be drawn down from.
159
+ # When true, credit blocks created by this top-up will require that the
160
+ # corresponding invoice is paid before they are drawn down from. If any topup
161
+ # block is pending payment, further automatic top-ups will be paused until the
162
+ # invoice is paid or voided.
161
163
  sig { returns(T.nilable(T::Boolean)) }
162
164
  attr_reader :require_successful_payment
163
165
 
@@ -183,8 +185,10 @@ module Orb
183
185
  net_terms:,
184
186
  # An optional memo to display on the invoice.
185
187
  memo: nil,
186
- # If true, new credit blocks created by this top-up will require that the
187
- # corresponding invoice is paid before they can be drawn down from.
188
+ # When true, credit blocks created by this top-up will require that the
189
+ # corresponding invoice is paid before they are drawn down from. If any topup
190
+ # block is pending payment, further automatic top-ups will be paused until the
191
+ # invoice is paid or voided.
188
192
  require_successful_payment: nil
189
193
  )
190
194
  end
@@ -148,8 +148,10 @@ module Orb
148
148
  sig { returns(T.nilable(String)) }
149
149
  attr_accessor :memo
150
150
 
151
- # If true, new credit blocks created by this top-up will require that the
152
- # corresponding invoice is paid before they can be drawn down from.
151
+ # When true, credit blocks created by this top-up will require that the
152
+ # corresponding invoice is paid before they are drawn down from. If any topup
153
+ # block is pending payment, further automatic top-ups will be paused until the
154
+ # invoice is paid or voided.
153
155
  sig { returns(T.nilable(T::Boolean)) }
154
156
  attr_reader :require_successful_payment
155
157
 
@@ -175,8 +177,10 @@ module Orb
175
177
  net_terms:,
176
178
  # An optional memo to display on the invoice.
177
179
  memo: nil,
178
- # If true, new credit blocks created by this top-up will require that the
179
- # corresponding invoice is paid before they can be drawn down from.
180
+ # When true, credit blocks created by this top-up will require that the
181
+ # corresponding invoice is paid before they are drawn down from. If any topup
182
+ # block is pending payment, further automatic top-ups will be paused until the
183
+ # invoice is paid or voided.
180
184
  require_successful_payment: nil
181
185
  )
182
186
  end
@@ -148,8 +148,10 @@ module Orb
148
148
  sig { returns(T.nilable(String)) }
149
149
  attr_accessor :memo
150
150
 
151
- # If true, new credit blocks created by this top-up will require that the
152
- # corresponding invoice is paid before they can be drawn down from.
151
+ # When true, credit blocks created by this top-up will require that the
152
+ # corresponding invoice is paid before they are drawn down from. If any topup
153
+ # block is pending payment, further automatic top-ups will be paused until the
154
+ # invoice is paid or voided.
153
155
  sig { returns(T.nilable(T::Boolean)) }
154
156
  attr_reader :require_successful_payment
155
157
 
@@ -175,8 +177,10 @@ module Orb
175
177
  net_terms:,
176
178
  # An optional memo to display on the invoice.
177
179
  memo: nil,
178
- # If true, new credit blocks created by this top-up will require that the
179
- # corresponding invoice is paid before they can be drawn down from.
180
+ # When true, credit blocks created by this top-up will require that the
181
+ # corresponding invoice is paid before they are drawn down from. If any topup
182
+ # block is pending payment, further automatic top-ups will be paused until the
183
+ # invoice is paid or voided.
180
184
  require_successful_payment: nil
181
185
  )
182
186
  end
@@ -148,8 +148,10 @@ module Orb
148
148
  sig { returns(T.nilable(String)) }
149
149
  attr_accessor :memo
150
150
 
151
- # If true, new credit blocks created by this top-up will require that the
152
- # corresponding invoice is paid before they can be drawn down from.
151
+ # When true, credit blocks created by this top-up will require that the
152
+ # corresponding invoice is paid before they are drawn down from. If any topup
153
+ # block is pending payment, further automatic top-ups will be paused until the
154
+ # invoice is paid or voided.
153
155
  sig { returns(T.nilable(T::Boolean)) }
154
156
  attr_reader :require_successful_payment
155
157
 
@@ -175,8 +177,10 @@ module Orb
175
177
  net_terms:,
176
178
  # An optional memo to display on the invoice.
177
179
  memo: nil,
178
- # If true, new credit blocks created by this top-up will require that the
179
- # corresponding invoice is paid before they can be drawn down from.
180
+ # When true, credit blocks created by this top-up will require that the
181
+ # corresponding invoice is paid before they are drawn down from. If any topup
182
+ # block is pending payment, further automatic top-ups will be paused until the
183
+ # invoice is paid or voided.
180
184
  require_successful_payment: nil
181
185
  )
182
186
  end
@@ -74,7 +74,7 @@ module Orb
74
74
 
75
75
  # A dictionary of custom properties. Values in this dictionary must be numeric,
76
76
  # boolean, or strings. Nested dictionaries are disallowed.
77
- sig { returns(T.anything) }
77
+ sig { returns(T::Hash[Symbol, T.anything]) }
78
78
  attr_accessor :properties
79
79
 
80
80
  # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -96,7 +96,7 @@ module Orb
96
96
  params(
97
97
  event_name: String,
98
98
  idempotency_key: String,
99
- properties: T.anything,
99
+ properties: T::Hash[Symbol, T.anything],
100
100
  timestamp: Time,
101
101
  customer_id: T.nilable(String),
102
102
  external_customer_id: T.nilable(String)
@@ -129,7 +129,7 @@ module Orb
129
129
  {
130
130
  event_name: String,
131
131
  idempotency_key: String,
132
- properties: T.anything,
132
+ properties: T::Hash[Symbol, T.anything],
133
133
  timestamp: Time,
134
134
  customer_id: T.nilable(String),
135
135
  external_customer_id: T.nilable(String)
@@ -61,7 +61,7 @@ module Orb
61
61
 
62
62
  # A dictionary of custom properties. Values in this dictionary must be numeric,
63
63
  # boolean, or strings. Nested dictionaries are disallowed.
64
- sig { returns(T.anything) }
64
+ sig { returns(T::Hash[Symbol, T.anything]) }
65
65
  attr_accessor :properties
66
66
 
67
67
  # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -80,7 +80,7 @@ module Orb
80
80
  deprecated: T::Boolean,
81
81
  event_name: String,
82
82
  external_customer_id: T.nilable(String),
83
- properties: T.anything,
83
+ properties: T::Hash[Symbol, T.anything],
84
84
  timestamp: Time
85
85
  ).returns(T.attached_class)
86
86
  end
@@ -116,7 +116,7 @@ module Orb
116
116
  deprecated: T::Boolean,
117
117
  event_name: String,
118
118
  external_customer_id: T.nilable(String),
119
- properties: T.anything,
119
+ properties: T::Hash[Symbol, T.anything],
120
120
  timestamp: Time
121
121
  }
122
122
  )
@@ -15,7 +15,7 @@ module Orb
15
15
 
16
16
  # A dictionary of custom properties. Values in this dictionary must be numeric,
17
17
  # boolean, or strings. Nested dictionaries are disallowed.
18
- sig { returns(T.anything) }
18
+ sig { returns(T::Hash[Symbol, T.anything]) }
19
19
  attr_accessor :properties
20
20
 
21
21
  # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -36,7 +36,7 @@ module Orb
36
36
  sig do
37
37
  params(
38
38
  event_name: String,
39
- properties: T.anything,
39
+ properties: T::Hash[Symbol, T.anything],
40
40
  timestamp: Time,
41
41
  customer_id: T.nilable(String),
42
42
  external_customer_id: T.nilable(String),
@@ -66,7 +66,7 @@ module Orb
66
66
  override.returns(
67
67
  {
68
68
  event_name: String,
69
- properties: T.anything,
69
+ properties: T::Hash[Symbol, T.anything],
70
70
  timestamp: Time,
71
71
  customer_id: T.nilable(String),
72
72
  external_customer_id: T.nilable(String),