shopify_api 13.1.0 → 13.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (136) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS +1 -1
  3. data/.github/workflows/build.yml +4 -0
  4. data/BREAKING_CHANGES_FOR_V10.md +231 -0
  5. data/CHANGELOG.md +14 -1
  6. data/CONTRIBUTING.md +25 -0
  7. data/Gemfile.lock +8 -15
  8. data/README.md +10 -34
  9. data/ROADMAP.md +10 -0
  10. data/docs/README.md +0 -1
  11. data/docs/getting_started.md +20 -3
  12. data/docs/usage/custom_apps.md +75 -0
  13. data/docs/usage/graphql.md +63 -18
  14. data/docs/usage/oauth.md +160 -27
  15. data/docs/usage/rest.md +204 -62
  16. data/docs/usage/webhooks.md +22 -4
  17. data/lib/shopify_api/admin_versions.rb +2 -1
  18. data/lib/shopify_api/auth/jwt_payload.rb +2 -2
  19. data/lib/shopify_api/auth/oauth.rb +15 -5
  20. data/lib/shopify_api/clients/http_client.rb +5 -1
  21. data/lib/shopify_api/context.rb +11 -5
  22. data/lib/shopify_api/rest/base.rb +22 -14
  23. data/lib/shopify_api/rest/resources/2022_10/assigned_fulfillment_order.rb +5 -3
  24. data/lib/shopify_api/rest/resources/2022_10/customer_address.rb +10 -0
  25. data/lib/shopify_api/rest/resources/2022_10/fulfillment_request.rb +10 -0
  26. data/lib/shopify_api/rest/resources/2022_10/order_risk.rb +5 -3
  27. data/lib/shopify_api/rest/resources/2023_01/assigned_fulfillment_order.rb +5 -3
  28. data/lib/shopify_api/rest/resources/2023_01/balance.rb +4 -0
  29. data/lib/shopify_api/rest/resources/2023_01/customer_address.rb +10 -0
  30. data/lib/shopify_api/rest/resources/2023_01/fulfillment_request.rb +10 -0
  31. data/lib/shopify_api/rest/resources/2023_01/order.rb +3 -0
  32. data/lib/shopify_api/rest/resources/2023_01/order_risk.rb +5 -3
  33. data/lib/shopify_api/rest/resources/2023_01/shop.rb +0 -3
  34. data/lib/shopify_api/rest/resources/2023_01/variant.rb +1 -5
  35. data/lib/shopify_api/rest/resources/2023_04/assigned_fulfillment_order.rb +5 -3
  36. data/lib/shopify_api/rest/resources/2023_04/balance.rb +4 -0
  37. data/lib/shopify_api/rest/resources/2023_04/customer_address.rb +10 -0
  38. data/lib/shopify_api/rest/resources/2023_04/fulfillment_request.rb +10 -0
  39. data/lib/shopify_api/rest/resources/2023_04/order.rb +3 -0
  40. data/lib/shopify_api/rest/resources/2023_04/order_risk.rb +5 -3
  41. data/lib/shopify_api/rest/resources/2023_04/shop.rb +0 -3
  42. data/lib/shopify_api/rest/resources/2023_04/variant.rb +1 -5
  43. data/lib/shopify_api/rest/resources/2023_07/assigned_fulfillment_order.rb +5 -3
  44. data/lib/shopify_api/rest/resources/2023_07/balance.rb +4 -0
  45. data/lib/shopify_api/rest/resources/2023_07/customer_address.rb +10 -0
  46. data/lib/shopify_api/rest/resources/2023_07/fulfillment_request.rb +10 -0
  47. data/lib/shopify_api/rest/resources/2023_07/order.rb +3 -0
  48. data/lib/shopify_api/rest/resources/2023_07/order_risk.rb +5 -3
  49. data/lib/shopify_api/rest/resources/2023_07/report.rb +121 -0
  50. data/lib/shopify_api/rest/resources/2023_07/shop.rb +0 -3
  51. data/lib/shopify_api/rest/resources/2023_07/variant.rb +1 -5
  52. data/lib/shopify_api/rest/resources/2023_10/abandoned_checkout.rb +190 -0
  53. data/lib/shopify_api/rest/resources/2023_10/access_scope.rb +58 -0
  54. data/lib/shopify_api/rest/resources/2023_10/apple_pay_certificate.rb +105 -0
  55. data/lib/shopify_api/rest/resources/2023_10/application_charge.rb +109 -0
  56. data/lib/shopify_api/rest/resources/2023_10/application_credit.rb +91 -0
  57. data/lib/shopify_api/rest/resources/2023_10/article.rb +265 -0
  58. data/lib/shopify_api/rest/resources/2023_10/asset.rb +118 -0
  59. data/lib/shopify_api/rest/resources/2023_10/assigned_fulfillment_order.rb +88 -0
  60. data/lib/shopify_api/rest/resources/2023_10/balance.rb +54 -0
  61. data/lib/shopify_api/rest/resources/2023_10/blog.rb +162 -0
  62. data/lib/shopify_api/rest/resources/2023_10/cancellation_request.rb +83 -0
  63. data/lib/shopify_api/rest/resources/2023_10/carrier_service.rb +116 -0
  64. data/lib/shopify_api/rest/resources/2023_10/checkout.rb +209 -0
  65. data/lib/shopify_api/rest/resources/2023_10/collect.rb +142 -0
  66. data/lib/shopify_api/rest/resources/2023_10/collection.rb +110 -0
  67. data/lib/shopify_api/rest/resources/2023_10/collection_listing.rb +155 -0
  68. data/lib/shopify_api/rest/resources/2023_10/comment.rb +283 -0
  69. data/lib/shopify_api/rest/resources/2023_10/country.rb +137 -0
  70. data/lib/shopify_api/rest/resources/2023_10/currency.rb +57 -0
  71. data/lib/shopify_api/rest/resources/2023_10/custom_collection.rb +187 -0
  72. data/lib/shopify_api/rest/resources/2023_10/customer.rb +329 -0
  73. data/lib/shopify_api/rest/resources/2023_10/customer_address.rb +211 -0
  74. data/lib/shopify_api/rest/resources/2023_10/deprecated_api_call.rb +57 -0
  75. data/lib/shopify_api/rest/resources/2023_10/discount_code.rb +222 -0
  76. data/lib/shopify_api/rest/resources/2023_10/dispute.rb +111 -0
  77. data/lib/shopify_api/rest/resources/2023_10/dispute_evidence.rb +117 -0
  78. data/lib/shopify_api/rest/resources/2023_10/dispute_file_upload.rb +81 -0
  79. data/lib/shopify_api/rest/resources/2023_10/draft_order.rb +275 -0
  80. data/lib/shopify_api/rest/resources/2023_10/event.rb +148 -0
  81. data/lib/shopify_api/rest/resources/2023_10/fulfillment.rb +231 -0
  82. data/lib/shopify_api/rest/resources/2023_10/fulfillment_event.rb +166 -0
  83. data/lib/shopify_api/rest/resources/2023_10/fulfillment_order.rb +312 -0
  84. data/lib/shopify_api/rest/resources/2023_10/fulfillment_request.rb +97 -0
  85. data/lib/shopify_api/rest/resources/2023_10/fulfillment_service.rb +130 -0
  86. data/lib/shopify_api/rest/resources/2023_10/gift_card.rb +218 -0
  87. data/lib/shopify_api/rest/resources/2023_10/gift_card_adjustment.rb +118 -0
  88. data/lib/shopify_api/rest/resources/2023_10/image.rb +157 -0
  89. data/lib/shopify_api/rest/resources/2023_10/inventory_item.rb +108 -0
  90. data/lib/shopify_api/rest/resources/2023_10/inventory_level.rb +179 -0
  91. data/lib/shopify_api/rest/resources/2023_10/location.rb +167 -0
  92. data/lib/shopify_api/rest/resources/2023_10/locations_for_move.rb +56 -0
  93. data/lib/shopify_api/rest/resources/2023_10/marketing_event.rb +209 -0
  94. data/lib/shopify_api/rest/resources/2023_10/metafield.rb +344 -0
  95. data/lib/shopify_api/rest/resources/2023_10/mobile_platform_application.rb +110 -0
  96. data/lib/shopify_api/rest/resources/2023_10/order.rb +491 -0
  97. data/lib/shopify_api/rest/resources/2023_10/order_risk.rb +144 -0
  98. data/lib/shopify_api/rest/resources/2023_10/page.rb +194 -0
  99. data/lib/shopify_api/rest/resources/2023_10/payment.rb +140 -0
  100. data/lib/shopify_api/rest/resources/2023_10/payment_gateway.rb +143 -0
  101. data/lib/shopify_api/rest/resources/2023_10/payment_transaction.rb +107 -0
  102. data/lib/shopify_api/rest/resources/2023_10/payout.rb +97 -0
  103. data/lib/shopify_api/rest/resources/2023_10/policy.rb +69 -0
  104. data/lib/shopify_api/rest/resources/2023_10/price_rule.rb +223 -0
  105. data/lib/shopify_api/rest/resources/2023_10/product.rb +223 -0
  106. data/lib/shopify_api/rest/resources/2023_10/product_listing.rb +196 -0
  107. data/lib/shopify_api/rest/resources/2023_10/product_resource_feedback.rb +88 -0
  108. data/lib/shopify_api/rest/resources/2023_10/province.rb +132 -0
  109. data/lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb +172 -0
  110. data/lib/shopify_api/rest/resources/2023_10/redirect.rb +139 -0
  111. data/lib/shopify_api/rest/resources/2023_10/refund.rb +151 -0
  112. data/lib/shopify_api/rest/resources/2023_10/report.rb +121 -0
  113. data/lib/shopify_api/rest/resources/2023_10/resource_feedback.rb +73 -0
  114. data/lib/shopify_api/rest/resources/2023_10/script_tag.rb +155 -0
  115. data/lib/shopify_api/rest/resources/2023_10/shipping_zone.rb +83 -0
  116. data/lib/shopify_api/rest/resources/2023_10/shop.rb +218 -0
  117. data/lib/shopify_api/rest/resources/2023_10/smart_collection.rb +216 -0
  118. data/lib/shopify_api/rest/resources/2023_10/storefront_access_token.rb +87 -0
  119. data/lib/shopify_api/rest/resources/2023_10/tender_transaction.rb +93 -0
  120. data/lib/shopify_api/rest/resources/2023_10/theme.rb +123 -0
  121. data/lib/shopify_api/rest/resources/2023_10/transaction.rb +184 -0
  122. data/lib/shopify_api/rest/resources/2023_10/usage_charge.rb +102 -0
  123. data/lib/shopify_api/rest/resources/2023_10/user.rb +138 -0
  124. data/lib/shopify_api/rest/resources/2023_10/variant.rb +208 -0
  125. data/lib/shopify_api/rest/resources/2023_10/webhook.rb +168 -0
  126. data/lib/shopify_api/version.rb +1 -1
  127. data/lib/shopify_api/webhooks/registration.rb +19 -4
  128. data/lib/shopify_api/webhooks/registrations/event_bridge.rb +1 -1
  129. data/lib/shopify_api/webhooks/registrations/http.rb +1 -1
  130. data/lib/shopify_api/webhooks/registrations/pub_sub.rb +2 -1
  131. data/lib/shopify_api/webhooks/registry.rb +25 -5
  132. data/shopify_api.gemspec +0 -1
  133. metadata +81 -20
  134. data/.github/workflows/stale.yml +0 -43
  135. data/docs/issues.md +0 -39
  136. data/docs/usage/session_storage.md +0 -46
