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
@@ -0,0 +1,696 @@
1
+ # typed: strong
2
+
3
+ module Stigg
4
+ module Models
5
+ module V1
6
+ module Customers
7
+ class PromotionalEntitlementRevokeResponse < Stigg::Internal::Type::BaseModel
8
+ OrHash =
9
+ T.type_alias do
10
+ T.any(
11
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse,
12
+ Stigg::Internal::AnyHash
13
+ )
14
+ end
15
+
16
+ # Granted feature entitlement
17
+ sig do
18
+ returns(
19
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data
20
+ )
21
+ end
22
+ attr_reader :data
23
+
24
+ sig do
25
+ params(
26
+ data:
27
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::OrHash
28
+ ).void
29
+ end
30
+ attr_writer :data
31
+
32
+ # Response object
33
+ sig do
34
+ params(
35
+ data:
36
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::OrHash
37
+ ).returns(T.attached_class)
38
+ end
39
+ def self.new(
40
+ # Granted feature entitlement
41
+ data:
42
+ )
43
+ end
44
+
45
+ sig do
46
+ override.returns(
47
+ {
48
+ data:
49
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data
50
+ }
51
+ )
52
+ end
53
+ def to_hash
54
+ end
55
+
56
+ class Data < Stigg::Internal::Type::BaseModel
57
+ OrHash =
58
+ T.type_alias do
59
+ T.any(
60
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data,
61
+ Stigg::Internal::AnyHash
62
+ )
63
+ end
64
+
65
+ # Unique identifier for the entity
66
+ sig { returns(String) }
67
+ attr_accessor :id
68
+
69
+ # Timestamp of when the record was created
70
+ sig { returns(Time) }
71
+ attr_accessor :created_at
72
+
73
+ # The description of the entitlement
74
+ sig { returns(T.nilable(String)) }
75
+ attr_accessor :description
76
+
77
+ # The end date of the promotional entitlement
78
+ sig { returns(T.nilable(Time)) }
79
+ attr_accessor :end_date
80
+
81
+ # The enum values of the entitlement
82
+ sig { returns(T.nilable(T::Array[String])) }
83
+ attr_accessor :enum_values
84
+
85
+ # The unique identifier for the environment
86
+ sig { returns(String) }
87
+ attr_accessor :environment_id
88
+
89
+ # Feature group IDs associated with this entitlement
90
+ sig { returns(T.nilable(T::Array[String])) }
91
+ attr_accessor :feature_group_ids
92
+
93
+ # The unique identifier of the entitlement feature
94
+ sig { returns(String) }
95
+ attr_accessor :feature_id
96
+
97
+ # Whether the entitlement has a soft limit
98
+ sig { returns(T.nilable(T::Boolean)) }
99
+ attr_accessor :has_soft_limit
100
+
101
+ # Whether the entitlement has an unlimited usage
102
+ sig { returns(T.nilable(T::Boolean)) }
103
+ attr_accessor :has_unlimited_usage
104
+
105
+ # Whether the entitlement is visible
106
+ sig { returns(T::Boolean) }
107
+ attr_accessor :is_visible
108
+
109
+ # The grant period of the promotional entitlement
110
+ sig do
111
+ returns(
112
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
113
+ )
114
+ end
115
+ attr_accessor :period
116
+
117
+ # The reset period of the entitlement
118
+ sig do
119
+ returns(
120
+ T.nilable(
121
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
122
+ )
123
+ )
124
+ end
125
+ attr_accessor :reset_period
126
+
127
+ # The reset period configuration of the entitlement
128
+ sig do
129
+ returns(
130
+ T.nilable(
131
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::Variants
132
+ )
133
+ )
134
+ end
135
+ attr_accessor :reset_period_configuration
136
+
137
+ # The start date of the entitlement
138
+ sig { returns(Time) }
139
+ attr_accessor :start_date
140
+
141
+ # The status of the entitlement
142
+ sig do
143
+ returns(
144
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::TaggedSymbol
145
+ )
146
+ end
147
+ attr_accessor :status
148
+
149
+ # Timestamp of when the record was last updated
150
+ sig { returns(Time) }
151
+ attr_accessor :updated_at
152
+
153
+ # The usage limit of the entitlement
154
+ sig { returns(T.nilable(Float)) }
155
+ attr_accessor :usage_limit
156
+
157
+ # Granted feature entitlement
158
+ sig do
159
+ params(
160
+ id: String,
161
+ created_at: Time,
162
+ description: T.nilable(String),
163
+ end_date: T.nilable(Time),
164
+ enum_values: T.nilable(T::Array[String]),
165
+ environment_id: String,
166
+ feature_group_ids: T.nilable(T::Array[String]),
167
+ feature_id: String,
168
+ has_soft_limit: T.nilable(T::Boolean),
169
+ has_unlimited_usage: T.nilable(T::Boolean),
170
+ is_visible: T::Boolean,
171
+ period:
172
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::OrSymbol,
173
+ reset_period:
174
+ T.nilable(
175
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::OrSymbol
176
+ ),
177
+ reset_period_configuration:
178
+ T.nilable(
179
+ T.any(
180
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::OrHash,
181
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::OrHash,
182
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::OrHash
183
+ )
184
+ ),
185
+ start_date: Time,
186
+ status:
187
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::OrSymbol,
188
+ updated_at: Time,
189
+ usage_limit: T.nilable(Float)
190
+ ).returns(T.attached_class)
191
+ end
192
+ def self.new(
193
+ # Unique identifier for the entity
194
+ id:,
195
+ # Timestamp of when the record was created
196
+ created_at:,
197
+ # The description of the entitlement
198
+ description:,
199
+ # The end date of the promotional entitlement
200
+ end_date:,
201
+ # The enum values of the entitlement
202
+ enum_values:,
203
+ # The unique identifier for the environment
204
+ environment_id:,
205
+ # Feature group IDs associated with this entitlement
206
+ feature_group_ids:,
207
+ # The unique identifier of the entitlement feature
208
+ feature_id:,
209
+ # Whether the entitlement has a soft limit
210
+ has_soft_limit:,
211
+ # Whether the entitlement has an unlimited usage
212
+ has_unlimited_usage:,
213
+ # Whether the entitlement is visible
214
+ is_visible:,
215
+ # The grant period of the promotional entitlement
216
+ period:,
217
+ # The reset period of the entitlement
218
+ reset_period:,
219
+ # The reset period configuration of the entitlement
220
+ reset_period_configuration:,
221
+ # The start date of the entitlement
222
+ start_date:,
223
+ # The status of the entitlement
224
+ status:,
225
+ # Timestamp of when the record was last updated
226
+ updated_at:,
227
+ # The usage limit of the entitlement
228
+ usage_limit:
229
+ )
230
+ end
231
+
232
+ sig do
233
+ override.returns(
234
+ {
235
+ id: String,
236
+ created_at: Time,
237
+ description: T.nilable(String),
238
+ end_date: T.nilable(Time),
239
+ enum_values: T.nilable(T::Array[String]),
240
+ environment_id: String,
241
+ feature_group_ids: T.nilable(T::Array[String]),
242
+ feature_id: String,
243
+ has_soft_limit: T.nilable(T::Boolean),
244
+ has_unlimited_usage: T.nilable(T::Boolean),
245
+ is_visible: T::Boolean,
246
+ period:
247
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol,
248
+ reset_period:
249
+ T.nilable(
250
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
251
+ ),
252
+ reset_period_configuration:
253
+ T.nilable(
254
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::Variants
255
+ ),
256
+ start_date: Time,
257
+ status:
258
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::TaggedSymbol,
259
+ updated_at: Time,
260
+ usage_limit: T.nilable(Float)
261
+ }
262
+ )
263
+ end
264
+ def to_hash
265
+ end
266
+
267
+ # The grant period of the promotional entitlement
268
+ module Period
269
+ extend Stigg::Internal::Type::Enum
270
+
271
+ TaggedSymbol =
272
+ T.type_alias do
273
+ T.all(
274
+ Symbol,
275
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period
276
+ )
277
+ end
278
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
279
+
280
+ PERIOD_1_WEEK =
281
+ T.let(
282
+ :"1 week",
283
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
284
+ )
285
+ PERIOD_1_MONTH =
286
+ T.let(
287
+ :"1 month",
288
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
289
+ )
290
+ PERIOD_6_MONTH =
291
+ T.let(
292
+ :"6 month",
293
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
294
+ )
295
+ PERIOD_1_YEAR =
296
+ T.let(
297
+ :"1 year",
298
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
299
+ )
300
+ LIFETIME =
301
+ T.let(
302
+ :lifetime,
303
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
304
+ )
305
+ CUSTOM =
306
+ T.let(
307
+ :custom,
308
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
309
+ )
310
+
311
+ sig do
312
+ override.returns(
313
+ T::Array[
314
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period::TaggedSymbol
315
+ ]
316
+ )
317
+ end
318
+ def self.values
319
+ end
320
+ end
321
+
322
+ # The reset period of the entitlement
323
+ module ResetPeriod
324
+ extend Stigg::Internal::Type::Enum
325
+
326
+ TaggedSymbol =
327
+ T.type_alias do
328
+ T.all(
329
+ Symbol,
330
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod
331
+ )
332
+ end
333
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
334
+
335
+ YEAR =
336
+ T.let(
337
+ :YEAR,
338
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
339
+ )
340
+ MONTH =
341
+ T.let(
342
+ :MONTH,
343
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
344
+ )
345
+ WEEK =
346
+ T.let(
347
+ :WEEK,
348
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
349
+ )
350
+ DAY =
351
+ T.let(
352
+ :DAY,
353
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
354
+ )
355
+ HOUR =
356
+ T.let(
357
+ :HOUR,
358
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
359
+ )
360
+
361
+ sig do
362
+ override.returns(
363
+ T::Array[
364
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod::TaggedSymbol
365
+ ]
366
+ )
367
+ end
368
+ def self.values
369
+ end
370
+ end
371
+
372
+ # The reset period configuration of the entitlement
373
+ module ResetPeriodConfiguration
374
+ extend Stigg::Internal::Type::Union
375
+
376
+ Variants =
377
+ T.type_alias do
378
+ T.any(
379
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig,
380
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig,
381
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig
382
+ )
383
+ end
384
+
385
+ class YearlyResetPeriodConfig < Stigg::Internal::Type::BaseModel
386
+ OrHash =
387
+ T.type_alias do
388
+ T.any(
389
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig,
390
+ Stigg::Internal::AnyHash
391
+ )
392
+ end
393
+
394
+ # Reset anchor (SubscriptionStart)
395
+ sig do
396
+ returns(
397
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo::TaggedSymbol
398
+ )
399
+ end
400
+ attr_accessor :according_to
401
+
402
+ # Yearly reset configuration
403
+ sig do
404
+ params(
405
+ according_to:
406
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo::OrSymbol
407
+ ).returns(T.attached_class)
408
+ end
409
+ def self.new(
410
+ # Reset anchor (SubscriptionStart)
411
+ according_to:
412
+ )
413
+ end
414
+
415
+ sig do
416
+ override.returns(
417
+ {
418
+ according_to:
419
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo::TaggedSymbol
420
+ }
421
+ )
422
+ end
423
+ def to_hash
424
+ end
425
+
426
+ # Reset anchor (SubscriptionStart)
427
+ module AccordingTo
428
+ extend Stigg::Internal::Type::Enum
429
+
430
+ TaggedSymbol =
431
+ T.type_alias do
432
+ T.all(
433
+ Symbol,
434
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo
435
+ )
436
+ end
437
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
438
+
439
+ SUBSCRIPTION_START =
440
+ T.let(
441
+ :SubscriptionStart,
442
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo::TaggedSymbol
443
+ )
444
+
445
+ sig do
446
+ override.returns(
447
+ T::Array[
448
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo::TaggedSymbol
449
+ ]
450
+ )
451
+ end
452
+ def self.values
453
+ end
454
+ end
455
+ end
456
+
457
+ class MonthlyResetPeriodConfig < Stigg::Internal::Type::BaseModel
458
+ OrHash =
459
+ T.type_alias do
460
+ T.any(
461
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig,
462
+ Stigg::Internal::AnyHash
463
+ )
464
+ end
465
+
466
+ # Reset anchor (SubscriptionStart or StartOfTheMonth)
467
+ sig do
468
+ returns(
469
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo::TaggedSymbol
470
+ )
471
+ end
472
+ attr_accessor :according_to
473
+
474
+ # Monthly reset configuration
475
+ sig do
476
+ params(
477
+ according_to:
478
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo::OrSymbol
479
+ ).returns(T.attached_class)
480
+ end
481
+ def self.new(
482
+ # Reset anchor (SubscriptionStart or StartOfTheMonth)
483
+ according_to:
484
+ )
485
+ end
486
+
487
+ sig do
488
+ override.returns(
489
+ {
490
+ according_to:
491
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo::TaggedSymbol
492
+ }
493
+ )
494
+ end
495
+ def to_hash
496
+ end
497
+
498
+ # Reset anchor (SubscriptionStart or StartOfTheMonth)
499
+ module AccordingTo
500
+ extend Stigg::Internal::Type::Enum
501
+
502
+ TaggedSymbol =
503
+ T.type_alias do
504
+ T.all(
505
+ Symbol,
506
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo
507
+ )
508
+ end
509
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
510
+
511
+ SUBSCRIPTION_START =
512
+ T.let(
513
+ :SubscriptionStart,
514
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo::TaggedSymbol
515
+ )
516
+ START_OF_THE_MONTH =
517
+ T.let(
518
+ :StartOfTheMonth,
519
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo::TaggedSymbol
520
+ )
521
+
522
+ sig do
523
+ override.returns(
524
+ T::Array[
525
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo::TaggedSymbol
526
+ ]
527
+ )
528
+ end
529
+ def self.values
530
+ end
531
+ end
532
+ end
533
+
534
+ class WeeklyResetPeriodConfig < Stigg::Internal::Type::BaseModel
535
+ OrHash =
536
+ T.type_alias do
537
+ T.any(
538
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig,
539
+ Stigg::Internal::AnyHash
540
+ )
541
+ end
542
+
543
+ # Reset anchor (SubscriptionStart or specific day)
544
+ sig do
545
+ returns(
546
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
547
+ )
548
+ end
549
+ attr_accessor :according_to
550
+
551
+ # Weekly reset configuration
552
+ sig do
553
+ params(
554
+ according_to:
555
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::OrSymbol
556
+ ).returns(T.attached_class)
557
+ end
558
+ def self.new(
559
+ # Reset anchor (SubscriptionStart or specific day)
560
+ according_to:
561
+ )
562
+ end
563
+
564
+ sig do
565
+ override.returns(
566
+ {
567
+ according_to:
568
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
569
+ }
570
+ )
571
+ end
572
+ def to_hash
573
+ end
574
+
575
+ # Reset anchor (SubscriptionStart or specific day)
576
+ module AccordingTo
577
+ extend Stigg::Internal::Type::Enum
578
+
579
+ TaggedSymbol =
580
+ T.type_alias do
581
+ T.all(
582
+ Symbol,
583
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo
584
+ )
585
+ end
586
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
587
+
588
+ SUBSCRIPTION_START =
589
+ T.let(
590
+ :SubscriptionStart,
591
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
592
+ )
593
+ EVERY_SUNDAY =
594
+ T.let(
595
+ :EverySunday,
596
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
597
+ )
598
+ EVERY_MONDAY =
599
+ T.let(
600
+ :EveryMonday,
601
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
602
+ )
603
+ EVERY_TUESDAY =
604
+ T.let(
605
+ :EveryTuesday,
606
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
607
+ )
608
+ EVERY_WEDNESDAY =
609
+ T.let(
610
+ :EveryWednesday,
611
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
612
+ )
613
+ EVERY_THURSDAY =
614
+ T.let(
615
+ :EveryThursday,
616
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
617
+ )
618
+ EVERY_FRIDAY =
619
+ T.let(
620
+ :EveryFriday,
621
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
622
+ )
623
+ EVERY_SATURDAY =
624
+ T.let(
625
+ :EverySaturday,
626
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
627
+ )
628
+
629
+ sig do
630
+ override.returns(
631
+ T::Array[
632
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo::TaggedSymbol
633
+ ]
634
+ )
635
+ end
636
+ def self.values
637
+ end
638
+ end
639
+ end
640
+
641
+ sig do
642
+ override.returns(
643
+ T::Array[
644
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::Variants
645
+ ]
646
+ )
647
+ end
648
+ def self.variants
649
+ end
650
+ end
651
+
652
+ # The status of the entitlement
653
+ module Status
654
+ extend Stigg::Internal::Type::Enum
655
+
656
+ TaggedSymbol =
657
+ T.type_alias do
658
+ T.all(
659
+ Symbol,
660
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status
661
+ )
662
+ end
663
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
664
+
665
+ ACTIVE =
666
+ T.let(
667
+ :Active,
668
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::TaggedSymbol
669
+ )
670
+ EXPIRED =
671
+ T.let(
672
+ :Expired,
673
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::TaggedSymbol
674
+ )
675
+ PAUSED =
676
+ T.let(
677
+ :Paused,
678
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::TaggedSymbol
679
+ )
680
+
681
+ sig do
682
+ override.returns(
683
+ T::Array[
684
+ Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status::TaggedSymbol
685
+ ]
686
+ )
687
+ end
688
+ def self.values
689
+ end
690
+ end
691
+ end
692
+ end
693
+ end
694
+ end
695
+ end
696
+ end