shopify_api 14.6.0 → 14.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/Gemfile.lock +12 -7
  4. data/docs/usage/oauth.md +14 -0
  5. data/docs/usage/rest.md +2 -0
  6. data/docs/usage/webhooks.md +11 -0
  7. data/lib/shopify_api/admin_versions.rb +2 -1
  8. data/lib/shopify_api/clients/rest/admin.rb +5 -0
  9. data/lib/shopify_api/context.rb +12 -3
  10. data/lib/shopify_api/errors/disabled_resource_error.rb +8 -0
  11. data/lib/shopify_api/rest/resources/2024_07/webhook.rb +1 -0
  12. data/lib/shopify_api/rest/resources/2024_10/webhook.rb +1 -0
  13. data/lib/shopify_api/rest/resources/2025_01/abandoned_checkout.rb +194 -0
  14. data/lib/shopify_api/rest/resources/2025_01/access_scope.rb +62 -0
  15. data/lib/shopify_api/rest/resources/2025_01/apple_pay_certificate.rb +109 -0
  16. data/lib/shopify_api/rest/resources/2025_01/application_charge.rb +113 -0
  17. data/lib/shopify_api/rest/resources/2025_01/application_credit.rb +95 -0
  18. data/lib/shopify_api/rest/resources/2025_01/article.rb +269 -0
  19. data/lib/shopify_api/rest/resources/2025_01/asset.rb +122 -0
  20. data/lib/shopify_api/rest/resources/2025_01/assigned_fulfillment_order.rb +92 -0
  21. data/lib/shopify_api/rest/resources/2025_01/balance.rb +58 -0
  22. data/lib/shopify_api/rest/resources/2025_01/blog.rb +166 -0
  23. data/lib/shopify_api/rest/resources/2025_01/cancellation_request.rb +87 -0
  24. data/lib/shopify_api/rest/resources/2025_01/carrier_service.rb +120 -0
  25. data/lib/shopify_api/rest/resources/2025_01/checkout.rb +213 -0
  26. data/lib/shopify_api/rest/resources/2025_01/collect.rb +146 -0
  27. data/lib/shopify_api/rest/resources/2025_01/collection.rb +114 -0
  28. data/lib/shopify_api/rest/resources/2025_01/collection_listing.rb +159 -0
  29. data/lib/shopify_api/rest/resources/2025_01/comment.rb +287 -0
  30. data/lib/shopify_api/rest/resources/2025_01/country.rb +141 -0
  31. data/lib/shopify_api/rest/resources/2025_01/currency.rb +61 -0
  32. data/lib/shopify_api/rest/resources/2025_01/custom_collection.rb +191 -0
  33. data/lib/shopify_api/rest/resources/2025_01/customer.rb +328 -0
  34. data/lib/shopify_api/rest/resources/2025_01/customer_address.rb +215 -0
  35. data/lib/shopify_api/rest/resources/2025_01/deprecated_api_call.rb +61 -0
  36. data/lib/shopify_api/rest/resources/2025_01/discount_code.rb +226 -0
  37. data/lib/shopify_api/rest/resources/2025_01/dispute.rb +115 -0
  38. data/lib/shopify_api/rest/resources/2025_01/dispute_evidence.rb +121 -0
  39. data/lib/shopify_api/rest/resources/2025_01/dispute_file_upload.rb +85 -0
  40. data/lib/shopify_api/rest/resources/2025_01/draft_order.rb +279 -0
  41. data/lib/shopify_api/rest/resources/2025_01/event.rb +152 -0
  42. data/lib/shopify_api/rest/resources/2025_01/fulfillment.rb +235 -0
  43. data/lib/shopify_api/rest/resources/2025_01/fulfillment_event.rb +167 -0
  44. data/lib/shopify_api/rest/resources/2025_01/fulfillment_order.rb +326 -0
  45. data/lib/shopify_api/rest/resources/2025_01/fulfillment_request.rb +116 -0
  46. data/lib/shopify_api/rest/resources/2025_01/fulfillment_service.rb +134 -0
  47. data/lib/shopify_api/rest/resources/2025_01/gift_card.rb +222 -0
  48. data/lib/shopify_api/rest/resources/2025_01/gift_card_adjustment.rb +122 -0
  49. data/lib/shopify_api/rest/resources/2025_01/image.rb +161 -0
  50. data/lib/shopify_api/rest/resources/2025_01/inventory_item.rb +112 -0
  51. data/lib/shopify_api/rest/resources/2025_01/inventory_level.rb +183 -0
  52. data/lib/shopify_api/rest/resources/2025_01/location.rb +171 -0
  53. data/lib/shopify_api/rest/resources/2025_01/locations_for_move.rb +60 -0
  54. data/lib/shopify_api/rest/resources/2025_01/marketing_event.rb +213 -0
  55. data/lib/shopify_api/rest/resources/2025_01/metafield.rb +348 -0
  56. data/lib/shopify_api/rest/resources/2025_01/mobile_platform_application.rb +120 -0
  57. data/lib/shopify_api/rest/resources/2025_01/order.rb +503 -0
  58. data/lib/shopify_api/rest/resources/2025_01/order_risk.rb +148 -0
  59. data/lib/shopify_api/rest/resources/2025_01/page.rb +198 -0
  60. data/lib/shopify_api/rest/resources/2025_01/payment.rb +98 -0
  61. data/lib/shopify_api/rest/resources/2025_01/payment_gateway.rb +147 -0
  62. data/lib/shopify_api/rest/resources/2025_01/payment_transaction.rb +117 -0
  63. data/lib/shopify_api/rest/resources/2025_01/payout.rb +101 -0
  64. data/lib/shopify_api/rest/resources/2025_01/policy.rb +73 -0
  65. data/lib/shopify_api/rest/resources/2025_01/price_rule.rb +227 -0
  66. data/lib/shopify_api/rest/resources/2025_01/product.rb +227 -0
  67. data/lib/shopify_api/rest/resources/2025_01/product_listing.rb +200 -0
  68. data/lib/shopify_api/rest/resources/2025_01/product_resource_feedback.rb +92 -0
  69. data/lib/shopify_api/rest/resources/2025_01/province.rb +136 -0
  70. data/lib/shopify_api/rest/resources/2025_01/recurring_application_charge.rb +184 -0
  71. data/lib/shopify_api/rest/resources/2025_01/redirect.rb +143 -0
  72. data/lib/shopify_api/rest/resources/2025_01/refund.rb +158 -0
  73. data/lib/shopify_api/rest/resources/2025_01/resource_feedback.rb +77 -0
  74. data/lib/shopify_api/rest/resources/2025_01/script_tag.rb +159 -0
  75. data/lib/shopify_api/rest/resources/2025_01/shipping_zone.rb +87 -0
  76. data/lib/shopify_api/rest/resources/2025_01/shop.rb +231 -0
  77. data/lib/shopify_api/rest/resources/2025_01/smart_collection.rb +220 -0
  78. data/lib/shopify_api/rest/resources/2025_01/storefront_access_token.rb +91 -0
  79. data/lib/shopify_api/rest/resources/2025_01/tender_transaction.rb +97 -0
  80. data/lib/shopify_api/rest/resources/2025_01/theme.rb +127 -0
  81. data/lib/shopify_api/rest/resources/2025_01/transaction.rb +194 -0
  82. data/lib/shopify_api/rest/resources/2025_01/usage_charge.rb +106 -0
  83. data/lib/shopify_api/rest/resources/2025_01/user.rb +142 -0
  84. data/lib/shopify_api/rest/resources/2025_01/variant.rb +212 -0
  85. data/lib/shopify_api/rest/resources/2025_01/webhook.rb +173 -0
  86. data/lib/shopify_api/version.rb +1 -1
  87. data/lib/shopify_api/webhooks/registration.rb +17 -3
  88. data/lib/shopify_api/webhooks/registrations/event_bridge.rb +22 -3
  89. data/lib/shopify_api/webhooks/registrations/http.rb +22 -3
  90. data/lib/shopify_api/webhooks/registrations/pub_sub.rb +23 -4
  91. data/lib/shopify_api/webhooks/registry.rb +15 -5
  92. metadata +77 -6
