shopify_api 9.0.0 → 9.0.1
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +85 -80
- data/README.md +398 -214
- data/lib/active_resource/detailed_log_subscriber.rb +13 -3
- data/lib/shopify_api/message_enricher.rb +7 -1
- data/lib/shopify_api/version.rb +1 -1
- data/test/detailed_log_subscriber_test.rb +22 -0
- data/test/message_enricher_test.rb +13 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 38767c160ec90d95eef7de111c88159b0e3c9cb2d5c5e652dfa4358e18ce79d0
|
4
|
+
data.tar.gz: b43efeb96b3a0afa293f654ec3544fa3c5742ad9be26a944ea9f9f101c290afa
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 99051f65afc34c7c00e28f1bd2cb73e0e009786468f386372003557f1de1c05b587ae9c46e0bf7c49531269e778fa2528a92aca176f9ffcba1acd59f6383b103
|
7
|
+
data.tar.gz: 440ca081056e1d68a3d3cc5164fb5ad7ef07f46a9aa076bc5c16290d2e6deef86d474fac2e836a72d4ebf3d1a72c21946429bc73b18b97120f67df2912009e4d
|
data/CHANGELOG.md
CHANGED
@@ -1,4 +1,9 @@
|
|
1
|
-
|
1
|
+
## Version 9.0.1
|
2
|
+
|
3
|
+
* Added warning message if API version used is unsupported or soon to be unsupported [#685](https://github.com/Shopify/shopify_api/pull/685)
|
4
|
+
* Take into account "errors" messages from response body [#677](https://github.com/Shopify/shopify_api/pull/677)
|
5
|
+
|
6
|
+
## Version 9.0.0
|
2
7
|
|
3
8
|
* Breaking change: Improved GraphQL client [#672](https://github.com/Shopify/shopify_api/pull/672). See the [client docs](docs/graphql.md) for usage and a migration guide.
|
4
9
|
|
@@ -23,7 +28,7 @@
|
|
23
28
|
|
24
29
|
* Release new Endpoint `order.fulfillment_orders`, and active resources `AssignedFulfillmentOrder` and `FulfillmentOrder` in 2020-01 REST API version [#633](https://github.com/Shopify/shopify_api/pull/633)
|
25
30
|
|
26
|
-
|
31
|
+
## Version 8.1.0
|
27
32
|
|
28
33
|
* Release 2020-01 REST ADMIN API VERSION [#656](https://github.com/Shopify/shopify_api/pull/656)
|
29
34
|
* Release new Endpoint `collection.products` and `collection.find()` in 2020-01 REST API version [#657](https://github.com/Shopify/shopify_api/pull/657)
|
@@ -32,7 +37,7 @@
|
|
32
37
|
* Small ruby compat fix [#623](https://github.com/Shopify/shopify_api/pull/623)
|
33
38
|
* Small consistency change [#621](https://github.com/Shopify/shopify_api/pull/621)
|
34
39
|
|
35
|
-
|
40
|
+
## Version 8.0.0
|
36
41
|
|
37
42
|
* Api Version changes [#600](https://github.com/Shopify/shopify_api/pull/600)
|
38
43
|
* Remove static Api Version definitions.
|
@@ -42,22 +47,22 @@
|
|
42
47
|
* `ApiVersion::NullVersion` cannot be instantiated and now has a `match?` method [#615](https://github.com/Shopify/shopify_api/pull/615/files)
|
43
48
|
* Introduces new Collection endpoint for looking up products without knowing collection type. Only available if ApiVersion is `:unstable` [#609](https://github.com/Shopify/shopify_api/pull/609)
|
44
49
|
|
45
|
-
|
50
|
+
## Version 7.1.0
|
46
51
|
|
47
52
|
* Add 2019-10 to known API versions
|
48
53
|
* Add support for cursor pagination [#594](https://github.com/Shopify/shopify_api/pull/594) and
|
49
54
|
[#611](https://github.com/Shopify/shopify_api/pull/611)
|
50
55
|
* `ShopifyAPI::Base.api_version` now defaults to `ShopifyAPI::ApiVersion::NullVersion` instead of `nil`. Making requests without first setting an ApiVersion raises `ApiVersionNotSetError` instead of `NoMethodError: undefined method 'construct_api_path' for nil:NilClass'` [#605](https://github.com/Shopify/shopify_api/pull/605)
|
51
56
|
|
52
|
-
|
57
|
+
## Version 7.0.2
|
53
58
|
|
54
59
|
* Add 2019-07 to known API versions.
|
55
60
|
|
56
|
-
|
61
|
+
## Version 7.0.1
|
57
62
|
|
58
63
|
* Support passing version string to `ShopifyAPI::Base.api_version` [#563](https://github.com/Shopify/shopify_api/pull/563)
|
59
64
|
|
60
|
-
|
65
|
+
## Version 7.0.0
|
61
66
|
|
62
67
|
* Removed support for `ActiveResouce` < `4.1`.
|
63
68
|
* Removed `ShopifyAPI::Oauth`.
|
@@ -68,41 +73,41 @@ arguments, See [migration notes](README.md#-breaking-change-notice-for-version-7
|
|
68
73
|
* Add support for newer call limit header `X-Shopify-Shop-Api-Call-Limit`.
|
69
74
|
* Removed all Ping resources.
|
70
75
|
|
71
|
-
|
76
|
+
## Version 6.0.0
|
72
77
|
|
73
78
|
* Removed undocumented `protocol` and `port` options from `ShopifyAPI::Session`.
|
74
79
|
|
75
|
-
|
80
|
+
## Version 5.2.4
|
76
81
|
|
77
82
|
* Added `currency` parameter to `ShopifyAPI::Order#capture`. This parameter is required for apps that belong to the
|
78
83
|
multi-currency beta program.
|
79
84
|
|
80
|
-
|
85
|
+
## Version 5.2.3
|
81
86
|
|
82
87
|
* Update delivery confirmation resource to delivery confirmation details resource.
|
83
88
|
|
84
|
-
|
89
|
+
## Version 5.2.2
|
85
90
|
|
86
91
|
* Add delivery confirmation endpoint to Ping resources.
|
87
92
|
|
88
|
-
|
93
|
+
## Version 5.2.1
|
89
94
|
|
90
95
|
* Log warning when Shopify indicates deprecated API call was performed
|
91
96
|
|
92
|
-
|
97
|
+
## Version 5.2.0
|
93
98
|
|
94
99
|
* Added `ShopifyAPI::Currency` to fetch list of supported currencies on a shop
|
95
100
|
* Added `ShopifyAPI::TenderTransaction` to fetch list of transactions on a shop
|
96
101
|
* Fixed bug with X-Shopify-Checkout-Version on ShopifyAPI::Checkout header being applied to all requests
|
97
102
|
|
98
|
-
|
103
|
+
## Version 5.1.0
|
99
104
|
|
100
105
|
* Added `ShopifyAPI::Publications`
|
101
106
|
* Added `ShopifyAPI::ProductPublications`
|
102
107
|
* Added `ShopifyAPI::CollectionPublications`
|
103
108
|
* Added support for new collection products endpoint from `ShopifyAPI::Collection#products`
|
104
109
|
|
105
|
-
|
110
|
+
## Version 5.0.0
|
106
111
|
|
107
112
|
* Breaking change: `ShopifyAPI::Checkout` now maps to the Checkout API, rather than the Abandoned Checkouts API
|
108
113
|
* See the README for more details
|
@@ -113,175 +118,175 @@ multi-currency beta program.
|
|
113
118
|
* Added support for `Checkout::complete` endpoint
|
114
119
|
* Fixed session handling support for Rails 5.2.1
|
115
120
|
|
116
|
-
|
121
|
+
## Version 4.13.0
|
117
122
|
* Added `ShopifyAPI::ApiPermission` resource for uninstalling an application
|
118
123
|
* Added a deprecation warning to `ShopifyAPI::OAuth`
|
119
124
|
|
120
|
-
|
125
|
+
## Version 4.12.0
|
121
126
|
|
122
127
|
* Added support for the GraphQL API
|
123
128
|
|
124
|
-
|
129
|
+
## Version 4.11.0
|
125
130
|
|
126
131
|
* Added `ShopifyAPI::InventoryItem`
|
127
132
|
* Added `ShopifyAPI::InventoryLevel`
|
128
133
|
* Added `#inventory_levels` method to `ShopifyAPI::Location`
|
129
134
|
|
130
|
-
|
135
|
+
## Version 4.10.0
|
131
136
|
|
132
137
|
* Added `ShopifyAPI::AccessScope`
|
133
138
|
|
134
|
-
|
139
|
+
## Version 4.9.1
|
135
140
|
|
136
141
|
* Fix a bug with custom properties for orders
|
137
142
|
|
138
|
-
|
143
|
+
## Version 4.9.0
|
139
144
|
|
140
145
|
* Added `ShopifyAPI::PriceRule`
|
141
146
|
* Added `ShopifyAPI::DiscountCode`
|
142
147
|
|
143
|
-
|
148
|
+
## Version 4.8.0
|
144
149
|
|
145
150
|
* Added `add_engagements` to `ShopifyAPI::MarketingEvent`
|
146
151
|
|
147
|
-
|
152
|
+
## Version 4.7.1
|
148
153
|
|
149
154
|
* Added support for URL parameter (e.g. limit & page) to ShopifyAPI::Metafields
|
150
155
|
* Added support for URL parameter (e.g. limit & page) to metafield operator in ShopifyAPI::Shop
|
151
156
|
|
152
|
-
|
157
|
+
## Version 4.7.0
|
153
158
|
|
154
159
|
* Removed the mandatory `application_id` parameter from `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
|
155
160
|
* Fixed a bug related to the non-standard primary key for `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
|
156
161
|
|
157
|
-
|
162
|
+
## Version 4.6.0
|
158
163
|
|
159
164
|
* Added `ShopifyAPI::Report`
|
160
165
|
|
161
|
-
|
166
|
+
## Version 4.5.0
|
162
167
|
|
163
168
|
* Added `ShopifyAPI::MarketingEvent`
|
164
169
|
|
165
|
-
|
170
|
+
## Version 4.4.0
|
166
171
|
|
167
172
|
* Added `ShopifyAPI::CustomerInvite`
|
168
173
|
* Support for Customer#send_invite endpoint
|
169
174
|
|
170
|
-
|
175
|
+
## Version 4.3.8
|
171
176
|
|
172
177
|
* Added `ShopifyAPI::ResourceFeedback`
|
173
178
|
|
174
|
-
|
179
|
+
## Version 4.3.7
|
175
180
|
|
176
181
|
* Added support for `complete` in `ShopifyAPI::DraftOrder`
|
177
182
|
|
178
|
-
|
183
|
+
## Version 4.3.6
|
179
184
|
|
180
185
|
* Fixed the `customer_saved_search_id` param in `ShopifyAPI::CustomerSavedSearch#customers`.
|
181
186
|
|
182
|
-
|
187
|
+
## Version 4.3.5
|
183
188
|
|
184
189
|
* Added support for online mode access tokens, token expiry, and associated_user information.
|
185
190
|
* Added `ShopifyAPI::DraftOrder`
|
186
191
|
* Added `ShopifyAPI::DraftOrderInvoice`
|
187
192
|
|
188
|
-
|
193
|
+
## Version 4.3.4
|
189
194
|
|
190
195
|
* Added `ShopifyAPI::ProductListing`
|
191
196
|
* Added `ShopifyAPI::CollectionListing`
|
192
197
|
|
193
|
-
|
198
|
+
## Version 4.3.3
|
194
199
|
|
195
200
|
* Added `ShopifyAPI::StorefrontAccessToken`
|
196
201
|
|
197
|
-
|
202
|
+
## Version 4.3.2
|
198
203
|
|
199
204
|
* Relax Ruby version requirement to >= `2.0`
|
200
205
|
|
201
|
-
|
206
|
+
## Version 4.3.1
|
202
207
|
|
203
208
|
* Support for ShopifyAPI::ApplicationCredit
|
204
209
|
|
205
|
-
|
210
|
+
## Version 4.3.0
|
206
211
|
|
207
212
|
* Require Ruby >= `2.3.0`
|
208
213
|
* Use inheritance instead of the deprecated Rails `Module#alias_method_chain`
|
209
214
|
|
210
|
-
|
215
|
+
## Version 4.2.2
|
211
216
|
|
212
217
|
* Support for AccessToken#delegate endpoint
|
213
218
|
|
214
|
-
|
219
|
+
## Version 4.2.1
|
215
220
|
|
216
221
|
* Support for Users and Discounts (Shopify Plus only)
|
217
222
|
* Adds Customer#account_activation_url method
|
218
223
|
* Adds ability to open a fulfillment.
|
219
224
|
|
220
|
-
|
225
|
+
## Version 4.2.0
|
221
226
|
|
222
227
|
* Threadsafety is now compatible with the latest ActiveResource master
|
223
228
|
|
224
|
-
|
229
|
+
## Version 4.1.1
|
225
230
|
|
226
231
|
* Added explicit 90 second timeout to `ShopifyAPI::Base`
|
227
232
|
|
228
|
-
|
233
|
+
## Version 4.0.7
|
229
234
|
|
230
235
|
* Added `ShippingAPI::ShippingZone`
|
231
236
|
|
232
|
-
|
237
|
+
## Version 4.0.6
|
233
238
|
|
234
239
|
* Replaced `cancelled` with `expired` in `ShopifyAPI::ApplicationCharge`
|
235
240
|
|
236
|
-
|
241
|
+
## Version 4.0.5
|
237
242
|
|
238
243
|
* Added `pending`, `cancelled`, `accepted`, `declined` helper methods to `ShopifyAPI::ApplicationCharge`
|
239
244
|
|
240
|
-
|
245
|
+
## Version 4.0.4
|
241
246
|
|
242
247
|
* Fixed truthiness for order cancellations. Requests are now sent in the request body and as JSON
|
243
248
|
|
244
|
-
|
249
|
+
## Version 4.0.3
|
245
250
|
|
246
251
|
* Fixed hmac signature validation for params with delimiters (`&`, `=` or `%`)
|
247
252
|
|
248
|
-
|
253
|
+
## Version 4.0.2
|
249
254
|
|
250
255
|
* Verify that the shop domain is a subdomain of .myshopify.com which creating the session
|
251
256
|
|
252
|
-
|
257
|
+
## Version 4.0.1
|
253
258
|
|
254
259
|
* Added `ShopifyAPI::OAuth.revoke` for easy token revocation.
|
255
260
|
|
256
|
-
|
261
|
+
## Version 3.2.6
|
257
262
|
|
258
263
|
* Fixed CustomerSavedSearch#customers method to now correctly return only relevant customers
|
259
264
|
|
260
|
-
|
265
|
+
## Version 3.2.5
|
261
266
|
|
262
267
|
* More useful error messages for activating nil sessions
|
263
268
|
* Add tests for commonly deleted objects, and metafield tests, fix naming error in order_risk_test.rb
|
264
269
|
|
265
|
-
|
270
|
+
## Version 3.2.4
|
266
271
|
|
267
272
|
* No API changes
|
268
273
|
|
269
|
-
|
274
|
+
## Version 3.2.3
|
270
275
|
|
271
276
|
* Added pry to the CLI
|
272
277
|
|
273
|
-
|
278
|
+
## Version 3.2.2
|
274
279
|
|
275
280
|
* Temporary fix for the CLI
|
276
281
|
* Add a specific exception for signature validation failures
|
277
282
|
|
278
|
-
|
283
|
+
## Version 3.2.1
|
279
284
|
|
280
285
|
* Added CarrierService resource
|
281
286
|
* Added optionally using threadsafe ActiveResource (see readme)
|
282
287
|
* Fixed bug in validate_signature
|
283
288
|
|
284
|
-
|
289
|
+
## Version 3.2.0
|
285
290
|
|
286
291
|
* in Session::request_token params is no longer optional, you must pass all the params and the method will now extract the code
|
287
292
|
* Fixed JSON errors handling (#103)
|
@@ -293,29 +298,29 @@ multi-currency beta program.
|
|
293
298
|
* Removed discontinued ProductSearchEngine resource
|
294
299
|
* Added convenience method Customer#search (#45)
|
295
300
|
|
296
|
-
|
301
|
+
## Version 3.1.8
|
297
302
|
|
298
303
|
* Expose `index` and `show` actions of `Location`
|
299
304
|
* Added create_permission_url and request_token helper methods
|
300
305
|
* Edited the readme to better describe the getting started procedure
|
301
306
|
|
302
|
-
|
307
|
+
## Version 3.1.7
|
303
308
|
|
304
309
|
* Expose `authors` and `tags` action on Article
|
305
310
|
|
306
|
-
|
311
|
+
## Version 3.1.6
|
307
312
|
|
308
313
|
* Add LineItem::Property resource
|
309
314
|
|
310
|
-
|
315
|
+
## Version 3.1.5
|
311
316
|
|
312
317
|
* Expose `orders` action on Customer
|
313
318
|
|
314
|
-
|
319
|
+
## Version 3.1.3
|
315
320
|
|
316
321
|
* Expose `complete` action on Fulfillment
|
317
322
|
|
318
|
-
|
323
|
+
## Version 3.1.2
|
319
324
|
|
320
325
|
* Includes port in domain URI (when other than http/80 or https/443)
|
321
326
|
* Adds access to CustomerSavedSearch
|
@@ -324,43 +329,43 @@ multi-currency beta program.
|
|
324
329
|
* Moves encode and as_json overrides to ShopifyAPI::Base scope
|
325
330
|
* Exposes the `order` action in SmartCollection for general use
|
326
331
|
|
327
|
-
|
332
|
+
## Version 3.0.3
|
328
333
|
|
329
334
|
* Add a `customers` helper method to the CustomerGroup resource
|
330
335
|
|
331
|
-
|
336
|
+
## Version 3.0.2
|
332
337
|
|
333
338
|
* Brevity in require statements
|
334
339
|
|
335
|
-
|
340
|
+
## Version 3.0.1
|
336
341
|
|
337
342
|
* Fix saving nested resources in ActiveResource 3.1+
|
338
343
|
|
339
|
-
|
344
|
+
## Version 3.0.0
|
340
345
|
|
341
346
|
* Added support for OAuth Authentication
|
342
347
|
* Removal of support for Legacy Authentication
|
343
348
|
* Added Cart resource
|
344
349
|
|
345
|
-
|
350
|
+
## Version 2.3.0
|
346
351
|
|
347
352
|
* Fix double root bug with ActiveSupport 3.2.0
|
348
353
|
* Add metafields methods on Customer resource
|
349
354
|
* Fix prefix_options on assets returned from Asset.find
|
350
355
|
|
351
|
-
|
356
|
+
## Version 2.2.0
|
352
357
|
|
353
358
|
* Fix issues with resources that have both direct and namespaced routes
|
354
359
|
* Added detailed logger to help with debugging ActiveResource
|
355
360
|
requests/responses
|
356
361
|
* Add fulfillment#cancel
|
357
362
|
|
358
|
-
|
363
|
+
## Version 2.1.0
|
359
364
|
|
360
365
|
* Fix JSON errors handling
|
361
366
|
* Remove global limit from ShopifyAPI::Limits
|
362
367
|
|
363
|
-
|
368
|
+
## Version 2.0.0
|
364
369
|
|
365
370
|
* Bump to 2.0.0 as this release breaks Rails 2 compatibility; we're now officially only supporting Rails 3. Rails 2 devs can follow the rails2 tag in this repo to know where we broke off
|
366
371
|
* Refactored resources into their own source files
|
@@ -370,60 +375,60 @@ requests/responses
|
|
370
375
|
* ShopifyAPI::Session#temp now available as a convenience method to support temporarily switching to other shops when making calls
|
371
376
|
* Fixes to `shopify console` CLI tool
|
372
377
|
|
373
|
-
|
378
|
+
## Version 1.2.5
|
374
379
|
|
375
380
|
* Fix for Article#comments
|
376
381
|
|
377
|
-
|
382
|
+
## Version 1.2.4
|
378
383
|
|
379
384
|
* Added Article#comments
|
380
385
|
* Added Order#cancel
|
381
386
|
* Added Comment#restore, #not_spam
|
382
387
|
|
383
|
-
|
388
|
+
## Version 1.2.3
|
384
389
|
|
385
390
|
* Added Customer, CustomerGroup support
|
386
391
|
|
387
|
-
|
392
|
+
## Version 1.2.2
|
388
393
|
|
389
394
|
* Added ScriptTag support
|
390
395
|
|
391
|
-
|
396
|
+
## Version 1.2.1
|
392
397
|
|
393
398
|
* Allow abbreviated names for all commands like rails does, e.g. 'shopify c' instead of 'shopify console'
|
394
399
|
* Fix Variant to support accessing both nested variants with a product prefix as well as top level variants directly
|
395
400
|
* Add 'grande' to supported product image size variants
|
396
401
|
|
397
|
-
|
402
|
+
## Version 1.2.0
|
398
403
|
|
399
404
|
* Command-line interface
|
400
405
|
* Allow custom params when fetching a single Asset
|
401
406
|
|
402
|
-
|
407
|
+
## Version 1.1.3 (November 4, 2010)
|
403
408
|
|
404
409
|
* Add ProductSearchEngines resource
|
405
410
|
|
406
|
-
|
411
|
+
## Version 1.1.2 (October 20, 2010)
|
407
412
|
|
408
413
|
* Fix for users of ActiveResource 3.x
|
409
414
|
|
410
|
-
|
415
|
+
## Version 1.1.1 (October 5, 2010)
|
411
416
|
|
412
417
|
* Remove hard coded xml formatting in API calls
|
413
418
|
* Remove jeweler stuff
|
414
419
|
* Ruby 1.9 encoding fix
|
415
420
|
|
416
|
-
|
421
|
+
## Version 1.1.0 (September 24, 2010)
|
417
422
|
|
418
423
|
* Add new Events API for Shop, Order, Product, CustomCollection, SmartCollection, Page, Blog and Article
|
419
424
|
* Add new 'compact' product image size variant
|
420
425
|
* Rails 3 fix: attribute_accessors has to be explicitly included since activesupport 3.0.0
|
421
426
|
|
422
|
-
|
427
|
+
## Version 1.0.6
|
423
428
|
|
424
429
|
* Add metafields
|
425
430
|
* Add latest changes from Shopify including asset support, token validation and a common base class
|
426
431
|
|
427
|
-
|
432
|
+
## Version 1.0.0
|
428
433
|
|
429
434
|
* extracting ShopifyAPI from Shopify into Gem
|