stigg 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.3
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 +8 -0
- data/README.md +1 -1
- data/lib/stigg/internal/type/base_model.rb +2 -2
- data/lib/stigg/models/v1/{coupon_create_response.rb → coupon.rb} +24 -24
- data/lib/stigg/models/v1/customer_import_params.rb +75 -0
- data/lib/stigg/models/v1/customer_import_response.rb +35 -0
- data/lib/stigg/models/v1/{customer_create_params.rb → customer_provision_params.rb} +16 -16
- data/lib/stigg/models/v1/customer_response.rb +1 -1
- data/lib/stigg/models/v1/customers/promotional_entitlement_grant_params.rb +296 -0
- data/lib/stigg/models/v1/customers/promotional_entitlement_grant_response.rb +341 -0
- data/lib/stigg/models/v1/customers/promotional_entitlement_revoke_params.rb +24 -0
- data/lib/stigg/models/v1/customers/promotional_entitlement_revoke_response.rb +342 -0
- data/lib/stigg/models/v1/event_report_params.rb +91 -0
- data/lib/stigg/models/v1/event_report_response.rb +25 -0
- data/lib/stigg/models/v1/{subscription_retrieve_response.rb → subscription.rb} +30 -29
- data/lib/stigg/models/v1/subscription_cancel_params.rb +75 -0
- data/lib/stigg/models/v1/subscription_import_params.rb +92 -0
- data/lib/stigg/models/v1/subscription_import_response.rb +32 -0
- data/lib/stigg/models/v1/{subscription_create_params.rb → subscription_provision_params.rb} +118 -118
- data/lib/stigg/models/v1/{subscription_create_response.rb → subscription_provision_response.rb} +76 -75
- data/lib/stigg/models/v1/subscription_update_params.rb +1114 -0
- data/lib/stigg/models/v1/subscriptions/{future_update_cancel_pending_payment_response.rb → cancel_subscription.rb} +7 -5
- data/lib/stigg/models/v1/usage_history_params.rb +54 -0
- data/lib/stigg/models/v1/usage_history_response.rb +155 -0
- data/lib/stigg/models/v1/usage_report_params.rb +114 -0
- data/lib/stigg/models/v1/usage_report_response.rb +120 -0
- data/lib/stigg/models.rb +0 -4
- data/lib/stigg/resources/v1/coupons.rb +4 -4
- data/lib/stigg/resources/v1/customers/promotional_entitlements.rb +69 -0
- data/lib/stigg/resources/v1/customers.rb +59 -37
- data/lib/stigg/resources/v1/events.rb +38 -0
- data/lib/stigg/resources/v1/subscriptions/future_update.rb +4 -4
- data/lib/stigg/resources/v1/subscriptions.rb +166 -64
- data/lib/stigg/resources/v1/usage.rb +79 -0
- data/lib/stigg/resources/v1.rb +6 -42
- data/lib/stigg/version.rb +1 -1
- data/lib/stigg.rb +25 -16
- data/rbi/stigg/models/v1/{coupon_create_response.rbi → coupon.rbi} +156 -252
- data/rbi/stigg/models/v1/customer_import_params.rbi +130 -0
- data/rbi/stigg/models/v1/customer_import_response.rbi +76 -0
- data/rbi/stigg/models/v1/{customer_create_params.rbi → customer_provision_params.rbi} +35 -35
- data/rbi/stigg/models/v1/customers/promotional_entitlement_grant_params.rbi +640 -0
- data/rbi/stigg/models/v1/customers/promotional_entitlement_grant_response.rbi +690 -0
- data/rbi/stigg/models/v1/customers/promotional_entitlement_revoke_params.rbi +42 -0
- data/rbi/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbi +696 -0
- data/rbi/stigg/models/v1/event_report_params.rbi +168 -0
- data/rbi/stigg/models/v1/event_report_response.rbi +35 -0
- data/rbi/stigg/models/v1/{subscription_migrate_response.rbi → subscription.rbi} +66 -117
- data/rbi/stigg/models/v1/subscription_cancel_params.rbi +182 -0
- data/rbi/stigg/models/v1/subscription_import_params.rbi +148 -0
- data/rbi/stigg/models/v1/subscription_import_response.rbi +69 -0
- data/rbi/stigg/models/v1/{subscription_create_params.rbi → subscription_provision_params.rbi} +794 -773
- data/rbi/stigg/models/v1/{subscription_create_response.rbi → subscription_provision_response.rbi} +481 -481
- data/rbi/stigg/models/v1/subscription_update_params.rbi +3578 -0
- data/rbi/stigg/models/v1/subscriptions/{future_update_cancel_schedule_response.rbi → cancel_subscription.rbi} +9 -16
- data/rbi/stigg/models/v1/usage_history_params.rbi +79 -0
- data/rbi/stigg/models/v1/usage_history_response.rbi +347 -0
- data/rbi/stigg/models/v1/usage_report_params.rbi +227 -0
- data/rbi/stigg/models/v1/usage_report_response.rbi +162 -0
- data/rbi/stigg/models.rbi +0 -4
- data/rbi/stigg/resources/v1/coupons.rbi +2 -2
- data/rbi/stigg/resources/v1/customers/promotional_entitlements.rbi +57 -0
- data/rbi/stigg/resources/v1/customers.rbi +53 -36
- data/rbi/stigg/resources/v1/events.rbi +28 -0
- data/rbi/stigg/resources/v1/subscriptions/future_update.rbi +2 -6
- data/rbi/stigg/resources/v1/subscriptions.rbi +179 -74
- data/rbi/stigg/resources/v1/usage.rbi +57 -0
- data/rbi/stigg/resources/v1.rbi +4 -26
- data/sig/stigg/models/v1/{coupon_create_response.rbs → coupon.rbs} +29 -32
- data/sig/stigg/models/v1/customer_import_params.rbs +74 -0
- data/sig/stigg/models/v1/customer_import_response.rbs +30 -0
- data/sig/stigg/models/v1/{customer_create_params.rbs → customer_provision_params.rbs} +22 -22
- data/sig/stigg/models/v1/customers/promotional_entitlement_grant_params.rbs +234 -0
- data/sig/stigg/models/v1/customers/promotional_entitlement_grant_response.rbs +281 -0
- data/sig/stigg/models/v1/customers/promotional_entitlement_revoke_params.rbs +27 -0
- data/sig/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbs +281 -0
- data/sig/stigg/models/v1/event_report_params.rbs +82 -0
- data/sig/stigg/models/v1/event_report_response.rbs +15 -0
- data/sig/stigg/models/v1/{subscription_retrieve_response.rbs → subscription.rbs} +36 -41
- data/sig/stigg/models/v1/subscription_cancel_params.rbs +79 -0
- data/sig/stigg/models/v1/subscription_import_params.rbs +84 -0
- data/sig/stigg/models/v1/subscription_import_response.rbs +30 -0
- data/sig/stigg/models/v1/{subscription_create_params.rbs → subscription_provision_params.rbs} +200 -200
- data/sig/stigg/models/v1/{subscription_create_response.rbs → subscription_provision_response.rbs} +106 -106
- data/sig/stigg/models/v1/subscription_update_params.rbs +1544 -0
- data/sig/stigg/models/v1/subscriptions/cancel_subscription.rbs +34 -0
- data/sig/stigg/models/v1/usage_history_params.rbs +52 -0
- data/sig/stigg/models/v1/usage_history_response.rbs +129 -0
- data/sig/stigg/models/v1/usage_report_params.rbs +102 -0
- data/sig/stigg/models/v1/usage_report_response.rbs +87 -0
- data/sig/stigg/models.rbs +0 -4
- data/sig/stigg/resources/v1/coupons.rbs +2 -2
- data/sig/stigg/resources/v1/customers/promotional_entitlements.rbs +23 -0
- data/sig/stigg/resources/v1/customers.rbs +17 -12
- data/sig/stigg/resources/v1/events.rbs +14 -0
- data/sig/stigg/resources/v1/subscriptions/future_update.rbs +2 -2
- data/sig/stigg/resources/v1/subscriptions.rbs +65 -32
- data/sig/stigg/resources/v1/usage.rbs +24 -0
- data/sig/stigg/resources/v1.rbs +2 -8
- metadata +77 -50
- data/lib/stigg/models/v1/coupon_retrieve_response.rb +0 -322
- data/lib/stigg/models/v1/subscription_delegate_response.rb +0 -314
- data/lib/stigg/models/v1/subscription_migrate_response.rb +0 -314
- data/lib/stigg/models/v1/subscription_transfer_response.rb +0 -314
- data/lib/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rb +0 -34
- data/lib/stigg/models/v1_create_event_params.rb +0 -89
- data/lib/stigg/models/v1_create_event_response.rb +0 -23
- data/lib/stigg/models/v1_create_usage_params.rb +0 -112
- data/lib/stigg/models/v1_create_usage_response.rb +0 -118
- data/lib/stigg/resources/v1/customers/usage.rb +0 -18
- data/rbi/stigg/models/v1/coupon_retrieve_response.rbi +0 -987
- data/rbi/stigg/models/v1/subscription_delegate_response.rbi +0 -618
- data/rbi/stigg/models/v1/subscription_retrieve_response.rbi +0 -618
- data/rbi/stigg/models/v1/subscription_transfer_response.rbi +0 -618
- data/rbi/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbi +0 -80
- data/rbi/stigg/models/v1_create_event_params.rbi +0 -161
- data/rbi/stigg/models/v1_create_event_response.rbi +0 -30
- data/rbi/stigg/models/v1_create_usage_params.rbi +0 -217
- data/rbi/stigg/models/v1_create_usage_response.rbi +0 -157
- data/rbi/stigg/resources/v1/customers/usage.rbi +0 -16
- data/sig/stigg/models/v1/coupon_retrieve_response.rbs +0 -394
- data/sig/stigg/models/v1/subscription_delegate_response.rbs +0 -255
- data/sig/stigg/models/v1/subscription_migrate_response.rbs +0 -255
- data/sig/stigg/models/v1/subscription_transfer_response.rbs +0 -255
- data/sig/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbs +0 -34
- data/sig/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rbs +0 -34
- data/sig/stigg/models/v1_create_event_params.rbs +0 -80
- data/sig/stigg/models/v1_create_event_response.rbs +0 -13
- data/sig/stigg/models/v1_create_usage_params.rbs +0 -100
- data/sig/stigg/models/v1_create_usage_response.rbs +0 -85
- data/sig/stigg/resources/v1/customers/usage.rbs +0 -11
data/lib/stigg/models/v1/{subscription_create_response.rb → subscription_provision_response.rb}
RENAMED
|
@@ -3,20 +3,20 @@
|
|
|
3
3
|
module Stigg
|
|
4
4
|
module Models
|
|
5
5
|
module V1
|
|
6
|
-
# @see Stigg::Resources::V1::Subscriptions#
|
|
7
|
-
class
|
|
6
|
+
# @see Stigg::Resources::V1::Subscriptions#provision
|
|
7
|
+
class SubscriptionProvisionResponse < Stigg::Internal::Type::BaseModel
|
|
8
8
|
# @!attribute data
|
|
9
9
|
# Provisioning result with status and subscription or checkout URL.
|
|
10
10
|
#
|
|
11
|
-
# @return [Stigg::Models::V1::
|
|
12
|
-
required :data, -> { Stigg::Models::V1::
|
|
11
|
+
# @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data]
|
|
12
|
+
required :data, -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data }
|
|
13
13
|
|
|
14
14
|
# @!method initialize(data:)
|
|
15
15
|
# Response object
|
|
16
16
|
#
|
|
17
|
-
# @param data [Stigg::Models::V1::
|
|
17
|
+
# @param data [Stigg::Models::V1::SubscriptionProvisionResponse::Data] Provisioning result with status and subscription or checkout URL.
|
|
18
18
|
|
|
19
|
-
# @see Stigg::Models::V1::
|
|
19
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse#data
|
|
20
20
|
class Data < Stigg::Internal::Type::BaseModel
|
|
21
21
|
# @!attribute id
|
|
22
22
|
# Unique identifier for the provisioned subscription
|
|
@@ -26,15 +26,15 @@ module Stigg
|
|
|
26
26
|
|
|
27
27
|
# @!attribute entitlements
|
|
28
28
|
#
|
|
29
|
-
# @return [Array<Stigg::Models::V1::
|
|
29
|
+
# @return [Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement>]
|
|
30
30
|
required :entitlements,
|
|
31
|
-
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::
|
|
31
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement] }
|
|
32
32
|
|
|
33
33
|
# @!attribute status
|
|
34
34
|
# Provision status: SUCCESS or PAYMENT_REQUIRED
|
|
35
35
|
#
|
|
36
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
37
|
-
required :status, enum: -> { Stigg::Models::V1::
|
|
36
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Status]
|
|
37
|
+
required :status, enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Status }
|
|
38
38
|
|
|
39
39
|
# @!attribute checkout_billing_id
|
|
40
40
|
# Checkout billing ID when payment is required
|
|
@@ -57,17 +57,17 @@ module Stigg
|
|
|
57
57
|
# @!attribute subscription
|
|
58
58
|
# Created subscription (when status is SUCCESS)
|
|
59
59
|
#
|
|
60
|
-
# @return [Stigg::Models::V1::
|
|
61
|
-
optional :subscription, -> { Stigg::Models::V1::
|
|
60
|
+
# @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription, nil]
|
|
61
|
+
optional :subscription, -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription }
|
|
62
62
|
|
|
63
63
|
# @!method initialize(id:, entitlements:, status:, checkout_billing_id: nil, checkout_url: nil, is_scheduled: nil, subscription: nil)
|
|
64
64
|
# Provisioning result with status and subscription or checkout URL.
|
|
65
65
|
#
|
|
66
66
|
# @param id [String] Unique identifier for the provisioned subscription
|
|
67
67
|
#
|
|
68
|
-
# @param entitlements [Array<Stigg::Models::V1::
|
|
68
|
+
# @param entitlements [Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement>]
|
|
69
69
|
#
|
|
70
|
-
# @param status [Symbol, Stigg::Models::V1::
|
|
70
|
+
# @param status [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Status] Provision status: SUCCESS or PAYMENT_REQUIRED
|
|
71
71
|
#
|
|
72
72
|
# @param checkout_billing_id [String, nil] Checkout billing ID when payment is required
|
|
73
73
|
#
|
|
@@ -75,7 +75,7 @@ module Stigg
|
|
|
75
75
|
#
|
|
76
76
|
# @param is_scheduled [Boolean] Whether the subscription is scheduled for future activation
|
|
77
77
|
#
|
|
78
|
-
# @param subscription [Stigg::Models::V1::
|
|
78
|
+
# @param subscription [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription] Created subscription (when status is SUCCESS)
|
|
79
79
|
|
|
80
80
|
class Entitlement < Stigg::Internal::Type::BaseModel
|
|
81
81
|
# @!attribute access_denied_reason
|
|
@@ -96,9 +96,9 @@ module Stigg
|
|
|
96
96
|
|
|
97
97
|
# @!attribute feature
|
|
98
98
|
#
|
|
99
|
-
# @return [Stigg::Models::V1::
|
|
99
|
+
# @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::Feature, nil]
|
|
100
100
|
optional :feature,
|
|
101
|
-
-> { Stigg::Models::V1::
|
|
101
|
+
-> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::Feature },
|
|
102
102
|
nil?: true
|
|
103
103
|
|
|
104
104
|
# @!attribute has_unlimited_usage
|
|
@@ -116,9 +116,9 @@ module Stigg
|
|
|
116
116
|
|
|
117
117
|
# @!attribute reset_period
|
|
118
118
|
#
|
|
119
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
119
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::ResetPeriod, nil]
|
|
120
120
|
optional :reset_period,
|
|
121
|
-
enum: -> { Stigg::Models::V1::
|
|
121
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::ResetPeriod },
|
|
122
122
|
api_name: :resetPeriod,
|
|
123
123
|
nil?: true
|
|
124
124
|
|
|
@@ -152,13 +152,13 @@ module Stigg
|
|
|
152
152
|
#
|
|
153
153
|
# @param entitlement_updated_at [Time, nil] entitlement updated at
|
|
154
154
|
#
|
|
155
|
-
# @param feature [Stigg::Models::V1::
|
|
155
|
+
# @param feature [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::Feature, nil]
|
|
156
156
|
#
|
|
157
157
|
# @param has_unlimited_usage [Boolean, nil]
|
|
158
158
|
#
|
|
159
159
|
# @param is_granted [Boolean]
|
|
160
160
|
#
|
|
161
|
-
# @param reset_period [Symbol, Stigg::Models::V1::
|
|
161
|
+
# @param reset_period [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement::ResetPeriod, nil]
|
|
162
162
|
#
|
|
163
163
|
# @param usage_limit [Float, nil]
|
|
164
164
|
#
|
|
@@ -168,7 +168,7 @@ module Stigg
|
|
|
168
168
|
#
|
|
169
169
|
# @param usage_period_start [Time, nil] usage period start
|
|
170
170
|
|
|
171
|
-
# @see Stigg::Models::V1::
|
|
171
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement#feature
|
|
172
172
|
class Feature < Stigg::Internal::Type::BaseModel
|
|
173
173
|
# @!attribute ref_id
|
|
174
174
|
# Feature ID
|
|
@@ -180,7 +180,7 @@ module Stigg
|
|
|
180
180
|
# @param ref_id [String] Feature ID
|
|
181
181
|
end
|
|
182
182
|
|
|
183
|
-
# @see Stigg::Models::V1::
|
|
183
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Entitlement#reset_period
|
|
184
184
|
module ResetPeriod
|
|
185
185
|
extend Stigg::Internal::Type::Enum
|
|
186
186
|
|
|
@@ -197,7 +197,7 @@ module Stigg
|
|
|
197
197
|
|
|
198
198
|
# Provision status: SUCCESS or PAYMENT_REQUIRED
|
|
199
199
|
#
|
|
200
|
-
# @see Stigg::Models::V1::
|
|
200
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data#status
|
|
201
201
|
module Status
|
|
202
202
|
extend Stigg::Internal::Type::Enum
|
|
203
203
|
|
|
@@ -208,7 +208,7 @@ module Stigg
|
|
|
208
208
|
# @return [Array<Symbol>]
|
|
209
209
|
end
|
|
210
210
|
|
|
211
|
-
# @see Stigg::Models::V1::
|
|
211
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data#subscription
|
|
212
212
|
class Subscription < Stigg::Internal::Type::BaseModel
|
|
213
213
|
# @!attribute id
|
|
214
214
|
# Subscription ID
|
|
@@ -237,9 +237,9 @@ module Stigg
|
|
|
237
237
|
# @!attribute payment_collection
|
|
238
238
|
# Payment collection
|
|
239
239
|
#
|
|
240
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
240
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PaymentCollection]
|
|
241
241
|
required :payment_collection,
|
|
242
|
-
enum: -> { Stigg::Models::V1::
|
|
242
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PaymentCollection },
|
|
243
243
|
api_name: :paymentCollection
|
|
244
244
|
|
|
245
245
|
# @!attribute plan_id
|
|
@@ -251,9 +251,9 @@ module Stigg
|
|
|
251
251
|
# @!attribute pricing_type
|
|
252
252
|
# Pricing type
|
|
253
253
|
#
|
|
254
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
254
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PricingType]
|
|
255
255
|
required :pricing_type,
|
|
256
|
-
enum: -> { Stigg::Models::V1::
|
|
256
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PricingType },
|
|
257
257
|
api_name: :pricingType
|
|
258
258
|
|
|
259
259
|
# @!attribute start_date
|
|
@@ -265,8 +265,9 @@ module Stigg
|
|
|
265
265
|
# @!attribute status
|
|
266
266
|
# Subscription status
|
|
267
267
|
#
|
|
268
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
269
|
-
required :status,
|
|
268
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Status]
|
|
269
|
+
required :status,
|
|
270
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Status }
|
|
270
271
|
|
|
271
272
|
# @!attribute cancellation_date
|
|
272
273
|
# Subscription cancellation date
|
|
@@ -277,9 +278,9 @@ module Stigg
|
|
|
277
278
|
# @!attribute cancel_reason
|
|
278
279
|
# Subscription cancel reason
|
|
279
280
|
#
|
|
280
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
281
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::CancelReason, nil]
|
|
281
282
|
optional :cancel_reason,
|
|
282
|
-
enum: -> { Stigg::Models::V1::
|
|
283
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::CancelReason },
|
|
283
284
|
api_name: :cancelReason,
|
|
284
285
|
nil?: true
|
|
285
286
|
|
|
@@ -322,17 +323,17 @@ module Stigg
|
|
|
322
323
|
# @!attribute payment_collection_method
|
|
323
324
|
# The method used to collect payments for a subscription
|
|
324
325
|
#
|
|
325
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
326
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PaymentCollectionMethod, nil]
|
|
326
327
|
optional :payment_collection_method,
|
|
327
|
-
enum: -> { Stigg::Models::V1::
|
|
328
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PaymentCollectionMethod },
|
|
328
329
|
api_name: :paymentCollectionMethod,
|
|
329
330
|
nil?: true
|
|
330
331
|
|
|
331
332
|
# @!attribute prices
|
|
332
333
|
#
|
|
333
|
-
# @return [Array<Stigg::Models::V1::
|
|
334
|
+
# @return [Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price>, nil]
|
|
334
335
|
optional :prices,
|
|
335
|
-
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::
|
|
336
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price] }
|
|
336
337
|
|
|
337
338
|
# @!attribute resource_id
|
|
338
339
|
# Resource ID
|
|
@@ -357,19 +358,19 @@ module Stigg
|
|
|
357
358
|
#
|
|
358
359
|
# @param customer_id [String] Customer ID
|
|
359
360
|
#
|
|
360
|
-
# @param payment_collection [Symbol, Stigg::Models::V1::
|
|
361
|
+
# @param payment_collection [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PaymentCollection] Payment collection
|
|
361
362
|
#
|
|
362
363
|
# @param plan_id [String] Plan ID
|
|
363
364
|
#
|
|
364
|
-
# @param pricing_type [Symbol, Stigg::Models::V1::
|
|
365
|
+
# @param pricing_type [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PricingType] Pricing type
|
|
365
366
|
#
|
|
366
367
|
# @param start_date [Time] Subscription start date
|
|
367
368
|
#
|
|
368
|
-
# @param status [Symbol, Stigg::Models::V1::
|
|
369
|
+
# @param status [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Status] Subscription status
|
|
369
370
|
#
|
|
370
371
|
# @param cancellation_date [Time, nil] Subscription cancellation date
|
|
371
372
|
#
|
|
372
|
-
# @param cancel_reason [Symbol, Stigg::Models::V1::
|
|
373
|
+
# @param cancel_reason [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::CancelReason, nil] Subscription cancel reason
|
|
373
374
|
#
|
|
374
375
|
# @param current_billing_period_end [Time, nil] End of the current billing period
|
|
375
376
|
#
|
|
@@ -383,9 +384,9 @@ module Stigg
|
|
|
383
384
|
#
|
|
384
385
|
# @param paying_customer_id [String, nil] Paying customer ID for delegated billing
|
|
385
386
|
#
|
|
386
|
-
# @param payment_collection_method [Symbol, Stigg::Models::V1::
|
|
387
|
+
# @param payment_collection_method [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::PaymentCollectionMethod, nil] The method used to collect payments for a subscription
|
|
387
388
|
#
|
|
388
|
-
# @param prices [Array<Stigg::Models::V1::
|
|
389
|
+
# @param prices [Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price>]
|
|
389
390
|
#
|
|
390
391
|
# @param resource_id [String, nil] Resource ID
|
|
391
392
|
#
|
|
@@ -393,7 +394,7 @@ module Stigg
|
|
|
393
394
|
|
|
394
395
|
# Payment collection
|
|
395
396
|
#
|
|
396
|
-
# @see Stigg::Models::V1::
|
|
397
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription#payment_collection
|
|
397
398
|
module PaymentCollection
|
|
398
399
|
extend Stigg::Internal::Type::Enum
|
|
399
400
|
|
|
@@ -408,7 +409,7 @@ module Stigg
|
|
|
408
409
|
|
|
409
410
|
# Pricing type
|
|
410
411
|
#
|
|
411
|
-
# @see Stigg::Models::V1::
|
|
412
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription#pricing_type
|
|
412
413
|
module PricingType
|
|
413
414
|
extend Stigg::Internal::Type::Enum
|
|
414
415
|
|
|
@@ -422,7 +423,7 @@ module Stigg
|
|
|
422
423
|
|
|
423
424
|
# Subscription status
|
|
424
425
|
#
|
|
425
|
-
# @see Stigg::Models::V1::
|
|
426
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription#status
|
|
426
427
|
module Status
|
|
427
428
|
extend Stigg::Internal::Type::Enum
|
|
428
429
|
|
|
@@ -439,7 +440,7 @@ module Stigg
|
|
|
439
440
|
|
|
440
441
|
# Subscription cancel reason
|
|
441
442
|
#
|
|
442
|
-
# @see Stigg::Models::V1::
|
|
443
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription#cancel_reason
|
|
443
444
|
module CancelReason
|
|
444
445
|
extend Stigg::Internal::Type::Enum
|
|
445
446
|
|
|
@@ -461,7 +462,7 @@ module Stigg
|
|
|
461
462
|
|
|
462
463
|
# The method used to collect payments for a subscription
|
|
463
464
|
#
|
|
464
|
-
# @see Stigg::Models::V1::
|
|
465
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription#payment_collection_method
|
|
465
466
|
module PaymentCollectionMethod
|
|
466
467
|
extend Stigg::Internal::Type::Enum
|
|
467
468
|
|
|
@@ -501,15 +502,15 @@ module Stigg
|
|
|
501
502
|
# @!attribute price
|
|
502
503
|
# Override price amount
|
|
503
504
|
#
|
|
504
|
-
# @return [Stigg::Models::V1::
|
|
505
|
-
optional :price, -> { Stigg::Models::V1::
|
|
505
|
+
# @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price, nil]
|
|
506
|
+
optional :price, -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price }
|
|
506
507
|
|
|
507
508
|
# @!attribute tiers
|
|
508
509
|
# Pricing tiers configuration
|
|
509
510
|
#
|
|
510
|
-
# @return [Array<Stigg::Models::V1::
|
|
511
|
+
# @return [Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier>, nil]
|
|
511
512
|
optional :tiers,
|
|
512
|
-
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::
|
|
513
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier] }
|
|
513
514
|
|
|
514
515
|
# @!method initialize(addon_id: nil, base_charge: nil, block_size: nil, feature_id: nil, price: nil, tiers: nil)
|
|
515
516
|
# @param addon_id [String, nil] Addon identifier for the price override
|
|
@@ -520,11 +521,11 @@ module Stigg
|
|
|
520
521
|
#
|
|
521
522
|
# @param feature_id [String, nil] Feature identifier for the price override
|
|
522
523
|
#
|
|
523
|
-
# @param price [Stigg::Models::V1::
|
|
524
|
+
# @param price [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price] Override price amount
|
|
524
525
|
#
|
|
525
|
-
# @param tiers [Array<Stigg::Models::V1::
|
|
526
|
+
# @param tiers [Array<Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier>] Pricing tiers configuration
|
|
526
527
|
|
|
527
|
-
# @see Stigg::Models::V1::
|
|
528
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price#price
|
|
528
529
|
class Price < Stigg::Internal::Type::BaseModel
|
|
529
530
|
# @!attribute amount
|
|
530
531
|
# The price amount
|
|
@@ -541,9 +542,9 @@ module Stigg
|
|
|
541
542
|
# @!attribute currency
|
|
542
543
|
# The price currency
|
|
543
544
|
#
|
|
544
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
545
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price::Currency, nil]
|
|
545
546
|
optional :currency,
|
|
546
|
-
enum: -> { Stigg::Models::V1::
|
|
547
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price::Currency }
|
|
547
548
|
|
|
548
549
|
# @!method initialize(amount: nil, billing_country_code: nil, currency: nil)
|
|
549
550
|
# Override price amount
|
|
@@ -552,11 +553,11 @@ module Stigg
|
|
|
552
553
|
#
|
|
553
554
|
# @param billing_country_code [String, nil] The billing country code of the price
|
|
554
555
|
#
|
|
555
|
-
# @param currency [Symbol, Stigg::Models::V1::
|
|
556
|
+
# @param currency [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price::Currency] The price currency
|
|
556
557
|
|
|
557
558
|
# The price currency
|
|
558
559
|
#
|
|
559
|
-
# @see Stigg::Models::V1::
|
|
560
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Price#currency
|
|
560
561
|
module Currency
|
|
561
562
|
extend Stigg::Internal::Type::Enum
|
|
562
563
|
|
|
@@ -686,17 +687,17 @@ module Stigg
|
|
|
686
687
|
# @!attribute flat_price
|
|
687
688
|
# The flat fee price of the price tier
|
|
688
689
|
#
|
|
689
|
-
# @return [Stigg::Models::V1::
|
|
690
|
+
# @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice, nil]
|
|
690
691
|
optional :flat_price,
|
|
691
|
-
-> { Stigg::Models::V1::
|
|
692
|
+
-> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice },
|
|
692
693
|
api_name: :flatPrice
|
|
693
694
|
|
|
694
695
|
# @!attribute unit_price
|
|
695
696
|
# The unit price of the price tier
|
|
696
697
|
#
|
|
697
|
-
# @return [Stigg::Models::V1::
|
|
698
|
+
# @return [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice, nil]
|
|
698
699
|
optional :unit_price,
|
|
699
|
-
-> { Stigg::Models::V1::
|
|
700
|
+
-> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice },
|
|
700
701
|
api_name: :unitPrice
|
|
701
702
|
|
|
702
703
|
# @!attribute up_to
|
|
@@ -706,13 +707,13 @@ module Stigg
|
|
|
706
707
|
optional :up_to, Float, api_name: :upTo
|
|
707
708
|
|
|
708
709
|
# @!method initialize(flat_price: nil, unit_price: nil, up_to: nil)
|
|
709
|
-
# @param flat_price [Stigg::Models::V1::
|
|
710
|
+
# @param flat_price [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice] The flat fee price of the price tier
|
|
710
711
|
#
|
|
711
|
-
# @param unit_price [Stigg::Models::V1::
|
|
712
|
+
# @param unit_price [Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice] The unit price of the price tier
|
|
712
713
|
#
|
|
713
714
|
# @param up_to [Float] The up to quantity of the price tier
|
|
714
715
|
|
|
715
|
-
# @see Stigg::Models::V1::
|
|
716
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier#flat_price
|
|
716
717
|
class FlatPrice < Stigg::Internal::Type::BaseModel
|
|
717
718
|
# @!attribute amount
|
|
718
719
|
# The price amount
|
|
@@ -729,9 +730,9 @@ module Stigg
|
|
|
729
730
|
# @!attribute currency
|
|
730
731
|
# The price currency
|
|
731
732
|
#
|
|
732
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
733
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice::Currency, nil]
|
|
733
734
|
optional :currency,
|
|
734
|
-
enum: -> { Stigg::Models::V1::
|
|
735
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice::Currency }
|
|
735
736
|
|
|
736
737
|
# @!method initialize(amount: nil, billing_country_code: nil, currency: nil)
|
|
737
738
|
# The flat fee price of the price tier
|
|
@@ -740,11 +741,11 @@ module Stigg
|
|
|
740
741
|
#
|
|
741
742
|
# @param billing_country_code [String, nil] The billing country code of the price
|
|
742
743
|
#
|
|
743
|
-
# @param currency [Symbol, Stigg::Models::V1::
|
|
744
|
+
# @param currency [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice::Currency] The price currency
|
|
744
745
|
|
|
745
746
|
# The price currency
|
|
746
747
|
#
|
|
747
|
-
# @see Stigg::Models::V1::
|
|
748
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::FlatPrice#currency
|
|
748
749
|
module Currency
|
|
749
750
|
extend Stigg::Internal::Type::Enum
|
|
750
751
|
|
|
@@ -870,7 +871,7 @@ module Stigg
|
|
|
870
871
|
end
|
|
871
872
|
end
|
|
872
873
|
|
|
873
|
-
# @see Stigg::Models::V1::
|
|
874
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier#unit_price
|
|
874
875
|
class UnitPrice < Stigg::Internal::Type::BaseModel
|
|
875
876
|
# @!attribute amount
|
|
876
877
|
# The price amount
|
|
@@ -887,9 +888,9 @@ module Stigg
|
|
|
887
888
|
# @!attribute currency
|
|
888
889
|
# The price currency
|
|
889
890
|
#
|
|
890
|
-
# @return [Symbol, Stigg::Models::V1::
|
|
891
|
+
# @return [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice::Currency, nil]
|
|
891
892
|
optional :currency,
|
|
892
|
-
enum: -> { Stigg::Models::V1::
|
|
893
|
+
enum: -> { Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice::Currency }
|
|
893
894
|
|
|
894
895
|
# @!method initialize(amount: nil, billing_country_code: nil, currency: nil)
|
|
895
896
|
# The unit price of the price tier
|
|
@@ -898,11 +899,11 @@ module Stigg
|
|
|
898
899
|
#
|
|
899
900
|
# @param billing_country_code [String, nil] The billing country code of the price
|
|
900
901
|
#
|
|
901
|
-
# @param currency [Symbol, Stigg::Models::V1::
|
|
902
|
+
# @param currency [Symbol, Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice::Currency] The price currency
|
|
902
903
|
|
|
903
904
|
# The price currency
|
|
904
905
|
#
|
|
905
|
-
# @see Stigg::Models::V1::
|
|
906
|
+
# @see Stigg::Models::V1::SubscriptionProvisionResponse::Data::Subscription::Price::Tier::UnitPrice#currency
|
|
906
907
|
module Currency
|
|
907
908
|
extend Stigg::Internal::Type::Enum
|
|
908
909
|
|