stigg 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

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 (124) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +29 -1
  4. data/lib/stigg/internal/my_cursor_id_page.rb +32 -4
  5. data/lib/stigg/models/v1/coupon_create_params.rb +2 -0
  6. data/lib/stigg/models/v1/coupon_create_response.rb +11 -6
  7. data/lib/stigg/models/v1/coupon_list_params.rb +14 -14
  8. data/lib/stigg/models/v1/coupon_list_response.rb +262 -278
  9. data/lib/stigg/models/v1/coupon_retrieve_response.rb +11 -6
  10. data/lib/stigg/models/v1/customer_create_params.rb +2 -0
  11. data/lib/stigg/models/v1/customer_list_params.rb +14 -14
  12. data/lib/stigg/models/v1/customer_list_response.rb +160 -174
  13. data/lib/stigg/models/v1/customer_response.rb +8 -1
  14. data/lib/stigg/models/v1/customer_update_params.rb +2 -0
  15. data/lib/stigg/models/v1/customers/payment_method_attach_params.rb +3 -1
  16. data/lib/stigg/models/v1/subscription_create_params.rb +1485 -6
  17. data/lib/stigg/models/v1/subscription_create_response.rb +703 -4
  18. data/lib/stigg/models/v1/subscription_delegate_params.rb +7 -2
  19. data/lib/stigg/models/v1/subscription_delegate_response.rb +42 -2
  20. data/lib/stigg/models/v1/subscription_list_params.rb +20 -24
  21. data/lib/stigg/models/v1/subscription_list_response.rb +255 -236
  22. data/lib/stigg/models/v1/subscription_migrate_params.rb +3 -3
  23. data/lib/stigg/models/v1/subscription_migrate_response.rb +42 -2
  24. data/lib/stigg/models/v1/subscription_preview_params.rb +139 -46
  25. data/lib/stigg/models/v1/subscription_preview_response.rb +164 -49
  26. data/lib/stigg/models/v1/subscription_retrieve_response.rb +42 -2
  27. data/lib/stigg/models/v1/subscription_transfer_params.rb +2 -6
  28. data/lib/stigg/models/v1/subscription_transfer_response.rb +42 -2
  29. data/lib/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rb +2 -0
  30. data/lib/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rb +2 -0
  31. data/lib/stigg/models/v1_create_event_params.rb +2 -0
  32. data/lib/stigg/models/v1_create_event_response.rb +8 -1
  33. data/lib/stigg/models/v1_create_usage_params.rb +19 -3
  34. data/lib/stigg/models/v1_create_usage_response.rb +7 -1
  35. data/lib/stigg/resources/v1/coupons.rb +12 -10
  36. data/lib/stigg/resources/v1/customers/payment_method.rb +6 -5
  37. data/lib/stigg/resources/v1/customers/usage.rb +0 -41
  38. data/lib/stigg/resources/v1/customers.rb +20 -20
  39. data/lib/stigg/resources/v1/subscriptions/future_update.rb +6 -4
  40. data/lib/stigg/resources/v1/subscriptions.rb +74 -49
  41. data/lib/stigg/resources/v1.rb +2 -2
  42. data/lib/stigg/version.rb +1 -1
  43. data/lib/stigg.rb +0 -7
  44. data/rbi/stigg/internal/my_cursor_id_page.rbi +27 -0
  45. data/rbi/stigg/models/v1/coupon_create_params.rbi +1 -0
  46. data/rbi/stigg/models/v1/coupon_create_response.rbi +11 -10
  47. data/rbi/stigg/models/v1/coupon_list_params.rbi +21 -21
  48. data/rbi/stigg/models/v1/coupon_list_response.rbi +812 -869
  49. data/rbi/stigg/models/v1/coupon_retrieve_response.rbi +11 -10
  50. data/rbi/stigg/models/v1/customer_create_params.rbi +1 -0
  51. data/rbi/stigg/models/v1/customer_list_params.rbi +21 -21
  52. data/rbi/stigg/models/v1/customer_list_response.rbi +307 -347
  53. data/rbi/stigg/models/v1/customer_response.rbi +8 -1
  54. data/rbi/stigg/models/v1/customer_update_params.rbi +1 -0
  55. data/rbi/stigg/models/v1/customers/payment_method_attach_params.rbi +3 -0
  56. data/rbi/stigg/models/v1/subscription_create_params.rbi +4975 -84
  57. data/rbi/stigg/models/v1/subscription_create_response.rbi +2508 -1
  58. data/rbi/stigg/models/v1/subscription_delegate_params.rbi +6 -2
  59. data/rbi/stigg/models/v1/subscription_delegate_response.rbi +84 -1
  60. data/rbi/stigg/models/v1/subscription_list_params.rbi +26 -28
  61. data/rbi/stigg/models/v1/subscription_list_response.rbi +460 -435
  62. data/rbi/stigg/models/v1/subscription_migrate_params.rbi +3 -3
  63. data/rbi/stigg/models/v1/subscription_migrate_response.rbi +84 -1
  64. data/rbi/stigg/models/v1/subscription_preview_params.rbi +112 -14
  65. data/rbi/stigg/models/v1/subscription_preview_response.rbi +139 -6
  66. data/rbi/stigg/models/v1/subscription_retrieve_response.rbi +84 -1
  67. data/rbi/stigg/models/v1/subscription_transfer_params.rbi +2 -4
  68. data/rbi/stigg/models/v1/subscription_transfer_response.rbi +84 -1
  69. data/rbi/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbi +1 -0
  70. data/rbi/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rbi +1 -0
  71. data/rbi/stigg/models/v1_create_event_params.rbi +1 -0
  72. data/rbi/stigg/models/v1_create_event_response.rbi +8 -1
  73. data/rbi/stigg/models/v1_create_usage_params.rbi +44 -4
  74. data/rbi/stigg/models/v1_create_usage_response.rbi +8 -1
  75. data/rbi/stigg/resources/v1/coupons.rbi +20 -12
  76. data/rbi/stigg/resources/v1/customers/payment_method.rbi +9 -3
  77. data/rbi/stigg/resources/v1/customers/usage.rbi +0 -29
  78. data/rbi/stigg/resources/v1/customers.rbi +34 -20
  79. data/rbi/stigg/resources/v1/subscriptions/future_update.rbi +12 -4
  80. data/rbi/stigg/resources/v1/subscriptions.rbi +102 -23
  81. data/rbi/stigg/resources/v1.rbi +2 -2
  82. data/sig/stigg/internal/my_cursor_id_page.rbs +17 -0
  83. data/sig/stigg/models/v1/coupon_create_response.rbs +4 -4
  84. data/sig/stigg/models/v1/coupon_list_params.rbs +11 -11
  85. data/sig/stigg/models/v1/coupon_list_response.rbs +331 -351
  86. data/sig/stigg/models/v1/coupon_retrieve_response.rbs +4 -4
  87. data/sig/stigg/models/v1/customer_list_params.rbs +11 -11
  88. data/sig/stigg/models/v1/customer_list_response.rbs +133 -153
  89. data/sig/stigg/models/v1/subscription_create_params.rbs +2029 -5
  90. data/sig/stigg/models/v1/subscription_create_response.rbs +1022 -0
  91. data/sig/stigg/models/v1/subscription_delegate_response.rbs +31 -0
  92. data/sig/stigg/models/v1/subscription_list_params.rbs +14 -14
  93. data/sig/stigg/models/v1/subscription_list_response.rbs +196 -189
  94. data/sig/stigg/models/v1/subscription_migrate_response.rbs +31 -0
  95. data/sig/stigg/models/v1/subscription_preview_params.rbs +2 -6
  96. data/sig/stigg/models/v1/subscription_retrieve_response.rbs +31 -0
  97. data/sig/stigg/models/v1/subscription_transfer_response.rbs +31 -0
  98. data/sig/stigg/models/v1_create_usage_params.rbs +15 -5
  99. data/sig/stigg/resources/v1/coupons.rbs +3 -3
  100. data/sig/stigg/resources/v1/customers/usage.rbs +0 -10
  101. data/sig/stigg/resources/v1/customers.rbs +3 -5
  102. data/sig/stigg/resources/v1/subscriptions.rbs +19 -4
  103. metadata +2 -23
  104. data/lib/stigg/models/v1/customers/promotional_create_params.rb +0 -294
  105. data/lib/stigg/models/v1/customers/promotional_create_response.rb +0 -268
  106. data/lib/stigg/models/v1/customers/promotional_revoke_params.rb +0 -24
  107. data/lib/stigg/models/v1/customers/promotional_revoke_response.rb +0 -268
  108. data/lib/stigg/models/v1/customers/usage_retrieve_params.rb +0 -56
  109. data/lib/stigg/models/v1/customers/usage_retrieve_response.rb +0 -145
  110. data/lib/stigg/resources/v1/customers/promotional.rb +0 -69
  111. data/rbi/stigg/models/v1/customers/promotional_create_params.rbi +0 -639
  112. data/rbi/stigg/models/v1/customers/promotional_create_response.rbi +0 -495
  113. data/rbi/stigg/models/v1/customers/promotional_revoke_params.rbi +0 -42
  114. data/rbi/stigg/models/v1/customers/promotional_revoke_response.rbi +0 -497
  115. data/rbi/stigg/models/v1/customers/usage_retrieve_params.rbi +0 -84
  116. data/rbi/stigg/models/v1/customers/usage_retrieve_response.rbi +0 -353
  117. data/rbi/stigg/resources/v1/customers/promotional.rbi +0 -53
  118. data/sig/stigg/models/v1/customers/promotional_create_params.rbs +0 -234
  119. data/sig/stigg/models/v1/customers/promotional_create_response.rbs +0 -209
  120. data/sig/stigg/models/v1/customers/promotional_revoke_params.rbs +0 -27
  121. data/sig/stigg/models/v1/customers/promotional_revoke_response.rbs +0 -209
  122. data/sig/stigg/models/v1/customers/usage_retrieve_params.rbs +0 -54
  123. data/sig/stigg/models/v1/customers/usage_retrieve_response.rbs +0 -134
  124. data/sig/stigg/resources/v1/customers/promotional.rbs +0 -23
