shopify_api 14.10.0 → 14.11.0

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 (84) hide show
  1. checksums.yaml +4 -4
  2. data/.github/dependabot.yml +4 -0
  3. data/.github/workflows/api_update_reminder.yml +2 -2
  4. data/.github/workflows/api_update_reminder_on_release.yml +2 -2
  5. data/.github/workflows/build.yml +2 -2
  6. data/.github/workflows/close-waiting-for-response-issues.yml +1 -1
  7. data/.github/workflows/remove-labels-on-activity.yml +2 -3
  8. data/CHANGELOG.md +3 -0
  9. data/Gemfile.lock +2 -2
  10. data/lib/shopify_api/admin_versions.rb +3 -2
  11. data/lib/shopify_api/rest/resources/2025_07/abandoned_checkout.rb +194 -0
  12. data/lib/shopify_api/rest/resources/2025_07/access_scope.rb +62 -0
  13. data/lib/shopify_api/rest/resources/2025_07/apple_pay_certificate.rb +109 -0
  14. data/lib/shopify_api/rest/resources/2025_07/application_charge.rb +113 -0
  15. data/lib/shopify_api/rest/resources/2025_07/application_credit.rb +95 -0
  16. data/lib/shopify_api/rest/resources/2025_07/article.rb +269 -0
  17. data/lib/shopify_api/rest/resources/2025_07/asset.rb +122 -0
  18. data/lib/shopify_api/rest/resources/2025_07/assigned_fulfillment_order.rb +92 -0
  19. data/lib/shopify_api/rest/resources/2025_07/balance.rb +58 -0
  20. data/lib/shopify_api/rest/resources/2025_07/blog.rb +166 -0
  21. data/lib/shopify_api/rest/resources/2025_07/cancellation_request.rb +87 -0
  22. data/lib/shopify_api/rest/resources/2025_07/carrier_service.rb +120 -0
  23. data/lib/shopify_api/rest/resources/2025_07/checkout.rb +213 -0
  24. data/lib/shopify_api/rest/resources/2025_07/collect.rb +146 -0
  25. data/lib/shopify_api/rest/resources/2025_07/collection.rb +114 -0
  26. data/lib/shopify_api/rest/resources/2025_07/collection_listing.rb +159 -0
  27. data/lib/shopify_api/rest/resources/2025_07/comment.rb +287 -0
  28. data/lib/shopify_api/rest/resources/2025_07/country.rb +141 -0
  29. data/lib/shopify_api/rest/resources/2025_07/currency.rb +61 -0
  30. data/lib/shopify_api/rest/resources/2025_07/custom_collection.rb +191 -0
  31. data/lib/shopify_api/rest/resources/2025_07/customer.rb +328 -0
  32. data/lib/shopify_api/rest/resources/2025_07/deprecated_api_call.rb +61 -0
  33. data/lib/shopify_api/rest/resources/2025_07/discount_code.rb +226 -0
  34. data/lib/shopify_api/rest/resources/2025_07/dispute.rb +115 -0
  35. data/lib/shopify_api/rest/resources/2025_07/dispute_evidence.rb +121 -0
  36. data/lib/shopify_api/rest/resources/2025_07/dispute_file_upload.rb +85 -0
  37. data/lib/shopify_api/rest/resources/2025_07/draft_order.rb +279 -0
  38. data/lib/shopify_api/rest/resources/2025_07/event.rb +152 -0
  39. data/lib/shopify_api/rest/resources/2025_07/fulfillment.rb +235 -0
  40. data/lib/shopify_api/rest/resources/2025_07/fulfillment_event.rb +167 -0
  41. data/lib/shopify_api/rest/resources/2025_07/fulfillment_order.rb +326 -0
  42. data/lib/shopify_api/rest/resources/2025_07/fulfillment_request.rb +116 -0
  43. data/lib/shopify_api/rest/resources/2025_07/fulfillment_service.rb +134 -0
  44. data/lib/shopify_api/rest/resources/2025_07/gift_card.rb +222 -0
  45. data/lib/shopify_api/rest/resources/2025_07/gift_card_adjustment.rb +122 -0
  46. data/lib/shopify_api/rest/resources/2025_07/image.rb +161 -0
  47. data/lib/shopify_api/rest/resources/2025_07/inventory_item.rb +112 -0
  48. data/lib/shopify_api/rest/resources/2025_07/inventory_level.rb +183 -0
  49. data/lib/shopify_api/rest/resources/2025_07/location.rb +171 -0
  50. data/lib/shopify_api/rest/resources/2025_07/locations_for_move.rb +60 -0
  51. data/lib/shopify_api/rest/resources/2025_07/marketing_event.rb +213 -0
  52. data/lib/shopify_api/rest/resources/2025_07/metafield.rb +348 -0
  53. data/lib/shopify_api/rest/resources/2025_07/mobile_platform_application.rb +120 -0
  54. data/lib/shopify_api/rest/resources/2025_07/order.rb +503 -0
  55. data/lib/shopify_api/rest/resources/2025_07/order_risk.rb +148 -0
  56. data/lib/shopify_api/rest/resources/2025_07/page.rb +198 -0
  57. data/lib/shopify_api/rest/resources/2025_07/payment.rb +98 -0
  58. data/lib/shopify_api/rest/resources/2025_07/payment_gateway.rb +147 -0
  59. data/lib/shopify_api/rest/resources/2025_07/payment_transaction.rb +117 -0
  60. data/lib/shopify_api/rest/resources/2025_07/payout.rb +101 -0
  61. data/lib/shopify_api/rest/resources/2025_07/policy.rb +73 -0
  62. data/lib/shopify_api/rest/resources/2025_07/price_rule.rb +227 -0
  63. data/lib/shopify_api/rest/resources/2025_07/product.rb +227 -0
  64. data/lib/shopify_api/rest/resources/2025_07/product_listing.rb +200 -0
  65. data/lib/shopify_api/rest/resources/2025_07/product_resource_feedback.rb +92 -0
  66. data/lib/shopify_api/rest/resources/2025_07/province.rb +136 -0
  67. data/lib/shopify_api/rest/resources/2025_07/recurring_application_charge.rb +184 -0
  68. data/lib/shopify_api/rest/resources/2025_07/redirect.rb +143 -0
  69. data/lib/shopify_api/rest/resources/2025_07/refund.rb +158 -0
  70. data/lib/shopify_api/rest/resources/2025_07/resource_feedback.rb +77 -0
  71. data/lib/shopify_api/rest/resources/2025_07/script_tag.rb +159 -0
  72. data/lib/shopify_api/rest/resources/2025_07/shipping_zone.rb +87 -0
  73. data/lib/shopify_api/rest/resources/2025_07/shop.rb +231 -0
  74. data/lib/shopify_api/rest/resources/2025_07/smart_collection.rb +220 -0
  75. data/lib/shopify_api/rest/resources/2025_07/storefront_access_token.rb +91 -0
  76. data/lib/shopify_api/rest/resources/2025_07/tender_transaction.rb +97 -0
  77. data/lib/shopify_api/rest/resources/2025_07/theme.rb +127 -0
  78. data/lib/shopify_api/rest/resources/2025_07/transaction.rb +194 -0
  79. data/lib/shopify_api/rest/resources/2025_07/usage_charge.rb +106 -0
  80. data/lib/shopify_api/rest/resources/2025_07/user.rb +142 -0
  81. data/lib/shopify_api/rest/resources/2025_07/variant.rb +212 -0
  82. data/lib/shopify_api/rest/resources/2025_07/webhook.rb +173 -0
  83. data/lib/shopify_api/version.rb +1 -1
  84. metadata +74 -2
