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,56 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Stigg
4
- module Models
5
- module V1
6
- module Customers
7
- # @see Stigg::Resources::V1::Customers::Usage#retrieve
8
- class UsageRetrieveParams < Stigg::Internal::Type::BaseModel
9
- extend Stigg::Internal::Type::RequestParameters::Converter
10
- include Stigg::Internal::Type::RequestParameters
11
-
12
- # @!attribute customer_id
13
- #
14
- # @return [String]
15
- required :customer_id, String
16
-
17
- # @!attribute start_date
18
- # The start date of the range
19
- #
20
- # @return [Time]
21
- required :start_date, Time
22
-
23
- # @!attribute end_date
24
- # The end date of the range
25
- #
26
- # @return [Time, nil]
27
- optional :end_date, Time
28
-
29
- # @!attribute group_by
30
- #
31
- # @return [String, nil]
32
- optional :group_by, String
33
-
34
- # @!attribute resource_id
35
- # Resource id
36
- #
37
- # @return [String, nil]
38
- optional :resource_id, String, nil?: true
39
-
40
- # @!method initialize(customer_id:, start_date:, end_date: nil, group_by: nil, resource_id: nil, request_options: {})
41
- # @param customer_id [String]
42
- #
43
- # @param start_date [Time] The start date of the range
44
- #
45
- # @param end_date [Time] The end date of the range
46
- #
47
- # @param group_by [String]
48
- #
49
- # @param resource_id [String, nil] Resource id
50
- #
51
- # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
52
- end
53
- end
54
- end
55
- end
56
- end
@@ -1,145 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Stigg
4
- module Models
5
- module V1
6
- module Customers
7
- # @see Stigg::Resources::V1::Customers::Usage#retrieve
8
- class UsageRetrieveResponse < Stigg::Internal::Type::BaseModel
9
- # @!attribute data
10
- #
11
- # @return [Stigg::Models::V1::Customers::UsageRetrieveResponse::Data]
12
- required :data, -> { Stigg::Models::V1::Customers::UsageRetrieveResponse::Data }
13
-
14
- # @!method initialize(data:)
15
- # @param data [Stigg::Models::V1::Customers::UsageRetrieveResponse::Data]
16
-
17
- # @see Stigg::Models::V1::Customers::UsageRetrieveResponse#data
18
- class Data < Stigg::Internal::Type::BaseModel
19
- # @!attribute markers
20
- # Markers for events that affecting feature usage
21
- #
22
- # @return [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker>]
23
- required :markers,
24
- -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker] }
25
-
26
- # @!attribute series
27
- # Series of usage history
28
- #
29
- # @return [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series>]
30
- required :series,
31
- -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series] }
32
-
33
- # @!method initialize(markers:, series:)
34
- # @param markers [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker>] Markers for events that affecting feature usage
35
- #
36
- # @param series [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series>] Series of usage history
37
-
38
- class Marker < Stigg::Internal::Type::BaseModel
39
- # @!attribute timestamp
40
- # Timestamp of the marker
41
- #
42
- # @return [Time]
43
- required :timestamp, Time
44
-
45
- # @!attribute type
46
- # Type of marker for a usage history point
47
- #
48
- # @return [Symbol, Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker::Type]
49
- required :type, enum: -> { Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker::Type }
50
-
51
- # @!method initialize(timestamp:, type:)
52
- # @param timestamp [Time] Timestamp of the marker
53
- #
54
- # @param type [Symbol, Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker::Type] Type of marker for a usage history point
55
-
56
- # Type of marker for a usage history point
57
- #
58
- # @see Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Marker#type
59
- module Type
60
- extend Stigg::Internal::Type::Enum
61
-
62
- PERIODIC_RESET = :PERIODIC_RESET
63
- SUBSCRIPTION_CHANGE_RESET = :SUBSCRIPTION_CHANGE_RESET
64
-
65
- # @!method self.values
66
- # @return [Array<Symbol>]
67
- end
68
- end
69
-
70
- class Series < Stigg::Internal::Type::BaseModel
71
- # @!attribute points
72
- # Points in the usage history series
73
- #
74
- # @return [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Point>]
75
- required :points,
76
- -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Point] }
77
-
78
- # @!attribute tags
79
- # Tags for the usage history series
80
- #
81
- # @return [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Tag>]
82
- required :tags,
83
- -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Tag] }
84
-
85
- # @!method initialize(points:, tags:)
86
- # @param points [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Point>] Points in the usage history series
87
- #
88
- # @param tags [Array<Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Tag>] Tags for the usage history series
89
-
90
- class Point < Stigg::Internal::Type::BaseModel
91
- # @!attribute is_reset_point
92
- # Indicates whether there was usage reset in this point, see `markers` for details
93
- #
94
- # @return [Boolean]
95
- required :is_reset_point, Stigg::Internal::Type::Boolean, api_name: :isResetPoint
96
-
97
- # @!attribute timestamp
98
- # Timestamp of the usage history point
99
- #
100
- # @return [Time]
101
- required :timestamp, Time
102
-
103
- # @!attribute value
104
- # Value of the usage history point
105
- #
106
- # @return [Float]
107
- required :value, Float
108
-
109
- # @!method initialize(is_reset_point:, timestamp:, value:)
110
- # Some parameter documentations has been truncated, see
111
- # {Stigg::Models::V1::Customers::UsageRetrieveResponse::Data::Series::Point} for
112
- # more details.
113
- #
114
- # @param is_reset_point [Boolean] Indicates whether there was usage reset in this point, see `markers` for details
115
- #
116
- # @param timestamp [Time] Timestamp of the usage history point
117
- #
118
- # @param value [Float] Value of the usage history point
119
- end
120
-
121
- class Tag < Stigg::Internal::Type::BaseModel
122
- # @!attribute key
123
- # Key of the tag
124
- #
125
- # @return [String]
126
- required :key, String
127
-
128
- # @!attribute value
129
- # Value of the tag
130
- #
131
- # @return [String]
132
- required :value, String
133
-
134
- # @!method initialize(key:, value:)
135
- # @param key [String] Key of the tag
136
- #
137
- # @param value [String] Value of the tag
138
- end
139
- end
140
- end
141
- end
142
- end
143
- end
144
- end
145
- end
@@ -1,214 +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 SubscriptionCreateParams < Stigg::Internal::Type::BaseModel
8
- extend Stigg::Internal::Type::RequestParameters::Converter
9
- include Stigg::Internal::Type::RequestParameters
10
-
11
- # @!attribute customer_id
12
- # Customer ID to provision the subscription for
13
- #
14
- # @return [String]
15
- required :customer_id, String, api_name: :customerId
16
-
17
- # @!attribute plan_id
18
- # Plan ID to provision
19
- #
20
- # @return [String]
21
- required :plan_id, String, api_name: :planId
22
-
23
- # @!attribute id
24
- # Unique identifier for the subscription
25
- #
26
- # @return [String, nil]
27
- optional :id, String, nil?: true
28
-
29
- # @!attribute await_payment_confirmation
30
- # Whether to wait for payment confirmation before returning the subscription
31
- #
32
- # @return [Boolean, nil]
33
- optional :await_payment_confirmation,
34
- Stigg::Internal::Type::Boolean,
35
- api_name: :awaitPaymentConfirmation
36
-
37
- # @!attribute billing_period
38
- #
39
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateParams::BillingPeriod, nil]
40
- optional :billing_period,
41
- enum: -> { Stigg::V1::SubscriptionCreateParams::BillingPeriod },
42
- api_name: :billingPeriod
43
-
44
- # @!attribute checkout_options
45
- #
46
- # @return [Stigg::Models::V1::SubscriptionCreateParams::CheckoutOptions, nil]
47
- optional :checkout_options,
48
- -> { Stigg::V1::SubscriptionCreateParams::CheckoutOptions },
49
- api_name: :checkoutOptions
50
-
51
- # @!attribute metadata
52
- # Additional metadata for the subscription
53
- #
54
- # @return [Hash{Symbol=>String}, nil]
55
- optional :metadata, Stigg::Internal::Type::HashOf[String]
56
-
57
- # @!attribute paying_customer_id
58
- # Optional paying customer ID for split billing scenarios
59
- #
60
- # @return [String, nil]
61
- optional :paying_customer_id, String, api_name: :payingCustomerId, nil?: true
62
-
63
- # @!attribute resource_id
64
- # Optional resource ID for multi-instance subscriptions
65
- #
66
- # @return [String, nil]
67
- optional :resource_id, String, api_name: :resourceId, nil?: true
68
-
69
- # @!attribute trial_override_configuration
70
- #
71
- # @return [Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration, nil]
72
- optional :trial_override_configuration,
73
- -> { Stigg::V1::SubscriptionCreateParams::TrialOverrideConfiguration },
74
- api_name: :trialOverrideConfiguration
75
-
76
- # @!method initialize(customer_id:, plan_id:, id: nil, await_payment_confirmation: nil, billing_period: nil, checkout_options: nil, metadata: nil, paying_customer_id: nil, resource_id: nil, trial_override_configuration: nil, request_options: {})
77
- # @param customer_id [String] Customer ID to provision the subscription for
78
- #
79
- # @param plan_id [String] Plan ID to provision
80
- #
81
- # @param id [String, nil] Unique identifier for the subscription
82
- #
83
- # @param await_payment_confirmation [Boolean] Whether to wait for payment confirmation before returning the subscription
84
- #
85
- # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionCreateParams::BillingPeriod]
86
- #
87
- # @param checkout_options [Stigg::Models::V1::SubscriptionCreateParams::CheckoutOptions]
88
- #
89
- # @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
90
- #
91
- # @param paying_customer_id [String, nil] Optional paying customer ID for split billing scenarios
92
- #
93
- # @param resource_id [String, nil] Optional resource ID for multi-instance subscriptions
94
- #
95
- # @param trial_override_configuration [Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration]
96
- #
97
- # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
98
-
99
- module BillingPeriod
100
- extend Stigg::Internal::Type::Enum
101
-
102
- MONTHLY = :MONTHLY
103
- ANNUALLY = :ANNUALLY
104
-
105
- # @!method self.values
106
- # @return [Array<Symbol>]
107
- end
108
-
109
- class CheckoutOptions < Stigg::Internal::Type::BaseModel
110
- # @!attribute cancel_url
111
- # URL to redirect to if checkout is canceled
112
- #
113
- # @return [String]
114
- required :cancel_url, String, api_name: :cancelUrl
115
-
116
- # @!attribute success_url
117
- # URL to redirect to after successful checkout
118
- #
119
- # @return [String]
120
- required :success_url, String, api_name: :successUrl
121
-
122
- # @!attribute allow_promo_codes
123
- # Allow promotional codes during checkout
124
- #
125
- # @return [Boolean, nil]
126
- optional :allow_promo_codes, Stigg::Internal::Type::Boolean, api_name: :allowPromoCodes
127
-
128
- # @!attribute allow_tax_id_collection
129
- # Allow tax ID collection during checkout
130
- #
131
- # @return [Boolean, nil]
132
- optional :allow_tax_id_collection, Stigg::Internal::Type::Boolean, api_name: :allowTaxIdCollection
133
-
134
- # @!attribute collect_billing_address
135
- # Collect billing address during checkout
136
- #
137
- # @return [Boolean, nil]
138
- optional :collect_billing_address, Stigg::Internal::Type::Boolean, api_name: :collectBillingAddress
139
-
140
- # @!attribute collect_phone_number
141
- # Collect phone number during checkout
142
- #
143
- # @return [Boolean, nil]
144
- optional :collect_phone_number, Stigg::Internal::Type::Boolean, api_name: :collectPhoneNumber
145
-
146
- # @!attribute reference_id
147
- # Optional reference ID for the checkout session
148
- #
149
- # @return [String, nil]
150
- optional :reference_id, String, api_name: :referenceId, nil?: true
151
-
152
- # @!method initialize(cancel_url:, success_url:, allow_promo_codes: nil, allow_tax_id_collection: nil, collect_billing_address: nil, collect_phone_number: nil, reference_id: nil)
153
- # @param cancel_url [String] URL to redirect to if checkout is canceled
154
- #
155
- # @param success_url [String] URL to redirect to after successful checkout
156
- #
157
- # @param allow_promo_codes [Boolean] Allow promotional codes during checkout
158
- #
159
- # @param allow_tax_id_collection [Boolean] Allow tax ID collection during checkout
160
- #
161
- # @param collect_billing_address [Boolean] Collect billing address during checkout
162
- #
163
- # @param collect_phone_number [Boolean] Collect phone number during checkout
164
- #
165
- # @param reference_id [String, nil] Optional reference ID for the checkout session
166
- end
167
-
168
- class TrialOverrideConfiguration < Stigg::Internal::Type::BaseModel
169
- # @!attribute is_trial
170
- # Whether the subscription should start with a trial period
171
- #
172
- # @return [Boolean]
173
- required :is_trial, Stigg::Internal::Type::Boolean, api_name: :isTrial
174
-
175
- # @!attribute trial_end_behavior
176
- # Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION
177
- #
178
- # @return [Symbol, Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration::TrialEndBehavior, nil]
179
- optional :trial_end_behavior,
180
- enum: -> {
181
- Stigg::V1::SubscriptionCreateParams::TrialOverrideConfiguration::TrialEndBehavior
182
- },
183
- api_name: :trialEndBehavior
184
-
185
- # @!attribute trial_end_date
186
- # Custom trial end date
187
- #
188
- # @return [Time, nil]
189
- optional :trial_end_date, Time, api_name: :trialEndDate
190
-
191
- # @!method initialize(is_trial:, trial_end_behavior: nil, trial_end_date: nil)
192
- # @param is_trial [Boolean] Whether the subscription should start with a trial period
193
- #
194
- # @param trial_end_behavior [Symbol, Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration::TrialEndBehavior] Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION
195
- #
196
- # @param trial_end_date [Time] Custom trial end date
197
-
198
- # Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION
199
- #
200
- # @see Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration#trial_end_behavior
201
- module TrialEndBehavior
202
- extend Stigg::Internal::Type::Enum
203
-
204
- CONVERT_TO_PAID = :CONVERT_TO_PAID
205
- CANCEL_SUBSCRIPTION = :CANCEL_SUBSCRIPTION
206
-
207
- # @!method self.values
208
- # @return [Array<Symbol>]
209
- end
210
- end
211
- end
212
- end
213
- end
214
- end