shopify_api 10.0.0 → 10.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/.github/pull_request_template.md +2 -2
  3. data/.github/workflows/build.yml +1 -0
  4. data/CHANGELOG.md +227 -212
  5. data/Gemfile.lock +1 -1
  6. data/lib/shopify_api/admin_versions.rb +14 -9
  7. data/lib/shopify_api/context.rb +2 -2
  8. data/lib/shopify_api/rest/base.rb +73 -31
  9. data/lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb +3 -4
  10. data/lib/shopify_api/rest/resources/2021_07/article.rb +9 -2
  11. data/lib/shopify_api/rest/resources/2021_07/gift_card_adjustment.rb +1 -1
  12. data/lib/shopify_api/rest/resources/2021_07/variant.rb +4 -0
  13. data/lib/shopify_api/rest/resources/2021_10/abandoned_checkout.rb +3 -4
  14. data/lib/shopify_api/rest/resources/2021_10/article.rb +9 -2
  15. data/lib/shopify_api/rest/resources/2021_10/gift_card_adjustment.rb +1 -1
  16. data/lib/shopify_api/rest/resources/2021_10/variant.rb +4 -0
  17. data/lib/shopify_api/rest/resources/2022_01/abandoned_checkout.rb +3 -4
  18. data/lib/shopify_api/rest/resources/2022_01/article.rb +9 -2
  19. data/lib/shopify_api/rest/resources/2022_01/gift_card_adjustment.rb +1 -1
  20. data/lib/shopify_api/rest/resources/2022_01/variant.rb +4 -0
  21. data/lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb +3 -4
  22. data/lib/shopify_api/rest/resources/2022_04/article.rb +9 -2
  23. data/lib/shopify_api/rest/resources/2022_04/gift_card_adjustment.rb +1 -1
  24. data/lib/shopify_api/rest/resources/2022_04/variant.rb +4 -0
  25. data/lib/shopify_api/version.rb +1 -1
  26. metadata +2 -2
