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,160 +0,0 @@
1
- # typed: strong
2
-
3
- module Stigg
4
- module Models
5
- class V1CreateEventParams < Stigg::Internal::Type::BaseModel
6
- extend Stigg::Internal::Type::RequestParameters::Converter
7
- include Stigg::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(Stigg::V1CreateEventParams, Stigg::Internal::AnyHash)
12
- end
13
-
14
- # A list of usage events to report
15
- sig { returns(T::Array[Stigg::V1CreateEventParams::Event]) }
16
- attr_accessor :events
17
-
18
- sig do
19
- params(
20
- events: T::Array[Stigg::V1CreateEventParams::Event::OrHash],
21
- request_options: Stigg::RequestOptions::OrHash
22
- ).returns(T.attached_class)
23
- end
24
- def self.new(
25
- # A list of usage events to report
26
- events:,
27
- request_options: {}
28
- )
29
- end
30
-
31
- sig do
32
- override.returns(
33
- {
34
- events: T::Array[Stigg::V1CreateEventParams::Event],
35
- request_options: Stigg::RequestOptions
36
- }
37
- )
38
- end
39
- def to_hash
40
- end
41
-
42
- class Event < Stigg::Internal::Type::BaseModel
43
- OrHash =
44
- T.type_alias do
45
- T.any(Stigg::V1CreateEventParams::Event, Stigg::Internal::AnyHash)
46
- end
47
-
48
- # Customer id
49
- sig { returns(String) }
50
- attr_accessor :customer_id
51
-
52
- # The name of the usage event
53
- sig { returns(String) }
54
- attr_accessor :event_name
55
-
56
- # Idempotency key
57
- sig { returns(String) }
58
- attr_accessor :idempotency_key
59
-
60
- # Dimensions associated with the usage event
61
- sig do
62
- returns(
63
- T.nilable(
64
- T::Hash[
65
- Symbol,
66
- Stigg::V1CreateEventParams::Event::Dimension::Variants
67
- ]
68
- )
69
- )
70
- end
71
- attr_reader :dimensions
72
-
73
- sig do
74
- params(
75
- dimensions:
76
- T::Hash[
77
- Symbol,
78
- Stigg::V1CreateEventParams::Event::Dimension::Variants
79
- ]
80
- ).void
81
- end
82
- attr_writer :dimensions
83
-
84
- # Resource id
85
- sig { returns(T.nilable(String)) }
86
- attr_accessor :resource_id
87
-
88
- # Timestamp
89
- sig { returns(T.nilable(Time)) }
90
- attr_reader :timestamp
91
-
92
- sig { params(timestamp: Time).void }
93
- attr_writer :timestamp
94
-
95
- sig do
96
- params(
97
- customer_id: String,
98
- event_name: String,
99
- idempotency_key: String,
100
- dimensions:
101
- T::Hash[
102
- Symbol,
103
- Stigg::V1CreateEventParams::Event::Dimension::Variants
104
- ],
105
- resource_id: T.nilable(String),
106
- timestamp: Time
107
- ).returns(T.attached_class)
108
- end
109
- def self.new(
110
- # Customer id
111
- customer_id:,
112
- # The name of the usage event
113
- event_name:,
114
- # Idempotency key
115
- idempotency_key:,
116
- # Dimensions associated with the usage event
117
- dimensions: nil,
118
- # Resource id
119
- resource_id: nil,
120
- # Timestamp
121
- timestamp: nil
122
- )
123
- end
124
-
125
- sig do
126
- override.returns(
127
- {
128
- customer_id: String,
129
- event_name: String,
130
- idempotency_key: String,
131
- dimensions:
132
- T::Hash[
133
- Symbol,
134
- Stigg::V1CreateEventParams::Event::Dimension::Variants
135
- ],
136
- resource_id: T.nilable(String),
137
- timestamp: Time
138
- }
139
- )
140
- end
141
- def to_hash
142
- end
143
-
144
- module Dimension
145
- extend Stigg::Internal::Type::Union
146
-
147
- Variants = T.type_alias { T.any(String, Float, T::Boolean) }
148
-
149
- sig do
150
- override.returns(
151
- T::Array[Stigg::V1CreateEventParams::Event::Dimension::Variants]
152
- )
153
- end
154
- def self.variants
155
- end
156
- end
157
- end
158
- end
159
- end
160
- end
@@ -1,23 +0,0 @@
1
- # typed: strong
2
-
3
- module Stigg
4
- module Models
5
- class V1CreateEventResponse < Stigg::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Stigg::Models::V1CreateEventResponse, Stigg::Internal::AnyHash)
9
- end
10
-
11
- sig { returns(T.anything) }
12
- attr_accessor :data
13
-
14
- sig { params(data: T.anything).returns(T.attached_class) }
15
- def self.new(data:)
16
- end
17
-
18
- sig { override.returns({ data: T.anything }) }
19
- def to_hash
20
- end
21
- end
22
- end
23
- end
@@ -1,177 +0,0 @@
1
- # typed: strong
2
-
3
- module Stigg
4
- module Models
5
- class V1CreateUsageParams < Stigg::Internal::Type::BaseModel
6
- extend Stigg::Internal::Type::RequestParameters::Converter
7
- include Stigg::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(Stigg::V1CreateUsageParams, Stigg::Internal::AnyHash)
12
- end
13
-
14
- # A list of usage reports to be submitted in bulk
15
- sig { returns(T::Array[Stigg::V1CreateUsageParams::Usage]) }
16
- attr_accessor :usages
17
-
18
- sig do
19
- params(
20
- usages: T::Array[Stigg::V1CreateUsageParams::Usage::OrHash],
21
- request_options: Stigg::RequestOptions::OrHash
22
- ).returns(T.attached_class)
23
- end
24
- def self.new(
25
- # A list of usage reports to be submitted in bulk
26
- usages:,
27
- request_options: {}
28
- )
29
- end
30
-
31
- sig do
32
- override.returns(
33
- {
34
- usages: T::Array[Stigg::V1CreateUsageParams::Usage],
35
- request_options: Stigg::RequestOptions
36
- }
37
- )
38
- end
39
- def to_hash
40
- end
41
-
42
- class Usage < Stigg::Internal::Type::BaseModel
43
- OrHash =
44
- T.type_alias do
45
- T.any(Stigg::V1CreateUsageParams::Usage, Stigg::Internal::AnyHash)
46
- end
47
-
48
- # Customer id
49
- sig { returns(String) }
50
- attr_accessor :customer_id
51
-
52
- # Feature id
53
- sig { returns(String) }
54
- attr_accessor :feature_id
55
-
56
- # The value to report for usage
57
- sig { returns(Integer) }
58
- attr_accessor :value
59
-
60
- # Timestamp of when the record was created
61
- sig { returns(T.nilable(Time)) }
62
- attr_reader :created_at
63
-
64
- sig { params(created_at: Time).void }
65
- attr_writer :created_at
66
-
67
- # Additional dimensions for the usage report
68
- sig { returns(T.nilable(T::Hash[Symbol, String])) }
69
- attr_reader :dimensions
70
-
71
- sig { params(dimensions: T::Hash[Symbol, String]).void }
72
- attr_writer :dimensions
73
-
74
- # Resource id
75
- sig { returns(T.nilable(String)) }
76
- attr_accessor :resource_id
77
-
78
- # The method by which the usage value should be updated
79
- sig do
80
- returns(
81
- T.nilable(
82
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::OrSymbol
83
- )
84
- )
85
- end
86
- attr_reader :update_behavior
87
-
88
- sig do
89
- params(
90
- update_behavior:
91
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::OrSymbol
92
- ).void
93
- end
94
- attr_writer :update_behavior
95
-
96
- sig do
97
- params(
98
- customer_id: String,
99
- feature_id: String,
100
- value: Integer,
101
- created_at: Time,
102
- dimensions: T::Hash[Symbol, String],
103
- resource_id: T.nilable(String),
104
- update_behavior:
105
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::OrSymbol
106
- ).returns(T.attached_class)
107
- end
108
- def self.new(
109
- # Customer id
110
- customer_id:,
111
- # Feature id
112
- feature_id:,
113
- # The value to report for usage
114
- value:,
115
- # Timestamp of when the record was created
116
- created_at: nil,
117
- # Additional dimensions for the usage report
118
- dimensions: nil,
119
- # Resource id
120
- resource_id: nil,
121
- # The method by which the usage value should be updated
122
- update_behavior: nil
123
- )
124
- end
125
-
126
- sig do
127
- override.returns(
128
- {
129
- customer_id: String,
130
- feature_id: String,
131
- value: Integer,
132
- created_at: Time,
133
- dimensions: T::Hash[Symbol, String],
134
- resource_id: T.nilable(String),
135
- update_behavior:
136
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::OrSymbol
137
- }
138
- )
139
- end
140
- def to_hash
141
- end
142
-
143
- # The method by which the usage value should be updated
144
- module UpdateBehavior
145
- extend Stigg::Internal::Type::Enum
146
-
147
- TaggedSymbol =
148
- T.type_alias do
149
- T.all(Symbol, Stigg::V1CreateUsageParams::Usage::UpdateBehavior)
150
- end
151
- OrSymbol = T.type_alias { T.any(Symbol, String) }
152
-
153
- DELTA =
154
- T.let(
155
- :DELTA,
156
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::TaggedSymbol
157
- )
158
- SET =
159
- T.let(
160
- :SET,
161
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::TaggedSymbol
162
- )
163
-
164
- sig do
165
- override.returns(
166
- T::Array[
167
- Stigg::V1CreateUsageParams::Usage::UpdateBehavior::TaggedSymbol
168
- ]
169
- )
170
- end
171
- def self.values
172
- end
173
- end
174
- end
175
- end
176
- end
177
- end
@@ -1,150 +0,0 @@
1
- # typed: strong
2
-
3
- module Stigg
4
- module Models
5
- class V1CreateUsageResponse < Stigg::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Stigg::Models::V1CreateUsageResponse, Stigg::Internal::AnyHash)
9
- end
10
-
11
- sig { returns(T::Array[Stigg::Models::V1CreateUsageResponse::Data]) }
12
- attr_accessor :data
13
-
14
- sig do
15
- params(
16
- data: T::Array[Stigg::Models::V1CreateUsageResponse::Data::OrHash]
17
- ).returns(T.attached_class)
18
- end
19
- def self.new(data:)
20
- end
21
-
22
- sig do
23
- override.returns(
24
- { data: T::Array[Stigg::Models::V1CreateUsageResponse::Data] }
25
- )
26
- end
27
- def to_hash
28
- end
29
-
30
- class Data < Stigg::Internal::Type::BaseModel
31
- OrHash =
32
- T.type_alias do
33
- T.any(
34
- Stigg::Models::V1CreateUsageResponse::Data,
35
- Stigg::Internal::AnyHash
36
- )
37
- end
38
-
39
- # Unique identifier for the entity
40
- sig { returns(String) }
41
- attr_accessor :id
42
-
43
- # Timestamp of when the record was created
44
- sig { returns(Time) }
45
- attr_accessor :created_at
46
-
47
- # Customer id
48
- sig { returns(String) }
49
- attr_accessor :customer_id
50
-
51
- # Feature id
52
- sig { returns(String) }
53
- attr_accessor :feature_id
54
-
55
- # Timestamp
56
- sig { returns(Time) }
57
- attr_accessor :timestamp
58
-
59
- # The usage measurement record
60
- sig { returns(Float) }
61
- attr_accessor :value
62
-
63
- # The current measured usage value
64
- sig { returns(T.nilable(Float)) }
65
- attr_accessor :current_usage
66
-
67
- # The date when the next usage reset will occur
68
- sig { returns(T.nilable(Time)) }
69
- attr_accessor :next_reset_date
70
-
71
- # Resource id
72
- sig { returns(T.nilable(String)) }
73
- attr_accessor :resource_id
74
-
75
- # The end date of the usage period in which this measurement resides (for
76
- # entitlements with a reset period)
77
- sig { returns(T.nilable(Time)) }
78
- attr_accessor :usage_period_end
79
-
80
- # The start date of the usage period in which this measurement resides (for
81
- # entitlements with a reset period)
82
- sig { returns(T.nilable(Time)) }
83
- attr_accessor :usage_period_start
84
-
85
- sig do
86
- params(
87
- id: String,
88
- created_at: Time,
89
- customer_id: String,
90
- feature_id: String,
91
- timestamp: Time,
92
- value: Float,
93
- current_usage: T.nilable(Float),
94
- next_reset_date: T.nilable(Time),
95
- resource_id: T.nilable(String),
96
- usage_period_end: T.nilable(Time),
97
- usage_period_start: T.nilable(Time)
98
- ).returns(T.attached_class)
99
- end
100
- def self.new(
101
- # Unique identifier for the entity
102
- id:,
103
- # Timestamp of when the record was created
104
- created_at:,
105
- # Customer id
106
- customer_id:,
107
- # Feature id
108
- feature_id:,
109
- # Timestamp
110
- timestamp:,
111
- # The usage measurement record
112
- value:,
113
- # The current measured usage value
114
- current_usage: nil,
115
- # The date when the next usage reset will occur
116
- next_reset_date: nil,
117
- # Resource id
118
- resource_id: nil,
119
- # The end date of the usage period in which this measurement resides (for
120
- # entitlements with a reset period)
121
- usage_period_end: nil,
122
- # The start date of the usage period in which this measurement resides (for
123
- # entitlements with a reset period)
124
- usage_period_start: nil
125
- )
126
- end
127
-
128
- sig do
129
- override.returns(
130
- {
131
- id: String,
132
- created_at: Time,
133
- customer_id: String,
134
- feature_id: String,
135
- timestamp: Time,
136
- value: Float,
137
- current_usage: T.nilable(Float),
138
- next_reset_date: T.nilable(Time),
139
- resource_id: T.nilable(String),
140
- usage_period_end: T.nilable(Time),
141
- usage_period_start: T.nilable(Time)
142
- }
143
- )
144
- end
145
- def to_hash
146
- end
147
- end
148
- end
149
- end
150
- end
@@ -1,45 +0,0 @@
1
- # typed: strong
2
-
3
- module Stigg
4
- module Resources
5
- class V1
6
- class Customers
7
- class Usage
8
- # Perform retrieval on a Usage history
9
- sig do
10
- params(
11
- feature_id: String,
12
- customer_id: String,
13
- start_date: Time,
14
- end_date: Time,
15
- group_by: String,
16
- resource_id: T.nilable(String),
17
- request_options: Stigg::RequestOptions::OrHash
18
- ).returns(Stigg::Models::V1::Customers::UsageRetrieveResponse)
19
- end
20
- def retrieve(
21
- # Path param: Feature id
22
- feature_id,
23
- # Path param: Customer id
24
- customer_id:,
25
- # Query param: The start date of the range
26
- start_date:,
27
- # Query param: The end date of the range
28
- end_date: nil,
29
- # Query param
30
- group_by: nil,
31
- # Query param: Resource id
32
- resource_id: nil,
33
- request_options: {}
34
- )
35
- end
36
-
37
- # @api private
38
- sig { params(client: Stigg::Client).returns(T.attached_class) }
39
- def self.new(client:)
40
- end
41
- end
42
- end
43
- end
44
- end
45
- end