orb-billing 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.38
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/README.md +29 -5
- data/lib/orb/internal/page.rb +6 -2
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/orb/internal/type/array_of.rb +5 -3
- data/lib/orb/internal/type/base_model.rb +12 -6
- data/lib/orb/internal/type/base_page.rb +4 -1
- data/lib/orb/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/orb/internal/type/converter.rb +6 -1
- data/lib/orb/internal/type/enum.rb +2 -0
- data/lib/orb/internal/type/hash_of.rb +3 -1
- data/lib/orb/internal/util.rb +28 -45
- data/lib/orb/models/alert.rb +1 -1
- data/lib/orb/models/coupon_list_params.rb +1 -1
- data/lib/orb/models/customer.rb +5 -5
- data/lib/orb/models/customer_create_params.rb +6 -6
- data/lib/orb/models/customer_update_by_external_id_params.rb +6 -6
- data/lib/orb/models/customer_update_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credit_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_params.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_create_response.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/credits/top_up_list_response.rb +2 -2
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +1 -1
- data/lib/orb/models/event_search_response.rb +1 -1
- data/lib/orb/models/events/backfill_close_response.rb +1 -1
- data/lib/orb/models/events/backfill_create_params.rb +1 -1
- data/lib/orb/models/events/backfill_create_response.rb +1 -1
- data/lib/orb/models/events/backfill_fetch_response.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +1 -1
- data/lib/orb/models/events/backfill_revert_response.rb +1 -1
- data/lib/orb/models/invoice.rb +8 -8
- data/lib/orb/models/invoice_create_params.rb +1 -1
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +8 -8
- data/lib/orb/models/invoice_issue_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +5 -5
- data/lib/orb/models/invoice_list_params.rb +1 -1
- data/lib/orb/models/pagination_metadata.rb +1 -1
- data/lib/orb/models/plan.rb +5 -5
- data/lib/orb/models/plan_create_params.rb +25 -25
- data/lib/orb/models/price.rb +28 -28
- data/lib/orb/models/price_create_params.rb +1 -1
- data/lib/orb/models/subscription.rb +6 -6
- data/lib/orb/models/subscription_cancel_params.rb +1 -1
- data/lib/orb/models/subscription_cancel_response.rb +6 -6
- data/lib/orb/models/subscription_create_params.rb +64 -64
- data/lib/orb/models/subscription_create_response.rb +6 -6
- data/lib/orb/models/subscription_price_intervals_params.rb +35 -35
- data/lib/orb/models/subscription_price_intervals_response.rb +6 -6
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +64 -64
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +6 -6
- data/lib/orb/models/subscription_trigger_phase_params.rb +1 -1
- data/lib/orb/models/subscription_trigger_phase_response.rb +6 -6
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +6 -6
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +6 -6
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +6 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +6 -6
- data/lib/orb/models/subscription_update_params.rb +1 -1
- data/lib/orb/models/subscription_update_trial_params.rb +1 -1
- data/lib/orb/models/subscription_update_trial_response.rb +6 -6
- data/lib/orb/resources/alerts.rb +6 -1
- data/lib/orb/resources/credit_notes.rb +6 -1
- data/lib/orb/resources/customers/balance_transactions.rb +6 -1
- data/lib/orb/resources/customers/credits/ledger.rb +12 -2
- data/lib/orb/resources/customers.rb +6 -1
- data/lib/orb/resources/invoices.rb +10 -1
- data/lib/orb/resources/metrics.rb +6 -1
- data/lib/orb/resources/plans.rb +6 -1
- data/lib/orb/resources/subscriptions.rb +12 -2
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -1
- data/rbi/lib/orb/internal/type/array_of.rbi +2 -2
- data/rbi/lib/orb/internal/type/{boolean_model.rbi → boolean.rbi} +1 -1
- data/rbi/lib/orb/internal/util.rbi +7 -5
- data/rbi/lib/orb/version.rbi +1 -1
- data/sig/orb/internal/type/array_of.rbs +2 -2
- data/sig/orb/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/orb/internal/util.rbs +5 -5
- data/sig/orb/version.rbs +1 -1
- metadata +5 -5
@@ -28,7 +28,7 @@ module Orb
|
|
28
28
|
# when a payment provider is provided on customer creation.
|
29
29
|
#
|
30
30
|
# @return [Boolean, nil]
|
31
|
-
optional :auto_collection, Orb::Internal::Type::
|
31
|
+
optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
|
32
32
|
|
33
33
|
# @!attribute billing_address
|
34
34
|
#
|
@@ -53,7 +53,7 @@ module Orb
|
|
53
53
|
# @!attribute email_delivery
|
54
54
|
#
|
55
55
|
# @return [Boolean, nil]
|
56
|
-
optional :email_delivery, Orb::Internal::Type::
|
56
|
+
optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
|
57
57
|
|
58
58
|
# @!attribute external_customer_id
|
59
59
|
# The external customer ID. This can only be set if empty and the customer has no
|
@@ -291,7 +291,7 @@ module Orb
|
|
291
291
|
# @!attribute excluded
|
292
292
|
#
|
293
293
|
# @return [Boolean, nil]
|
294
|
-
optional :excluded, Orb::Internal::Type::
|
294
|
+
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
295
295
|
|
296
296
|
# @!parse
|
297
297
|
# # @param accounting_providers [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
@@ -423,7 +423,7 @@ module Orb
|
|
423
423
|
# @!attribute exempt
|
424
424
|
#
|
425
425
|
# @return [Boolean]
|
426
|
-
required :exempt, Orb::Internal::Type::
|
426
|
+
required :exempt, Orb::Internal::Type::Boolean
|
427
427
|
|
428
428
|
# @!parse
|
429
429
|
# # @param exempt [Boolean]
|
@@ -492,7 +492,7 @@ module Orb
|
|
492
492
|
# @!attribute tax_exempt
|
493
493
|
#
|
494
494
|
# @return [Boolean]
|
495
|
-
required :tax_exempt, Orb::Internal::Type::
|
495
|
+
required :tax_exempt, Orb::Internal::Type::Boolean
|
496
496
|
|
497
497
|
# @!attribute tax_provider
|
498
498
|
#
|
@@ -518,7 +518,7 @@ module Orb
|
|
518
518
|
# @!attribute tax_exempt
|
519
519
|
#
|
520
520
|
# @return [Boolean]
|
521
|
-
required :tax_exempt, Orb::Internal::Type::
|
521
|
+
required :tax_exempt, Orb::Internal::Type::Boolean
|
522
522
|
|
523
523
|
# @!attribute tax_provider
|
524
524
|
#
|
@@ -28,7 +28,7 @@ module Orb
|
|
28
28
|
# when a payment provider is provided on customer creation.
|
29
29
|
#
|
30
30
|
# @return [Boolean, nil]
|
31
|
-
optional :auto_collection, Orb::Internal::Type::
|
31
|
+
optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
|
32
32
|
|
33
33
|
# @!attribute billing_address
|
34
34
|
#
|
@@ -51,7 +51,7 @@ module Orb
|
|
51
51
|
# @!attribute email_delivery
|
52
52
|
#
|
53
53
|
# @return [Boolean, nil]
|
54
|
-
optional :email_delivery, Orb::Internal::Type::
|
54
|
+
optional :email_delivery, Orb::Internal::Type::Boolean, nil?: true
|
55
55
|
|
56
56
|
# @!attribute external_customer_id
|
57
57
|
# The external customer ID. This can only be set if empty and the customer has no
|
@@ -283,7 +283,7 @@ module Orb
|
|
283
283
|
# @!attribute excluded
|
284
284
|
#
|
285
285
|
# @return [Boolean, nil]
|
286
|
-
optional :excluded, Orb::Internal::Type::
|
286
|
+
optional :excluded, Orb::Internal::Type::Boolean, nil?: true
|
287
287
|
|
288
288
|
# @!parse
|
289
289
|
# # @param accounting_providers [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
|
@@ -415,7 +415,7 @@ module Orb
|
|
415
415
|
# @!attribute exempt
|
416
416
|
#
|
417
417
|
# @return [Boolean]
|
418
|
-
required :exempt, Orb::Internal::Type::
|
418
|
+
required :exempt, Orb::Internal::Type::Boolean
|
419
419
|
|
420
420
|
# @!parse
|
421
421
|
# # @param exempt [Boolean]
|
@@ -482,7 +482,7 @@ module Orb
|
|
482
482
|
# @!attribute tax_exempt
|
483
483
|
#
|
484
484
|
# @return [Boolean]
|
485
|
-
required :tax_exempt, Orb::Internal::Type::
|
485
|
+
required :tax_exempt, Orb::Internal::Type::Boolean
|
486
486
|
|
487
487
|
# @!attribute tax_provider
|
488
488
|
#
|
@@ -508,7 +508,7 @@ module Orb
|
|
508
508
|
# @!attribute tax_exempt
|
509
509
|
#
|
510
510
|
# @return [Boolean]
|
511
|
-
required :tax_exempt, Orb::Internal::Type::
|
511
|
+
required :tax_exempt, Orb::Internal::Type::Boolean
|
512
512
|
|
513
513
|
# @!attribute tax_provider
|
514
514
|
#
|
@@ -153,7 +153,7 @@ module Orb
|
|
153
153
|
# saved payment method.
|
154
154
|
#
|
155
155
|
# @return [Boolean]
|
156
|
-
required :auto_collection, Orb::Internal::Type::
|
156
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
157
157
|
|
158
158
|
# @!attribute net_terms
|
159
159
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -174,7 +174,7 @@ module Orb
|
|
174
174
|
# paid before it can be drawn down from.
|
175
175
|
#
|
176
176
|
# @return [Boolean, nil]
|
177
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
177
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
178
178
|
|
179
179
|
# @!parse
|
180
180
|
# # @return [Boolean]
|
@@ -152,7 +152,7 @@ module Orb
|
|
152
152
|
# saved payment method.
|
153
153
|
#
|
154
154
|
# @return [Boolean]
|
155
|
-
required :auto_collection, Orb::Internal::Type::
|
155
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
156
156
|
|
157
157
|
# @!attribute net_terms
|
158
158
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -173,7 +173,7 @@ module Orb
|
|
173
173
|
# paid before it can be drawn down from.
|
174
174
|
#
|
175
175
|
# @return [Boolean, nil]
|
176
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
176
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
177
177
|
|
178
178
|
# @!parse
|
179
179
|
# # @return [Boolean]
|
@@ -99,7 +99,7 @@ module Orb
|
|
99
99
|
# saved payment method.
|
100
100
|
#
|
101
101
|
# @return [Boolean]
|
102
|
-
required :auto_collection, Orb::Internal::Type::
|
102
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
103
103
|
|
104
104
|
# @!attribute net_terms
|
105
105
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -120,7 +120,7 @@ module Orb
|
|
120
120
|
# corresponding invoice is paid before they can be drawn down from.
|
121
121
|
#
|
122
122
|
# @return [Boolean, nil]
|
123
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
123
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
124
124
|
|
125
125
|
# @!parse
|
126
126
|
# # @return [Boolean]
|
@@ -92,7 +92,7 @@ module Orb
|
|
92
92
|
# saved payment method.
|
93
93
|
#
|
94
94
|
# @return [Boolean]
|
95
|
-
required :auto_collection, Orb::Internal::Type::
|
95
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
96
96
|
|
97
97
|
# @!attribute net_terms
|
98
98
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -113,7 +113,7 @@ module Orb
|
|
113
113
|
# corresponding invoice is paid before they can be drawn down from.
|
114
114
|
#
|
115
115
|
# @return [Boolean, nil]
|
116
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
116
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
117
117
|
|
118
118
|
# @!parse
|
119
119
|
# # @return [Boolean]
|
@@ -98,7 +98,7 @@ module Orb
|
|
98
98
|
# saved payment method.
|
99
99
|
#
|
100
100
|
# @return [Boolean]
|
101
|
-
required :auto_collection, Orb::Internal::Type::
|
101
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
102
102
|
|
103
103
|
# @!attribute net_terms
|
104
104
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -119,7 +119,7 @@ module Orb
|
|
119
119
|
# corresponding invoice is paid before they can be drawn down from.
|
120
120
|
#
|
121
121
|
# @return [Boolean, nil]
|
122
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
122
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
123
123
|
|
124
124
|
# @!parse
|
125
125
|
# # @return [Boolean]
|
@@ -91,7 +91,7 @@ module Orb
|
|
91
91
|
# saved payment method.
|
92
92
|
#
|
93
93
|
# @return [Boolean]
|
94
|
-
required :auto_collection, Orb::Internal::Type::
|
94
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
95
95
|
|
96
96
|
# @!attribute net_terms
|
97
97
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -112,7 +112,7 @@ module Orb
|
|
112
112
|
# corresponding invoice is paid before they can be drawn down from.
|
113
113
|
#
|
114
114
|
# @return [Boolean, nil]
|
115
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
115
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
116
116
|
|
117
117
|
# @!parse
|
118
118
|
# # @return [Boolean]
|
@@ -92,7 +92,7 @@ module Orb
|
|
92
92
|
# saved payment method.
|
93
93
|
#
|
94
94
|
# @return [Boolean]
|
95
|
-
required :auto_collection, Orb::Internal::Type::
|
95
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
96
96
|
|
97
97
|
# @!attribute net_terms
|
98
98
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -113,7 +113,7 @@ module Orb
|
|
113
113
|
# corresponding invoice is paid before they can be drawn down from.
|
114
114
|
#
|
115
115
|
# @return [Boolean, nil]
|
116
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
116
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
117
117
|
|
118
118
|
# @!parse
|
119
119
|
# # @return [Boolean]
|
@@ -91,7 +91,7 @@ module Orb
|
|
91
91
|
# saved payment method.
|
92
92
|
#
|
93
93
|
# @return [Boolean]
|
94
|
-
required :auto_collection, Orb::Internal::Type::
|
94
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
95
95
|
|
96
96
|
# @!attribute net_terms
|
97
97
|
# The net terms determines the difference between the invoice date and the issue
|
@@ -112,7 +112,7 @@ module Orb
|
|
112
112
|
# corresponding invoice is paid before they can be drawn down from.
|
113
113
|
#
|
114
114
|
# @return [Boolean, nil]
|
115
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
115
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
116
116
|
|
117
117
|
# @!parse
|
118
118
|
# # @return [Boolean]
|
@@ -24,7 +24,7 @@ module Orb
|
|
24
24
|
# Flag to enable additional debug information in the endpoint response
|
25
25
|
#
|
26
26
|
# @return [Boolean, nil]
|
27
|
-
optional :debug, Orb::Internal::Type::
|
27
|
+
optional :debug, Orb::Internal::Type::Boolean
|
28
28
|
|
29
29
|
# @!parse
|
30
30
|
# # @return [Boolean]
|
@@ -35,7 +35,7 @@ module Orb
|
|
35
35
|
# A boolean indicating whether the event is currently deprecated.
|
36
36
|
#
|
37
37
|
# @return [Boolean]
|
38
|
-
required :deprecated, Orb::Internal::Type::
|
38
|
+
required :deprecated, Orb::Internal::Type::Boolean
|
39
39
|
|
40
40
|
# @!attribute event_name
|
41
41
|
# A name to meaningfully identify the action or event type.
|
@@ -41,7 +41,7 @@ module Orb
|
|
41
41
|
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -60,7 +60,7 @@ module Orb
|
|
60
60
|
# events. If false, adds the newly ingested events to the existing events.
|
61
61
|
#
|
62
62
|
# @return [Boolean, nil]
|
63
|
-
optional :replace_existing_events, Orb::Internal::Type::
|
63
|
+
optional :replace_existing_events, Orb::Internal::Type::Boolean
|
64
64
|
|
65
65
|
# @!parse
|
66
66
|
# # @return [Boolean]
|
@@ -41,7 +41,7 @@ module Orb
|
|
41
41
|
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -41,7 +41,7 @@ module Orb
|
|
41
41
|
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -41,7 +41,7 @@ module Orb
|
|
41
41
|
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
@@ -41,7 +41,7 @@ module Orb
|
|
41
41
|
# events will be added to the existing events.
|
42
42
|
#
|
43
43
|
# @return [Boolean]
|
44
|
-
required :replace_existing_events, Orb::Internal::Type::
|
44
|
+
required :replace_existing_events, Orb::Internal::Type::Boolean
|
45
45
|
|
46
46
|
# @!attribute reverted_at
|
47
47
|
# The time at which this backfill was reverted.
|
data/lib/orb/models/invoice.rb
CHANGED
@@ -362,7 +362,7 @@ module Orb
|
|
362
362
|
# false otherwise.
|
363
363
|
#
|
364
364
|
# @return [Boolean]
|
365
|
-
required :will_auto_issue, Orb::Internal::Type::
|
365
|
+
required :will_auto_issue, Orb::Internal::Type::Boolean
|
366
366
|
|
367
367
|
# @!parse
|
368
368
|
# # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
@@ -468,7 +468,7 @@ module Orb
|
|
468
468
|
# True only if auto-collection is enabled for this invoice.
|
469
469
|
#
|
470
470
|
# @return [Boolean, nil]
|
471
|
-
required :enabled, Orb::Internal::Type::
|
471
|
+
required :enabled, Orb::Internal::Type::Boolean, nil?: true
|
472
472
|
|
473
473
|
# @!attribute next_attempt_at
|
474
474
|
# If the invoice is scheduled for auto-collection, this field will reflect when
|
@@ -1354,7 +1354,7 @@ module Orb
|
|
1354
1354
|
# that apply to only one price.
|
1355
1355
|
#
|
1356
1356
|
# @return [Boolean]
|
1357
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1357
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1358
1358
|
|
1359
1359
|
# @!attribute reason
|
1360
1360
|
# The reason for the adjustment.
|
@@ -1429,7 +1429,7 @@ module Orb
|
|
1429
1429
|
# that apply to only one price.
|
1430
1430
|
#
|
1431
1431
|
# @return [Boolean]
|
1432
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1432
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1433
1433
|
|
1434
1434
|
# @!attribute reason
|
1435
1435
|
# The reason for the adjustment.
|
@@ -1490,7 +1490,7 @@ module Orb
|
|
1490
1490
|
# that apply to only one price.
|
1491
1491
|
#
|
1492
1492
|
# @return [Boolean]
|
1493
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1493
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1494
1494
|
|
1495
1495
|
# @!attribute percentage_discount
|
1496
1496
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
@@ -1558,7 +1558,7 @@ module Orb
|
|
1558
1558
|
# that apply to only one price.
|
1559
1559
|
#
|
1560
1560
|
# @return [Boolean]
|
1561
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1561
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1562
1562
|
|
1563
1563
|
# @!attribute item_id
|
1564
1564
|
# The item ID that revenue from this minimum will be attributed to.
|
@@ -1634,7 +1634,7 @@ module Orb
|
|
1634
1634
|
# that apply to only one price.
|
1635
1635
|
#
|
1636
1636
|
# @return [Boolean]
|
1637
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1637
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1638
1638
|
|
1639
1639
|
# @!attribute maximum_amount
|
1640
1640
|
# The maximum amount to charge in a given billing period for the prices this
|
@@ -2109,7 +2109,7 @@ module Orb
|
|
2109
2109
|
# Whether the payment attempt succeeded.
|
2110
2110
|
#
|
2111
2111
|
# @return [Boolean]
|
2112
|
-
required :succeeded, Orb::Internal::Type::
|
2112
|
+
required :succeeded, Orb::Internal::Type::Boolean
|
2113
2113
|
|
2114
2114
|
# @!parse
|
2115
2115
|
# # @param id [String]
|
@@ -75,7 +75,7 @@ module Orb
|
|
75
75
|
# the resulting invoice will require manual review to issue. Defaulted to false.
|
76
76
|
#
|
77
77
|
# @return [Boolean, nil]
|
78
|
-
optional :will_auto_issue, Orb::Internal::Type::
|
78
|
+
optional :will_auto_issue, Orb::Internal::Type::Boolean
|
79
79
|
|
80
80
|
# @!parse
|
81
81
|
# # @return [Boolean]
|
@@ -365,7 +365,7 @@ module Orb
|
|
365
365
|
# false otherwise.
|
366
366
|
#
|
367
367
|
# @return [Boolean]
|
368
|
-
required :will_auto_issue, Orb::Internal::Type::
|
368
|
+
required :will_auto_issue, Orb::Internal::Type::Boolean
|
369
369
|
|
370
370
|
# @!parse
|
371
371
|
# # @param id [String]
|
@@ -465,7 +465,7 @@ module Orb
|
|
465
465
|
# True only if auto-collection is enabled for this invoice.
|
466
466
|
#
|
467
467
|
# @return [Boolean, nil]
|
468
|
-
required :enabled, Orb::Internal::Type::
|
468
|
+
required :enabled, Orb::Internal::Type::Boolean, nil?: true
|
469
469
|
|
470
470
|
# @!attribute next_attempt_at
|
471
471
|
# If the invoice is scheduled for auto-collection, this field will reflect when
|
@@ -1359,7 +1359,7 @@ module Orb
|
|
1359
1359
|
# that apply to only one price.
|
1360
1360
|
#
|
1361
1361
|
# @return [Boolean]
|
1362
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1362
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1363
1363
|
|
1364
1364
|
# @!attribute reason
|
1365
1365
|
# The reason for the adjustment.
|
@@ -1434,7 +1434,7 @@ module Orb
|
|
1434
1434
|
# that apply to only one price.
|
1435
1435
|
#
|
1436
1436
|
# @return [Boolean]
|
1437
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1437
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1438
1438
|
|
1439
1439
|
# @!attribute reason
|
1440
1440
|
# The reason for the adjustment.
|
@@ -1495,7 +1495,7 @@ module Orb
|
|
1495
1495
|
# that apply to only one price.
|
1496
1496
|
#
|
1497
1497
|
# @return [Boolean]
|
1498
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1498
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1499
1499
|
|
1500
1500
|
# @!attribute percentage_discount
|
1501
1501
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
@@ -1563,7 +1563,7 @@ module Orb
|
|
1563
1563
|
# that apply to only one price.
|
1564
1564
|
#
|
1565
1565
|
# @return [Boolean]
|
1566
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1566
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1567
1567
|
|
1568
1568
|
# @!attribute item_id
|
1569
1569
|
# The item ID that revenue from this minimum will be attributed to.
|
@@ -1639,7 +1639,7 @@ module Orb
|
|
1639
1639
|
# that apply to only one price.
|
1640
1640
|
#
|
1641
1641
|
# @return [Boolean]
|
1642
|
-
required :is_invoice_level, Orb::Internal::Type::
|
1642
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
1643
1643
|
|
1644
1644
|
# @!attribute maximum_amount
|
1645
1645
|
# The maximum amount to charge in a given billing period for the prices this
|
@@ -2119,7 +2119,7 @@ module Orb
|
|
2119
2119
|
# Whether the payment attempt succeeded.
|
2120
2120
|
#
|
2121
2121
|
# @return [Boolean]
|
2122
|
-
required :succeeded, Orb::Internal::Type::
|
2122
|
+
required :succeeded, Orb::Internal::Type::Boolean
|
2123
2123
|
|
2124
2124
|
# @!parse
|
2125
2125
|
# # @param id [String]
|
@@ -255,7 +255,7 @@ module Orb
|
|
255
255
|
# that apply to only one price.
|
256
256
|
#
|
257
257
|
# @return [Boolean]
|
258
|
-
required :is_invoice_level, Orb::Internal::Type::
|
258
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
259
259
|
|
260
260
|
# @!attribute reason
|
261
261
|
# The reason for the adjustment.
|
@@ -330,7 +330,7 @@ module Orb
|
|
330
330
|
# that apply to only one price.
|
331
331
|
#
|
332
332
|
# @return [Boolean]
|
333
|
-
required :is_invoice_level, Orb::Internal::Type::
|
333
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
334
334
|
|
335
335
|
# @!attribute reason
|
336
336
|
# The reason for the adjustment.
|
@@ -391,7 +391,7 @@ module Orb
|
|
391
391
|
# that apply to only one price.
|
392
392
|
#
|
393
393
|
# @return [Boolean]
|
394
|
-
required :is_invoice_level, Orb::Internal::Type::
|
394
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
395
395
|
|
396
396
|
# @!attribute percentage_discount
|
397
397
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
@@ -459,7 +459,7 @@ module Orb
|
|
459
459
|
# that apply to only one price.
|
460
460
|
#
|
461
461
|
# @return [Boolean]
|
462
|
-
required :is_invoice_level, Orb::Internal::Type::
|
462
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
463
463
|
|
464
464
|
# @!attribute item_id
|
465
465
|
# The item ID that revenue from this minimum will be attributed to.
|
@@ -535,7 +535,7 @@ module Orb
|
|
535
535
|
# that apply to only one price.
|
536
536
|
#
|
537
537
|
# @return [Boolean]
|
538
|
-
required :is_invoice_level, Orb::Internal::Type::
|
538
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
539
539
|
|
540
540
|
# @!attribute maximum_amount
|
541
541
|
# The maximum amount to charge in a given billing period for the prices this
|
@@ -92,7 +92,7 @@ module Orb
|
|
92
92
|
# @!attribute is_recurring
|
93
93
|
#
|
94
94
|
# @return [Boolean, nil]
|
95
|
-
optional :is_recurring, Orb::Internal::Type::
|
95
|
+
optional :is_recurring, Orb::Internal::Type::Boolean, nil?: true
|
96
96
|
|
97
97
|
# @!attribute [r] limit
|
98
98
|
# The number of items to fetch. Defaults to 20.
|
data/lib/orb/models/plan.rb
CHANGED
@@ -248,7 +248,7 @@ module Orb
|
|
248
248
|
# that apply to only one price.
|
249
249
|
#
|
250
250
|
# @return [Boolean]
|
251
|
-
required :is_invoice_level, Orb::Internal::Type::
|
251
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
252
252
|
|
253
253
|
# @!attribute plan_phase_order
|
254
254
|
# The plan phase in which this adjustment is active.
|
@@ -323,7 +323,7 @@ module Orb
|
|
323
323
|
# that apply to only one price.
|
324
324
|
#
|
325
325
|
# @return [Boolean]
|
326
|
-
required :is_invoice_level, Orb::Internal::Type::
|
326
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
327
327
|
|
328
328
|
# @!attribute plan_phase_order
|
329
329
|
# The plan phase in which this adjustment is active.
|
@@ -384,7 +384,7 @@ module Orb
|
|
384
384
|
# that apply to only one price.
|
385
385
|
#
|
386
386
|
# @return [Boolean]
|
387
|
-
required :is_invoice_level, Orb::Internal::Type::
|
387
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
388
388
|
|
389
389
|
# @!attribute percentage_discount
|
390
390
|
# The percentage (as a value between 0 and 1) by which to discount the price
|
@@ -452,7 +452,7 @@ module Orb
|
|
452
452
|
# that apply to only one price.
|
453
453
|
#
|
454
454
|
# @return [Boolean]
|
455
|
-
required :is_invoice_level, Orb::Internal::Type::
|
455
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
456
456
|
|
457
457
|
# @!attribute item_id
|
458
458
|
# The item ID that revenue from this minimum will be attributed to.
|
@@ -528,7 +528,7 @@ module Orb
|
|
528
528
|
# that apply to only one price.
|
529
529
|
#
|
530
530
|
# @return [Boolean]
|
531
|
-
required :is_invoice_level, Orb::Internal::Type::
|
531
|
+
required :is_invoice_level, Orb::Internal::Type::Boolean
|
532
532
|
|
533
533
|
# @!attribute maximum_amount
|
534
534
|
# The maximum amount to charge in a given billing period for the prices this
|