shopify_api 4.9.0 → 9.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.github/CODEOWNERS +1 -0
- data/.github/ISSUE_TEMPLATE.md +36 -0
- data/.github/probots.yml +2 -0
- data/.github/workflows/build.yml +41 -0
- data/.gitignore +5 -1
- data/.rubocop.yml +28 -0
- data/.rubocop_todo.yml +75 -0
- data/CHANGELOG.md +491 -0
- data/CONTRIBUTING.md +1 -1
- data/Gemfile +6 -2
- data/Gemfile.lock +151 -0
- data/Gemfile_ar41 +5 -0
- data/Gemfile_ar50 +5 -0
- data/Gemfile_ar51 +5 -0
- data/Gemfile_ar_master +0 -1
- data/README.md +492 -100
- data/RELEASING +10 -9
- data/Rakefile +21 -5
- data/SECURITY.md +59 -0
- data/docker-compose.yml +13 -0
- data/docs/_config.yml +1 -0
- data/docs/_includes/footer.html +28 -0
- data/docs/_includes/head.html +28 -0
- data/docs/_layouts/index.html +57 -0
- data/docs/graphql.md +241 -0
- data/docs/index.md +639 -0
- data/lib/active_resource/connection_ext.rb +1 -0
- data/lib/active_resource/detailed_log_subscriber.rb +43 -7
- data/lib/active_resource/json_errors.rb +8 -2
- data/lib/shopify_api.rb +16 -6
- data/lib/shopify_api/api_access.rb +57 -0
- data/lib/shopify_api/api_version.rb +206 -0
- data/lib/shopify_api/connection.rb +7 -4
- data/lib/shopify_api/countable.rb +3 -2
- data/lib/shopify_api/disable_prefix_check.rb +31 -0
- data/lib/shopify_api/events.rb +2 -1
- data/lib/shopify_api/graphql.rb +103 -0
- data/lib/shopify_api/graphql/http_client.rb +22 -0
- data/lib/shopify_api/graphql/railtie.rb +17 -0
- data/lib/shopify_api/graphql/task.rake +100 -0
- data/lib/shopify_api/limits.rb +9 -9
- data/lib/shopify_api/message_enricher.rb +25 -0
- data/lib/shopify_api/meta.rb +14 -0
- data/lib/shopify_api/metafields.rb +5 -4
- data/lib/shopify_api/paginated_collection.rb +69 -0
- data/lib/shopify_api/pagination_link_headers.rb +34 -0
- data/lib/shopify_api/resources.rb +3 -1
- data/lib/shopify_api/resources/abandoned_checkout.rb +7 -0
- data/lib/shopify_api/resources/access_scope.rb +10 -0
- data/lib/shopify_api/resources/access_token.rb +1 -0
- data/lib/shopify_api/resources/address.rb +1 -0
- data/lib/shopify_api/resources/announcement.rb +2 -1
- data/lib/shopify_api/resources/api_permission.rb +9 -0
- data/lib/shopify_api/resources/application_charge.rb +1 -0
- data/lib/shopify_api/resources/application_credit.rb +1 -0
- data/lib/shopify_api/resources/array_base.rb +13 -0
- data/lib/shopify_api/resources/article.rb +3 -2
- data/lib/shopify_api/resources/asset.rb +28 -23
- data/lib/shopify_api/resources/assigned_fulfillment_order.rb +16 -0
- data/lib/shopify_api/resources/base.rb +101 -24
- data/lib/shopify_api/resources/billing_address.rb +2 -1
- data/lib/shopify_api/resources/blog.rb +2 -1
- data/lib/shopify_api/resources/carrier_service.rb +1 -0
- data/lib/shopify_api/resources/cart.rb +2 -1
- data/lib/shopify_api/resources/checkout.rb +27 -1
- data/lib/shopify_api/resources/collect.rb +2 -0
- data/lib/shopify_api/resources/collection.rb +14 -0
- data/lib/shopify_api/resources/collection_listing.rb +11 -1
- data/lib/shopify_api/resources/collection_publication.rb +10 -0
- data/lib/shopify_api/resources/comment.rb +20 -5
- data/lib/shopify_api/resources/country.rb +1 -0
- data/lib/shopify_api/resources/currency.rb +6 -0
- data/lib/shopify_api/resources/custom_collection.rb +7 -6
- data/lib/shopify_api/resources/customer.rb +2 -1
- data/lib/shopify_api/resources/customer_group.rb +1 -0
- data/lib/shopify_api/resources/{customer_invite_message.rb → customer_invite.rb} +1 -0
- data/lib/shopify_api/resources/customer_saved_search.rb +4 -1
- data/lib/shopify_api/resources/discount_code.rb +1 -0
- data/lib/shopify_api/resources/discount_code_batch.rb +34 -0
- data/lib/shopify_api/resources/draft_order.rb +1 -0
- data/lib/shopify_api/resources/draft_order_invoice.rb +1 -0
- data/lib/shopify_api/resources/event.rb +2 -0
- data/lib/shopify_api/resources/fulfillment.rb +46 -3
- data/lib/shopify_api/resources/fulfillment_event.rb +2 -1
- data/lib/shopify_api/resources/fulfillment_order.rb +151 -0
- data/lib/shopify_api/resources/fulfillment_order_locations_for_move.rb +5 -0
- data/lib/shopify_api/resources/fulfillment_request.rb +1 -0
- data/lib/shopify_api/resources/fulfillment_service.rb +1 -0
- data/lib/shopify_api/resources/fulfillment_v2.rb +21 -0
- data/lib/shopify_api/resources/gift_card.rb +1 -0
- data/lib/shopify_api/resources/image.rb +4 -3
- data/lib/shopify_api/resources/inventory_item.rb +6 -0
- data/lib/shopify_api/resources/inventory_level.rb +54 -0
- data/lib/shopify_api/resources/line_item.rb +10 -1
- data/lib/shopify_api/resources/location.rb +4 -0
- data/lib/shopify_api/resources/marketing_event.rb +3 -0
- data/lib/shopify_api/resources/metafield.rb +2 -0
- data/lib/shopify_api/resources/note_attribute.rb +1 -0
- data/lib/shopify_api/resources/option.rb +1 -0
- data/lib/shopify_api/resources/order.rb +25 -5
- data/lib/shopify_api/resources/order_risk.rb +1 -0
- data/lib/shopify_api/resources/page.rb +1 -0
- data/lib/shopify_api/resources/payment.rb +7 -0
- data/lib/shopify_api/resources/payment_details.rb +1 -0
- data/lib/shopify_api/resources/ping.rb +3 -0
- data/lib/shopify_api/resources/policy.rb +1 -0
- data/lib/shopify_api/resources/price_rule.rb +1 -1
- data/lib/shopify_api/resources/product.rb +33 -7
- data/lib/shopify_api/resources/product_listing.rb +9 -1
- data/lib/shopify_api/resources/product_publication.rb +10 -0
- data/lib/shopify_api/resources/province.rb +1 -0
- data/lib/shopify_api/resources/publication.rb +5 -0
- data/lib/shopify_api/resources/receipt.rb +1 -0
- data/lib/shopify_api/resources/recurring_application_charge.rb +4 -1
- data/lib/shopify_api/resources/redirect.rb +1 -0
- data/lib/shopify_api/resources/refund.rb +6 -4
- data/lib/shopify_api/resources/report.rb +1 -0
- data/lib/shopify_api/resources/resource_feedback.rb +1 -1
- data/lib/shopify_api/resources/rule.rb +1 -0
- data/lib/shopify_api/resources/script_tag.rb +1 -0
- data/lib/shopify_api/resources/shipping_address.rb +1 -0
- data/lib/shopify_api/resources/shipping_line.rb +2 -1
- data/lib/shopify_api/resources/shipping_rate.rb +7 -0
- data/lib/shopify_api/resources/shipping_zone.rb +1 -0
- data/lib/shopify_api/resources/shop.rb +10 -7
- data/lib/shopify_api/resources/smart_collection.rb +3 -3
- data/lib/shopify_api/resources/storefront_access_token.rb +1 -0
- data/lib/shopify_api/resources/tax_line.rb +1 -0
- data/lib/shopify_api/resources/tax_service.rb +1 -0
- data/lib/shopify_api/resources/tender_transaction.rb +6 -0
- data/lib/shopify_api/resources/theme.rb +1 -0
- data/lib/shopify_api/resources/transaction.rb +1 -0
- data/lib/shopify_api/resources/usage_charge.rb +1 -0
- data/lib/shopify_api/resources/user.rb +1 -0
- data/lib/shopify_api/resources/variant.rb +35 -0
- data/lib/shopify_api/resources/webhook.rb +1 -0
- data/lib/shopify_api/session.rb +109 -45
- data/lib/shopify_api/version.rb +2 -1
- data/lib/verify_docs.rb +8 -0
- data/service.yml +8 -0
- data/shopify_api.gemspec +19 -8
- data/test/abandoned_checkouts_test.rb +29 -0
- data/test/access_scope_test.rb +23 -0
- data/test/access_token_test.rb +6 -5
- data/test/active_resource/json_errors_test.rb +6 -6
- data/test/api_access_test.rb +153 -0
- data/test/api_permission_test.rb +9 -0
- data/test/api_version_test.rb +157 -0
- data/test/application_charge_test.rb +30 -27
- data/test/application_credit_test.rb +10 -9
- data/test/article_test.rb +34 -35
- data/test/asset_test.rb +14 -6
- data/test/assigned_fulfillment_order_test.rb +78 -0
- data/test/base_test.rb +147 -59
- data/test/blog_test.rb +4 -3
- data/test/carrier_service_test.rb +7 -6
- data/test/cart_test.rb +2 -1
- data/test/checkouts_test.rb +72 -4
- data/test/collect_test.rb +4 -3
- data/test/collection_listing_test.rb +56 -13
- data/test/collection_publication_test.rb +40 -0
- data/test/collection_test.rb +50 -0
- data/test/countable_test.rb +3 -2
- data/test/currency_test.rb +21 -0
- data/test/custom_collection_test.rb +4 -3
- data/test/customer_saved_search_test.rb +18 -8
- data/test/customer_test.rb +22 -14
- data/test/detailed_log_subscriber_test.rb +113 -19
- data/test/discount_code_batch_test.rb +41 -0
- data/test/discount_code_test.rb +22 -16
- data/test/draft_order_test.rb +68 -52
- data/test/fixtures/abandoned_checkout.json +184 -0
- data/test/fixtures/abandoned_checkouts.json +186 -0
- data/test/fixtures/access_scopes.json +10 -0
- data/test/fixtures/api_versions.json +38 -0
- data/test/fixtures/apis.json +42 -0
- data/test/fixtures/assigned_fulfillment_orders.json +80 -0
- data/test/fixtures/checkout.json +160 -0
- data/test/fixtures/checkouts.json +25 -49
- data/test/fixtures/collection.json +17 -0
- data/test/fixtures/collection_listing_product_ids2.json +1 -0
- data/test/fixtures/collection_products.json +47 -0
- data/test/fixtures/collection_publication.json +11 -0
- data/test/fixtures/collection_publications.json +13 -0
- data/test/fixtures/currencies.json +25 -0
- data/test/fixtures/discount_code_batch.json +14 -0
- data/test/fixtures/discount_code_batch_discount_codes.json +21 -0
- data/test/fixtures/fulfillment_order.json +39 -0
- data/test/fixtures/fulfillment_order_locations_for_move.json +18 -0
- data/test/fixtures/fulfillment_orders.json +80 -0
- data/test/fixtures/fulfillments.json +53 -0
- data/test/fixtures/graphql/2019-10.json +1083 -0
- data/test/fixtures/graphql/dummy_schema.rb +16 -0
- data/test/fixtures/graphql/unstable.json +1083 -0
- data/test/fixtures/inventory_level.json +7 -0
- data/test/fixtures/inventory_levels.json +24 -0
- data/test/fixtures/order_with_properties.json +373 -0
- data/test/fixtures/payment.json +7 -0
- data/test/fixtures/payments.json +9 -0
- data/test/fixtures/ping/conversation.json +1 -0
- data/test/fixtures/ping/failed_delivery_confirmation.json +1 -0
- data/test/fixtures/ping/message.json +1 -0
- data/test/fixtures/ping/successful_delivery_confirmation.json +1 -0
- data/test/fixtures/product_listing_product_ids.json +1 -1
- data/test/fixtures/product_listing_product_ids2.json +1 -0
- data/test/fixtures/product_publication.json +11 -0
- data/test/fixtures/product_publications.json +13 -0
- data/test/fixtures/publications.json +9 -0
- data/test/fixtures/shipping_rates.json +12 -0
- data/test/fixtures/smart_collection_products.json +155 -0
- data/test/fixtures/tender_transactions.json +52 -0
- data/test/fulfillment_event_test.rb +31 -26
- data/test/fulfillment_order_test.rb +530 -0
- data/test/fulfillment_order_test_helper.rb +8 -0
- data/test/fulfillment_request_test.rb +10 -8
- data/test/fulfillment_service_test.rb +13 -12
- data/test/fulfillment_test.rb +198 -20
- data/test/fulfillment_v2_test.rb +66 -0
- data/test/gift_card_test.rb +6 -4
- data/test/graphql/http_client_test.rb +26 -0
- data/test/graphql_test.rb +190 -0
- data/test/image_test.rb +19 -17
- data/test/inventory_level_test.rb +68 -0
- data/test/lib/webmock_extensions/last_request.rb +16 -0
- data/test/limits_test.rb +4 -3
- data/test/location_test.rb +15 -0
- data/test/marketing_event_test.rb +21 -21
- data/test/message_enricher_test.rb +45 -0
- data/test/meta_test.rb +47 -0
- data/test/metafield_test.rb +30 -20
- data/test/order_risk_test.rb +17 -16
- data/test/order_test.rb +110 -17
- data/test/pagination_test.rb +290 -0
- data/test/payment_test.rb +19 -0
- data/test/policy_test.rb +6 -5
- data/test/price_rule_test.rb +20 -15
- data/test/product_listing_test.rb +72 -15
- data/test/product_publication_test.rb +40 -0
- data/test/product_test.rb +80 -19
- data/test/publication_test.rb +12 -0
- data/test/recurring_application_charge_test.rb +105 -50
- data/test/redirect_test.rb +4 -3
- data/test/refund_test.rb +22 -17
- data/test/report_test.rb +12 -10
- data/test/resource_feedback_test.rb +14 -13
- data/test/script_tag_test.rb +10 -9
- data/test/session_test.rb +497 -111
- data/test/shipping_rate_test.rb +17 -0
- data/test/shipping_zone_test.rb +4 -3
- data/test/shop_test.rb +47 -33
- data/test/smart_collection_test.rb +5 -4
- data/test/storefront_access_token_test.rb +13 -15
- data/test/tax_service_test.rb +7 -3
- data/test/tender_transaction_test.rb +18 -0
- data/test/test_helper.rb +98 -67
- data/test/transaction_test.rb +4 -3
- data/test/usage_charge_test.rb +12 -8
- data/test/user_test.rb +4 -3
- data/test/variant_test.rb +50 -20
- data/test/webhook_test.rb +10 -7
- metadata +196 -37
- data/.travis.yml +0 -36
- data/CHANGELOG +0 -292
- data/Gemfile_ar30 +0 -6
- data/Gemfile_ar31 +0 -6
- data/Gemfile_ar32 +0 -6
- data/Gemfile_ar40 +0 -6
- data/bin/shopify +0 -3
- data/lib/active_resource/base_ext.rb +0 -21
- data/lib/active_resource/disable_prefix_check.rb +0 -36
- data/lib/active_resource/to_query.rb +0 -10
- data/lib/shopify_api/json_format.rb +0 -18
- data/lib/shopify_api/resources/discount.rb +0 -11
- data/lib/shopify_api/resources/o_auth.rb +0 -9
- data/test/discount_test.rb +0 -52
- data/test/fixtures/discount.json +0 -17
- data/test/fixtures/discount_disabled.json +0 -17
- data/test/fixtures/discounts.json +0 -34
- data/test/fixtures/o_auth_revoke.json +0 -5
- data/test/o_auth_test.rb +0 -8
@@ -1,4 +1,30 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
module ShopifyAPI
|
2
4
|
class Checkout < Base
|
5
|
+
self.primary_key = :token
|
6
|
+
|
7
|
+
def self.headers
|
8
|
+
super.merge('X-Shopify-Checkout-Version' => '2016-09-06')
|
9
|
+
end
|
10
|
+
|
11
|
+
def complete
|
12
|
+
post(:complete)
|
13
|
+
end
|
14
|
+
|
15
|
+
def ready?
|
16
|
+
return false unless persisted?
|
17
|
+
|
18
|
+
reload
|
19
|
+
[200, 201].include?(ShopifyAPI::Base.connection.response.code.to_i)
|
20
|
+
end
|
21
|
+
|
22
|
+
def payments
|
23
|
+
Payment.find(:all, params: { checkout_id: id })
|
24
|
+
end
|
25
|
+
|
26
|
+
def shipping_rates
|
27
|
+
ShippingRate.find(:all, params: { checkout_id: id })
|
28
|
+
end
|
3
29
|
end
|
4
|
-
end
|
30
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module ShopifyAPI
|
4
|
+
class Collection < Base
|
5
|
+
include Events
|
6
|
+
include Metafields
|
7
|
+
|
8
|
+
def products(options = {})
|
9
|
+
available_in_version = ShopifyAPI::ApiVersion.find_version('2020-01')
|
10
|
+
raise NotImplementedError unless ShopifyAPI::Base.api_version >= available_in_version
|
11
|
+
Product.find(:all, from: "#{self.class.prefix}collections/#{id}/products.json", params: options)
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -1,9 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
module ShopifyAPI
|
2
3
|
class CollectionListing < Base
|
3
4
|
self.primary_key = :collection_id
|
4
5
|
|
6
|
+
early_july_pagination_release!
|
7
|
+
|
5
8
|
def product_ids
|
6
|
-
|
9
|
+
ProductId.all(params: { collection_id: collection_id })
|
10
|
+
end
|
11
|
+
|
12
|
+
class ProductId < ArrayBase
|
13
|
+
self.resource_prefix = 'collection_listings/:collection_id/'
|
14
|
+
|
15
|
+
early_july_pagination_release!
|
7
16
|
end
|
17
|
+
private_constant :ProductId
|
8
18
|
end
|
9
19
|
end
|
@@ -1,9 +1,24 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
module ShopifyAPI
|
2
3
|
class Comment < Base
|
3
|
-
def remove
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
def
|
4
|
+
def remove
|
5
|
+
load_attributes_from_response(post(:remove, {}, only_id))
|
6
|
+
end
|
7
|
+
|
8
|
+
def spam
|
9
|
+
load_attributes_from_response(post(:spam, {}, only_id))
|
10
|
+
end
|
11
|
+
|
12
|
+
def approve
|
13
|
+
load_attributes_from_response(post(:approve, {}, only_id))
|
14
|
+
end
|
15
|
+
|
16
|
+
def restore
|
17
|
+
load_attributes_from_response(post(:restore, {}, only_id))
|
18
|
+
end
|
19
|
+
|
20
|
+
def not_spam
|
21
|
+
load_attributes_from_response(post(:not_spam, {}, only_id))
|
22
|
+
end
|
8
23
|
end
|
9
24
|
end
|
@@ -1,19 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
module ShopifyAPI
|
2
3
|
class CustomCollection < Base
|
3
4
|
include Events
|
4
5
|
include Metafields
|
5
6
|
|
6
7
|
def products
|
7
|
-
Product.find(:all, :
|
8
|
+
Product.find(:all, params: { collection_id: self.id })
|
8
9
|
end
|
9
|
-
|
10
|
+
|
10
11
|
def add_product(product)
|
11
|
-
Collect.create(:
|
12
|
+
Collect.create(collection_id: self.id, product_id: product.id)
|
12
13
|
end
|
13
|
-
|
14
|
+
|
14
15
|
def remove_product(product)
|
15
|
-
collect = Collect.find(:first, :
|
16
|
+
collect = Collect.find(:first, params: { collection_id: self.id, product_id: product.id })
|
16
17
|
collect.destroy if collect
|
17
18
|
end
|
18
|
-
end
|
19
|
+
end
|
19
20
|
end
|
@@ -1,9 +1,12 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
require 'shopify_api/resources/customer'
|
2
3
|
|
3
4
|
module ShopifyAPI
|
4
5
|
class CustomerSavedSearch < Base
|
6
|
+
early_july_pagination_release!
|
7
|
+
|
5
8
|
def customers(params = {})
|
6
|
-
Customer.search(params.merge({:
|
9
|
+
Customer.search(params.merge({ customer_saved_search_id: self.id }))
|
7
10
|
end
|
8
11
|
end
|
9
12
|
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
module ShopifyAPI
|
3
|
+
class DiscountCodeBatch < Base
|
4
|
+
init_prefix :price_rule
|
5
|
+
|
6
|
+
self.collection_name = 'batch'
|
7
|
+
|
8
|
+
def price_rule_id
|
9
|
+
@prefix_options[:price_rule_id]
|
10
|
+
end
|
11
|
+
|
12
|
+
def discount_code_job
|
13
|
+
@discount_codes ||= begin
|
14
|
+
if id
|
15
|
+
path = self.class.api_version.construct_api_path(
|
16
|
+
"price_rules/#{price_rule_id}/batch/#{id}/discount_codes.json"
|
17
|
+
)
|
18
|
+
discount_codes = ShopifyAPI::DiscountCode.find(:all, from: path)
|
19
|
+
discount_codes.each do |code|
|
20
|
+
errors = code.attributes['errors']
|
21
|
+
errors.attributes.each do |key, values|
|
22
|
+
values.each { |message| code.errors.add(key, message) }
|
23
|
+
end
|
24
|
+
end
|
25
|
+
discount_codes
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def encode(options = {})
|
31
|
+
send("to_#{self.class.format.extension}", options)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -1,3 +1,4 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
module ShopifyAPI
|
2
3
|
class Fulfillment < Base
|
3
4
|
init_prefix :order
|
@@ -6,8 +7,50 @@ module ShopifyAPI
|
|
6
7
|
@prefix_options[:order_id]
|
7
8
|
end
|
8
9
|
|
9
|
-
def cancel
|
10
|
-
|
11
|
-
|
10
|
+
def cancel
|
11
|
+
load_attributes_from_response(post(:cancel, {}, only_id))
|
12
|
+
end
|
13
|
+
|
14
|
+
def complete
|
15
|
+
load_attributes_from_response(post(:complete, {}, only_id))
|
16
|
+
end
|
17
|
+
|
18
|
+
def open
|
19
|
+
load_attributes_from_response(post(:open, {}, only_id))
|
20
|
+
end
|
21
|
+
|
22
|
+
def order_id=(order_id)
|
23
|
+
prefix_options[:order_id] = order_id
|
24
|
+
end
|
25
|
+
|
26
|
+
def load(attributes, remove_root = false, persisted = false)
|
27
|
+
order_id = attributes['order_id']
|
28
|
+
prefix_options[:order_id] = order_id if order_id
|
29
|
+
super(attributes, remove_root, persisted)
|
30
|
+
end
|
31
|
+
|
32
|
+
def save
|
33
|
+
if prefix_options[:order_id].present?
|
34
|
+
super
|
35
|
+
else
|
36
|
+
line_items = attributes['line_items_by_fulfillment_order'] || attributes[:line_items_by_fulfillment_order]
|
37
|
+
if line_items.blank?
|
38
|
+
raise ShopifyAPI::ValidationException,
|
39
|
+
"either 'line_items_by_fulfillment_order' or prefix_options[:order_id] is required"
|
40
|
+
end
|
41
|
+
|
42
|
+
fulfillmentV2 = FulfillmentV2.new(attributes)
|
43
|
+
result = fulfillmentV2.save
|
44
|
+
load(fulfillmentV2.attributes, false, true)
|
45
|
+
result
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
def update_tracking(tracking_info:, notify_customer:)
|
50
|
+
fulfillmentV2 = FulfillmentV2.new(attributes)
|
51
|
+
result = fulfillmentV2.update_tracking(tracking_info: tracking_info, notify_customer: notify_customer)
|
52
|
+
load(fulfillmentV2.attributes, false, true)
|
53
|
+
result
|
54
|
+
end
|
12
55
|
end
|
13
56
|
end
|
@@ -1,6 +1,7 @@
|
|
1
|
+
# frozen_string_literal: true
|
1
2
|
module ShopifyAPI
|
2
3
|
class FulfillmentEvent < Base
|
3
|
-
self.
|
4
|
+
self.resource_prefix = "orders/:order_id/fulfillments/:fulfillment_id/"
|
4
5
|
self.collection_name = 'events'
|
5
6
|
self.element_name = 'event'
|
6
7
|
|
@@ -0,0 +1,151 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
module ShopifyAPI
|
3
|
+
class FulfillmentOrder < Base
|
4
|
+
MINIMUM_VERSION = '2020-01'
|
5
|
+
|
6
|
+
def initialize(attributes = {}, persisted = false)
|
7
|
+
ShopifyAPI::Base.version_validation!(MINIMUM_VERSION)
|
8
|
+
super(attributes, persisted)
|
9
|
+
end
|
10
|
+
|
11
|
+
def self.find(scope, *args)
|
12
|
+
ShopifyAPI::Base.version_validation!(MINIMUM_VERSION)
|
13
|
+
|
14
|
+
if scope == :all
|
15
|
+
order_id = args.first&.dig(:params, :order_id)
|
16
|
+
raise ShopifyAPI::ValidationException, "'order_id' is required" if order_id.blank?
|
17
|
+
|
18
|
+
order = ::ShopifyAPI::Order.new(id: order_id)
|
19
|
+
order.fulfillment_orders(args.first[:params].except(:order_id))
|
20
|
+
else
|
21
|
+
super(scope, *args)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def fulfillments(options = {})
|
26
|
+
fulfillment_hashes = get(:fulfillments, options)
|
27
|
+
fulfillment_hashes.map { |fulfillment_hash| Fulfillment.new(fulfillment_hash) }
|
28
|
+
end
|
29
|
+
|
30
|
+
def locations_for_move
|
31
|
+
locations_for_move_hashes = get(:locations_for_move, {})
|
32
|
+
|
33
|
+
locations_for_move_hashes.map do |locations_for_move_hash|
|
34
|
+
FulfillmentOrderLocationsForMove.new(locations_for_move_hash)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
def move(new_location_id:)
|
39
|
+
body = {
|
40
|
+
fulfillment_order: {
|
41
|
+
new_location_id: new_location_id,
|
42
|
+
},
|
43
|
+
}
|
44
|
+
keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:move, {}, body.to_json))
|
45
|
+
load_keyed_fulfillment_order(keyed_fulfillment_orders, 'original_fulfillment_order')
|
46
|
+
keyed_fulfillment_orders
|
47
|
+
end
|
48
|
+
|
49
|
+
def cancel
|
50
|
+
keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:cancel, {}, only_id))
|
51
|
+
load_keyed_fulfillment_order(keyed_fulfillment_orders, 'fulfillment_order')
|
52
|
+
keyed_fulfillment_orders
|
53
|
+
end
|
54
|
+
|
55
|
+
def open
|
56
|
+
load_attributes_from_response(post(:open, {}, only_id))
|
57
|
+
end
|
58
|
+
|
59
|
+
def reschedule(new_fulfill_at:)
|
60
|
+
body = {
|
61
|
+
fulfillment_order: {
|
62
|
+
new_fulfill_at: new_fulfill_at,
|
63
|
+
},
|
64
|
+
}
|
65
|
+
load_attributes_from_response(post(:reschedule, {}, body.to_json))
|
66
|
+
end
|
67
|
+
|
68
|
+
def close(message: nil)
|
69
|
+
body = {
|
70
|
+
fulfillment_order: {
|
71
|
+
message: message,
|
72
|
+
},
|
73
|
+
}
|
74
|
+
load_attributes_from_response(post(:close, {}, body.to_json))
|
75
|
+
end
|
76
|
+
|
77
|
+
def request_fulfillment(fulfillment_order_line_items: nil, message: nil)
|
78
|
+
body = {
|
79
|
+
fulfillment_request: {
|
80
|
+
fulfillment_order_line_items: fulfillment_order_line_items,
|
81
|
+
message: message,
|
82
|
+
},
|
83
|
+
}
|
84
|
+
keyed_fulfillment_orders = keyed_fulfillment_orders_from_response(post(:fulfillment_request, {}, body.to_json))
|
85
|
+
load_keyed_fulfillment_order(keyed_fulfillment_orders, 'original_fulfillment_order')
|
86
|
+
keyed_fulfillment_orders
|
87
|
+
end
|
88
|
+
|
89
|
+
def accept_fulfillment_request(message: nil)
|
90
|
+
body = {
|
91
|
+
fulfillment_request: {
|
92
|
+
message: message,
|
93
|
+
},
|
94
|
+
}
|
95
|
+
load_attributes_from_response(post('fulfillment_request/accept', {}, body.to_json))
|
96
|
+
end
|
97
|
+
|
98
|
+
def reject_fulfillment_request(message: nil)
|
99
|
+
body = {
|
100
|
+
fulfillment_request: {
|
101
|
+
message: message,
|
102
|
+
},
|
103
|
+
}
|
104
|
+
load_attributes_from_response(post('fulfillment_request/reject', {}, body.to_json))
|
105
|
+
end
|
106
|
+
|
107
|
+
def request_cancellation(message: nil)
|
108
|
+
body = {
|
109
|
+
cancellation_request: {
|
110
|
+
message: message,
|
111
|
+
},
|
112
|
+
}
|
113
|
+
load_attributes_from_response(post(:cancellation_request, {}, body.to_json))
|
114
|
+
end
|
115
|
+
|
116
|
+
def accept_cancellation_request(message: nil)
|
117
|
+
body = {
|
118
|
+
cancellation_request: {
|
119
|
+
message: message,
|
120
|
+
},
|
121
|
+
}
|
122
|
+
load_attributes_from_response(post('cancellation_request/accept', {}, body.to_json))
|
123
|
+
end
|
124
|
+
|
125
|
+
def reject_cancellation_request(message: nil)
|
126
|
+
body = {
|
127
|
+
cancellation_request: {
|
128
|
+
message: message,
|
129
|
+
},
|
130
|
+
}
|
131
|
+
load_attributes_from_response(post('cancellation_request/reject', {}, body.to_json))
|
132
|
+
end
|
133
|
+
|
134
|
+
private
|
135
|
+
|
136
|
+
def load_keyed_fulfillment_order(keyed_fulfillment_orders, key)
|
137
|
+
if keyed_fulfillment_orders[key]&.attributes
|
138
|
+
load(keyed_fulfillment_orders[key].attributes, false, true)
|
139
|
+
end
|
140
|
+
end
|
141
|
+
|
142
|
+
def keyed_fulfillment_orders_from_response(response)
|
143
|
+
return load_attributes_from_response(response) if response.code != '200'
|
144
|
+
|
145
|
+
keyed_fulfillment_orders = ActiveSupport::JSON.decode(response.body)
|
146
|
+
keyed_fulfillment_orders.transform_values do |fulfillment_order_attributes|
|
147
|
+
FulfillmentOrder.new(fulfillment_order_attributes) if fulfillment_order_attributes
|
148
|
+
end
|
149
|
+
end
|
150
|
+
end
|
151
|
+
end
|