stigg 0.1.0.pre.alpha.1 → 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.
Files changed (190) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +29 -1
  4. data/lib/stigg/internal/my_cursor_id_page.rb +32 -4
  5. data/lib/stigg/internal/type/base_model.rb +2 -2
  6. data/lib/stigg/models/v1/{coupon_create_response.rb → coupon.rb} +31 -26
  7. data/lib/stigg/models/v1/coupon_create_params.rb +2 -0
  8. data/lib/stigg/models/v1/coupon_list_params.rb +14 -14
  9. data/lib/stigg/models/v1/coupon_list_response.rb +262 -278
  10. data/lib/stigg/models/v1/customer_import_params.rb +75 -0
  11. data/lib/stigg/models/v1/customer_import_response.rb +35 -0
  12. data/lib/stigg/models/v1/customer_list_params.rb +14 -14
  13. data/lib/stigg/models/v1/customer_list_response.rb +160 -174
  14. data/lib/stigg/models/v1/{customer_create_params.rb → customer_provision_params.rb} +18 -16
  15. data/lib/stigg/models/v1/customer_response.rb +9 -2
  16. data/lib/stigg/models/v1/customer_update_params.rb +2 -0
  17. data/lib/stigg/models/v1/customers/payment_method_attach_params.rb +3 -1
  18. data/lib/stigg/models/v1/customers/{promotional_create_params.rb → promotional_entitlement_grant_params.rb} +46 -44
  19. data/lib/stigg/models/v1/customers/{promotional_create_response.rb → promotional_entitlement_grant_response.rb} +105 -32
  20. data/lib/stigg/models/v1/customers/{promotional_revoke_params.rb → promotional_entitlement_revoke_params.rb} +2 -2
  21. data/lib/stigg/models/v1/customers/{promotional_revoke_response.rb → promotional_entitlement_revoke_response.rb} +107 -33
  22. data/lib/stigg/models/v1/event_report_params.rb +91 -0
  23. data/lib/stigg/models/v1/event_report_response.rb +25 -0
  24. data/lib/stigg/models/v1/{subscription_retrieve_response.rb → subscription.rb} +67 -26
  25. data/lib/stigg/models/v1/subscription_cancel_params.rb +75 -0
  26. data/lib/stigg/models/v1/subscription_delegate_params.rb +7 -2
  27. data/lib/stigg/models/v1/subscription_import_params.rb +92 -0
  28. data/lib/stigg/models/v1/subscription_import_response.rb +32 -0
  29. data/lib/stigg/models/v1/subscription_list_params.rb +20 -24
  30. data/lib/stigg/models/v1/subscription_list_response.rb +255 -236
  31. data/lib/stigg/models/v1/subscription_migrate_params.rb +3 -3
  32. data/lib/stigg/models/v1/subscription_preview_params.rb +139 -46
  33. data/lib/stigg/models/v1/subscription_preview_response.rb +164 -49
  34. data/lib/stigg/models/v1/subscription_provision_params.rb +1693 -0
  35. data/lib/stigg/models/v1/subscription_provision_response.rb +1038 -0
  36. data/lib/stigg/models/v1/subscription_transfer_params.rb +2 -6
  37. data/lib/stigg/models/v1/subscription_update_params.rb +1114 -0
  38. data/lib/stigg/models/v1/subscriptions/{future_update_cancel_pending_payment_response.rb → cancel_subscription.rb} +9 -5
  39. data/lib/stigg/models/v1/usage_history_params.rb +54 -0
  40. data/lib/stigg/models/v1/usage_history_response.rb +155 -0
  41. data/lib/stigg/models/v1/usage_report_params.rb +114 -0
  42. data/lib/stigg/models/v1/usage_report_response.rb +120 -0
  43. data/lib/stigg/models.rb +0 -4
  44. data/lib/stigg/resources/v1/coupons.rb +16 -14
  45. data/lib/stigg/resources/v1/customers/payment_method.rb +6 -5
  46. data/lib/stigg/resources/v1/customers/{promotional.rb → promotional_entitlements.rb} +17 -17
  47. data/lib/stigg/resources/v1/customers.rb +78 -56
  48. data/lib/stigg/resources/v1/events.rb +38 -0
  49. data/lib/stigg/resources/v1/subscriptions/future_update.rb +10 -8
  50. data/lib/stigg/resources/v1/subscriptions.rb +206 -79
  51. data/lib/stigg/resources/v1/usage.rb +79 -0
  52. data/lib/stigg/resources/v1.rb +6 -42
  53. data/lib/stigg/version.rb +1 -1
  54. data/lib/stigg.rb +25 -23
  55. data/rbi/stigg/internal/my_cursor_id_page.rbi +27 -0
  56. data/rbi/stigg/models/v1/coupon.rbi +891 -0
  57. data/rbi/stigg/models/v1/coupon_create_params.rbi +1 -0
  58. data/rbi/stigg/models/v1/coupon_list_params.rbi +21 -21
  59. data/rbi/stigg/models/v1/coupon_list_response.rbi +812 -869
  60. data/rbi/stigg/models/v1/customer_import_params.rbi +130 -0
  61. data/rbi/stigg/models/v1/customer_import_response.rbi +76 -0
  62. data/rbi/stigg/models/v1/customer_list_params.rbi +21 -21
  63. data/rbi/stigg/models/v1/customer_list_response.rbi +307 -347
  64. data/rbi/stigg/models/v1/{customer_create_params.rbi → customer_provision_params.rbi} +36 -35
  65. data/rbi/stigg/models/v1/customer_response.rbi +8 -1
  66. data/rbi/stigg/models/v1/customer_update_params.rbi +1 -0
  67. data/rbi/stigg/models/v1/customers/payment_method_attach_params.rbi +3 -0
  68. data/rbi/stigg/models/v1/customers/{promotional_create_params.rbi → promotional_entitlement_grant_params.rbi} +78 -77
  69. data/rbi/stigg/models/v1/customers/promotional_entitlement_grant_response.rbi +690 -0
  70. data/rbi/stigg/models/v1/customers/{promotional_revoke_params.rbi → promotional_entitlement_revoke_params.rbi} +2 -2
  71. data/rbi/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbi +696 -0
  72. data/rbi/stigg/models/v1/event_report_params.rbi +168 -0
  73. data/rbi/stigg/models/v1/event_report_response.rbi +35 -0
  74. data/rbi/stigg/models/v1/{subscription_migrate_response.rbi → subscription.rbi} +130 -98
  75. data/rbi/stigg/models/v1/subscription_cancel_params.rbi +182 -0
  76. data/rbi/stigg/models/v1/subscription_delegate_params.rbi +6 -2
  77. data/rbi/stigg/models/v1/subscription_import_params.rbi +148 -0
  78. data/rbi/stigg/models/v1/subscription_import_response.rbi +69 -0
  79. data/rbi/stigg/models/v1/subscription_list_params.rbi +26 -28
  80. data/rbi/stigg/models/v1/subscription_list_response.rbi +460 -435
  81. data/rbi/stigg/models/v1/subscription_migrate_params.rbi +3 -3
  82. data/rbi/stigg/models/v1/subscription_preview_params.rbi +112 -14
  83. data/rbi/stigg/models/v1/subscription_preview_response.rbi +139 -6
  84. data/rbi/stigg/models/v1/subscription_provision_params.rbi +5306 -0
  85. data/rbi/stigg/models/v1/subscription_provision_response.rbi +3175 -0
  86. data/rbi/stigg/models/v1/subscription_transfer_params.rbi +2 -4
  87. data/rbi/stigg/models/v1/subscription_update_params.rbi +3578 -0
  88. data/rbi/stigg/models/v1/subscriptions/{future_update_cancel_schedule_response.rbi → cancel_subscription.rbi} +10 -16
  89. data/rbi/stigg/models/v1/usage_history_params.rbi +79 -0
  90. data/rbi/stigg/models/v1/usage_history_response.rbi +347 -0
  91. data/rbi/stigg/models/v1/usage_report_params.rbi +227 -0
  92. data/rbi/stigg/models/v1/usage_report_response.rbi +162 -0
  93. data/rbi/stigg/models.rbi +0 -4
  94. data/rbi/stigg/resources/v1/coupons.rbi +22 -14
  95. data/rbi/stigg/resources/v1/customers/payment_method.rbi +9 -3
  96. data/rbi/stigg/resources/v1/customers/{promotional.rbi → promotional_entitlements.rbi} +13 -9
  97. data/rbi/stigg/resources/v1/customers.rbi +84 -53
  98. data/rbi/stigg/resources/v1/events.rbi +28 -0
  99. data/rbi/stigg/resources/v1/subscriptions/future_update.rbi +14 -10
  100. data/rbi/stigg/resources/v1/subscriptions.rbi +242 -58
  101. data/rbi/stigg/resources/v1/usage.rbi +57 -0
  102. data/rbi/stigg/resources/v1.rbi +4 -26
  103. data/sig/stigg/internal/my_cursor_id_page.rbs +17 -0
  104. data/sig/stigg/models/v1/{coupon_create_response.rbs → coupon.rbs} +29 -32
  105. data/sig/stigg/models/v1/coupon_list_params.rbs +11 -11
  106. data/sig/stigg/models/v1/coupon_list_response.rbs +331 -351
  107. data/sig/stigg/models/v1/customer_import_params.rbs +74 -0
  108. data/sig/stigg/models/v1/customer_import_response.rbs +30 -0
  109. data/sig/stigg/models/v1/customer_list_params.rbs +11 -11
  110. data/sig/stigg/models/v1/customer_list_response.rbs +133 -153
  111. data/sig/stigg/models/v1/{customer_create_params.rbs → customer_provision_params.rbs} +22 -22
  112. data/sig/stigg/models/v1/customers/{promotional_create_params.rbs → promotional_entitlement_grant_params.rbs} +43 -43
  113. data/sig/stigg/models/v1/customers/promotional_entitlement_grant_response.rbs +281 -0
  114. data/sig/stigg/models/v1/customers/{promotional_revoke_params.rbs → promotional_entitlement_revoke_params.rbs} +2 -2
  115. data/sig/stigg/models/v1/customers/promotional_entitlement_revoke_response.rbs +281 -0
  116. data/sig/stigg/models/v1/event_report_params.rbs +82 -0
  117. data/sig/stigg/models/v1/event_report_response.rbs +15 -0
  118. data/sig/stigg/models/v1/{subscription_retrieve_response.rbs → subscription.rbs} +61 -35
  119. data/sig/stigg/models/v1/subscription_cancel_params.rbs +79 -0
  120. data/sig/stigg/models/v1/subscription_import_params.rbs +84 -0
  121. data/sig/stigg/models/v1/subscription_import_response.rbs +30 -0
  122. data/sig/stigg/models/v1/subscription_list_params.rbs +14 -14
  123. data/sig/stigg/models/v1/subscription_list_response.rbs +196 -189
  124. data/sig/stigg/models/v1/subscription_preview_params.rbs +2 -6
  125. data/sig/stigg/models/v1/subscription_provision_params.rbs +2223 -0
  126. data/sig/stigg/models/v1/subscription_provision_response.rbs +1305 -0
  127. data/sig/stigg/models/v1/subscription_update_params.rbs +1544 -0
  128. data/sig/stigg/models/v1/subscriptions/cancel_subscription.rbs +34 -0
  129. data/sig/stigg/models/v1/usage_history_params.rbs +52 -0
  130. data/sig/stigg/models/v1/usage_history_response.rbs +129 -0
  131. data/sig/stigg/models/v1/usage_report_params.rbs +102 -0
  132. data/sig/stigg/models/v1/usage_report_response.rbs +87 -0
  133. data/sig/stigg/models.rbs +0 -4
  134. data/sig/stigg/resources/v1/coupons.rbs +5 -5
  135. data/sig/stigg/resources/v1/customers/{promotional.rbs → promotional_entitlements.rbs} +5 -5
  136. data/sig/stigg/resources/v1/customers.rbs +20 -17
  137. data/sig/stigg/resources/v1/events.rbs +14 -0
  138. data/sig/stigg/resources/v1/subscriptions/future_update.rbs +2 -2
  139. data/sig/stigg/resources/v1/subscriptions.rbs +68 -20
  140. data/sig/stigg/resources/v1/usage.rbs +24 -0
  141. data/sig/stigg/resources/v1.rbs +2 -8
  142. metadata +77 -71
  143. data/lib/stigg/models/v1/coupon_retrieve_response.rb +0 -317
  144. data/lib/stigg/models/v1/customers/usage_retrieve_params.rb +0 -56
  145. data/lib/stigg/models/v1/customers/usage_retrieve_response.rb +0 -145
  146. data/lib/stigg/models/v1/subscription_create_params.rb +0 -214
  147. data/lib/stigg/models/v1/subscription_create_response.rb +0 -338
  148. data/lib/stigg/models/v1/subscription_delegate_response.rb +0 -274
  149. data/lib/stigg/models/v1/subscription_migrate_response.rb +0 -274
  150. data/lib/stigg/models/v1/subscription_transfer_response.rb +0 -274
  151. data/lib/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rb +0 -32
  152. data/lib/stigg/models/v1_create_event_params.rb +0 -87
  153. data/lib/stigg/models/v1_create_event_response.rb +0 -16
  154. data/lib/stigg/models/v1_create_usage_params.rb +0 -96
  155. data/lib/stigg/models/v1_create_usage_response.rb +0 -112
  156. data/lib/stigg/resources/v1/customers/usage.rb +0 -59
  157. data/rbi/stigg/models/v1/coupon_create_response.rbi +0 -986
  158. data/rbi/stigg/models/v1/coupon_retrieve_response.rbi +0 -986
  159. data/rbi/stigg/models/v1/customers/promotional_create_response.rbi +0 -495
  160. data/rbi/stigg/models/v1/customers/promotional_revoke_response.rbi +0 -497
  161. data/rbi/stigg/models/v1/customers/usage_retrieve_params.rbi +0 -84
  162. data/rbi/stigg/models/v1/customers/usage_retrieve_response.rbi +0 -353
  163. data/rbi/stigg/models/v1/subscription_create_params.rbi +0 -394
  164. data/rbi/stigg/models/v1/subscription_create_response.rbi +0 -668
  165. data/rbi/stigg/models/v1/subscription_delegate_response.rbi +0 -535
  166. data/rbi/stigg/models/v1/subscription_retrieve_response.rbi +0 -535
  167. data/rbi/stigg/models/v1/subscription_transfer_response.rbi +0 -535
  168. data/rbi/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbi +0 -79
  169. data/rbi/stigg/models/v1_create_event_params.rbi +0 -160
  170. data/rbi/stigg/models/v1_create_event_response.rbi +0 -23
  171. data/rbi/stigg/models/v1_create_usage_params.rbi +0 -177
  172. data/rbi/stigg/models/v1_create_usage_response.rbi +0 -150
  173. data/rbi/stigg/resources/v1/customers/usage.rbi +0 -45
  174. data/sig/stigg/models/v1/coupon_retrieve_response.rbs +0 -394
  175. data/sig/stigg/models/v1/customers/promotional_create_response.rbs +0 -209
  176. data/sig/stigg/models/v1/customers/promotional_revoke_response.rbs +0 -209
  177. data/sig/stigg/models/v1/customers/usage_retrieve_params.rbs +0 -54
  178. data/sig/stigg/models/v1/customers/usage_retrieve_response.rbs +0 -134
  179. data/sig/stigg/models/v1/subscription_create_params.rbs +0 -199
  180. data/sig/stigg/models/v1/subscription_create_response.rbs +0 -283
  181. data/sig/stigg/models/v1/subscription_delegate_response.rbs +0 -224
  182. data/sig/stigg/models/v1/subscription_migrate_response.rbs +0 -224
  183. data/sig/stigg/models/v1/subscription_transfer_response.rbs +0 -224
  184. data/sig/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbs +0 -34
  185. data/sig/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rbs +0 -34
  186. data/sig/stigg/models/v1_create_event_params.rbs +0 -80
  187. data/sig/stigg/models/v1_create_event_response.rbs +0 -13
  188. data/sig/stigg/models/v1_create_usage_params.rbs +0 -90
  189. data/sig/stigg/models/v1_create_usage_response.rbs +0 -85
  190. data/sig/stigg/resources/v1/customers/usage.rbs +0 -21
