shopify_api 1.0.4 → 12.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/CODEOWNERS +1 -0
- data/.github/ISSUE_TEMPLATE.md +35 -0
- data/.github/dependabot.yml +20 -0
- data/.github/pull_request_template.md +20 -0
- data/.github/workflows/build.yml +42 -0
- data/.github/workflows/cla.yml +22 -0
- data/.github/workflows/close-waiting-for-response-issues.yml +20 -0
- data/.github/workflows/remove-labels-on-activity.yml +16 -0
- data/.github/workflows/stale.yml +32 -0
- data/.rubocop.yml +59 -0
- data/BREAKING_CHANGES_FOR_OLDER_VERSIONS.md +110 -0
- data/CHANGELOG.md +574 -0
- data/CONTRIBUTING.md +9 -0
- data/Gemfile +13 -0
- data/Gemfile.lock +159 -0
- data/LICENSE +2 -2
- data/README.md +138 -0
- data/RELEASING.md +19 -0
- data/Rakefile +16 -50
- data/SECURITY.md +59 -0
- data/bin/tapioca +29 -0
- data/dev.yml +32 -0
- data/docs/README.md +13 -0
- data/docs/getting_started.md +53 -0
- data/docs/issues.md +39 -0
- data/docs/usage/graphql.md +115 -0
- data/docs/usage/graphql_storefront.md +42 -0
- data/docs/usage/oauth.md +104 -0
- data/docs/usage/rest.md +137 -0
- data/docs/usage/session_storage.md +46 -0
- data/docs/usage/webhooks.md +98 -0
- data/lib/shopify_api/admin_versions.rb +19 -0
- data/lib/shopify_api/auth/associated_user.rb +36 -0
- data/lib/shopify_api/auth/auth_scopes.rb +75 -0
- data/lib/shopify_api/auth/file_session_storage.rb +72 -0
- data/lib/shopify_api/auth/jwt_payload.rb +83 -0
- data/lib/shopify_api/auth/oauth/auth_query.rb +47 -0
- data/lib/shopify_api/auth/oauth/session_cookie.rb +28 -0
- data/lib/shopify_api/auth/oauth.rb +135 -0
- data/lib/shopify_api/auth/session.rb +119 -0
- data/lib/shopify_api/auth/session_storage.rb +30 -0
- data/lib/shopify_api/auth.rb +26 -0
- data/lib/shopify_api/clients/graphql/admin.rb +15 -0
- data/lib/shopify_api/clients/graphql/client.rb +40 -0
- data/lib/shopify_api/clients/graphql/storefront.rb +35 -0
- data/lib/shopify_api/clients/http_client.rb +100 -0
- data/lib/shopify_api/clients/http_request.rb +35 -0
- data/lib/shopify_api/clients/http_response.rb +66 -0
- data/lib/shopify_api/clients/rest/admin.rb +118 -0
- data/lib/shopify_api/context.rb +196 -0
- data/lib/shopify_api/errors/context_not_setup_error.rb +9 -0
- data/lib/shopify_api/errors/cookie_not_found_error.rb +9 -0
- data/lib/shopify_api/errors/feature_deprecated_error.rb +9 -0
- data/lib/shopify_api/errors/http_response_error.rb +23 -0
- data/lib/shopify_api/errors/invalid_graphql_request_error.rb +9 -0
- data/lib/shopify_api/errors/invalid_http_request_error.rb +9 -0
- data/lib/shopify_api/errors/invalid_jwt_token_error.rb +9 -0
- data/lib/shopify_api/errors/invalid_oauth_error.rb +9 -0
- data/lib/shopify_api/errors/invalid_webhook_error.rb +9 -0
- data/lib/shopify_api/errors/invalid_webhook_registration_error.rb +9 -0
- data/lib/shopify_api/errors/log_level_not_found_error.rb +9 -0
- data/lib/shopify_api/errors/max_http_retries_exceeded_error.rb +9 -0
- data/lib/shopify_api/errors/missing_jwt_token_error.rb +9 -0
- data/lib/shopify_api/errors/missing_required_argument_error.rb +9 -0
- data/lib/shopify_api/errors/no_active_session_error.rb +9 -0
- data/lib/shopify_api/errors/no_session_cookie_error.rb +9 -0
- data/lib/shopify_api/errors/no_webhook_handler.rb +9 -0
- data/lib/shopify_api/errors/private_app_error.rb +9 -0
- data/lib/shopify_api/errors/request_access_token_error.rb +9 -0
- data/lib/shopify_api/errors/session_not_found_error.rb +9 -0
- data/lib/shopify_api/errors/session_storage_error.rb +9 -0
- data/lib/shopify_api/errors/unsupported_oauth_error.rb +9 -0
- data/lib/shopify_api/errors/unsupported_version_error.rb +9 -0
- data/lib/shopify_api/errors/webhook_registration_error.rb +9 -0
- data/lib/shopify_api/inflector.rb +17 -0
- data/lib/shopify_api/logger.rb +82 -0
- data/lib/shopify_api/rest/base.rb +387 -0
- data/lib/shopify_api/rest/base_errors.rb +32 -0
- data/lib/shopify_api/rest/resources/2022_01/abandoned_checkout.rb +190 -0
- data/lib/shopify_api/rest/resources/2022_01/access_scope.rb +58 -0
- data/lib/shopify_api/rest/resources/2022_01/android_pay_key.rb +77 -0
- data/lib/shopify_api/rest/resources/2022_01/apple_pay_certificate.rb +105 -0
- data/lib/shopify_api/rest/resources/2022_01/application_charge.rb +104 -0
- data/lib/shopify_api/rest/resources/2022_01/application_credit.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_01/article.rb +265 -0
- data/lib/shopify_api/rest/resources/2022_01/asset.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_01/assigned_fulfillment_order.rb +79 -0
- data/lib/shopify_api/rest/resources/2022_01/balance.rb +50 -0
- data/lib/shopify_api/rest/resources/2022_01/blog.rb +162 -0
- data/lib/shopify_api/rest/resources/2022_01/cancellation_request.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_01/carrier_service.rb +116 -0
- data/lib/shopify_api/rest/resources/2022_01/checkout.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_01/collect.rb +142 -0
- data/lib/shopify_api/rest/resources/2022_01/collection.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_01/collection_listing.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_01/comment.rb +283 -0
- data/lib/shopify_api/rest/resources/2022_01/country.rb +137 -0
- data/lib/shopify_api/rest/resources/2022_01/currency.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_01/custom_collection.rb +187 -0
- data/lib/shopify_api/rest/resources/2022_01/customer.rb +318 -0
- data/lib/shopify_api/rest/resources/2022_01/customer_address.rb +201 -0
- data/lib/shopify_api/rest/resources/2022_01/customer_saved_search.rb +169 -0
- data/lib/shopify_api/rest/resources/2022_01/deprecated_api_call.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_01/discount_code.rb +219 -0
- data/lib/shopify_api/rest/resources/2022_01/dispute.rb +111 -0
- data/lib/shopify_api/rest/resources/2022_01/draft_order.rb +275 -0
- data/lib/shopify_api/rest/resources/2022_01/event.rb +148 -0
- data/lib/shopify_api/rest/resources/2022_01/fulfillment.rb +268 -0
- data/lib/shopify_api/rest/resources/2022_01/fulfillment_event.rb +166 -0
- data/lib/shopify_api/rest/resources/2022_01/fulfillment_order.rb +281 -0
- data/lib/shopify_api/rest/resources/2022_01/fulfillment_request.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_01/fulfillment_service.rb +130 -0
- data/lib/shopify_api/rest/resources/2022_01/gift_card.rb +215 -0
- data/lib/shopify_api/rest/resources/2022_01/gift_card_adjustment.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_01/image.rb +157 -0
- data/lib/shopify_api/rest/resources/2022_01/inventory_item.rb +108 -0
- data/lib/shopify_api/rest/resources/2022_01/inventory_level.rb +179 -0
- data/lib/shopify_api/rest/resources/2022_01/location.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_01/locations_for_move.rb +56 -0
- data/lib/shopify_api/rest/resources/2022_01/marketing_event.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_01/metafield.rb +349 -0
- data/lib/shopify_api/rest/resources/2022_01/mobile_platform_application.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_01/order.rb +473 -0
- data/lib/shopify_api/rest/resources/2022_01/order_risk.rb +135 -0
- data/lib/shopify_api/rest/resources/2022_01/page.rb +194 -0
- data/lib/shopify_api/rest/resources/2022_01/payment.rb +140 -0
- data/lib/shopify_api/rest/resources/2022_01/payment_gateway.rb +143 -0
- data/lib/shopify_api/rest/resources/2022_01/payment_transaction.rb +107 -0
- data/lib/shopify_api/rest/resources/2022_01/payout.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_01/policy.rb +69 -0
- data/lib/shopify_api/rest/resources/2022_01/price_rule.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_01/product.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_01/product_listing.rb +196 -0
- data/lib/shopify_api/rest/resources/2022_01/product_resource_feedback.rb +88 -0
- data/lib/shopify_api/rest/resources/2022_01/province.rb +132 -0
- data/lib/shopify_api/rest/resources/2022_01/recurring_application_charge.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_01/redirect.rb +139 -0
- data/lib/shopify_api/rest/resources/2022_01/refund.rb +151 -0
- data/lib/shopify_api/rest/resources/2022_01/report.rb +121 -0
- data/lib/shopify_api/rest/resources/2022_01/resource_feedback.rb +73 -0
- data/lib/shopify_api/rest/resources/2022_01/script_tag.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_01/shipping_zone.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_01/shop.rb +218 -0
- data/lib/shopify_api/rest/resources/2022_01/smart_collection.rb +216 -0
- data/lib/shopify_api/rest/resources/2022_01/storefront_access_token.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_01/tender_transaction.rb +93 -0
- data/lib/shopify_api/rest/resources/2022_01/theme.rb +120 -0
- data/lib/shopify_api/rest/resources/2022_01/transaction.rb +181 -0
- data/lib/shopify_api/rest/resources/2022_01/usage_charge.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_01/user.rb +138 -0
- data/lib/shopify_api/rest/resources/2022_01/variant.rb +212 -0
- data/lib/shopify_api/rest/resources/2022_01/webhook.rb +168 -0
- data/lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb +190 -0
- data/lib/shopify_api/rest/resources/2022_04/access_scope.rb +58 -0
- data/lib/shopify_api/rest/resources/2022_04/android_pay_key.rb +77 -0
- data/lib/shopify_api/rest/resources/2022_04/apple_pay_certificate.rb +105 -0
- data/lib/shopify_api/rest/resources/2022_04/application_charge.rb +104 -0
- data/lib/shopify_api/rest/resources/2022_04/application_credit.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_04/article.rb +265 -0
- data/lib/shopify_api/rest/resources/2022_04/asset.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_04/assigned_fulfillment_order.rb +79 -0
- data/lib/shopify_api/rest/resources/2022_04/balance.rb +50 -0
- data/lib/shopify_api/rest/resources/2022_04/blog.rb +162 -0
- data/lib/shopify_api/rest/resources/2022_04/cancellation_request.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_04/carrier_service.rb +116 -0
- data/lib/shopify_api/rest/resources/2022_04/checkout.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_04/collect.rb +142 -0
- data/lib/shopify_api/rest/resources/2022_04/collection.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_04/collection_listing.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_04/comment.rb +283 -0
- data/lib/shopify_api/rest/resources/2022_04/country.rb +137 -0
- data/lib/shopify_api/rest/resources/2022_04/currency.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_04/custom_collection.rb +187 -0
- data/lib/shopify_api/rest/resources/2022_04/customer.rb +321 -0
- data/lib/shopify_api/rest/resources/2022_04/customer_address.rb +201 -0
- data/lib/shopify_api/rest/resources/2022_04/customer_saved_search.rb +169 -0
- data/lib/shopify_api/rest/resources/2022_04/deprecated_api_call.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_04/discount_code.rb +219 -0
- data/lib/shopify_api/rest/resources/2022_04/dispute.rb +111 -0
- data/lib/shopify_api/rest/resources/2022_04/draft_order.rb +275 -0
- data/lib/shopify_api/rest/resources/2022_04/event.rb +148 -0
- data/lib/shopify_api/rest/resources/2022_04/fulfillment.rb +268 -0
- data/lib/shopify_api/rest/resources/2022_04/fulfillment_event.rb +166 -0
- data/lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb +284 -0
- data/lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb +130 -0
- data/lib/shopify_api/rest/resources/2022_04/gift_card.rb +215 -0
- data/lib/shopify_api/rest/resources/2022_04/gift_card_adjustment.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_04/image.rb +157 -0
- data/lib/shopify_api/rest/resources/2022_04/inventory_item.rb +108 -0
- data/lib/shopify_api/rest/resources/2022_04/inventory_level.rb +179 -0
- data/lib/shopify_api/rest/resources/2022_04/location.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_04/locations_for_move.rb +56 -0
- data/lib/shopify_api/rest/resources/2022_04/marketing_event.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_04/metafield.rb +342 -0
- data/lib/shopify_api/rest/resources/2022_04/mobile_platform_application.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_04/order.rb +473 -0
- data/lib/shopify_api/rest/resources/2022_04/order_risk.rb +135 -0
- data/lib/shopify_api/rest/resources/2022_04/page.rb +194 -0
- data/lib/shopify_api/rest/resources/2022_04/payment.rb +140 -0
- data/lib/shopify_api/rest/resources/2022_04/payment_gateway.rb +143 -0
- data/lib/shopify_api/rest/resources/2022_04/payment_transaction.rb +107 -0
- data/lib/shopify_api/rest/resources/2022_04/payout.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_04/policy.rb +69 -0
- data/lib/shopify_api/rest/resources/2022_04/price_rule.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_04/product.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_04/product_listing.rb +196 -0
- data/lib/shopify_api/rest/resources/2022_04/product_resource_feedback.rb +88 -0
- data/lib/shopify_api/rest/resources/2022_04/province.rb +132 -0
- data/lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_04/redirect.rb +139 -0
- data/lib/shopify_api/rest/resources/2022_04/refund.rb +151 -0
- data/lib/shopify_api/rest/resources/2022_04/report.rb +121 -0
- data/lib/shopify_api/rest/resources/2022_04/resource_feedback.rb +73 -0
- data/lib/shopify_api/rest/resources/2022_04/script_tag.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_04/shipping_zone.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_04/shop.rb +218 -0
- data/lib/shopify_api/rest/resources/2022_04/smart_collection.rb +216 -0
- data/lib/shopify_api/rest/resources/2022_04/storefront_access_token.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_04/tender_transaction.rb +93 -0
- data/lib/shopify_api/rest/resources/2022_04/theme.rb +120 -0
- data/lib/shopify_api/rest/resources/2022_04/transaction.rb +181 -0
- data/lib/shopify_api/rest/resources/2022_04/usage_charge.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_04/user.rb +138 -0
- data/lib/shopify_api/rest/resources/2022_04/variant.rb +212 -0
- data/lib/shopify_api/rest/resources/2022_04/webhook.rb +168 -0
- data/lib/shopify_api/rest/resources/2022_07/abandoned_checkout.rb +190 -0
- data/lib/shopify_api/rest/resources/2022_07/access_scope.rb +58 -0
- data/lib/shopify_api/rest/resources/2022_07/android_pay_key.rb +77 -0
- data/lib/shopify_api/rest/resources/2022_07/apple_pay_certificate.rb +105 -0
- data/lib/shopify_api/rest/resources/2022_07/application_charge.rb +104 -0
- data/lib/shopify_api/rest/resources/2022_07/application_credit.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_07/article.rb +265 -0
- data/lib/shopify_api/rest/resources/2022_07/asset.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_07/assigned_fulfillment_order.rb +79 -0
- data/lib/shopify_api/rest/resources/2022_07/balance.rb +50 -0
- data/lib/shopify_api/rest/resources/2022_07/blog.rb +162 -0
- data/lib/shopify_api/rest/resources/2022_07/cancellation_request.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_07/carrier_service.rb +113 -0
- data/lib/shopify_api/rest/resources/2022_07/checkout.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_07/collect.rb +142 -0
- data/lib/shopify_api/rest/resources/2022_07/collection.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_07/collection_listing.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_07/comment.rb +283 -0
- data/lib/shopify_api/rest/resources/2022_07/country.rb +137 -0
- data/lib/shopify_api/rest/resources/2022_07/currency.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_07/custom_collection.rb +187 -0
- data/lib/shopify_api/rest/resources/2022_07/customer.rb +321 -0
- data/lib/shopify_api/rest/resources/2022_07/customer_address.rb +201 -0
- data/lib/shopify_api/rest/resources/2022_07/customer_saved_search.rb +169 -0
- data/lib/shopify_api/rest/resources/2022_07/deprecated_api_call.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_07/discount_code.rb +219 -0
- data/lib/shopify_api/rest/resources/2022_07/dispute.rb +111 -0
- data/lib/shopify_api/rest/resources/2022_07/dispute_evidence.rb +117 -0
- data/lib/shopify_api/rest/resources/2022_07/dispute_file_upload.rb +81 -0
- data/lib/shopify_api/rest/resources/2022_07/draft_order.rb +275 -0
- data/lib/shopify_api/rest/resources/2022_07/event.rb +148 -0
- data/lib/shopify_api/rest/resources/2022_07/fulfillment.rb +221 -0
- data/lib/shopify_api/rest/resources/2022_07/fulfillment_event.rb +166 -0
- data/lib/shopify_api/rest/resources/2022_07/fulfillment_order.rb +310 -0
- data/lib/shopify_api/rest/resources/2022_07/fulfillment_request.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_07/fulfillment_service.rb +130 -0
- data/lib/shopify_api/rest/resources/2022_07/gift_card.rb +215 -0
- data/lib/shopify_api/rest/resources/2022_07/gift_card_adjustment.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_07/image.rb +157 -0
- data/lib/shopify_api/rest/resources/2022_07/inventory_item.rb +108 -0
- data/lib/shopify_api/rest/resources/2022_07/inventory_level.rb +179 -0
- data/lib/shopify_api/rest/resources/2022_07/location.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_07/locations_for_move.rb +56 -0
- data/lib/shopify_api/rest/resources/2022_07/marketing_event.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_07/metafield.rb +342 -0
- data/lib/shopify_api/rest/resources/2022_07/mobile_platform_application.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_07/order.rb +473 -0
- data/lib/shopify_api/rest/resources/2022_07/order_risk.rb +135 -0
- data/lib/shopify_api/rest/resources/2022_07/page.rb +194 -0
- data/lib/shopify_api/rest/resources/2022_07/payment.rb +140 -0
- data/lib/shopify_api/rest/resources/2022_07/payment_gateway.rb +143 -0
- data/lib/shopify_api/rest/resources/2022_07/payment_transaction.rb +107 -0
- data/lib/shopify_api/rest/resources/2022_07/payout.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_07/policy.rb +69 -0
- data/lib/shopify_api/rest/resources/2022_07/price_rule.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_07/product.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_07/product_listing.rb +196 -0
- data/lib/shopify_api/rest/resources/2022_07/product_resource_feedback.rb +88 -0
- data/lib/shopify_api/rest/resources/2022_07/province.rb +132 -0
- data/lib/shopify_api/rest/resources/2022_07/recurring_application_charge.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_07/redirect.rb +139 -0
- data/lib/shopify_api/rest/resources/2022_07/refund.rb +151 -0
- data/lib/shopify_api/rest/resources/2022_07/report.rb +121 -0
- data/lib/shopify_api/rest/resources/2022_07/resource_feedback.rb +73 -0
- data/lib/shopify_api/rest/resources/2022_07/script_tag.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_07/shipping_zone.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_07/shop.rb +218 -0
- data/lib/shopify_api/rest/resources/2022_07/smart_collection.rb +216 -0
- data/lib/shopify_api/rest/resources/2022_07/storefront_access_token.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_07/tender_transaction.rb +93 -0
- data/lib/shopify_api/rest/resources/2022_07/theme.rb +120 -0
- data/lib/shopify_api/rest/resources/2022_07/transaction.rb +181 -0
- data/lib/shopify_api/rest/resources/2022_07/usage_charge.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_07/user.rb +138 -0
- data/lib/shopify_api/rest/resources/2022_07/variant.rb +212 -0
- data/lib/shopify_api/rest/resources/2022_07/webhook.rb +168 -0
- data/lib/shopify_api/rest/resources/2022_10/abandoned_checkout.rb +190 -0
- data/lib/shopify_api/rest/resources/2022_10/access_scope.rb +58 -0
- data/lib/shopify_api/rest/resources/2022_10/android_pay_key.rb +77 -0
- data/lib/shopify_api/rest/resources/2022_10/apple_pay_certificate.rb +105 -0
- data/lib/shopify_api/rest/resources/2022_10/application_charge.rb +104 -0
- data/lib/shopify_api/rest/resources/2022_10/application_credit.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_10/article.rb +265 -0
- data/lib/shopify_api/rest/resources/2022_10/asset.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_10/assigned_fulfillment_order.rb +79 -0
- data/lib/shopify_api/rest/resources/2022_10/balance.rb +50 -0
- data/lib/shopify_api/rest/resources/2022_10/blog.rb +162 -0
- data/lib/shopify_api/rest/resources/2022_10/cancellation_request.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_10/carrier_service.rb +113 -0
- data/lib/shopify_api/rest/resources/2022_10/checkout.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_10/collect.rb +142 -0
- data/lib/shopify_api/rest/resources/2022_10/collection.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_10/collection_listing.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_10/comment.rb +283 -0
- data/lib/shopify_api/rest/resources/2022_10/country.rb +137 -0
- data/lib/shopify_api/rest/resources/2022_10/currency.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_10/custom_collection.rb +187 -0
- data/lib/shopify_api/rest/resources/2022_10/customer.rb +321 -0
- data/lib/shopify_api/rest/resources/2022_10/customer_address.rb +201 -0
- data/lib/shopify_api/rest/resources/2022_10/customer_saved_search.rb +169 -0
- data/lib/shopify_api/rest/resources/2022_10/deprecated_api_call.rb +57 -0
- data/lib/shopify_api/rest/resources/2022_10/discount_code.rb +219 -0
- data/lib/shopify_api/rest/resources/2022_10/dispute.rb +111 -0
- data/lib/shopify_api/rest/resources/2022_10/dispute_evidence.rb +117 -0
- data/lib/shopify_api/rest/resources/2022_10/dispute_file_upload.rb +81 -0
- data/lib/shopify_api/rest/resources/2022_10/draft_order.rb +275 -0
- data/lib/shopify_api/rest/resources/2022_10/event.rb +148 -0
- data/lib/shopify_api/rest/resources/2022_10/fulfillment.rb +221 -0
- data/lib/shopify_api/rest/resources/2022_10/fulfillment_event.rb +166 -0
- data/lib/shopify_api/rest/resources/2022_10/fulfillment_order.rb +310 -0
- data/lib/shopify_api/rest/resources/2022_10/fulfillment_request.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_10/fulfillment_service.rb +130 -0
- data/lib/shopify_api/rest/resources/2022_10/gift_card.rb +215 -0
- data/lib/shopify_api/rest/resources/2022_10/gift_card_adjustment.rb +118 -0
- data/lib/shopify_api/rest/resources/2022_10/image.rb +157 -0
- data/lib/shopify_api/rest/resources/2022_10/inventory_item.rb +108 -0
- data/lib/shopify_api/rest/resources/2022_10/inventory_level.rb +179 -0
- data/lib/shopify_api/rest/resources/2022_10/location.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_10/locations_for_move.rb +56 -0
- data/lib/shopify_api/rest/resources/2022_10/marketing_event.rb +209 -0
- data/lib/shopify_api/rest/resources/2022_10/metafield.rb +342 -0
- data/lib/shopify_api/rest/resources/2022_10/mobile_platform_application.rb +110 -0
- data/lib/shopify_api/rest/resources/2022_10/order.rb +476 -0
- data/lib/shopify_api/rest/resources/2022_10/order_risk.rb +135 -0
- data/lib/shopify_api/rest/resources/2022_10/page.rb +194 -0
- data/lib/shopify_api/rest/resources/2022_10/payment.rb +140 -0
- data/lib/shopify_api/rest/resources/2022_10/payment_gateway.rb +143 -0
- data/lib/shopify_api/rest/resources/2022_10/payment_transaction.rb +107 -0
- data/lib/shopify_api/rest/resources/2022_10/payout.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_10/policy.rb +69 -0
- data/lib/shopify_api/rest/resources/2022_10/price_rule.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_10/product.rb +223 -0
- data/lib/shopify_api/rest/resources/2022_10/product_listing.rb +196 -0
- data/lib/shopify_api/rest/resources/2022_10/product_resource_feedback.rb +88 -0
- data/lib/shopify_api/rest/resources/2022_10/province.rb +132 -0
- data/lib/shopify_api/rest/resources/2022_10/recurring_application_charge.rb +167 -0
- data/lib/shopify_api/rest/resources/2022_10/redirect.rb +139 -0
- data/lib/shopify_api/rest/resources/2022_10/refund.rb +151 -0
- data/lib/shopify_api/rest/resources/2022_10/report.rb +121 -0
- data/lib/shopify_api/rest/resources/2022_10/resource_feedback.rb +73 -0
- data/lib/shopify_api/rest/resources/2022_10/script_tag.rb +155 -0
- data/lib/shopify_api/rest/resources/2022_10/shipping_zone.rb +83 -0
- data/lib/shopify_api/rest/resources/2022_10/shop.rb +221 -0
- data/lib/shopify_api/rest/resources/2022_10/smart_collection.rb +216 -0
- data/lib/shopify_api/rest/resources/2022_10/storefront_access_token.rb +87 -0
- data/lib/shopify_api/rest/resources/2022_10/tender_transaction.rb +93 -0
- data/lib/shopify_api/rest/resources/2022_10/theme.rb +120 -0
- data/lib/shopify_api/rest/resources/2022_10/transaction.rb +181 -0
- data/lib/shopify_api/rest/resources/2022_10/usage_charge.rb +97 -0
- data/lib/shopify_api/rest/resources/2022_10/user.rb +138 -0
- data/lib/shopify_api/rest/resources/2022_10/variant.rb +212 -0
- data/lib/shopify_api/rest/resources/2022_10/webhook.rb +168 -0
- data/lib/shopify_api/utils/graphql_proxy.rb +52 -0
- data/lib/shopify_api/utils/hmac_validator.rb +44 -0
- data/lib/shopify_api/utils/http_utils.rb +17 -0
- data/lib/shopify_api/utils/session_utils.rb +152 -0
- data/lib/shopify_api/utils/verifiable_query.rb +18 -0
- data/lib/shopify_api/version.rb +6 -0
- data/lib/shopify_api/webhooks/handler.rb +15 -0
- data/lib/shopify_api/webhooks/register_result.rb +14 -0
- data/lib/shopify_api/webhooks/registration.rb +73 -0
- data/lib/shopify_api/webhooks/registrations/event_bridge.rb +61 -0
- data/lib/shopify_api/webhooks/registrations/http.rb +72 -0
- data/lib/shopify_api/webhooks/registrations/pub_sub.rb +65 -0
- data/lib/shopify_api/webhooks/registry.rb +215 -0
- data/lib/shopify_api/webhooks/request.rb +56 -0
- data/lib/shopify_api.rb +23 -472
- data/service.yml +1 -0
- data/shipit.rubygems.yml +1 -0
- data/shopify_api.gemspec +43 -102
- data/sorbet/config +3 -0
- data/sorbet/rbi/gems/activesupport@7.0.1.rbi +654 -0
- data/sorbet/rbi/gems/addressable@2.8.0.rbi +290 -0
- data/sorbet/rbi/gems/ast@2.4.2.rbi +54 -0
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +8 -0
- data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +2401 -0
- data/sorbet/rbi/gems/crack@0.4.5.rbi +57 -0
- data/sorbet/rbi/gems/diff-lcs@1.5.0.rbi +185 -0
- data/sorbet/rbi/gems/fakefs@1.4.1.rbi +571 -0
- data/sorbet/rbi/gems/hash_diff@1.0.0.rbi +47 -0
- data/sorbet/rbi/gems/hashdiff@1.0.1.rbi +82 -0
- data/sorbet/rbi/gems/httparty@0.20.0.rbi +573 -0
- data/sorbet/rbi/gems/i18n@1.8.11.rbi +25 -0
- data/sorbet/rbi/gems/jwt@2.3.0.rbi +437 -0
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +8 -0
- data/sorbet/rbi/gems/mime-types-data@3.2022.0105.rbi +73 -0
- data/sorbet/rbi/gems/mime-types@3.4.1.rbi +295 -0
- data/sorbet/rbi/gems/minitest@5.15.0.rbi +541 -0
- data/sorbet/rbi/gems/mocha@1.13.0.rbi +986 -0
- data/sorbet/rbi/gems/multi_xml@0.6.0.rbi +36 -0
- data/sorbet/rbi/gems/oj@3.13.11.rbi +274 -0
- data/sorbet/rbi/gems/openssl@3.0.0.rbi +581 -0
- data/sorbet/rbi/gems/parallel@1.21.0.rbi +113 -0
- data/sorbet/rbi/gems/parser@3.1.0.0.rbi +1741 -0
- data/sorbet/rbi/gems/pry@0.14.1.rbi +8 -0
- data/sorbet/rbi/gems/public_suffix@4.0.6.rbi +145 -0
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +157 -0
- data/sorbet/rbi/gems/rake@13.0.6.rbi +814 -0
- data/sorbet/rbi/gems/rbi@0.0.11.rbi +1646 -0
- data/sorbet/rbi/gems/regexp_parser@2.2.0.rbi +1130 -0
- data/sorbet/rbi/gems/rexml@3.2.5.rbi +709 -0
- data/sorbet/rbi/gems/rubocop-ast@1.15.1.rbi +1921 -0
- data/sorbet/rbi/gems/rubocop-shopify@2.4.0.rbi +8 -0
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.5.rbi +295 -0
- data/sorbet/rbi/gems/rubocop@1.25.1.rbi +13507 -0
- data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +405 -0
- data/sorbet/rbi/gems/securerandom@0.1.1.rbi +10 -0
- data/sorbet/rbi/gems/spoom@1.1.8.rbi +1252 -0
- data/sorbet/rbi/gems/tapioca@0.6.3.rbi +1238 -0
- data/sorbet/rbi/gems/thor@1.2.1.rbi +844 -0
- data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +858 -0
- data/sorbet/rbi/gems/unicode-display_width@2.1.0.rbi +26 -0
- data/sorbet/rbi/gems/unparser@0.6.3.rbi +1816 -0
- data/sorbet/rbi/gems/webmock@3.14.0.rbi +683 -0
- data/sorbet/rbi/gems/webrick@1.7.0.rbi +601 -0
- data/sorbet/rbi/gems/yard-sorbet@0.6.1.rbi +199 -0
- data/sorbet/rbi/gems/yard@0.9.27.rbi +4145 -0
- data/sorbet/rbi/gems/zeitwerk@2.5.4.rbi +200 -0
- data/sorbet/rbi/shims/fakefs.rbi +1 -0
- data/sorbet/rbi/shims/openssl.rb +3 -0
- data/sorbet/rbi/todo.rbi +8 -0
- data/sorbet/tapioca/config.yml +4 -0
- data/sorbet/tapioca/require.rb +20 -0
- metadata +736 -80
- data/.document +0 -5
- data/.gitignore +0 -5
- data/CHANGELOG +0 -5
- data/README.rdoc +0 -55
- data/VERSION +0 -1
- data/test/order_test.rb +0 -48
- data/test/shopify_api_test.rb +0 -21
- data/test/test_helper.rb +0 -28
data/.document
DELETED
data/CHANGELOG
DELETED
data/README.rdoc
DELETED
@@ -1,55 +0,0 @@
|
|
1
|
-
= Shopify API
|
2
|
-
|
3
|
-
The Shopify API gem allows Ruby developers to programmatically access the admin section of Shopify stores.
|
4
|
-
|
5
|
-
The API is implemented as XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Product, or Collection, has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
|
6
|
-
|
7
|
-
|
8
|
-
== Usage
|
9
|
-
|
10
|
-
=== Requirements
|
11
|
-
|
12
|
-
All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:
|
13
|
-
|
14
|
-
* Shop owners can create applications for themselves through their own admin (under the Preferences > Applications tab).
|
15
|
-
* Shopify Partners create applications through their admin: http://app.shopify.com/services/partners
|
16
|
-
|
17
|
-
For more information and detailed documentation about the API visit http://api.shopify.com
|
18
|
-
|
19
|
-
=== Getting Started
|
20
|
-
|
21
|
-
ShopifyAPI uses ActiveResource to communicate with the REST web service. ActiveResource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:
|
22
|
-
|
23
|
-
1. First create a new application in either the partners admin or your store admin and write down your API_KEY and SHARED_SECRET.
|
24
|
-
|
25
|
-
2. You will need to supply two parameters to the Session class before you instantiate it:
|
26
|
-
|
27
|
-
ShopifyAPI::Session.setup({:api_key => API_KEY, :secret => SHARED_SECRET})
|
28
|
-
|
29
|
-
3. Create a new Session for a specific shop. That session is not fully valid yet, but it can be used to create a URL that you will redirect your users to:
|
30
|
-
|
31
|
-
session = ShopifyAPI::Session.new("yourshopname.myshopify.com")
|
32
|
-
session.valid? # returns false
|
33
|
-
|
34
|
-
4. To access the API shop owners need a "token" from that specific shop. In order to get this token they need to authorize with that shop first. The URL to redirect your user to can be generated via:
|
35
|
-
|
36
|
-
url = session.create_permission_url
|
37
|
-
|
38
|
-
5. After visiting this URL, the shop redirects the owner to a custom URL of your application where the "token" gets sent to (it's param name is just "t"). Use that token to instantiate a "valid" session, that is ready to make calls to that particular shop.
|
39
|
-
|
40
|
-
token = params[:t]
|
41
|
-
session = ShopifyAPI::Session.new("yourshopname.myshopify.com", token)
|
42
|
-
session.valid? # returns true
|
43
|
-
|
44
|
-
6. Now you can finally get the fully authorized URL for that shop. Use that URL to configure ActiveResource and you're set:
|
45
|
-
|
46
|
-
ActiveResource::Base.site = session.site
|
47
|
-
|
48
|
-
7. Get data from that shop (returns ActiveResource instances):
|
49
|
-
|
50
|
-
shop = ShopifyAPI::Shop.current
|
51
|
-
latest_orders = ShopifyAPI::Order.find(:all)
|
52
|
-
|
53
|
-
== Copyright
|
54
|
-
|
55
|
-
Copyright (c) 2009 "JadedPixel inc.". See LICENSE for details.
|
data/VERSION
DELETED
@@ -1 +0,0 @@
|
|
1
|
-
1.0.4
|
data/test/order_test.rb
DELETED
@@ -1,48 +0,0 @@
|
|
1
|
-
require 'test_helper'
|
2
|
-
|
3
|
-
class OrderTest < Test::Unit::TestCase
|
4
|
-
def setup
|
5
|
-
ActiveResource::Base.site = "http://localhost"
|
6
|
-
end
|
7
|
-
|
8
|
-
context "Order" do
|
9
|
-
context "#note_attributes" do
|
10
|
-
|
11
|
-
should "be loaded correctly from order xml" do
|
12
|
-
order_xml = <<-XML
|
13
|
-
<?xml version="1.0" encoding="UTF-8"?>
|
14
|
-
<order>
|
15
|
-
<note-attributes type="array">
|
16
|
-
<note-attribute>
|
17
|
-
<name>size</name>
|
18
|
-
<value>large</value>
|
19
|
-
</note-attribute>
|
20
|
-
</note-attributes>
|
21
|
-
</order>
|
22
|
-
XML
|
23
|
-
|
24
|
-
order = ShopifyAPI::Order.new(Hash.from_xml(order_xml)["order"])
|
25
|
-
|
26
|
-
assert_equal 1, order.note_attributes.size
|
27
|
-
|
28
|
-
note_attribute = order.note_attributes.first
|
29
|
-
assert_equal "size", note_attribute.name
|
30
|
-
assert_equal "large", note_attribute.value
|
31
|
-
end
|
32
|
-
|
33
|
-
should "be able to add note attributes to an order" do
|
34
|
-
order = ShopifyAPI::Order.new
|
35
|
-
order.note_attributes = []
|
36
|
-
order.note_attributes << ShopifyAPI::NoteAttribute.new(:name => "color", :value => "blue")
|
37
|
-
|
38
|
-
order_xml = Hash.from_xml(order.to_xml)
|
39
|
-
assert note_attributes = order_xml["order"]["note_attributes"]
|
40
|
-
assert_instance_of Array, note_attributes
|
41
|
-
|
42
|
-
attribute = note_attributes.first
|
43
|
-
assert_equal "color", attribute["name"]
|
44
|
-
assert_equal "blue", attribute["value"]
|
45
|
-
end
|
46
|
-
end
|
47
|
-
end
|
48
|
-
end
|
data/test/shopify_api_test.rb
DELETED
@@ -1,21 +0,0 @@
|
|
1
|
-
require 'test_helper'
|
2
|
-
|
3
|
-
class ShopifyApiTest < Test::Unit::TestCase
|
4
|
-
|
5
|
-
context "Session" do
|
6
|
-
should "not be valid without a url" do
|
7
|
-
session = ShopifyAPI::Session.new(nil, "any-token")
|
8
|
-
assert_not session.valid?
|
9
|
-
end
|
10
|
-
|
11
|
-
should "not be valid without token" do
|
12
|
-
session = ShopifyAPI::Session.new("testshop.myshopify.com")
|
13
|
-
assert_not session.valid?
|
14
|
-
end
|
15
|
-
|
16
|
-
should "be valid with any token and any url" do
|
17
|
-
session = ShopifyAPI::Session.new("testshop.myshopify.com", "any-token")
|
18
|
-
assert session.valid?
|
19
|
-
end
|
20
|
-
end
|
21
|
-
end
|
data/test/test_helper.rb
DELETED
@@ -1,28 +0,0 @@
|
|
1
|
-
require 'rubygems'
|
2
|
-
require 'test/unit'
|
3
|
-
|
4
|
-
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
5
|
-
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
6
|
-
require 'shopify_api'
|
7
|
-
|
8
|
-
# setup ShopifyAPI with fake api_key and secret
|
9
|
-
ShopifyAPI::Session.setup(:api_key => "API Test key", :secret => "API Test secret")
|
10
|
-
|
11
|
-
class Test::Unit::TestCase
|
12
|
-
def self.test(string, &block)
|
13
|
-
define_method("test:#{string}", &block)
|
14
|
-
end
|
15
|
-
|
16
|
-
def self.should(string, &block)
|
17
|
-
self.test("should_#{string}", &block)
|
18
|
-
end
|
19
|
-
|
20
|
-
def self.context(string)
|
21
|
-
yield
|
22
|
-
end
|
23
|
-
|
24
|
-
# Custom Assertions
|
25
|
-
def assert_not(expression)
|
26
|
-
assert_block("Expected <#{expression}> to be false!") { not expression }
|
27
|
-
end
|
28
|
-
end
|