@@ -0,0 +1,265 @@
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 Article < 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
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
+ def initialize(session: ShopifyAPI::Context.active_session)
17
+ super(session: session)
18
+
19
+ @author = T.let(nil, T.nilable(String))
20
+ @blog_id = T.let(nil, T.nilable(Integer))
21
+ @body_html = T.let(nil, T.nilable(String))
22
+ @created_at = T.let(nil, T.nilable(String))
23
+ @handle = T.let(nil, T.nilable(String))
24
+ @id = T.let(nil, T.nilable(Integer))
25
+ @image = T.let(nil, T.nilable(T.any(String, T::Hash[T.untyped, T.untyped])))
26
+ @metafields = T.let(nil, T.nilable(T::Array[T.untyped]))
27
+ @published = T.let(nil, T.nilable(T::Boolean))
28
+ @published_at = T.let(nil, T.nilable(String))
29
+ @summary_html = T.let(nil, T.nilable(String))
30
+ @tags = T.let(nil, T.nilable(String))
31
+ @template_suffix = T.let(nil, T.nilable(String))
32
+ @title = T.let(nil, T.nilable(String))
33
+ @updated_at = T.let(nil, T.nilable(String))
34
+ @user_id = T.let(nil, T.nilable(Integer))
35
+ end
36
+
37
+ @has_one = T.let({}, T::Hash[Symbol, Class])
38
+ @has_many = T.let({
39
+ metafields: Metafield
40
+ }, T::Hash[Symbol, Class])
41
+ @paths = T.let([
42
+ {http_method: :delete, operation: :delete, ids: [:blog_id, :id], path: "blogs/<blog_id>/articles/<id>.json"},
43
+ {http_method: :get, operation: :authors, ids: [], path: "articles/authors.json"},
44
+ {http_method: :get, operation: :count, ids: [:blog_id], path: "blogs/<blog_id>/articles/count.json"},
45
+ {http_method: :get, operation: :get, ids: [:blog_id], path: "blogs/<blog_id>/articles.json"},
46
+ {http_method: :get, operation: :get, ids: [:blog_id, :id], path: "blogs/<blog_id>/articles/<id>.json"},
47
+ {http_method: :get, operation: :tags, ids: [], path: "articles/tags.json"},
48
+ {http_method: :get, operation: :tags, ids: [:blog_id], path: "blogs/<blog_id>/articles/tags.json"},
49
+ {http_method: :post, operation: :post, ids: [:blog_id], path: "blogs/<blog_id>/articles.json"},
50
+ {http_method: :put, operation: :put, ids: [:blog_id, :id], path: "blogs/<blog_id>/articles/<id>.json"}
51
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
52
+
53
+ sig { returns(T.nilable(String)) }
54
+ attr_reader :author
55
+ sig { returns(T.nilable(Integer)) }
56
+ attr_reader :blog_id
57
+ sig { returns(T.nilable(String)) }
58
+ attr_reader :body_html
59
+ sig { returns(T.nilable(String)) }
60
+ attr_reader :created_at
61
+ sig { returns(T.nilable(String)) }
62
+ attr_reader :handle
63
+ sig { returns(T.nilable(Integer)) }
64
+ attr_reader :id
65
+ sig { returns(T.nilable(T.any(String, T::Hash[T.untyped, T.untyped]))) }
66
+ attr_reader :image
67
+ sig { returns(T.nilable(T::Array[Metafield])) }
68
+ attr_reader :metafields
69
+ sig { returns(T.nilable(T::Boolean)) }
70
+ attr_reader :published
71
+ sig { returns(T.nilable(String)) }
72
+ attr_reader :published_at
73
+ sig { returns(T.nilable(String)) }
74
+ attr_reader :summary_html
75
+ sig { returns(T.nilable(String)) }
76
+ attr_reader :tags
77
+ sig { returns(T.nilable(String)) }
78
+ attr_reader :template_suffix
79
+ sig { returns(T.nilable(String)) }
80
+ attr_reader :title
81
+ sig { returns(T.nilable(String)) }
82
+ attr_reader :updated_at
83
+ sig { returns(T.nilable(Integer)) }
84
+ attr_reader :user_id
85
+
86
+ class << self
87
+ sig do
88
+ params(
89
+ id: T.any(Integer, String),
90
+ blog_id: T.nilable(T.any(Integer, String)),
91
+ fields: T.untyped,
92
+ session: Auth::Session
93
+ ).returns(T.nilable(Article))
94
+ end
95
+ def find(
96
+ id:,
97
+ blog_id: nil,
98
+ fields: nil,
99
+ session: ShopifyAPI::Context.active_session
100
+ )
101
+ result = base_find(
102
+ session: session,
103
+ ids: {id: id, blog_id: blog_id},
104
+ params: {fields: fields},
105
+ )
106
+ T.cast(result[0], T.nilable(Article))
107
+ end
108
+
109
+ sig do
110
+ params(
111
+ id: T.any(Integer, String),
112
+ blog_id: T.nilable(T.any(Integer, String)),
113
+ session: Auth::Session
114
+ ).returns(T.untyped)
115
+ end
116
+ def delete(
117
+ id:,
118
+ blog_id: nil,
119
+ session: ShopifyAPI::Context.active_session
120
+ )
121
+ request(
122
+ http_method: :delete,
123
+ operation: :delete,
124
+ session: session,
125
+ ids: {id: id, blog_id: blog_id},
126
+ params: {},
127
+ )
128
+ end
129
+
130
+ sig do
131
+ params(
132
+ blog_id: T.nilable(T.any(Integer, String)),
133
+ limit: T.untyped,
134
+ since_id: T.untyped,
135
+ created_at_min: T.untyped,
136
+ created_at_max: T.untyped,
137
+ updated_at_min: T.untyped,
138
+ updated_at_max: T.untyped,
139
+ published_at_min: T.untyped,
140
+ published_at_max: T.untyped,
141
+ published_status: T.untyped,
142
+ handle: T.untyped,
143
+ tag: T.untyped,
144
+ author: T.untyped,
145
+ fields: T.untyped,
146
+ session: Auth::Session,
147
+ kwargs: T.untyped
148
+ ).returns(T::Array[Article])
149
+ end
150
+ def all(
151
+ blog_id: nil,
152
+ limit: nil,
153
+ since_id: nil,
154
+ created_at_min: nil,
155
+ created_at_max: nil,
156
+ updated_at_min: nil,
157
+ updated_at_max: nil,
158
+ published_at_min: nil,
159
+ published_at_max: nil,
160
+ published_status: nil,
161
+ handle: nil,
162
+ tag: nil,
163
+ author: nil,
164
+ fields: nil,
165
+ session: ShopifyAPI::Context.active_session,
166
+ **kwargs
167
+ )
168
+ response = base_find(
169
+ session: session,
170
+ ids: {blog_id: blog_id},
171
+ params: {limit: limit, 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, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status, handle: handle, tag: tag, author: author, fields: fields}.merge(kwargs).compact,
172
+ )
173
+
174
+ T.cast(response, T::Array[Article])
175
+ end
176
+
177
+ sig do
178
+ params(
179
+ session: Auth::Session,
180
+ kwargs: T.untyped
181
+ ).returns(T.untyped)
182
+ end
183
+ def authors(
184
+ session: ShopifyAPI::Context.active_session,
185
+ **kwargs
186
+ )
187
+ request(
188
+ http_method: :get,
189
+ operation: :authors,
190
+ session: session,
191
+ ids: {},
192
+ params: {}.merge(kwargs).compact,
193
+ body: {},
194
+ entity: nil,
195
+ )
196
+ end
197
+
198
+ sig do
199
+ params(
200
+ blog_id: T.nilable(T.any(Integer, String)),
201
+ created_at_min: T.untyped,
202
+ created_at_max: T.untyped,
203
+ updated_at_min: T.untyped,
204
+ updated_at_max: T.untyped,
205
+ published_at_min: T.untyped,
206
+ published_at_max: T.untyped,
207
+ published_status: T.untyped,
208
+ session: Auth::Session,
209
+ kwargs: T.untyped
210
+ ).returns(T.untyped)
211
+ end
212
+ def count(
213
+ blog_id: nil,
214
+ created_at_min: nil,
215
+ created_at_max: nil,
216
+ updated_at_min: nil,
217
+ updated_at_max: nil,
218
+ published_at_min: nil,
219
+ published_at_max: nil,
220
+ published_status: nil,
221
+ session: ShopifyAPI::Context.active_session,
222
+ **kwargs
223
+ )
224
+ request(
225
+ http_method: :get,
226
+ operation: :count,
227
+ session: session,
228
+ ids: {blog_id: blog_id},
229
+ 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, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status}.merge(kwargs).compact,
230
+ body: {},
231
+ entity: nil,
232
+ )
233
+ end
234
+
235
+ sig do
236
+ params(
237
+ blog_id: T.nilable(T.any(Integer, String)),
238
+ limit: T.untyped,
239
+ popular: T.untyped,
240
+ session: Auth::Session,
241
+ kwargs: T.untyped
242
+ ).returns(T.untyped)
243
+ end
244
+ def tags(
245
+ blog_id: nil,
246
+ limit: nil,
247
+ popular: nil,
248
+ session: ShopifyAPI::Context.active_session,
249
+ **kwargs
250
+ )
251
+ request(
252
+ http_method: :get,
253
+ operation: :tags,
254
+ session: session,
255
+ ids: {blog_id: blog_id},
256
+ params: {limit: limit, popular: popular}.merge(kwargs).compact,
257
+ body: {},
258
+ entity: nil,
259
+ )
260
+ end
261
+
262
+ end
263
+
264
+ end
265
+ end
@@ -0,0 +1,118 @@
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 Asset < 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
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
+ def initialize(session: ShopifyAPI::Context.active_session)
17
+ super(session: session)
18
+
19
+ @attachment = T.let(nil, T.nilable(String))
20
+ @checksum = T.let(nil, T.nilable(String))
21
+ @content_type = T.let(nil, T.nilable(String))
22
+ @created_at = T.let(nil, T.nilable(String))
23
+ @key = T.let(nil, T.nilable(String))
24
+ @public_url = T.let(nil, T.nilable(String))
25
+ @size = T.let(nil, T.nilable(Integer))
26
+ @theme_id = T.let(nil, T.nilable(Integer))
27
+ @updated_at = T.let(nil, T.nilable(String))
28
+ @value = T.let(nil, T.nilable(String))
29
+ end
30
+
31
+ @has_one = T.let({}, T::Hash[Symbol, Class])
32
+ @has_many = T.let({}, T::Hash[Symbol, Class])
33
+ @paths = T.let([
34
+ {http_method: :delete, operation: :delete, ids: [:theme_id], path: "themes/<theme_id>/assets.json"},
35
+ {http_method: :get, operation: :get, ids: [:theme_id], path: "themes/<theme_id>/assets.json"},
36
+ {http_method: :get, operation: :get, ids: [:theme_id], path: "themes/<theme_id>/assets.json"},
37
+ {http_method: :put, operation: :put, ids: [:theme_id], path: "themes/<theme_id>/assets.json"}
38
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
39
+
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :attachment
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :checksum
44
+ sig { returns(T.nilable(String)) }
45
+ attr_reader :content_type
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :created_at
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :key
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :public_url
52
+ sig { returns(T.nilable(Integer)) }
53
+ attr_reader :size
54
+ sig { returns(T.nilable(Integer)) }
55
+ attr_reader :theme_id
56
+ sig { returns(T.nilable(String)) }
57
+ attr_reader :updated_at
58
+ sig { returns(T.nilable(String)) }
59
+ attr_reader :value
60
+
61
+ class << self
62
+ sig do
63
+ returns(String)
64
+ end
65
+ def primary_key()
66
+ "key"
67
+ end
68
+
69
+ sig do
70
+ params(
71
+ theme_id: T.nilable(T.any(Integer, String)),
72
+ asset: T.nilable(T::Hash[T.untyped, T.untyped]),
73
+ session: Auth::Session
74
+ ).returns(T.untyped)
75
+ end
76
+ def delete(
77
+ theme_id: nil,
78
+ asset: nil,
79
+ session: ShopifyAPI::Context.active_session
80
+ )
81
+ request(
82
+ http_method: :delete,
83
+ operation: :delete,
84
+ session: session,
85
+ ids: {theme_id: theme_id},
86
+ params: {asset: asset},
87
+ )
88
+ end
89
+
90
+ sig do
91
+ params(
92
+ theme_id: T.nilable(T.any(Integer, String)),
93
+ fields: T.untyped,
94
+ asset: T.nilable(T::Hash[T.untyped, T.untyped]),
95
+ session: Auth::Session,
96
+ kwargs: T.untyped
97
+ ).returns(T::Array[Asset])
98
+ end
99
+ def all(
100
+ theme_id: nil,
101
+ fields: nil,
102
+ asset: nil,
103
+ session: ShopifyAPI::Context.active_session,
104
+ **kwargs
105
+ )
106
+ response = base_find(
107
+ session: session,
108
+ ids: {theme_id: theme_id},
109
+ params: {fields: fields, asset: asset}.merge(kwargs).compact,
110
+ )
111
+
112
+ T.cast(response, T::Array[Asset])
113
+ end
114
+
115
+ end
116
+
117
+ end
118
+ end
@@ -0,0 +1,88 @@
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 AssignedFulfillmentOrder < 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
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
+ def initialize(session: ShopifyAPI::Context.active_session)
17
+ super(session: session)
18
+
19
+ @assigned_location_id = T.let(nil, T.nilable(Integer))
20
+ @destination = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
21
+ @id = T.let(nil, T.nilable(Integer))
22
+ @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
23
+ @order_id = T.let(nil, T.nilable(Integer))
24
+ @request_status = T.let(nil, T.nilable(String))
25
+ @shop_id = T.let(nil, T.nilable(Integer))
26
+ @status = T.let(nil, T.nilable(String))
27
+ end
28
+
29
+ @has_one = T.let({}, T::Hash[Symbol, Class])
30
+ @has_many = T.let({}, T::Hash[Symbol, Class])
31
+ @paths = T.let([
32
+ {http_method: :get, operation: :get, ids: [], path: "assigned_fulfillment_orders.json"}
33
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
34
+
35
+ sig { returns(T.nilable(Integer)) }
36
+ attr_reader :assigned_location_id
37
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
38
+ attr_reader :destination
39
+ sig { returns(T.nilable(Integer)) }
40
+ attr_reader :id
41
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
42
+ attr_reader :line_items
43
+ sig { returns(T.nilable(Integer)) }
44
+ attr_reader :order_id
45
+ sig { returns(T.nilable(String)) }
46
+ attr_reader :request_status
47
+ sig { returns(T.nilable(Integer)) }
48
+ attr_reader :shop_id
49
+ sig { returns(T.nilable(String)) }
50
+ attr_reader :status
51
+
52
+ class << self
53
+ sig do
54
+ returns(T::Array[String])
55
+ end
56
+ def json_response_body_names()
57
+ [
58
+ "fulfillment_order"
59
+ ]
60
+ end
61
+
62
+ sig do
63
+ params(
64
+ assignment_status: T.untyped,
65
+ location_ids: T.nilable(T.any(T::Array[T.untyped], Integer, String)),
66
+ session: Auth::Session,
67
+ kwargs: T.untyped
68
+ ).returns(T::Array[AssignedFulfillmentOrder])
69
+ end
70
+ def all(
71
+ assignment_status: nil,
72
+ location_ids: nil,
73
+ session: ShopifyAPI::Context.active_session,
74
+ **kwargs
75
+ )
76
+ response = base_find(
77
+ session: session,
78
+ ids: {},
79
+ params: {assignment_status: assignment_status, location_ids: location_ids}.merge(kwargs).compact,
80
+ )
81
+
82
+ T.cast(response, T::Array[AssignedFulfillmentOrder])
83
+ end
84
+
85
+ end
86
+
87
+ end
88
+ end
@@ -0,0 +1,54 @@
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 Balance < 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
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
+ def initialize(session: ShopifyAPI::Context.active_session)
17
+ super(session: session)
18
+
19
+ @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
20
+ end
21
+
22
+ @has_one = T.let({}, T::Hash[Symbol, Class])
23
+ @has_many = T.let({}, T::Hash[Symbol, Class])
24
+ @paths = T.let([
25
+ {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
26
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
27
+
28
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
29
+ attr_reader :balance
30
+
31
+ class << self
32
+ sig do
33
+ params(
34
+ session: Auth::Session,
35
+ kwargs: T.untyped
36
+ ).returns(T::Array[Balance])
37
+ end
38
+ def all(
39
+ session: ShopifyAPI::Context.active_session,
40
+ **kwargs
41
+ )
42
+ response = base_find(
43
+ session: session,
44
+ ids: {},
45
+ params: {}.merge(kwargs).compact,
46
+ )
47
+
48
+ T.cast(response, T::Array[Balance])
49
+ end
50
+
51
+ end
52
+
53
+ end
54
+ end
@@ -0,0 +1,162 @@
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 Blog < 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
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
+ def initialize(session: ShopifyAPI::Context.active_session)
17
+ super(session: session)
18
+
19
+ @admin_graphql_api_id = T.let(nil, T.nilable(String))
20
+ @commentable = T.let(nil, T.nilable(String))
21
+ @created_at = T.let(nil, T.nilable(String))
22
+ @feedburner = T.let(nil, T.nilable(String))
23
+ @feedburner_location = T.let(nil, T.nilable(String))
24
+ @handle = T.let(nil, T.nilable(String))
25
+ @id = T.let(nil, T.nilable(Integer))
26
+ @metafields = T.let(nil, T.nilable(T::Array[T.untyped]))
27
+ @tags = T.let(nil, T.nilable(String))
28
+ @template_suffix = T.let(nil, T.nilable(String))
29
+ @title = T.let(nil, T.nilable(String))
30
+ @updated_at = T.let(nil, T.nilable(String))
31
+ end
32
+
33
+ @has_one = T.let({}, T::Hash[Symbol, Class])
34
+ @has_many = T.let({
35
+ metafields: Metafield
36
+ }, T::Hash[Symbol, Class])
37
+ @paths = T.let([
38
+ {http_method: :delete, operation: :delete, ids: [:id], path: "blogs/<id>.json"},
39
+ {http_method: :get, operation: :count, ids: [], path: "blogs/count.json"},
40
+ {http_method: :get, operation: :get, ids: [], path: "blogs.json"},
41
+ {http_method: :get, operation: :get, ids: [:id], path: "blogs/<id>.json"},
42
+ {http_method: :post, operation: :post, ids: [], path: "blogs.json"},
43
+ {http_method: :put, operation: :put, ids: [:id], path: "blogs/<id>.json"}
44
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
45
+
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :admin_graphql_api_id
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :commentable
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :created_at
52
+ sig { returns(T.nilable(String)) }
53
+ attr_reader :feedburner
54
+ sig { returns(T.nilable(String)) }
55
+ attr_reader :feedburner_location
56
+ sig { returns(T.nilable(String)) }
57
+ attr_reader :handle
58
+ sig { returns(T.nilable(Integer)) }
59
+ attr_reader :id
60
+ sig { returns(T.nilable(T::Array[Metafield])) }
61
+ attr_reader :metafields
62
+ sig { returns(T.nilable(String)) }
63
+ attr_reader :tags
64
+ sig { returns(T.nilable(String)) }
65
+ attr_reader :template_suffix
66
+ sig { returns(T.nilable(String)) }
67
+ attr_reader :title
68
+ sig { returns(T.nilable(String)) }
69
+ attr_reader :updated_at
70
+
71
+ class << self
72
+ sig do
73
+ params(
74
+ id: T.any(Integer, String),
75
+ fields: T.untyped,
76
+ session: Auth::Session
77
+ ).returns(T.nilable(Blog))
78
+ end
79
+ def find(
80
+ id:,
81
+ fields: nil,
82
+ session: ShopifyAPI::Context.active_session
83
+ )
84
+ result = base_find(
85
+ session: session,
86
+ ids: {id: id},
87
+ params: {fields: fields},
88
+ )
89
+ T.cast(result[0], T.nilable(Blog))
90
+ end
91
+
92
+ sig do
93
+ params(
94
+ id: T.any(Integer, String),
95
+ session: Auth::Session
96
+ ).returns(T.untyped)
97
+ end
98
+ def delete(
99
+ id:,
100
+ session: ShopifyAPI::Context.active_session
101
+ )
102
+ request(
103
+ http_method: :delete,
104
+ operation: :delete,
105
+ session: session,
106
+ ids: {id: id},
107
+ params: {},
108
+ )
109
+ end
110
+
111
+ sig do
112
+ params(
113
+ limit: T.untyped,
114
+ since_id: T.untyped,
115
+ handle: T.untyped,
116
+ fields: T.untyped,
117
+ session: Auth::Session,
118
+ kwargs: T.untyped
119
+ ).returns(T::Array[Blog])
120
+ end
121
+ def all(
122
+ limit: nil,
123
+ since_id: nil,
124
+ handle: nil,
125
+ fields: nil,
126
+ session: ShopifyAPI::Context.active_session,
127
+ **kwargs
128
+ )
129
+ response = base_find(
130
+ session: session,
131
+ ids: {},
132
+ params: {limit: limit, since_id: since_id, handle: handle, fields: fields}.merge(kwargs).compact,
133
+ )
134
+
135
+ T.cast(response, T::Array[Blog])
136
+ end
137
+
138
+ sig do
139
+ params(
140
+ session: Auth::Session,
141
+ kwargs: T.untyped
142
+ ).returns(T.untyped)
143
+ end
144
+ def count(
145
+ session: ShopifyAPI::Context.active_session,
146
+ **kwargs
147
+ )
148
+ request(
149
+ http_method: :get,
150
+ operation: :count,
151
+ session: session,
152
+ ids: {},
153
+ params: {}.merge(kwargs).compact,
154
+ body: {},
155
+ entity: nil,
156
+ )
157
+ end
158
+
159
+ end
160
+
161
+ end
162
+ end