@@ -0,0 +1,141 @@
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 Country < 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
+ @id = T.let(nil, T.nilable(Integer))
23
+ @name = T.let(nil, T.nilable(String))
24
+ @provinces = T.let(nil, T.nilable(T::Array[T.untyped]))
25
+ @tax = T.let(nil, T.nilable(Float))
26
+
27
+ super(session: session, from_hash: from_hash)
28
+ end
29
+
30
+ @has_one = T.let({}, T::Hash[Symbol, Class])
31
+ @has_many = T.let({
32
+ provinces: Province
33
+ }, T::Hash[Symbol, Class])
34
+ @paths = T.let([
35
+ {http_method: :delete, operation: :delete, ids: [:id], path: "countries/<id>.json"},
36
+ {http_method: :get, operation: :count, ids: [], path: "countries/count.json"},
37
+ {http_method: :get, operation: :get, ids: [], path: "countries.json"},
38
+ {http_method: :get, operation: :get, ids: [:id], path: "countries/<id>.json"},
39
+ {http_method: :post, operation: :post, ids: [], path: "countries.json"},
40
+ {http_method: :put, operation: :put, ids: [:id], path: "countries/<id>.json"}
41
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
42
+
43
+ sig { returns(T.nilable(String)) }
44
+ attr_reader :code
45
+ sig { returns(T.nilable(Integer)) }
46
+ attr_reader :id
47
+ sig { returns(T.nilable(String)) }
48
+ attr_reader :name
49
+ sig { returns(T.nilable(T::Array[Province])) }
50
+ attr_reader :provinces
51
+ sig { returns(T.nilable(Float)) }
52
+ attr_reader :tax
53
+
54
+ class << self
55
+ sig do
56
+ params(
57
+ id: T.any(Integer, String),
58
+ fields: T.untyped,
59
+ session: Auth::Session
60
+ ).returns(T.nilable(Country))
61
+ end
62
+ def find(
63
+ id:,
64
+ fields: nil,
65
+ session: ShopifyAPI::Context.active_session
66
+ )
67
+ result = base_find(
68
+ session: session,
69
+ ids: {id: id},
70
+ params: {fields: fields},
71
+ )
72
+ T.cast(result[0], T.nilable(Country))
73
+ end
74
+
75
+ sig do
76
+ params(
77
+ id: T.any(Integer, String),
78
+ session: Auth::Session
79
+ ).returns(T.untyped)
80
+ end
81
+ def delete(
82
+ id:,
83
+ session: ShopifyAPI::Context.active_session
84
+ )
85
+ request(
86
+ http_method: :delete,
87
+ operation: :delete,
88
+ session: session,
89
+ ids: {id: id},
90
+ params: {},
91
+ )
92
+ end
93
+
94
+ sig do
95
+ params(
96
+ since_id: T.untyped,
97
+ fields: T.untyped,
98
+ session: Auth::Session,
99
+ kwargs: T.untyped
100
+ ).returns(T::Array[Country])
101
+ end
102
+ def all(
103
+ since_id: nil,
104
+ fields: nil,
105
+ session: ShopifyAPI::Context.active_session,
106
+ **kwargs
107
+ )
108
+ response = base_find(
109
+ session: session,
110
+ ids: {},
111
+ params: {since_id: since_id, fields: fields}.merge(kwargs).compact,
112
+ )
113
+
114
+ T.cast(response, T::Array[Country])
115
+ end
116
+
117
+ sig do
118
+ params(
119
+ session: Auth::Session,
120
+ kwargs: T.untyped
121
+ ).returns(T.untyped)
122
+ end
123
+ def count(
124
+ session: ShopifyAPI::Context.active_session,
125
+ **kwargs
126
+ )
127
+ request(
128
+ http_method: :get,
129
+ operation: :count,
130
+ session: session,
131
+ ids: {},
132
+ params: {}.merge(kwargs).compact,
133
+ body: {},
134
+ entity: nil,
135
+ )
136
+ end
137
+
138
+ end
139
+
140
+ end
141
+ 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 Currency < 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
+ @currency = T.let(nil, T.nilable(String))
22
+ @rate_updated_at = T.let(nil, T.nilable(String))
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: "currencies.json"}
31
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
32
+
33
+ sig { returns(T.nilable(String)) }
34
+ attr_reader :currency
35
+ sig { returns(T.nilable(String)) }
36
+ attr_reader :rate_updated_at
37
+
38
+ class << self
39
+ sig do
40
+ params(
41
+ session: Auth::Session,
42
+ kwargs: T.untyped
43
+ ).returns(T::Array[Currency])
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[Currency])
56
+ end
57
+
58
+ end
59
+
60
+ end
61
+ end
@@ -0,0 +1,191 @@
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 CustomCollection < 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
+ @title = T.let(nil, T.nilable(String))
22
+ @body_html = 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
+ @published = T.let(nil, T.nilable(T::Boolean))
27
+ @published_at = T.let(nil, T.nilable(String))
28
+ @published_scope = T.let(nil, T.nilable(String))
29
+ @sort_order = T.let(nil, T.nilable(String))
30
+ @template_suffix = T.let(nil, T.nilable(String))
31
+ @updated_at = T.let(nil, T.nilable(String))
32
+
33
+ super(session: session, from_hash: from_hash)
34
+ end
35
+
36
+ @has_one = T.let({}, T::Hash[Symbol, Class])
37
+ @has_many = T.let({}, T::Hash[Symbol, Class])
38
+ @paths = T.let([
39
+ {http_method: :delete, operation: :delete, ids: [:id], path: "custom_collections/<id>.json"},
40
+ {http_method: :get, operation: :count, ids: [], path: "custom_collections/count.json"},
41
+ {http_method: :get, operation: :get, ids: [], path: "custom_collections.json"},
42
+ {http_method: :get, operation: :get, ids: [:id], path: "custom_collections/<id>.json"},
43
+ {http_method: :post, operation: :post, ids: [], path: "custom_collections.json"},
44
+ {http_method: :put, operation: :put, ids: [:id], path: "custom_collections/<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 :title
49
+ sig { returns(T.nilable(String)) }
50
+ attr_reader :body_html
51
+ sig { returns(T.nilable(String)) }
52
+ attr_reader :handle
53
+ sig { returns(T.nilable(Integer)) }
54
+ attr_reader :id
55
+ sig { returns(T.nilable(T.any(String, T::Hash[T.untyped, T.untyped]))) }
56
+ attr_reader :image
57
+ sig { returns(T.nilable(T::Boolean)) }
58
+ attr_reader :published
59
+ sig { returns(T.nilable(String)) }
60
+ attr_reader :published_at
61
+ sig { returns(T.nilable(String)) }
62
+ attr_reader :published_scope
63
+ sig { returns(T.nilable(String)) }
64
+ attr_reader :sort_order
65
+ sig { returns(T.nilable(String)) }
66
+ attr_reader :template_suffix
67
+ sig { returns(T.nilable(String)) }
68
+ attr_reader :updated_at
69
+
70
+ class << self
71
+ sig do
72
+ params(
73
+ id: T.any(Integer, String),
74
+ fields: T.untyped,
75
+ session: Auth::Session
76
+ ).returns(T.nilable(CustomCollection))
77
+ end
78
+ def find(
79
+ id:,
80
+ fields: nil,
81
+ session: ShopifyAPI::Context.active_session
82
+ )
83
+ result = base_find(
84
+ session: session,
85
+ ids: {id: id},
86
+ params: {fields: fields},
87
+ )
88
+ T.cast(result[0], T.nilable(CustomCollection))
89
+ end
90
+
91
+ sig do
92
+ params(
93
+ id: T.any(Integer, String),
94
+ session: Auth::Session
95
+ ).returns(T.untyped)
96
+ end
97
+ def delete(
98
+ id:,
99
+ session: ShopifyAPI::Context.active_session
100
+ )
101
+ request(
102
+ http_method: :delete,
103
+ operation: :delete,
104
+ session: session,
105
+ ids: {id: id},
106
+ params: {},
107
+ )
108
+ end
109
+
110
+ sig do
111
+ params(
112
+ limit: T.untyped,
113
+ ids: T.untyped,
114
+ since_id: T.untyped,
115
+ title: T.untyped,
116
+ product_id: T.untyped,
117
+ handle: T.untyped,
118
+ updated_at_min: T.untyped,
119
+ updated_at_max: T.untyped,
120
+ published_at_min: T.untyped,
121
+ published_at_max: T.untyped,
122
+ published_status: T.untyped,
123
+ fields: T.untyped,
124
+ session: Auth::Session,
125
+ kwargs: T.untyped
126
+ ).returns(T::Array[CustomCollection])
127
+ end
128
+ def all(
129
+ limit: nil,
130
+ ids: nil,
131
+ since_id: nil,
132
+ title: nil,
133
+ product_id: nil,
134
+ handle: nil,
135
+ updated_at_min: nil,
136
+ updated_at_max: nil,
137
+ published_at_min: nil,
138
+ published_at_max: nil,
139
+ published_status: nil,
140
+ fields: nil,
141
+ session: ShopifyAPI::Context.active_session,
142
+ **kwargs
143
+ )
144
+ response = base_find(
145
+ session: session,
146
+ ids: {},
147
+ params: {limit: limit, ids: ids, since_id: since_id, title: title, product_id: product_id, handle: handle, 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, fields: fields}.merge(kwargs).compact,
148
+ )
149
+
150
+ T.cast(response, T::Array[CustomCollection])
151
+ end
152
+
153
+ sig do
154
+ params(
155
+ title: T.untyped,
156
+ product_id: T.untyped,
157
+ updated_at_min: T.untyped,
158
+ updated_at_max: T.untyped,
159
+ published_at_min: T.untyped,
160
+ published_at_max: T.untyped,
161
+ published_status: T.untyped,
162
+ session: Auth::Session,
163
+ kwargs: T.untyped
164
+ ).returns(T.untyped)
165
+ end
166
+ def count(
167
+ title: nil,
168
+ product_id: nil,
169
+ updated_at_min: nil,
170
+ updated_at_max: nil,
171
+ published_at_min: nil,
172
+ published_at_max: nil,
173
+ published_status: nil,
174
+ session: ShopifyAPI::Context.active_session,
175
+ **kwargs
176
+ )
177
+ request(
178
+ http_method: :get,
179
+ operation: :count,
180
+ session: session,
181
+ ids: {},
182
+ params: {title: title, product_id: product_id, 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,
183
+ body: {},
184
+ entity: nil,
185
+ )
186
+ end
187
+
188
+ end
189
+
190
+ end
191
+ end