@@ -0,0 +1,328 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+ ########################################################################################################################
5
+ # This file is auto-generated. If you have an issue, please create a GitHub issue. #
6
+ ########################################################################################################################
7
+
8
+ module ShopifyAPI
9
+ class Customer < ShopifyAPI::Rest::Base
10
+ extend T::Sig
11
+
12
+ @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
13
+ @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
14
+
15
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @addresses = T.let(nil, T.nilable(T::Array[T.untyped]))
22
+ @created_at = T.let(nil, T.nilable(String))
23
+ @currency = T.let(nil, T.nilable(String))
24
+ @default_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
25
+ @email = T.let(nil, T.nilable(String))
26
+ @email_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
27
+ @first_name = T.let(nil, T.nilable(String))
28
+ @id = T.let(nil, T.nilable(Integer))
29
+ @last_name = T.let(nil, T.nilable(String))
30
+ @last_order_id = T.let(nil, T.nilable(Integer))
31
+ @last_order_name = T.let(nil, T.nilable(String))
32
+ @marketing_opt_in_level = T.let(nil, T.nilable(String))
33
+ @metafield = T.let(nil, T.nilable(Metafield))
34
+ @multipass_identifier = T.let(nil, T.nilable(String))
35
+ @note = T.let(nil, T.nilable(String))
36
+ @orders_count = T.let(nil, T.nilable(Integer))
37
+ @password = T.let(nil, T.nilable(String))
38
+ @password_confirmation = T.let(nil, T.nilable(String))
39
+ @phone = T.let(nil, T.nilable(String))
40
+ @sms_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
41
+ @state = T.let(nil, T.nilable(String))
42
+ @tags = T.let(nil, T.nilable(String))
43
+ @tax_exempt = T.let(nil, T.nilable(T::Boolean))
44
+ @tax_exemptions = T.let(nil, T.nilable(T::Array[T.untyped]))
45
+ @total_spent = T.let(nil, T.nilable(String))
46
+ @updated_at = T.let(nil, T.nilable(String))
47
+ @verified_email = T.let(nil, T.nilable(T::Boolean))
48
+
49
+ super(session: session, from_hash: from_hash)
50
+ end
51
+
52
+ @has_one = T.let({
53
+ metafield: Metafield
54
+ }, T::Hash[Symbol, Class])
55
+ @has_many = T.let({}, T::Hash[Symbol, Class])
56
+ @atomic_hash_attributes = [:email_marketing_consent]
57
+ @paths = T.let([
58
+ {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
59
+ {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},
60
+ {http_method: :get, operation: :get, ids: [], path: "customers.json"},
61
+ {http_method: :get, operation: :get, ids: [:id], path: "customers/<id>.json"},
62
+ {http_method: :get, operation: :orders, ids: [:id], path: "customers/<id>/orders.json"},
63
+ {http_method: :get, operation: :search, ids: [], path: "customers/search.json"},
64
+ {http_method: :post, operation: :account_activation_url, ids: [:id], path: "customers/<id>/account_activation_url.json"},
65
+ {http_method: :post, operation: :post, ids: [], path: "customers.json"},
66
+ {http_method: :post, operation: :send_invite, ids: [:id], path: "customers/<id>/send_invite.json"},
67
+ {http_method: :put, operation: :put, ids: [:id], path: "customers/<id>.json"}
68
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
69
+
70
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
71
+ attr_reader :addresses
72
+ sig { returns(T.nilable(String)) }
73
+ attr_reader :created_at
74
+ sig { returns(T.nilable(String)) }
75
+ attr_reader :currency
76
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
77
+ attr_reader :default_address
78
+ sig { returns(T.nilable(String)) }
79
+ attr_reader :email
80
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
81
+ attr_reader :email_marketing_consent
82
+ sig { returns(T.nilable(String)) }
83
+ attr_reader :first_name
84
+ sig { returns(T.nilable(Integer)) }
85
+ attr_reader :id
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :last_name
88
+ sig { returns(T.nilable(Integer)) }
89
+ attr_reader :last_order_id
90
+ sig { returns(T.nilable(String)) }
91
+ attr_reader :last_order_name
92
+ sig { returns(T.nilable(String)) }
93
+ attr_reader :marketing_opt_in_level
94
+ sig { returns(T.nilable(Metafield)) }
95
+ attr_reader :metafield
96
+ sig { returns(T.nilable(String)) }
97
+ attr_reader :multipass_identifier
98
+ sig { returns(T.nilable(String)) }
99
+ attr_reader :note
100
+ sig { returns(T.nilable(Integer)) }
101
+ attr_reader :orders_count
102
+ sig { returns(T.nilable(String)) }
103
+ attr_reader :password
104
+ sig { returns(T.nilable(String)) }
105
+ attr_reader :password_confirmation
106
+ sig { returns(T.nilable(String)) }
107
+ attr_reader :phone
108
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
109
+ attr_reader :sms_marketing_consent
110
+ sig { returns(T.nilable(String)) }
111
+ attr_reader :state
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :tags
114
+ sig { returns(T.nilable(T::Boolean)) }
115
+ attr_reader :tax_exempt
116
+ sig { returns(T.nilable(T::Array[String])) }
117
+ attr_reader :tax_exemptions
118
+ sig { returns(T.nilable(String)) }
119
+ attr_reader :total_spent
120
+ sig { returns(T.nilable(String)) }
121
+ attr_reader :updated_at
122
+ sig { returns(T.nilable(T::Boolean)) }
123
+ attr_reader :verified_email
124
+
125
+ class << self
126
+ sig do
127
+ params(
128
+ id: T.any(Integer, String),
129
+ fields: T.untyped,
130
+ session: Auth::Session
131
+ ).returns(T.nilable(Customer))
132
+ end
133
+ def find(
134
+ id:,
135
+ fields: nil,
136
+ session: ShopifyAPI::Context.active_session
137
+ )
138
+ result = base_find(
139
+ session: session,
140
+ ids: {id: id},
141
+ params: {fields: fields},
142
+ )
143
+ T.cast(result[0], T.nilable(Customer))
144
+ end
145
+
146
+ sig do
147
+ params(
148
+ id: T.any(Integer, String),
149
+ session: Auth::Session
150
+ ).returns(T.untyped)
151
+ end
152
+ def delete(
153
+ id:,
154
+ session: ShopifyAPI::Context.active_session
155
+ )
156
+ request(
157
+ http_method: :delete,
158
+ operation: :delete,
159
+ session: session,
160
+ ids: {id: id},
161
+ params: {},
162
+ )
163
+ end
164
+
165
+ sig do
166
+ params(
167
+ ids: T.untyped,
168
+ since_id: T.untyped,
169
+ created_at_min: T.untyped,
170
+ created_at_max: T.untyped,
171
+ updated_at_min: T.untyped,
172
+ updated_at_max: T.untyped,
173
+ limit: T.untyped,
174
+ fields: T.untyped,
175
+ session: Auth::Session,
176
+ kwargs: T.untyped
177
+ ).returns(T::Array[Customer])
178
+ end
179
+ def all(
180
+ ids: nil,
181
+ since_id: nil,
182
+ created_at_min: nil,
183
+ created_at_max: nil,
184
+ updated_at_min: nil,
185
+ updated_at_max: nil,
186
+ limit: nil,
187
+ fields: nil,
188
+ session: ShopifyAPI::Context.active_session,
189
+ **kwargs
190
+ )
191
+ response = base_find(
192
+ session: session,
193
+ ids: {},
194
+ params: {ids: ids, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, limit: limit, fields: fields}.merge(kwargs).compact,
195
+ )
196
+
197
+ T.cast(response, T::Array[Customer])
198
+ end
199
+
200
+ sig do
201
+ params(
202
+ created_at_min: T.untyped,
203
+ created_at_max: T.untyped,
204
+ updated_at_min: T.untyped,
205
+ updated_at_max: T.untyped,
206
+ session: Auth::Session,
207
+ kwargs: T.untyped
208
+ ).returns(T.untyped)
209
+ end
210
+ def count(
211
+ created_at_min: nil,
212
+ created_at_max: nil,
213
+ updated_at_min: nil,
214
+ updated_at_max: nil,
215
+ session: ShopifyAPI::Context.active_session,
216
+ **kwargs
217
+ )
218
+ request(
219
+ http_method: :get,
220
+ operation: :count,
221
+ session: session,
222
+ ids: {},
223
+ params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
224
+ body: {},
225
+ entity: nil,
226
+ )
227
+ end
228
+
229
+ sig do
230
+ params(
231
+ id: T.any(Integer, String),
232
+ status: T.untyped,
233
+ session: Auth::Session,
234
+ kwargs: T.untyped
235
+ ).returns(T.untyped)
236
+ end
237
+ def orders(
238
+ id:,
239
+ status: nil,
240
+ session: ShopifyAPI::Context.active_session,
241
+ **kwargs
242
+ )
243
+ request(
244
+ http_method: :get,
245
+ operation: :orders,
246
+ session: session,
247
+ ids: {id: id},
248
+ params: {status: status}.merge(kwargs).compact,
249
+ body: {},
250
+ entity: nil,
251
+ )
252
+ end
253
+
254
+ sig do
255
+ params(
256
+ order: T.untyped,
257
+ query: T.untyped,
258
+ limit: T.untyped,
259
+ fields: T.untyped,
260
+ session: Auth::Session,
261
+ kwargs: T.untyped
262
+ ).returns(T.untyped)
263
+ end
264
+ def search(
265
+ order: nil,
266
+ query: nil,
267
+ limit: nil,
268
+ fields: nil,
269
+ session: ShopifyAPI::Context.active_session,
270
+ **kwargs
271
+ )
272
+ request(
273
+ http_method: :get,
274
+ operation: :search,
275
+ session: session,
276
+ ids: {},
277
+ params: {order: order, query: query, limit: limit, fields: fields}.merge(kwargs).compact,
278
+ body: {},
279
+ entity: nil,
280
+ )
281
+ end
282
+
283
+ end
284
+
285
+ sig do
286
+ params(
287
+ body: T.untyped,
288
+ kwargs: T.untyped
289
+ ).returns(T.untyped)
290
+ end
291
+ def account_activation_url(
292
+ body: nil,
293
+ **kwargs
294
+ )
295
+ self.class.request(
296
+ http_method: :post,
297
+ operation: :account_activation_url,
298
+ session: @session,
299
+ ids: {id: @id},
300
+ params: {}.merge(kwargs).compact,
301
+ body: body,
302
+ entity: self,
303
+ )
304
+ end
305
+
306
+ sig do
307
+ params(
308
+ body: T.untyped,
309
+ kwargs: T.untyped
310
+ ).returns(T.untyped)
311
+ end
312
+ def send_invite(
313
+ body: nil,
314
+ **kwargs
315
+ )
316
+ self.class.request(
317
+ http_method: :post,
318
+ operation: :send_invite,
319
+ session: @session,
320
+ ids: {id: @id},
321
+ params: {}.merge(kwargs).compact,
322
+ body: body,
323
+ entity: self,
324
+ )
325
+ end
326
+
327
+ end
328
+ end
@@ -0,0 +1,61 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+ ########################################################################################################################
5
+ # This file is auto-generated. If you have an issue, please create a GitHub issue. #
6
+ ########################################################################################################################
7
+
8
+ module ShopifyAPI
9
+ class DeprecatedApiCall < ShopifyAPI::Rest::Base
10
+ extend T::Sig
11
+
12
+ @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
13
+ @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
14
+
15
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @data_updated_at = T.let(nil, T.nilable(String))
22
+ @deprecated_api_calls = T.let(nil, T.nilable(T::Array[T.untyped]))
23
+
24
+ super(session: session, from_hash: from_hash)
25
+ end
26
+
27
+ @has_one = T.let({}, T::Hash[Symbol, Class])
28
+ @has_many = T.let({}, T::Hash[Symbol, Class])
29
+ @paths = T.let([
30
+ {http_method: :get, operation: :get, ids: [], path: "deprecated_api_calls.json"}
31
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
32
+
33
+ sig { returns(T.nilable(String)) }
34
+ attr_reader :data_updated_at
35
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
36
+ attr_reader :deprecated_api_calls
37
+
38
+ class << self
39
+ sig do
40
+ params(
41
+ session: Auth::Session,
42
+ kwargs: T.untyped
43
+ ).returns(T::Array[DeprecatedApiCall])
44
+ end
45
+ def all(
46
+ session: ShopifyAPI::Context.active_session,
47
+ **kwargs
48
+ )
49
+ response = base_find(
50
+ session: session,
51
+ ids: {},
52
+ params: {}.merge(kwargs).compact,
53
+ )
54
+
55
+ T.cast(response, T::Array[DeprecatedApiCall])
56
+ end
57
+
58
+ end
59
+
60
+ end
61
+ end
@@ -0,0 +1,226 @@
1
+ # typed: false
2
+ # frozen_string_literal: true
3
+
4
+ ########################################################################################################################
5
+ # This file is auto-generated. If you have an issue, please create a GitHub issue. #
6
+ ########################################################################################################################
7
+
8
+ module ShopifyAPI
9
+ class DiscountCode < ShopifyAPI::Rest::Base
10
+ extend T::Sig
11
+
12
+ @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
13
+ @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
14
+
15
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @code = T.let(nil, T.nilable(String))
22
+ @created_at = T.let(nil, T.nilable(String))
23
+ @errors = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
24
+ @id = T.let(nil, T.nilable(Integer))
25
+ @price_rule_id = T.let(nil, T.nilable(Integer))
26
+ @updated_at = T.let(nil, T.nilable(String))
27
+ @usage_count = T.let(nil, T.nilable(Integer))
28
+
29
+ super(session: session, from_hash: from_hash)
30
+ end
31
+
32
+ @has_one = T.let({}, T::Hash[Symbol, Class])
33
+ @has_many = T.let({}, T::Hash[Symbol, Class])
34
+ @paths = T.let([
35
+ {http_method: :delete, operation: :delete, ids: [:price_rule_id, :id], path: "price_rules/<price_rule_id>/discount_codes/<id>.json"},
36
+ {http_method: :get, operation: :count, ids: [], path: "discount_codes/count.json"},
37
+ {http_method: :get, operation: :get, ids: [:price_rule_id, :batch_id], path: "price_rules/<price_rule_id>/batch/<batch_id>/discount_codes.json"},
38
+ {http_method: :get, operation: :get, ids: [:price_rule_id], path: "price_rules/<price_rule_id>/discount_codes.json"},
39
+ {http_method: :get, operation: :get, ids: [:price_rule_id, :id], path: "price_rules/<price_rule_id>/discount_codes/<id>.json"},
40
+ {http_method: :get, operation: :get_all, ids: [:price_rule_id, :batch_id], path: "price_rules/<price_rule_id>/batch/<batch_id>.json"},
41
+ {http_method: :get, operation: :lookup, ids: [], path: "discount_codes/lookup.json"},
42
+ {http_method: :post, operation: :batch, ids: [:price_rule_id], path: "price_rules/<price_rule_id>/batch.json"},
43
+ {http_method: :post, operation: :post, ids: [:price_rule_id], path: "price_rules/<price_rule_id>/discount_codes.json"},
44
+ {http_method: :put, operation: :put, ids: [:price_rule_id, :id], path: "price_rules/<price_rule_id>/discount_codes/<id>.json"}
45
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
46
+
47
+ sig { returns(T.nilable(String)) }
48
+ attr_reader :code
49
+ sig { returns(T.nilable(String)) }
50
+ attr_reader :created_at
51
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
52
+ attr_reader :errors
53
+ sig { returns(T.nilable(Integer)) }
54
+ attr_reader :id
55
+ sig { returns(T.nilable(Integer)) }
56
+ attr_reader :price_rule_id
57
+ sig { returns(T.nilable(String)) }
58
+ attr_reader :updated_at
59
+ sig { returns(T.nilable(Integer)) }
60
+ attr_reader :usage_count
61
+
62
+ class << self
63
+ sig do
64
+ params(
65
+ id: T.any(Integer, String),
66
+ price_rule_id: T.nilable(T.any(Integer, String)),
67
+ session: Auth::Session
68
+ ).returns(T.nilable(DiscountCode))
69
+ end
70
+ def find(
71
+ id:,
72
+ price_rule_id: nil,
73
+ session: ShopifyAPI::Context.active_session
74
+ )
75
+ result = base_find(
76
+ session: session,
77
+ ids: {id: id, price_rule_id: price_rule_id},
78
+ params: {},
79
+ )
80
+ T.cast(result[0], T.nilable(DiscountCode))
81
+ end
82
+
83
+ sig do
84
+ params(
85
+ id: T.any(Integer, String),
86
+ price_rule_id: T.nilable(T.any(Integer, String)),
87
+ session: Auth::Session
88
+ ).returns(T.untyped)
89
+ end
90
+ def delete(
91
+ id:,
92
+ price_rule_id: nil,
93
+ session: ShopifyAPI::Context.active_session
94
+ )
95
+ request(
96
+ http_method: :delete,
97
+ operation: :delete,
98
+ session: session,
99
+ ids: {id: id, price_rule_id: price_rule_id},
100
+ params: {},
101
+ )
102
+ end
103
+
104
+ sig do
105
+ params(
106
+ price_rule_id: T.nilable(T.any(Integer, String)),
107
+ batch_id: T.nilable(T.any(Integer, String)),
108
+ session: Auth::Session,
109
+ kwargs: T.untyped
110
+ ).returns(T::Array[DiscountCode])
111
+ end
112
+ def all(
113
+ price_rule_id: nil,
114
+ batch_id: nil,
115
+ session: ShopifyAPI::Context.active_session,
116
+ **kwargs
117
+ )
118
+ response = base_find(
119
+ session: session,
120
+ ids: {price_rule_id: price_rule_id, batch_id: batch_id},
121
+ params: {}.merge(kwargs).compact,
122
+ )
123
+
124
+ T.cast(response, T::Array[DiscountCode])
125
+ end
126
+
127
+ sig do
128
+ params(
129
+ times_used: T.untyped,
130
+ times_used_min: T.untyped,
131
+ times_used_max: T.untyped,
132
+ session: Auth::Session,
133
+ kwargs: T.untyped
134
+ ).returns(T.untyped)
135
+ end
136
+ def count(
137
+ times_used: nil,
138
+ times_used_min: nil,
139
+ times_used_max: nil,
140
+ session: ShopifyAPI::Context.active_session,
141
+ **kwargs
142
+ )
143
+ request(
144
+ http_method: :get,
145
+ operation: :count,
146
+ session: session,
147
+ ids: {},
148
+ params: {times_used: times_used, times_used_min: times_used_min, times_used_max: times_used_max}.merge(kwargs).compact,
149
+ body: {},
150
+ entity: nil,
151
+ )
152
+ end
153
+
154
+ sig do
155
+ params(
156
+ price_rule_id: T.nilable(T.any(Integer, String)),
157
+ batch_id: T.nilable(T.any(Integer, String)),
158
+ session: Auth::Session,
159
+ kwargs: T.untyped
160
+ ).returns(T.untyped)
161
+ end
162
+ def get_all(
163
+ price_rule_id: nil,
164
+ batch_id: nil,
165
+ session: ShopifyAPI::Context.active_session,
166
+ **kwargs
167
+ )
168
+ request(
169
+ http_method: :get,
170
+ operation: :get_all,
171
+ session: session,
172
+ ids: {price_rule_id: price_rule_id, batch_id: batch_id},
173
+ params: {}.merge(kwargs).compact,
174
+ body: {},
175
+ entity: nil,
176
+ )
177
+ end
178
+
179
+ sig do
180
+ params(
181
+ code: T.untyped,
182
+ session: Auth::Session,
183
+ kwargs: T.untyped
184
+ ).returns(T.untyped)
185
+ end
186
+ def lookup(
187
+ code: nil,
188
+ session: ShopifyAPI::Context.active_session,
189
+ **kwargs
190
+ )
191
+ request(
192
+ http_method: :get,
193
+ operation: :lookup,
194
+ session: session,
195
+ ids: {},
196
+ params: {code: code}.merge(kwargs).compact,
197
+ body: {},
198
+ entity: nil,
199
+ )
200
+ end
201
+
202
+ end
203
+
204
+ sig do
205
+ params(
206
+ body: T.untyped,
207
+ kwargs: T.untyped
208
+ ).returns(T.untyped)
209
+ end
210
+ def batch(
211
+ body: nil,
212
+ **kwargs
213
+ )
214
+ self.class.request(
215
+ http_method: :post,
216
+ operation: :batch,
217
+ session: @session,
218
+ ids: {price_rule_id: @price_rule_id},
219
+ params: {}.merge(kwargs).compact,
220
+ body: body,
221
+ entity: self,
222
+ )
223
+ end
224
+
225
+ end
226
+ end