@@ -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,69 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Stigg
4
- module Resources
5
- class V1
6
- class Customers
7
- class Promotional
8
- # Create a new Promotional Entitlements
9
- #
10
- # @overload create(customer_id, promotional_entitlements:, request_options: {})
11
- #
12
- # @param customer_id [String] The unique identifier of the entitlement customer
13
- #
14
- # @param promotional_entitlements [Array<Stigg::Models::V1::Customers::PromotionalCreateParams::PromotionalEntitlement>] Promotional entitlements to grant
15
- #
16
- # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
17
- #
18
- # @return [Stigg::Models::V1::Customers::PromotionalCreateResponse]
19
- #
20
- # @see Stigg::Models::V1::Customers::PromotionalCreateParams
21
- def create(customer_id, params)
22
- parsed, options = Stigg::V1::Customers::PromotionalCreateParams.dump_request(params)
23
- @client.request(
24
- method: :post,
25
- path: ["api/v1/customers/%1$s/promotional", customer_id],
26
- body: parsed,
27
- model: Stigg::Models::V1::Customers::PromotionalCreateResponse,
28
- options: options
29
- )
30
- end
31
-
32
- # Perform revocation on a Promotional Entitlement
33
- #
34
- # @overload revoke(feature_id, customer_id:, request_options: {})
35
- #
36
- # @param feature_id [String] The unique identifier of the entitlement feature
37
- #
38
- # @param customer_id [String] The unique identifier of the entitlement customer
39
- #
40
- # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
41
- #
42
- # @return [Stigg::Models::V1::Customers::PromotionalRevokeResponse]
43
- #
44
- # @see Stigg::Models::V1::Customers::PromotionalRevokeParams
45
- def revoke(feature_id, params)
46
- parsed, options = Stigg::V1::Customers::PromotionalRevokeParams.dump_request(params)
47
- customer_id =
48
- parsed.delete(:customer_id) do
49
- raise ArgumentError.new("missing required path argument #{_1}")
50
- end
51
- @client.request(
52
- method: :delete,
53
- path: ["api/v1/customers/%1$s/promotional/featureId/%2$s", customer_id, feature_id],
54
- model: Stigg::Models::V1::Customers::PromotionalRevokeResponse,
55
- options: options
56
- )
57
- end
58
-
59
- # @api private
60
- #
61
- # @param client [Stigg::Client]
62
- def initialize(client:)
63
- @client = client
64
- end
65
- end
66
- end
67
- end
68
- end
69
- end