data/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ # Changelog
2
+
3
+ ## Unreleased
4
+
5
+ ## Version 10.0.1
6
+
7
+ ### Fixed
8
+
9
+ - [#919](https://github.com/Shopify/shopify_api/pull/919) Allow REST resources to configure a deny list of attributes to be excluded when saving
10
+ - [#920](https://github.com/Shopify/shopify_api/pull/920) Set all values received from the API response to REST resource objects, and allow setting / getting attributes with special characters (such as `?`)
11
+ - [#927](https://github.com/Shopify/shopify_api/pull/927) Fix the `ShopifyAPI::AdminVersions` module for backward compatibility
12
+
1
13
  ## Version 10.0.0
2
14
 
3
15
  - Major update to the library to provide _all_ essential functions needed for a Shopify app, supporting embedded apps with session tokens. See the [full list of changes](https://github.com/Shopify/shopify_api#breaking-change-notice-for-version-1000) here
@@ -8,496 +20,499 @@
8
20
 
9
21
  ## Version 9.5
10
22
 
11
- * [#883](https://github.com/Shopify/shopify_api/pull/883) Add support for Ruby 3.0
23
+ - [#883](https://github.com/Shopify/shopify_api/pull/883) Add support for Ruby 3.0
12
24
 
13
25
  ## Version 9.4.1
14
26
 
15
- * [#847](https://github.com/Shopify/shopify_api/pull/847) Update `create_permission_url` method to use grant_options
16
- * [#852](https://github.com/Shopify/shopify_api/pull/852) Bumping kramdown to fix a security vulnerability
27
+ - [#847](https://github.com/Shopify/shopify_api/pull/847) Update `create_permission_url` method to use grant_options
28
+ - [#852](https://github.com/Shopify/shopify_api/pull/852) Bumping kramdown to fix a security vulnerability
17
29
 
18
30
  ## Version 9.4.0
19
31
 
20
- * [#843](https://github.com/Shopify/shopify_api/pull/843) Introduce a new `access_scopes` attribute on the Session class.
21
- * Specifying this in the Session constructor is optional. By default, this attribute returns `nil`.
32
+ - [#843](https://github.com/Shopify/shopify_api/pull/843) Introduce a new `access_scopes` attribute on the Session class.
33
+ - Specifying this in the Session constructor is optional. By default, this attribute returns `nil`.
22
34
 
23
35
  ## Version 9.3.0
24
36
 
25
- * [#797](https://github.com/Shopify/shopify_api/pull/797) Release new Endpoint `fulfillment_order.open` and `fulfillment_order.reschedule`.
37
+ - [#797](https://github.com/Shopify/shopify_api/pull/797) Release new Endpoint `fulfillment_order.open` and `fulfillment_order.reschedule`.
26
38
 
27
- * [#818](https://github.com/Shopify/shopify_api/pull/818) Avoid depending on ActiveSupport in Sesssion class.
39
+ - [#818](https://github.com/Shopify/shopify_api/pull/818) Avoid depending on ActiveSupport in Sesssion class.
28
40
 
29
- * Freeze all string literals. This should have no impact unless your application is modifying ('monkeypatching') the internals of the library in an unusual way.
41
+ - Freeze all string literals. This should have no impact unless your application is modifying ('monkeypatching') the internals of the library in an unusual way.
30
42
 
31
- * [#802](https://github.com/Shopify/shopify_api/pull/802) Made `inventory_quantity` a read-only field in Variant
43
+ - [#802](https://github.com/Shopify/shopify_api/pull/802) Made `inventory_quantity` a read-only field in Variant
32
44
 
33
- * [#821](https://github.com/Shopify/shopify_api/pull/821) Add logging based on environment variable, move log subscriber out of `detailed_log_subscriber`.
45
+ - [#821](https://github.com/Shopify/shopify_api/pull/821) Add logging based on environment variable, move log subscriber out of `detailed_log_subscriber`.
34
46
  The `ActiveResource::DetailedLogSubscriber` no longer automatically attaches when the class is loaded. If you were previously relying on that behaviour, you'll now need to call `ActiveResource::DetailedLogSubscriber.attach_to(:active_resource_detailed)`. (If using the new `SHOPIFY_LOG_PATH` environment setting then this is handled for you).
35
47
 
36
- * Provide `ApiAccess` value object to encapsulate scope operations [#829](https://github.com/Shopify/shopify_api/pull/829)
48
+ - Provide `ApiAccess` value object to encapsulate scope operations [#829](https://github.com/Shopify/shopify_api/pull/829)
37
49
 
38
50
  ## Version 9.2.0
39
51
 
40
- * Removes the `shopify` binary which will be used by the Shopify CLI
52
+ - Removes the `shopify` binary which will be used by the Shopify CLI
41
53
 
42
54
  ## Version 9.1.1
43
55
 
44
- * Make cursor based pagination return relative uri's when fetching next and previous pages. [#726](https://github.com/Shopify/shopify_api/pull/726)
56
+ - Make cursor based pagination return relative uri's when fetching next and previous pages. [#726](https://github.com/Shopify/shopify_api/pull/726)
45
57
 
46
58
  ## Version 9.1.0
47
59
 
48
- * Implements equality operator on `Session` [#714](https://github.com/Shopify/shopify_api/pull/714)
60
+ - Implements equality operator on `Session` [#714](https://github.com/Shopify/shopify_api/pull/714)
49
61
 
50
62
  ## Version 9.0.4
51
63
 
52
- * Contains [#708](https://github.com/Shopify/shopify_api/pull/708) which is a revert for [#655](https://github.com/shopify/shopify_api/pull/655) due to the deprecated inventory parameters not being removed correctly in some cases
64
+ - Contains [#708](https://github.com/Shopify/shopify_api/pull/708) which is a revert for [#655](https://github.com/shopify/shopify_api/pull/655) due to the deprecated inventory parameters not being removed correctly in some cases
53
65
 
54
66
  ## Version 9.0.3
55
67
 
56
- * We now raise a `ShopifyAPI::ValidationException` exception when clients try to use `Product` and `Variant` with deprecated inventory-related fields in API version `2019-10` or later. [#655](https://github.com/shopify/shopify_api/pull/655) Deprecation and migration information can be found in the following documents:
57
- * [Product Variant REST API Reference](https://shopify.dev/docs/admin-api/rest/reference/products/product-variant)
58
- * [Migrate your app to support multiple locations](https://shopify.dev/tutorials/migrate-your-app-to-support-multiple-locations)
59
- * [Manage product inventory with the Admin API](https://shopify.dev/tutorials/manage-product-inventory-with-admin-api)
60
- * Added support for the Discount Code API batch endpoints [#701](https://github.com/shopify/shopify_api/pull/701)
61
- * [Create](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-01)
62
- * [Show](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-01)
63
- * [List](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01)
64
- * Fix issue in the README to explicitly say clients need to require the `shopify_api` gem [#700](https://github.com/Shopify/shopify_api/pull/700)
68
+ - We now raise a `ShopifyAPI::ValidationException` exception when clients try to use `Product` and `Variant` with deprecated inventory-related fields in API version `2019-10` or later. [#655](https://github.com/shopify/shopify_api/pull/655) Deprecation and migration information can be found in the following documents:
69
+ - [Product Variant REST API Reference](https://shopify.dev/docs/admin-api/rest/reference/products/product-variant)
70
+ - [Migrate your app to support multiple locations](https://shopify.dev/tutorials/migrate-your-app-to-support-multiple-locations)
71
+ - [Manage product inventory with the Admin API](https://shopify.dev/tutorials/manage-product-inventory-with-admin-api)
72
+ - Added support for the Discount Code API batch endpoints [#701](https://github.com/shopify/shopify_api/pull/701)
73
+ - [Create](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_create-2020-01)
74
+ - [Show](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_show-2020-01)
75
+ - [List](https://shopify.dev/docs/admin-api/rest/reference/discounts/discountcode#batch_discount_codes_index-2020-01)
76
+ - Fix issue in the README to explicitly say clients need to require the `shopify_api` gem [#700](https://github.com/Shopify/shopify_api/pull/700)
65
77
 
66
78
  ## Version 9.0.2
67
79
 
68
- * Added optional flag passed to `initialize_clients` to prevent from raising the `InvalidSchema` exception [#693](https://github.com/Shopify/shopify_api/pull/693)
80
+ - Added optional flag passed to `initialize_clients` to prevent from raising the `InvalidSchema` exception [#693](https://github.com/Shopify/shopify_api/pull/693)
69
81
 
70
82
  ## Version 9.0.1
71
83
 
72
- * Added warning message if API version used is unsupported or soon to be unsupported [#685](https://github.com/Shopify/shopify_api/pull/685)
73
- * Take into account "errors" messages from response body [#677](https://github.com/Shopify/shopify_api/pull/677)
84
+ - Added warning message if API version used is unsupported or soon to be unsupported [#685](https://github.com/Shopify/shopify_api/pull/685)
85
+ - Take into account "errors" messages from response body [#677](https://github.com/Shopify/shopify_api/pull/677)
74
86
 
75
87
  ## Version 9.0.0
76
88
 
77
- * 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.
89
+ - 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.
90
+
91
+ - Added options hash to create_permission_url and makes redirect_uri required [#670](https://github.com/Shopify/shopify_api/pull/670)
78
92
 
79
- * Added options hash to create_permission_url and makes redirect_uri required [#670](https://github.com/Shopify/shopify_api/pull/670)
93
+ - Release new Endpoint `fulfillment_order.locations_for_move` in 2020-01 REST API version [#669](https://github.com/Shopify/shopify_api/pull/669)
80
94
 
81
- * Release new Endpoint `fulfillment_order.locations_for_move` in 2020-01 REST API version [#669](https://github.com/Shopify/shopify_api/pull/669)
95
+ - Release new Endpoints for `fulfillment` in 2020-01 REST API version [#639](https://github.com/Shopify/shopify_api/pull/639):
82
96
 
83
- * Release new Endpoints for `fulfillment` in 2020-01 REST API version [#639](https://github.com/Shopify/shopify_api/pull/639):
84
- * `fulfillment.create` with `line_items_by_fulfillment_order`
85
- * `fulfillment.update_tracking`
86
- * `fulfillment.cancel`
97
+ - `fulfillment.create` with `line_items_by_fulfillment_order`
98
+ - `fulfillment.update_tracking`
99
+ - `fulfillment.cancel`
87
100
 
88
- * Release new Endpoints for `fulfillment_order` in 2020-01 REST API version [#637](https://github.com/Shopify/shopify_api/pull/637):
89
- * `fulfillment_order.fulfillment_request`
90
- * `fulfillment_order.fulfillment_request.accept`
91
- * `fulfillment_order.fulfillment_request.reject`
92
- * `fulfillment_order.cancellation_request`
93
- * `fulfillment_order.cancellation_request.accept`
94
- * `fulfillment_order.cancellation_request.reject`
101
+ - Release new Endpoints for `fulfillment_order` in 2020-01 REST API version [#637](https://github.com/Shopify/shopify_api/pull/637):
95
102
 
96
- * Release new Endpoints `fulfillment_order.move`, `fulfillment_order.cancel` and `fulfillment_order.close` in 2020-01 REST API version [#635](https://github.com/Shopify/shopify_api/pull/635)
103
+ - `fulfillment_order.fulfillment_request`
104
+ - `fulfillment_order.fulfillment_request.accept`
105
+ - `fulfillment_order.fulfillment_request.reject`
106
+ - `fulfillment_order.cancellation_request`
107
+ - `fulfillment_order.cancellation_request.accept`
108
+ - `fulfillment_order.cancellation_request.reject`
97
109
 
98
- * 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)
110
+ - Release new Endpoints `fulfillment_order.move`, `fulfillment_order.cancel` and `fulfillment_order.close` in 2020-01 REST API version [#635](https://github.com/Shopify/shopify_api/pull/635)
111
+
112
+ - 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)
99
113
 
100
114
  ## Version 8.1.0
101
115
 
102
- * Release 2020-01 REST ADMIN API VERSION [#656](https://github.com/Shopify/shopify_api/pull/656)
103
- * Release new Endpoint `collection.products` and `collection.find()` in 2020-01 REST API version [#657](https://github.com/Shopify/shopify_api/pull/657)
104
- * Enrich 4xx errors with error message from response body [#647](https://github.com/Shopify/shopify_api/pull/647)
105
- * Make relative cursor based pagination work across page loads [#625](https://github.com/Shopify/shopify_api/pull/625)
106
- * Small ruby compat fix [#623](https://github.com/Shopify/shopify_api/pull/623)
107
- * Small consistency change [#621](https://github.com/Shopify/shopify_api/pull/621)
116
+ - Release 2020-01 REST ADMIN API VERSION [#656](https://github.com/Shopify/shopify_api/pull/656)
117
+ - Release new Endpoint `collection.products` and `collection.find()` in 2020-01 REST API version [#657](https://github.com/Shopify/shopify_api/pull/657)
118
+ - Enrich 4xx errors with error message from response body [#647](https://github.com/Shopify/shopify_api/pull/647)
119
+ - Make relative cursor based pagination work across page loads [#625](https://github.com/Shopify/shopify_api/pull/625)
120
+ - Small ruby compat fix [#623](https://github.com/Shopify/shopify_api/pull/623)
121
+ - Small consistency change [#621](https://github.com/Shopify/shopify_api/pull/621)
108
122
 
109
123
  ## Version 8.0.0
110
124
 
111
- * Api Version changes [#600](https://github.com/Shopify/shopify_api/pull/600)
112
- * Remove static Api Version definitions.
113
- * Introduces Api Version lookup modes: `:define_on_unknown` and `:raise_on_unknown`
114
- * See [migration notes](README.md#-breaking-change-notice-for-version-800-)
115
- * `Session.valid?` checks that api_version `is_a?(ApiVersion)` instead of `present?`
116
- * `ApiVersion::NullVersion` cannot be instantiated and now has a `match?` method [#615](https://github.com/Shopify/shopify_api/pull/615/files)
117
- * 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)
125
+ - Api Version changes [#600](https://github.com/Shopify/shopify_api/pull/600)
126
+ - Remove static Api Version definitions.
127
+ - Introduces Api Version lookup modes: `:define_on_unknown` and `:raise_on_unknown`
128
+ - See [migration notes](README.md#-breaking-change-notice-for-version-800-)
129
+ - `Session.valid?` checks that api_version `is_a?(ApiVersion)` instead of `present?`
130
+ - `ApiVersion::NullVersion` cannot be instantiated and now has a `match?` method [#615](https://github.com/Shopify/shopify_api/pull/615/files)
131
+ - 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)
118
132
 
119
133
  ## Version 7.1.0
120
134
 
121
- * Add 2019-10 to known API versions
122
- * Add support for cursor pagination [#594](https://github.com/Shopify/shopify_api/pull/594) and
123
- [#611](https://github.com/Shopify/shopify_api/pull/611)
124
- * `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)
135
+ - Add 2019-10 to known API versions
136
+ - Add support for cursor pagination [#594](https://github.com/Shopify/shopify_api/pull/594) and
137
+ [#611](https://github.com/Shopify/shopify_api/pull/611)
138
+ - `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)
125
139
 
126
140
  ## Version 7.0.2
127
141
 
128
- * Add 2019-07 to known API versions.
142
+ - Add 2019-07 to known API versions.
129
143
 
130
144
  ## Version 7.0.1
131
145
 
132
- * Support passing version string to `ShopifyAPI::Base.api_version` [#563](https://github.com/Shopify/shopify_api/pull/563)
146
+ - Support passing version string to `ShopifyAPI::Base.api_version` [#563](https://github.com/Shopify/shopify_api/pull/563)
133
147
 
134
148
  ## Version 7.0.0
135
149
 
136
- * Removed support for `ActiveResouce` < `4.1`.
137
- * Removed `ShopifyAPI::Oauth`.
138
- * Added api version support, See [migration
139
- notes](README.md#-breaking-change-notice-for-version-700-)
140
- * Changed `ShopifyAPI::Session` method signatures from positional to keyword
141
- arguments, See [migration notes](README.md#-breaking-change-notice-for-version-700-)
142
- * Add support for newer call limit header `X-Shopify-Shop-Api-Call-Limit`.
143
- * Removed all Ping resources.
150
+ - Removed support for `ActiveResouce` < `4.1`.
151
+ - Removed `ShopifyAPI::Oauth`.
152
+ - Added api version support, See [migration
153
+ notes](README.md#-breaking-change-notice-for-version-700-)
154
+ - Changed `ShopifyAPI::Session` method signatures from positional to keyword
155
+ arguments, See [migration notes](README.md#-breaking-change-notice-for-version-700-)
156
+ - Add support for newer call limit header `X-Shopify-Shop-Api-Call-Limit`.
157
+ - Removed all Ping resources.
144
158
 
145
159
  ## Version 6.0.0
146
160
 
147
- * Removed undocumented `protocol` and `port` options from `ShopifyAPI::Session`.
161
+ - Removed undocumented `protocol` and `port` options from `ShopifyAPI::Session`.
148
162
 
149
163
  ## Version 5.2.4
150
164
 
151
- * Added `currency` parameter to `ShopifyAPI::Order#capture`. This parameter is required for apps that belong to the
152
- multi-currency beta program.
165
+ - Added `currency` parameter to `ShopifyAPI::Order#capture`. This parameter is required for apps that belong to the
166
+ multi-currency beta program.
153
167
 
154
168
  ## Version 5.2.3
155
169
 
156
- * Update delivery confirmation resource to delivery confirmation details resource.
170
+ - Update delivery confirmation resource to delivery confirmation details resource.
157
171
 
158
172
  ## Version 5.2.2
159
173
 
160
- * Add delivery confirmation endpoint to Ping resources.
174
+ - Add delivery confirmation endpoint to Ping resources.
161
175
 
162
176
  ## Version 5.2.1
163
177
 
164
- * Log warning when Shopify indicates deprecated API call was performed
178
+ - Log warning when Shopify indicates deprecated API call was performed
165
179
 
166
180
  ## Version 5.2.0
167
181
 
168
- * Added `ShopifyAPI::Currency` to fetch list of supported currencies on a shop
169
- * Added `ShopifyAPI::TenderTransaction` to fetch list of transactions on a shop
170
- * Fixed bug with X-Shopify-Checkout-Version on ShopifyAPI::Checkout header being applied to all requests
182
+ - Added `ShopifyAPI::Currency` to fetch list of supported currencies on a shop
183
+ - Added `ShopifyAPI::TenderTransaction` to fetch list of transactions on a shop
184
+ - Fixed bug with X-Shopify-Checkout-Version on ShopifyAPI::Checkout header being applied to all requests
171
185
 
172
186
  ## Version 5.1.0
173
187
 
174
- * Added `ShopifyAPI::Publications`
175
- * Added `ShopifyAPI::ProductPublications`
176
- * Added `ShopifyAPI::CollectionPublications`
177
- * Added support for new collection products endpoint from `ShopifyAPI::Collection#products`
188
+ - Added `ShopifyAPI::Publications`
189
+ - Added `ShopifyAPI::ProductPublications`
190
+ - Added `ShopifyAPI::CollectionPublications`
191
+ - Added support for new collection products endpoint from `ShopifyAPI::Collection#products`
178
192
 
179
193
  ## Version 5.0.0
180
194
 
181
- * Breaking change: `ShopifyAPI::Checkout` now maps to the Checkout API, rather than the Abandoned Checkouts API
182
- * See the README for more details
183
- * Added `ShopifyAPI::AbandonedCheckout`
184
- * Added support for X-Shopify-Checkout-Version header on `ShopifyAPI::Checkout`
185
- * Added `ShopifyAPI::ShippingRate`
186
- * Added `ShopifyAPI::Payment`
187
- * Added support for `Checkout::complete` endpoint
188
- * Fixed session handling support for Rails 5.2.1
195
+ - Breaking change: `ShopifyAPI::Checkout` now maps to the Checkout API, rather than the Abandoned Checkouts API
196
+ - See the README for more details
197
+ - Added `ShopifyAPI::AbandonedCheckout`
198
+ - Added support for X-Shopify-Checkout-Version header on `ShopifyAPI::Checkout`
199
+ - Added `ShopifyAPI::ShippingRate`
200
+ - Added `ShopifyAPI::Payment`
201
+ - Added support for `Checkout::complete` endpoint
202
+ - Fixed session handling support for Rails 5.2.1
189
203
 
190
204
  ## Version 4.13.0
191
- * Added `ShopifyAPI::ApiPermission` resource for uninstalling an application
192
- * Added a deprecation warning to `ShopifyAPI::OAuth`
205
+
206
+ - Added `ShopifyAPI::ApiPermission` resource for uninstalling an application
207
+ - Added a deprecation warning to `ShopifyAPI::OAuth`
193
208
 
194
209
  ## Version 4.12.0
195
210
 
196
- * Added support for the GraphQL API
211
+ - Added support for the GraphQL API
197
212
 
198
213
  ## Version 4.11.0
199
214
 
200
- * Added `ShopifyAPI::InventoryItem`
201
- * Added `ShopifyAPI::InventoryLevel`
202
- * Added `#inventory_levels` method to `ShopifyAPI::Location`
215
+ - Added `ShopifyAPI::InventoryItem`
216
+ - Added `ShopifyAPI::InventoryLevel`
217
+ - Added `#inventory_levels` method to `ShopifyAPI::Location`
203
218
 
204
219
  ## Version 4.10.0
205
220
 
206
- * Added `ShopifyAPI::AccessScope`
221
+ - Added `ShopifyAPI::AccessScope`
207
222
 
208
223
  ## Version 4.9.1
209
224
 
210
- * Fix a bug with custom properties for orders
225
+ - Fix a bug with custom properties for orders
211
226
 
212
227
  ## Version 4.9.0
213
228
 
214
- * Added `ShopifyAPI::PriceRule`
215
- * Added `ShopifyAPI::DiscountCode`
229
+ - Added `ShopifyAPI::PriceRule`
230
+ - Added `ShopifyAPI::DiscountCode`
216
231
 
217
232
  ## Version 4.8.0
218
233
 
219
- * Added `add_engagements` to `ShopifyAPI::MarketingEvent`
234
+ - Added `add_engagements` to `ShopifyAPI::MarketingEvent`
220
235
 
221
236
  ## Version 4.7.1
222
237
 
223
- * Added support for URL parameter (e.g. limit & page) to ShopifyAPI::Metafields
224
- * Added support for URL parameter (e.g. limit & page) to metafield operator in ShopifyAPI::Shop
238
+ - Added support for URL parameter (e.g. limit & page) to ShopifyAPI::Metafields
239
+ - Added support for URL parameter (e.g. limit & page) to metafield operator in ShopifyAPI::Shop
225
240
 
226
241
  ## Version 4.7.0
227
242
 
228
- * Removed the mandatory `application_id` parameter from `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
229
- * Fixed a bug related to the non-standard primary key for `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
243
+ - Removed the mandatory `application_id` parameter from `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
244
+ - Fixed a bug related to the non-standard primary key for `ShopifyAPI::ProductListing` and `ShopifyAPI::CollectionListing`
230
245
 
231
246
  ## Version 4.6.0
232
247
 
233
- * Added `ShopifyAPI::Report`
248
+ - Added `ShopifyAPI::Report`
234
249
 
235
250
  ## Version 4.5.0
236
251
 
237
- * Added `ShopifyAPI::MarketingEvent`
252
+ - Added `ShopifyAPI::MarketingEvent`
238
253
 
239
254
  ## Version 4.4.0
240
255
 
241
- * Added `ShopifyAPI::CustomerInvite`
242
- * Support for Customer#send_invite endpoint
256
+ - Added `ShopifyAPI::CustomerInvite`
257
+ - Support for Customer#send_invite endpoint
243
258
 
244
259
  ## Version 4.3.8
245
260
 
246
- * Added `ShopifyAPI::ResourceFeedback`
261
+ - Added `ShopifyAPI::ResourceFeedback`
247
262
 
248
263
  ## Version 4.3.7
249
264
 
250
- * Added support for `complete` in `ShopifyAPI::DraftOrder`
265
+ - Added support for `complete` in `ShopifyAPI::DraftOrder`
251
266
 
252
267
  ## Version 4.3.6
253
268
 
254
- * Fixed the `customer_saved_search_id` param in `ShopifyAPI::CustomerSavedSearch#customers`.
269
+ - Fixed the `customer_saved_search_id` param in `ShopifyAPI::CustomerSavedSearch#customers`.
255
270
 
256
271
  ## Version 4.3.5
257
272
 
258
- * Added support for online mode access tokens, token expiry, and associated_user information.
259
- * Added `ShopifyAPI::DraftOrder`
260
- * Added `ShopifyAPI::DraftOrderInvoice`
273
+ - Added support for online mode access tokens, token expiry, and associated_user information.
274
+ - Added `ShopifyAPI::DraftOrder`
275
+ - Added `ShopifyAPI::DraftOrderInvoice`
261
276
 
262
277
  ## Version 4.3.4
263
278
 
264
- * Added `ShopifyAPI::ProductListing`
265
- * Added `ShopifyAPI::CollectionListing`
279
+ - Added `ShopifyAPI::ProductListing`
280
+ - Added `ShopifyAPI::CollectionListing`
266
281
 
267
282
  ## Version 4.3.3
268
283
 
269
- * Added `ShopifyAPI::StorefrontAccessToken`
284
+ - Added `ShopifyAPI::StorefrontAccessToken`
270
285
 
271
286
  ## Version 4.3.2
272
287
 
273
- * Relax Ruby version requirement to >= `2.0`
288
+ - Relax Ruby version requirement to >= `2.0`
274
289
 
275
290
  ## Version 4.3.1
276
291
 
277
- * Support for ShopifyAPI::ApplicationCredit
292
+ - Support for ShopifyAPI::ApplicationCredit
278
293
 
279
294
  ## Version 4.3.0
280
295
 
281
- * Require Ruby >= `2.3.0`
282
- * Use inheritance instead of the deprecated Rails `Module#alias_method_chain`
296
+ - Require Ruby >= `2.3.0`
297
+ - Use inheritance instead of the deprecated Rails `Module#alias_method_chain`
283
298
 
284
299
  ## Version 4.2.2
285
300
 
286
- * Support for AccessToken#delegate endpoint
301
+ - Support for AccessToken#delegate endpoint
287
302
 
288
303
  ## Version 4.2.1
289
304
 
290
- * Support for Users and Discounts (Shopify Plus only)
291
- * Adds Customer#account_activation_url method
292
- * Adds ability to open a fulfillment.
305
+ - Support for Users and Discounts (Shopify Plus only)
306
+ - Adds Customer#account_activation_url method
307
+ - Adds ability to open a fulfillment.
293
308
 
294
309
  ## Version 4.2.0
295
310
 
296
- * Threadsafety is now compatible with the latest ActiveResource master
311
+ - Threadsafety is now compatible with the latest ActiveResource master
297
312
 
298
313
  ## Version 4.1.1
299
314
 
300
- * Added explicit 90 second timeout to `ShopifyAPI::Base`
315
+ - Added explicit 90 second timeout to `ShopifyAPI::Base`
301
316
 
302
317
  ## Version 4.0.7
303
318
 
304
- * Added `ShippingAPI::ShippingZone`
319
+ - Added `ShippingAPI::ShippingZone`
305
320
 
306
321
  ## Version 4.0.6
307
322
 
308
- * Replaced `cancelled` with `expired` in `ShopifyAPI::ApplicationCharge`
323
+ - Replaced `cancelled` with `expired` in `ShopifyAPI::ApplicationCharge`
309
324
 
310
325
  ## Version 4.0.5
311
326
 
312
- * Added `pending`, `cancelled`, `accepted`, `declined` helper methods to `ShopifyAPI::ApplicationCharge`
327
+ - Added `pending`, `cancelled`, `accepted`, `declined` helper methods to `ShopifyAPI::ApplicationCharge`
313
328
 
314
329
  ## Version 4.0.4
315
330
 
316
- * Fixed truthiness for order cancellations. Requests are now sent in the request body and as JSON
331
+ - Fixed truthiness for order cancellations. Requests are now sent in the request body and as JSON
317
332
 
318
333
  ## Version 4.0.3
319
334
 
320
- * Fixed hmac signature validation for params with delimiters (`&`, `=` or `%`)
335
+ - Fixed hmac signature validation for params with delimiters (`&`, `=` or `%`)
321
336
 
322
337
  ## Version 4.0.2
323
338
 
324
- * Verify that the shop domain is a subdomain of .myshopify.com which creating the session
339
+ - Verify that the shop domain is a subdomain of .myshopify.com which creating the session
325
340
 
326
341
  ## Version 4.0.1
327
342
 
328
- * Added `ShopifyAPI::OAuth.revoke` for easy token revocation.
343
+ - Added `ShopifyAPI::OAuth.revoke` for easy token revocation.
329
344
 
330
345
  ## Version 3.2.6
331
346
 
332
- * Fixed CustomerSavedSearch#customers method to now correctly return only relevant customers
347
+ - Fixed CustomerSavedSearch#customers method to now correctly return only relevant customers
333
348
 
334
349
  ## Version 3.2.5
335
350
 
336
- * More useful error messages for activating nil sessions
337
- * Add tests for commonly deleted objects, and metafield tests, fix naming error in order_risk_test.rb
351
+ - More useful error messages for activating nil sessions
352
+ - Add tests for commonly deleted objects, and metafield tests, fix naming error in order_risk_test.rb
338
353
 
339
354
  ## Version 3.2.4
340
355
 
341
- * No API changes
356
+ - No API changes
342
357
 
343
358
  ## Version 3.2.3
344
359
 
345
- * Added pry to the CLI
360
+ - Added pry to the CLI
346
361
 
347
362
  ## Version 3.2.2
348
363
 
349
- * Temporary fix for the CLI
350
- * Add a specific exception for signature validation failures
364
+ - Temporary fix for the CLI
365
+ - Add a specific exception for signature validation failures
351
366
 
352
367
  ## Version 3.2.1
353
368
 
354
- * Added CarrierService resource
355
- * Added optionally using threadsafe ActiveResource (see readme)
356
- * Fixed bug in validate_signature
369
+ - Added CarrierService resource
370
+ - Added optionally using threadsafe ActiveResource (see readme)
371
+ - Fixed bug in validate_signature
357
372
 
358
373
  ## Version 3.2.0
359
374
 
360
- * in Session::request_token params is no longer optional, you must pass all the params and the method will now extract the code
361
- * Fixed JSON errors handling (#103)
362
- * Fixed compatibility with Ruby 2.1.x (#83)
363
- * Fixed getting parent ID from nested resources like Variants (#44)
364
- * Cleaned up compatibility with ActiveResource 4.0.x
365
- * Added OrderRisk resource
366
- * Added FulfillmentService resource
367
- * Removed discontinued ProductSearchEngine resource
368
- * Added convenience method Customer#search (#45)
375
+ - in Session::request_token params is no longer optional, you must pass all the params and the method will now extract the code
376
+ - Fixed JSON errors handling (#103)
377
+ - Fixed compatibility with Ruby 2.1.x (#83)
378
+ - Fixed getting parent ID from nested resources like Variants (#44)
379
+ - Cleaned up compatibility with ActiveResource 4.0.x
380
+ - Added OrderRisk resource
381
+ - Added FulfillmentService resource
382
+ - Removed discontinued ProductSearchEngine resource
383
+ - Added convenience method Customer#search (#45)
369
384
 
370
385
  ## Version 3.1.8
371
386
 
372
- * Expose `index` and `show` actions of `Location`
373
- * Added create_permission_url and request_token helper methods
374
- * Edited the readme to better describe the getting started procedure
387
+ - Expose `index` and `show` actions of `Location`
388
+ - Added create_permission_url and request_token helper methods
389
+ - Edited the readme to better describe the getting started procedure
375
390
 
376
391
  ## Version 3.1.7
377
392
 
378
- * Expose `authors` and `tags` action on Article
393
+ - Expose `authors` and `tags` action on Article
379
394
 
380
395
  ## Version 3.1.6
381
396
 
382
- * Add LineItem::Property resource
397
+ - Add LineItem::Property resource
383
398
 
384
399
  ## Version 3.1.5
385
400
 
386
- * Expose `orders` action on Customer
401
+ - Expose `orders` action on Customer
387
402
 
388
403
  ## Version 3.1.3
389
404
 
390
- * Expose `complete` action on Fulfillment
405
+ - Expose `complete` action on Fulfillment
391
406
 
392
407
  ## Version 3.1.2
393
408
 
394
- * Includes port in domain URI (when other than http/80 or https/443)
395
- * Adds access to CustomerSavedSearch
396
- * Adds resources: Order::DefaultAddress, Client::ClientDetails, Announcement
397
- * Allows access to Articles without a blog_id
398
- * Moves encode and as_json overrides to ShopifyAPI::Base scope
399
- * Exposes the `order` action in SmartCollection for general use
409
+ - Includes port in domain URI (when other than http/80 or https/443)
410
+ - Adds access to CustomerSavedSearch
411
+ - Adds resources: Order::DefaultAddress, Client::ClientDetails, Announcement
412
+ - Allows access to Articles without a blog_id
413
+ - Moves encode and as_json overrides to ShopifyAPI::Base scope
414
+ - Exposes the `order` action in SmartCollection for general use
400
415
 
401
416
  ## Version 3.0.3
402
417
 
403
- * Add a `customers` helper method to the CustomerGroup resource
418
+ - Add a `customers` helper method to the CustomerGroup resource
404
419
 
405
420
  ## Version 3.0.2
406
421
 
407
- * Brevity in require statements
422
+ - Brevity in require statements
408
423
 
409
424
  ## Version 3.0.1
410
425
 
411
- * Fix saving nested resources in ActiveResource 3.1+
426
+ - Fix saving nested resources in ActiveResource 3.1+
412
427
 
413
428
  ## Version 3.0.0
414
429
 
415
- * Added support for OAuth Authentication
416
- * Removal of support for Legacy Authentication
417
- * Added Cart resource
430
+ - Added support for OAuth Authentication
431
+ - Removal of support for Legacy Authentication
432
+ - Added Cart resource
418
433
 
419
434
  ## Version 2.3.0
420
435
 
421
- * Fix double root bug with ActiveSupport 3.2.0
422
- * Add metafields methods on Customer resource
423
- * Fix prefix_options on assets returned from Asset.find
436
+ - Fix double root bug with ActiveSupport 3.2.0
437
+ - Add metafields methods on Customer resource
438
+ - Fix prefix_options on assets returned from Asset.find
424
439
 
425
440
  ## Version 2.2.0
426
441
 
427
- * Fix issues with resources that have both direct and namespaced routes
428
- * Added detailed logger to help with debugging ActiveResource
429
- requests/responses
430
- * Add fulfillment#cancel
442
+ - Fix issues with resources that have both direct and namespaced routes
443
+ - Added detailed logger to help with debugging ActiveResource
444
+ requests/responses
445
+ - Add fulfillment#cancel
431
446
 
432
447
  ## Version 2.1.0
433
448
 
434
- * Fix JSON errors handling
435
- * Remove global limit from ShopifyAPI::Limits
449
+ - Fix JSON errors handling
450
+ - Remove global limit from ShopifyAPI::Limits
436
451
 
437
452
  ## Version 2.0.0
438
453
 
439
- * 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
440
- * Refactored resources into their own source files
441
- * Added API limits functionality
442
- * Patched ActiveResource issue with roots in JSON
443
- * Added pending, cancelled, accepted, and declined convenience methods to ShopifyAPI::RecurringApplicationCharge
444
- * ShopifyAPI::Session#temp now available as a convenience method to support temporarily switching to other shops when making calls
445
- * Fixes to `shopify console` CLI tool
454
+ - 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
455
+ - Refactored resources into their own source files
456
+ - Added API limits functionality
457
+ - Patched ActiveResource issue with roots in JSON
458
+ - Added pending, cancelled, accepted, and declined convenience methods to ShopifyAPI::RecurringApplicationCharge
459
+ - ShopifyAPI::Session#temp now available as a convenience method to support temporarily switching to other shops when making calls
460
+ - Fixes to `shopify console` CLI tool
446
461
 
447
462
  ## Version 1.2.5
448
463
 
449
- * Fix for Article#comments
464
+ - Fix for Article#comments
450
465
 
451
466
  ## Version 1.2.4
452
467
 
453
- * Added Article#comments
454
- * Added Order#cancel
455
- * Added Comment#restore, #not_spam
468
+ - Added Article#comments
469
+ - Added Order#cancel
470
+ - Added Comment#restore, #not_spam
456
471
 
457
472
  ## Version 1.2.3
458
473
 
459
- * Added Customer, CustomerGroup support
474
+ - Added Customer, CustomerGroup support
460
475
 
461
476
  ## Version 1.2.2
462
477
 
463
- * Added ScriptTag support
478
+ - Added ScriptTag support
464
479
 
465
480
  ## Version 1.2.1
466
481
 
467
- * Allow abbreviated names for all commands like rails does, e.g. 'shopify c' instead of 'shopify console'
468
- * Fix Variant to support accessing both nested variants with a product prefix as well as top level variants directly
469
- * Add 'grande' to supported product image size variants
482
+ - Allow abbreviated names for all commands like rails does, e.g. 'shopify c' instead of 'shopify console'
483
+ - Fix Variant to support accessing both nested variants with a product prefix as well as top level variants directly
484
+ - Add 'grande' to supported product image size variants
470
485
 
471
486
  ## Version 1.2.0
472
487
 
473
- * Command-line interface
474
- * Allow custom params when fetching a single Asset
488
+ - Command-line interface
489
+ - Allow custom params when fetching a single Asset
475
490
 
476
491
  ## Version 1.1.3 (November 4, 2010)
477
492
 
478
- * Add ProductSearchEngines resource
493
+ - Add ProductSearchEngines resource
479
494
 
480
495
  ## Version 1.1.2 (October 20, 2010)
481
496
 
482
- * Fix for users of ActiveResource 3.x
497
+ - Fix for users of ActiveResource 3.x
483
498
 
484
499
  ## Version 1.1.1 (October 5, 2010)
485
500
 
486
- * Remove hard coded xml formatting in API calls
487
- * Remove jeweler stuff
488
- * Ruby 1.9 encoding fix
501
+ - Remove hard coded xml formatting in API calls
502
+ - Remove jeweler stuff
503
+ - Ruby 1.9 encoding fix
489
504
 
490
505
  ## Version 1.1.0 (September 24, 2010)
491
506
 
492
- * Add new Events API for Shop, Order, Product, CustomCollection, SmartCollection, Page, Blog and Article
493
- * Add new 'compact' product image size variant
494
- * Rails 3 fix: attribute_accessors has to be explicitly included since activesupport 3.0.0
507
+ - Add new Events API for Shop, Order, Product, CustomCollection, SmartCollection, Page, Blog and Article
508
+ - Add new 'compact' product image size variant
509
+ - Rails 3 fix: attribute_accessors has to be explicitly included since activesupport 3.0.0
495
510
 
496
511
  ## Version 1.0.6
497
512
 
498
- * Add metafields
499
- * Add latest changes from Shopify including asset support, token validation and a common base class
513
+ - Add metafields
514
+ - Add latest changes from Shopify including asset support, token validation and a common base class
500
515
 
501
516
  ## Version 1.0.0
502
517
 
503
- * extracting ShopifyAPI from Shopify into Gem
518
+ - extracting ShopifyAPI from Shopify into Gem