@@ -1,338 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Stigg
4
- module Models
5
- module V1
6
- # @see Stigg::Resources::V1::Subscriptions#create
7
- class SubscriptionCreateResponse < Stigg::Internal::Type::BaseModel
8
- # @!attribute data
9
- #
10
- # @return [Stigg::Models::V1::SubscriptionCreateResponse::Data]
11
- required :data, -> { Stigg::Models::V1::SubscriptionCreateResponse::Data }
12
-
13
- # @!method initialize(data:)
14
- # @param data [Stigg::Models::V1::SubscriptionCreateResponse::Data]
15
-
16
- # @see Stigg::Models::V1::SubscriptionCreateResponse#data
17
- class Data < Stigg::Internal::Type::BaseModel
18
- # @!attribute id
19
- # Unique identifier for the provisioned subscription
20
- #
21
- # @return [String]
22
- required :id, String
23
-
24
- # @!attribute status
25
- # Provision status: SUCCESS or PAYMENT_REQUIRED
26
- #
27
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Status]
28
- required :status, enum: -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Status }
29
-
30
- # @!attribute checkout_billing_id
31
- # Checkout billing ID when payment is required
32
- #
33
- # @return [String, nil]
34
- optional :checkout_billing_id, String, api_name: :checkoutBillingId, nil?: true
35
-
36
- # @!attribute checkout_url
37
- # URL to complete payment when PAYMENT_REQUIRED
38
- #
39
- # @return [String, nil]
40
- optional :checkout_url, String, api_name: :checkoutUrl, nil?: true
41
-
42
- # @!attribute is_scheduled
43
- # Whether the subscription is scheduled for future activation
44
- #
45
- # @return [Boolean, nil]
46
- optional :is_scheduled, Stigg::Internal::Type::Boolean, api_name: :isScheduled
47
-
48
- # @!attribute subscription
49
- #
50
- # @return [Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription, nil]
51
- optional :subscription, -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription }
52
-
53
- # @!method initialize(id:, status:, checkout_billing_id: nil, checkout_url: nil, is_scheduled: nil, subscription: nil)
54
- # @param id [String] Unique identifier for the provisioned subscription
55
- #
56
- # @param status [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Status] Provision status: SUCCESS or PAYMENT_REQUIRED
57
- #
58
- # @param checkout_billing_id [String, nil] Checkout billing ID when payment is required
59
- #
60
- # @param checkout_url [String, nil] URL to complete payment when PAYMENT_REQUIRED
61
- #
62
- # @param is_scheduled [Boolean] Whether the subscription is scheduled for future activation
63
- #
64
- # @param subscription [Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription]
65
-
66
- # Provision status: SUCCESS or PAYMENT_REQUIRED
67
- #
68
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data#status
69
- module Status
70
- extend Stigg::Internal::Type::Enum
71
-
72
- SUCCESS = :SUCCESS
73
- PAYMENT_REQUIRED = :PAYMENT_REQUIRED
74
-
75
- # @!method self.values
76
- # @return [Array<Symbol>]
77
- end
78
-
79
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data#subscription
80
- class Subscription < Stigg::Internal::Type::BaseModel
81
- # @!attribute id
82
- # Subscription ID
83
- #
84
- # @return [String]
85
- required :id, String
86
-
87
- # @!attribute billing_id
88
- # Billing ID
89
- #
90
- # @return [String, nil]
91
- required :billing_id, String, api_name: :billingId, nil?: true
92
-
93
- # @!attribute created_at
94
- # Created at
95
- #
96
- # @return [Time]
97
- required :created_at, Time, api_name: :createdAt
98
-
99
- # @!attribute customer_id
100
- # Customer ID
101
- #
102
- # @return [String]
103
- required :customer_id, String, api_name: :customerId
104
-
105
- # @!attribute payment_collection
106
- # Payment collection
107
- #
108
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PaymentCollection]
109
- required :payment_collection,
110
- enum: -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PaymentCollection },
111
- api_name: :paymentCollection
112
-
113
- # @!attribute plan_id
114
- # Plan ID
115
- #
116
- # @return [String]
117
- required :plan_id, String, api_name: :planId
118
-
119
- # @!attribute pricing_type
120
- # Pricing type
121
- #
122
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PricingType]
123
- required :pricing_type,
124
- enum: -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PricingType },
125
- api_name: :pricingType
126
-
127
- # @!attribute start_date
128
- # Subscription start date
129
- #
130
- # @return [Time]
131
- required :start_date, Time, api_name: :startDate
132
-
133
- # @!attribute status
134
- # Subscription status
135
- #
136
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::Status]
137
- required :status, enum: -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::Status }
138
-
139
- # @!attribute cancellation_date
140
- # Subscription cancellation date
141
- #
142
- # @return [Time, nil]
143
- optional :cancellation_date, Time, api_name: :cancellationDate, nil?: true
144
-
145
- # @!attribute cancel_reason
146
- # Subscription cancel reason
147
- #
148
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::CancelReason, nil]
149
- optional :cancel_reason,
150
- enum: -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::CancelReason },
151
- api_name: :cancelReason,
152
- nil?: true
153
-
154
- # @!attribute current_billing_period_end
155
- # End of the current billing period
156
- #
157
- # @return [Time, nil]
158
- optional :current_billing_period_end, Time, api_name: :currentBillingPeriodEnd, nil?: true
159
-
160
- # @!attribute current_billing_period_start
161
- # Start of the current billing period
162
- #
163
- # @return [Time, nil]
164
- optional :current_billing_period_start, Time, api_name: :currentBillingPeriodStart, nil?: true
165
-
166
- # @!attribute effective_end_date
167
- # Subscription effective end date
168
- #
169
- # @return [Time, nil]
170
- optional :effective_end_date, Time, api_name: :effectiveEndDate, nil?: true
171
-
172
- # @!attribute end_date
173
- # Subscription end date
174
- #
175
- # @return [Time, nil]
176
- optional :end_date, Time, api_name: :endDate, nil?: true
177
-
178
- # @!attribute metadata
179
- # Additional metadata for the subscription
180
- #
181
- # @return [Hash{Symbol=>String}, nil]
182
- optional :metadata, Stigg::Internal::Type::HashOf[String]
183
-
184
- # @!attribute paying_customer_id
185
- # Paying customer ID for delegated billing
186
- #
187
- # @return [String, nil]
188
- optional :paying_customer_id, String, api_name: :payingCustomerId, nil?: true
189
-
190
- # @!attribute payment_collection_method
191
- # The method used to collect payments for a subscription
192
- #
193
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PaymentCollectionMethod, nil]
194
- optional :payment_collection_method,
195
- enum: -> { Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PaymentCollectionMethod },
196
- api_name: :paymentCollectionMethod,
197
- nil?: true
198
-
199
- # @!attribute resource_id
200
- # Resource ID
201
- #
202
- # @return [String, nil]
203
- optional :resource_id, String, api_name: :resourceId, nil?: true
204
-
205
- # @!attribute trial_end_date
206
- # Subscription trial end date
207
- #
208
- # @return [Time, nil]
209
- optional :trial_end_date, Time, api_name: :trialEndDate, nil?: true
210
-
211
- # @!method initialize(id:, billing_id:, created_at:, customer_id:, payment_collection:, plan_id:, pricing_type:, start_date:, status:, cancellation_date: nil, cancel_reason: nil, current_billing_period_end: nil, current_billing_period_start: nil, effective_end_date: nil, end_date: nil, metadata: nil, paying_customer_id: nil, payment_collection_method: nil, resource_id: nil, trial_end_date: nil)
212
- # @param id [String] Subscription ID
213
- #
214
- # @param billing_id [String, nil] Billing ID
215
- #
216
- # @param created_at [Time] Created at
217
- #
218
- # @param customer_id [String] Customer ID
219
- #
220
- # @param payment_collection [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PaymentCollection] Payment collection
221
- #
222
- # @param plan_id [String] Plan ID
223
- #
224
- # @param pricing_type [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PricingType] Pricing type
225
- #
226
- # @param start_date [Time] Subscription start date
227
- #
228
- # @param status [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::Status] Subscription status
229
- #
230
- # @param cancellation_date [Time, nil] Subscription cancellation date
231
- #
232
- # @param cancel_reason [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::CancelReason, nil] Subscription cancel reason
233
- #
234
- # @param current_billing_period_end [Time, nil] End of the current billing period
235
- #
236
- # @param current_billing_period_start [Time, nil] Start of the current billing period
237
- #
238
- # @param effective_end_date [Time, nil] Subscription effective end date
239
- #
240
- # @param end_date [Time, nil] Subscription end date
241
- #
242
- # @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
243
- #
244
- # @param paying_customer_id [String, nil] Paying customer ID for delegated billing
245
- #
246
- # @param payment_collection_method [Symbol, Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription::PaymentCollectionMethod, nil] The method used to collect payments for a subscription
247
- #
248
- # @param resource_id [String, nil] Resource ID
249
- #
250
- # @param trial_end_date [Time, nil] Subscription trial end date
251
-
252
- # Payment collection
253
- #
254
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription#payment_collection
255
- module PaymentCollection
256
- extend Stigg::Internal::Type::Enum
257
-
258
- NOT_REQUIRED = :NOT_REQUIRED
259
- PROCESSING = :PROCESSING
260
- FAILED = :FAILED
261
- ACTION_REQUIRED = :ACTION_REQUIRED
262
-
263
- # @!method self.values
264
- # @return [Array<Symbol>]
265
- end
266
-
267
- # Pricing type
268
- #
269
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription#pricing_type
270
- module PricingType
271
- extend Stigg::Internal::Type::Enum
272
-
273
- FREE = :FREE
274
- PAID = :PAID
275
- CUSTOM = :CUSTOM
276
-
277
- # @!method self.values
278
- # @return [Array<Symbol>]
279
- end
280
-
281
- # Subscription status
282
- #
283
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription#status
284
- module Status
285
- extend Stigg::Internal::Type::Enum
286
-
287
- PAYMENT_PENDING = :PAYMENT_PENDING
288
- ACTIVE = :ACTIVE
289
- EXPIRED = :EXPIRED
290
- IN_TRIAL = :IN_TRIAL
291
- CANCELED = :CANCELED
292
- NOT_STARTED = :NOT_STARTED
293
-
294
- # @!method self.values
295
- # @return [Array<Symbol>]
296
- end
297
-
298
- # Subscription cancel reason
299
- #
300
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription#cancel_reason
301
- module CancelReason
302
- extend Stigg::Internal::Type::Enum
303
-
304
- UPGRADE_OR_DOWNGRADE = :UPGRADE_OR_DOWNGRADE
305
- CANCELLED_BY_BILLING = :CANCELLED_BY_BILLING
306
- EXPIRED = :EXPIRED
307
- DETACH_BILLING = :DETACH_BILLING
308
- TRIAL_ENDED = :TRIAL_ENDED
309
- IMMEDIATE = :Immediate
310
- TRIAL_CONVERTED = :TRIAL_CONVERTED
311
- PENDING_PAYMENT_EXPIRED = :PENDING_PAYMENT_EXPIRED
312
- SCHEDULED_CANCELLATION = :ScheduledCancellation
313
- CUSTOMER_ARCHIVED = :CustomerArchived
314
- AUTO_CANCELLATION_RULE = :AutoCancellationRule
315
-
316
- # @!method self.values
317
- # @return [Array<Symbol>]
318
- end
319
-
320
- # The method used to collect payments for a subscription
321
- #
322
- # @see Stigg::Models::V1::SubscriptionCreateResponse::Data::Subscription#payment_collection_method
323
- module PaymentCollectionMethod
324
- extend Stigg::Internal::Type::Enum
325
-
326
- CHARGE = :CHARGE
327
- INVOICE = :INVOICE
328
- NONE = :NONE
329
-
330
- # @!method self.values
331
- # @return [Array<Symbol>]
332
- end
333
- end
334
- end
335
- end
336
- end
337
- end
338
- end
@@ -1,274 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Stigg
4
- module Models
5
- module V1
6
- # @see Stigg::Resources::V1::Subscriptions#delegate
7
- class SubscriptionDelegateResponse < Stigg::Internal::Type::BaseModel
8
- # @!attribute data
9
- #
10
- # @return [Stigg::Models::V1::SubscriptionDelegateResponse::Data]
11
- required :data, -> { Stigg::Models::V1::SubscriptionDelegateResponse::Data }
12
-
13
- # @!method initialize(data:)
14
- # @param data [Stigg::Models::V1::SubscriptionDelegateResponse::Data]
15
-
16
- # @see Stigg::Models::V1::SubscriptionDelegateResponse#data
17
- class Data < Stigg::Internal::Type::BaseModel
18
- # @!attribute id
19
- # Subscription ID
20
- #
21
- # @return [String]
22
- required :id, String
23
-
24
- # @!attribute billing_id
25
- # Billing ID
26
- #
27
- # @return [String, nil]
28
- required :billing_id, String, api_name: :billingId, nil?: true
29
-
30
- # @!attribute created_at
31
- # Created at
32
- #
33
- # @return [Time]
34
- required :created_at, Time, api_name: :createdAt
35
-
36
- # @!attribute customer_id
37
- # Customer ID
38
- #
39
- # @return [String]
40
- required :customer_id, String, api_name: :customerId
41
-
42
- # @!attribute payment_collection
43
- # Payment collection
44
- #
45
- # @return [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::PaymentCollection]
46
- required :payment_collection,
47
- enum: -> { Stigg::Models::V1::SubscriptionDelegateResponse::Data::PaymentCollection },
48
- api_name: :paymentCollection
49
-
50
- # @!attribute plan_id
51
- # Plan ID
52
- #
53
- # @return [String]
54
- required :plan_id, String, api_name: :planId
55
-
56
- # @!attribute pricing_type
57
- # Pricing type
58
- #
59
- # @return [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::PricingType]
60
- required :pricing_type,
61
- enum: -> { Stigg::Models::V1::SubscriptionDelegateResponse::Data::PricingType },
62
- api_name: :pricingType
63
-
64
- # @!attribute start_date
65
- # Subscription start date
66
- #
67
- # @return [Time]
68
- required :start_date, Time, api_name: :startDate
69
-
70
- # @!attribute status
71
- # Subscription status
72
- #
73
- # @return [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::Status]
74
- required :status, enum: -> { Stigg::Models::V1::SubscriptionDelegateResponse::Data::Status }
75
-
76
- # @!attribute cancellation_date
77
- # Subscription cancellation date
78
- #
79
- # @return [Time, nil]
80
- optional :cancellation_date, Time, api_name: :cancellationDate, nil?: true
81
-
82
- # @!attribute cancel_reason
83
- # Subscription cancel reason
84
- #
85
- # @return [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::CancelReason, nil]
86
- optional :cancel_reason,
87
- enum: -> { Stigg::Models::V1::SubscriptionDelegateResponse::Data::CancelReason },
88
- api_name: :cancelReason,
89
- nil?: true
90
-
91
- # @!attribute current_billing_period_end
92
- # End of the current billing period
93
- #
94
- # @return [Time, nil]
95
- optional :current_billing_period_end, Time, api_name: :currentBillingPeriodEnd, nil?: true
96
-
97
- # @!attribute current_billing_period_start
98
- # Start of the current billing period
99
- #
100
- # @return [Time, nil]
101
- optional :current_billing_period_start, Time, api_name: :currentBillingPeriodStart, nil?: true
102
-
103
- # @!attribute effective_end_date
104
- # Subscription effective end date
105
- #
106
- # @return [Time, nil]
107
- optional :effective_end_date, Time, api_name: :effectiveEndDate, nil?: true
108
-
109
- # @!attribute end_date
110
- # Subscription end date
111
- #
112
- # @return [Time, nil]
113
- optional :end_date, Time, api_name: :endDate, nil?: true
114
-
115
- # @!attribute metadata
116
- # Additional metadata for the subscription
117
- #
118
- # @return [Hash{Symbol=>String}, nil]
119
- optional :metadata, Stigg::Internal::Type::HashOf[String]
120
-
121
- # @!attribute paying_customer_id
122
- # Paying customer ID for delegated billing
123
- #
124
- # @return [String, nil]
125
- optional :paying_customer_id, String, api_name: :payingCustomerId, nil?: true
126
-
127
- # @!attribute payment_collection_method
128
- # The method used to collect payments for a subscription
129
- #
130
- # @return [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::PaymentCollectionMethod, nil]
131
- optional :payment_collection_method,
132
- enum: -> { Stigg::Models::V1::SubscriptionDelegateResponse::Data::PaymentCollectionMethod },
133
- api_name: :paymentCollectionMethod,
134
- nil?: true
135
-
136
- # @!attribute resource_id
137
- # Resource ID
138
- #
139
- # @return [String, nil]
140
- optional :resource_id, String, api_name: :resourceId, nil?: true
141
-
142
- # @!attribute trial_end_date
143
- # Subscription trial end date
144
- #
145
- # @return [Time, nil]
146
- optional :trial_end_date, Time, api_name: :trialEndDate, nil?: true
147
-
148
- # @!method initialize(id:, billing_id:, created_at:, customer_id:, payment_collection:, plan_id:, pricing_type:, start_date:, status:, cancellation_date: nil, cancel_reason: nil, current_billing_period_end: nil, current_billing_period_start: nil, effective_end_date: nil, end_date: nil, metadata: nil, paying_customer_id: nil, payment_collection_method: nil, resource_id: nil, trial_end_date: nil)
149
- # @param id [String] Subscription ID
150
- #
151
- # @param billing_id [String, nil] Billing ID
152
- #
153
- # @param created_at [Time] Created at
154
- #
155
- # @param customer_id [String] Customer ID
156
- #
157
- # @param payment_collection [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::PaymentCollection] Payment collection
158
- #
159
- # @param plan_id [String] Plan ID
160
- #
161
- # @param pricing_type [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::PricingType] Pricing type
162
- #
163
- # @param start_date [Time] Subscription start date
164
- #
165
- # @param status [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::Status] Subscription status
166
- #
167
- # @param cancellation_date [Time, nil] Subscription cancellation date
168
- #
169
- # @param cancel_reason [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::CancelReason, nil] Subscription cancel reason
170
- #
171
- # @param current_billing_period_end [Time, nil] End of the current billing period
172
- #
173
- # @param current_billing_period_start [Time, nil] Start of the current billing period
174
- #
175
- # @param effective_end_date [Time, nil] Subscription effective end date
176
- #
177
- # @param end_date [Time, nil] Subscription end date
178
- #
179
- # @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
180
- #
181
- # @param paying_customer_id [String, nil] Paying customer ID for delegated billing
182
- #
183
- # @param payment_collection_method [Symbol, Stigg::Models::V1::SubscriptionDelegateResponse::Data::PaymentCollectionMethod, nil] The method used to collect payments for a subscription
184
- #
185
- # @param resource_id [String, nil] Resource ID
186
- #
187
- # @param trial_end_date [Time, nil] Subscription trial end date
188
-
189
- # Payment collection
190
- #
191
- # @see Stigg::Models::V1::SubscriptionDelegateResponse::Data#payment_collection
192
- module PaymentCollection
193
- extend Stigg::Internal::Type::Enum
194
-
195
- NOT_REQUIRED = :NOT_REQUIRED
196
- PROCESSING = :PROCESSING
197
- FAILED = :FAILED
198
- ACTION_REQUIRED = :ACTION_REQUIRED
199
-
200
- # @!method self.values
201
- # @return [Array<Symbol>]
202
- end
203
-
204
- # Pricing type
205
- #
206
- # @see Stigg::Models::V1::SubscriptionDelegateResponse::Data#pricing_type
207
- module PricingType
208
- extend Stigg::Internal::Type::Enum
209
-
210
- FREE = :FREE
211
- PAID = :PAID
212
- CUSTOM = :CUSTOM
213
-
214
- # @!method self.values
215
- # @return [Array<Symbol>]
216
- end
217
-
218
- # Subscription status
219
- #
220
- # @see Stigg::Models::V1::SubscriptionDelegateResponse::Data#status
221
- module Status
222
- extend Stigg::Internal::Type::Enum
223
-
224
- PAYMENT_PENDING = :PAYMENT_PENDING
225
- ACTIVE = :ACTIVE
226
- EXPIRED = :EXPIRED
227
- IN_TRIAL = :IN_TRIAL
228
- CANCELED = :CANCELED
229
- NOT_STARTED = :NOT_STARTED
230
-
231
- # @!method self.values
232
- # @return [Array<Symbol>]
233
- end
234
-
235
- # Subscription cancel reason
236
- #
237
- # @see Stigg::Models::V1::SubscriptionDelegateResponse::Data#cancel_reason
238
- module CancelReason
239
- extend Stigg::Internal::Type::Enum
240
-
241
- UPGRADE_OR_DOWNGRADE = :UPGRADE_OR_DOWNGRADE
242
- CANCELLED_BY_BILLING = :CANCELLED_BY_BILLING
243
- EXPIRED = :EXPIRED
244
- DETACH_BILLING = :DETACH_BILLING
245
- TRIAL_ENDED = :TRIAL_ENDED
246
- IMMEDIATE = :Immediate
247
- TRIAL_CONVERTED = :TRIAL_CONVERTED
248
- PENDING_PAYMENT_EXPIRED = :PENDING_PAYMENT_EXPIRED
249
- SCHEDULED_CANCELLATION = :ScheduledCancellation
250
- CUSTOMER_ARCHIVED = :CustomerArchived
251
- AUTO_CANCELLATION_RULE = :AutoCancellationRule
252
-
253
- # @!method self.values
254
- # @return [Array<Symbol>]
255
- end
256
-
257
- # The method used to collect payments for a subscription
258
- #
259
- # @see Stigg::Models::V1::SubscriptionDelegateResponse::Data#payment_collection_method
260
- module PaymentCollectionMethod
261
- extend Stigg::Internal::Type::Enum
262
-
263
- CHARGE = :CHARGE
264
- INVOICE = :INVOICE
265
- NONE = :NONE
266
-
267
- # @!method self.values
268
- # @return [Array<Symbol>]
269
- end
270
- end
271
- end
272
- end
273
- end
274
- end