shopify_api 9.5.1 → 10.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (766) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS +1 -1
  3. data/.github/ISSUE_TEMPLATE.md +1 -2
  4. data/.github/dependabot.yml +20 -0
  5. data/.github/probots.yml +1 -1
  6. data/.github/pull_request_template.md +20 -0
  7. data/.github/workflows/build.yml +18 -19
  8. data/.rubocop.yml +49 -18
  9. data/CHANGELOG.md +3 -1
  10. data/CONTRIBUTING.md +4 -3
  11. data/Gemfile +6 -4
  12. data/Gemfile.lock +104 -117
  13. data/LICENSE +2 -2
  14. data/README.md +92 -494
  15. data/RELEASING +1 -1
  16. data/Rakefile +14 -46
  17. data/SECURITY.md +2 -2
  18. data/bin/tapioca +29 -0
  19. data/dev.yml +22 -1
  20. data/docs/README.md +13 -0
  21. data/docs/getting_started.md +53 -0
  22. data/docs/issues.md +39 -0
  23. data/docs/usage/graphql.md +115 -0
  24. data/docs/usage/graphql_storefront.md +42 -0
  25. data/docs/usage/oauth.md +105 -0
  26. data/docs/usage/rest.md +137 -0
  27. data/docs/usage/session_storage.md +46 -0
  28. data/docs/usage/webhooks.md +98 -0
  29. data/lib/shopify_api/admin_versions.rb +15 -0
  30. data/lib/shopify_api/auth/associated_user.rb +36 -0
  31. data/lib/shopify_api/auth/auth_scopes.rb +75 -0
  32. data/lib/shopify_api/auth/file_session_storage.rb +70 -0
  33. data/lib/shopify_api/auth/jwt_payload.rb +69 -0
  34. data/lib/shopify_api/auth/oauth/auth_query.rb +47 -0
  35. data/lib/shopify_api/auth/oauth/session_cookie.rb +28 -0
  36. data/lib/shopify_api/auth/oauth.rb +129 -0
  37. data/lib/shopify_api/auth/session.rb +119 -0
  38. data/lib/shopify_api/auth/session_storage.rb +30 -0
  39. data/lib/shopify_api/clients/graphql/admin.rb +15 -0
  40. data/lib/shopify_api/clients/graphql/client.rb +40 -0
  41. data/lib/shopify_api/clients/graphql/storefront.rb +35 -0
  42. data/lib/shopify_api/clients/http_client.rb +100 -0
  43. data/lib/shopify_api/clients/http_request.rb +35 -0
  44. data/lib/shopify_api/clients/http_response.rb +66 -0
  45. data/lib/shopify_api/clients/rest/admin.rb +118 -0
  46. data/lib/shopify_api/context.rb +151 -0
  47. data/lib/shopify_api/errors/context_not_setup_error.rb +9 -0
  48. data/lib/shopify_api/errors/cookie_not_found_error.rb +9 -0
  49. data/lib/shopify_api/errors/http_response_error.rb +19 -0
  50. data/lib/shopify_api/errors/invalid_graphql_request_error.rb +9 -0
  51. data/lib/shopify_api/errors/invalid_http_request_error.rb +9 -0
  52. data/lib/shopify_api/errors/invalid_jwt_token_error.rb +9 -0
  53. data/lib/shopify_api/errors/invalid_oauth_error.rb +9 -0
  54. data/lib/shopify_api/errors/invalid_webhook_error.rb +9 -0
  55. data/lib/shopify_api/errors/invalid_webhook_registration_error.rb +9 -0
  56. data/lib/shopify_api/errors/max_http_retries_exceeded_error.rb +9 -0
  57. data/lib/shopify_api/errors/missing_jwt_token_error.rb +9 -0
  58. data/lib/shopify_api/errors/no_active_session_error.rb +9 -0
  59. data/lib/shopify_api/errors/no_session_cookie_error.rb +9 -0
  60. data/lib/shopify_api/errors/no_webhook_handler.rb +9 -0
  61. data/lib/shopify_api/errors/private_app_error.rb +9 -0
  62. data/lib/shopify_api/errors/request_access_token_error.rb +9 -0
  63. data/lib/shopify_api/errors/session_not_found_error.rb +9 -0
  64. data/lib/shopify_api/errors/session_storage_error.rb +9 -0
  65. data/lib/shopify_api/errors/unsupported_oauth_error.rb +9 -0
  66. data/lib/shopify_api/errors/unsupported_version_error.rb +9 -0
  67. data/lib/shopify_api/errors/webhook_registration_error.rb +9 -0
  68. data/lib/shopify_api/inflector.rb +17 -0
  69. data/lib/shopify_api/rest/base.rb +318 -0
  70. data/lib/shopify_api/rest/base_errors.rb +32 -0
  71. data/lib/shopify_api/rest/resources/2021_07/abandoned_checkout.rb +186 -0
  72. data/lib/shopify_api/rest/resources/2021_07/access_scope.rb +54 -0
  73. data/lib/shopify_api/rest/resources/2021_07/android_pay_key.rb +73 -0
  74. data/lib/shopify_api/rest/resources/2021_07/apple_pay_certificate.rb +101 -0
  75. data/lib/shopify_api/rest/resources/2021_07/application_charge.rb +100 -0
  76. data/lib/shopify_api/rest/resources/2021_07/application_credit.rb +83 -0
  77. data/lib/shopify_api/rest/resources/2021_07/article.rb +254 -0
  78. data/lib/shopify_api/rest/resources/2021_07/asset.rb +114 -0
  79. data/lib/shopify_api/rest/resources/2021_07/assigned_fulfillment_order.rb +75 -0
  80. data/lib/shopify_api/rest/resources/2021_07/balance.rb +46 -0
  81. data/lib/shopify_api/rest/resources/2021_07/blog.rb +158 -0
  82. data/lib/shopify_api/rest/resources/2021_07/cancellation_request.rb +79 -0
  83. data/lib/shopify_api/rest/resources/2021_07/carrier_service.rb +112 -0
  84. data/lib/shopify_api/rest/resources/2021_07/checkout.rb +205 -0
  85. data/lib/shopify_api/rest/resources/2021_07/collect.rb +138 -0
  86. data/lib/shopify_api/rest/resources/2021_07/collection.rb +106 -0
  87. data/lib/shopify_api/rest/resources/2021_07/collection_listing.rb +151 -0
  88. data/lib/shopify_api/rest/resources/2021_07/comment.rb +279 -0
  89. data/lib/shopify_api/rest/resources/2021_07/country.rb +133 -0
  90. data/lib/shopify_api/rest/resources/2021_07/currency.rb +53 -0
  91. data/lib/shopify_api/rest/resources/2021_07/custom_collection.rb +183 -0
  92. data/lib/shopify_api/rest/resources/2021_07/customer.rb +285 -0
  93. data/lib/shopify_api/rest/resources/2021_07/customer_address.rb +197 -0
  94. data/lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb +165 -0
  95. data/lib/shopify_api/rest/resources/2021_07/deprecated_api_call.rb +53 -0
  96. data/lib/shopify_api/rest/resources/2021_07/discount_code.rb +215 -0
  97. data/lib/shopify_api/rest/resources/2021_07/dispute.rb +107 -0
  98. data/lib/shopify_api/rest/resources/2021_07/draft_order.rb +266 -0
  99. data/lib/shopify_api/rest/resources/2021_07/event.rb +144 -0
  100. data/lib/shopify_api/rest/resources/2021_07/fulfillment.rb +191 -0
  101. data/lib/shopify_api/rest/resources/2021_07/fulfillment_event.rb +162 -0
  102. data/lib/shopify_api/rest/resources/2021_07/fulfillment_order.rb +224 -0
  103. data/lib/shopify_api/rest/resources/2021_07/fulfillment_request.rb +79 -0
  104. data/lib/shopify_api/rest/resources/2021_07/fulfillment_service.rb +126 -0
  105. data/lib/shopify_api/rest/resources/2021_07/gift_card.rb +203 -0
  106. data/lib/shopify_api/rest/resources/2021_07/gift_card_adjustment.rb +114 -0
  107. data/lib/shopify_api/rest/resources/2021_07/image.rb +153 -0
  108. data/lib/shopify_api/rest/resources/2021_07/inventory_item.rb +104 -0
  109. data/lib/shopify_api/rest/resources/2021_07/inventory_level.rb +175 -0
  110. data/lib/shopify_api/rest/resources/2021_07/location.rb +163 -0
  111. data/lib/shopify_api/rest/resources/2021_07/locations_for_move.rb +52 -0
  112. data/lib/shopify_api/rest/resources/2021_07/marketing_event.rb +205 -0
  113. data/lib/shopify_api/rest/resources/2021_07/metafield.rb +338 -0
  114. data/lib/shopify_api/rest/resources/2021_07/mobile_platform_application.rb +106 -0
  115. data/lib/shopify_api/rest/resources/2021_07/order.rb +466 -0
  116. data/lib/shopify_api/rest/resources/2021_07/order_risk.rb +131 -0
  117. data/lib/shopify_api/rest/resources/2021_07/page.rb +190 -0
  118. data/lib/shopify_api/rest/resources/2021_07/payment.rb +136 -0
  119. data/lib/shopify_api/rest/resources/2021_07/payment_gateway.rb +139 -0
  120. data/lib/shopify_api/rest/resources/2021_07/payment_transaction.rb +103 -0
  121. data/lib/shopify_api/rest/resources/2021_07/payout.rb +93 -0
  122. data/lib/shopify_api/rest/resources/2021_07/policy.rb +65 -0
  123. data/lib/shopify_api/rest/resources/2021_07/price_rule.rb +219 -0
  124. data/lib/shopify_api/rest/resources/2021_07/product.rb +219 -0
  125. data/lib/shopify_api/rest/resources/2021_07/product_listing.rb +192 -0
  126. data/lib/shopify_api/rest/resources/2021_07/product_resource_feedback.rb +84 -0
  127. data/lib/shopify_api/rest/resources/2021_07/province.rb +128 -0
  128. data/lib/shopify_api/rest/resources/2021_07/recurring_application_charge.rb +163 -0
  129. data/lib/shopify_api/rest/resources/2021_07/redirect.rb +135 -0
  130. data/lib/shopify_api/rest/resources/2021_07/refund.rb +147 -0
  131. data/lib/shopify_api/rest/resources/2021_07/report.rb +117 -0
  132. data/lib/shopify_api/rest/resources/2021_07/resource_feedback.rb +69 -0
  133. data/lib/shopify_api/rest/resources/2021_07/script_tag.rb +151 -0
  134. data/lib/shopify_api/rest/resources/2021_07/shipping_zone.rb +79 -0
  135. data/lib/shopify_api/rest/resources/2021_07/shop.rb +214 -0
  136. data/lib/shopify_api/rest/resources/2021_07/smart_collection.rb +212 -0
  137. data/lib/shopify_api/rest/resources/2021_07/storefront_access_token.rb +83 -0
  138. data/lib/shopify_api/rest/resources/2021_07/tender_transaction.rb +89 -0
  139. data/lib/shopify_api/rest/resources/2021_07/theme.rb +116 -0
  140. data/lib/shopify_api/rest/resources/2021_07/transaction.rb +174 -0
  141. data/lib/shopify_api/rest/resources/2021_07/usage_charge.rb +93 -0
  142. data/lib/shopify_api/rest/resources/2021_07/user.rb +134 -0
  143. data/lib/shopify_api/rest/resources/2021_07/variant.rb +204 -0
  144. data/lib/shopify_api/rest/resources/2021_07/webhook.rb +164 -0
  145. data/lib/shopify_api/rest/resources/2021_10/abandoned_checkout.rb +186 -0
  146. data/lib/shopify_api/rest/resources/2021_10/access_scope.rb +54 -0
  147. data/lib/shopify_api/rest/resources/2021_10/android_pay_key.rb +73 -0
  148. data/lib/shopify_api/rest/resources/2021_10/apple_pay_certificate.rb +101 -0
  149. data/lib/shopify_api/rest/resources/2021_10/application_charge.rb +100 -0
  150. data/lib/shopify_api/rest/resources/2021_10/application_credit.rb +83 -0
  151. data/lib/shopify_api/rest/resources/2021_10/article.rb +254 -0
  152. data/lib/shopify_api/rest/resources/2021_10/asset.rb +114 -0
  153. data/lib/shopify_api/rest/resources/2021_10/assigned_fulfillment_order.rb +75 -0
  154. data/lib/shopify_api/rest/resources/2021_10/balance.rb +46 -0
  155. data/lib/shopify_api/rest/resources/2021_10/blog.rb +158 -0
  156. data/lib/shopify_api/rest/resources/2021_10/cancellation_request.rb +79 -0
  157. data/lib/shopify_api/rest/resources/2021_10/carrier_service.rb +112 -0
  158. data/lib/shopify_api/rest/resources/2021_10/checkout.rb +205 -0
  159. data/lib/shopify_api/rest/resources/2021_10/collect.rb +138 -0
  160. data/lib/shopify_api/rest/resources/2021_10/collection.rb +106 -0
  161. data/lib/shopify_api/rest/resources/2021_10/collection_listing.rb +151 -0
  162. data/lib/shopify_api/rest/resources/2021_10/comment.rb +279 -0
  163. data/lib/shopify_api/rest/resources/2021_10/country.rb +133 -0
  164. data/lib/shopify_api/rest/resources/2021_10/currency.rb +53 -0
  165. data/lib/shopify_api/rest/resources/2021_10/custom_collection.rb +183 -0
  166. data/lib/shopify_api/rest/resources/2021_10/customer.rb +288 -0
  167. data/lib/shopify_api/rest/resources/2021_10/customer_address.rb +197 -0
  168. data/lib/shopify_api/rest/resources/2021_10/customer_saved_search.rb +165 -0
  169. data/lib/shopify_api/rest/resources/2021_10/deprecated_api_call.rb +53 -0
  170. data/lib/shopify_api/rest/resources/2021_10/discount_code.rb +215 -0
  171. data/lib/shopify_api/rest/resources/2021_10/dispute.rb +107 -0
  172. data/lib/shopify_api/rest/resources/2021_10/draft_order.rb +269 -0
  173. data/lib/shopify_api/rest/resources/2021_10/event.rb +144 -0
  174. data/lib/shopify_api/rest/resources/2021_10/fulfillment.rb +194 -0
  175. data/lib/shopify_api/rest/resources/2021_10/fulfillment_event.rb +162 -0
  176. data/lib/shopify_api/rest/resources/2021_10/fulfillment_order.rb +277 -0
  177. data/lib/shopify_api/rest/resources/2021_10/fulfillment_request.rb +79 -0
  178. data/lib/shopify_api/rest/resources/2021_10/fulfillment_service.rb +126 -0
  179. data/lib/shopify_api/rest/resources/2021_10/gift_card.rb +203 -0
  180. data/lib/shopify_api/rest/resources/2021_10/gift_card_adjustment.rb +114 -0
  181. data/lib/shopify_api/rest/resources/2021_10/image.rb +153 -0
  182. data/lib/shopify_api/rest/resources/2021_10/inventory_item.rb +104 -0
  183. data/lib/shopify_api/rest/resources/2021_10/inventory_level.rb +175 -0
  184. data/lib/shopify_api/rest/resources/2021_10/location.rb +163 -0
  185. data/lib/shopify_api/rest/resources/2021_10/locations_for_move.rb +52 -0
  186. data/lib/shopify_api/rest/resources/2021_10/marketing_event.rb +205 -0
  187. data/lib/shopify_api/rest/resources/2021_10/metafield.rb +338 -0
  188. data/lib/shopify_api/rest/resources/2021_10/mobile_platform_application.rb +106 -0
  189. data/lib/shopify_api/rest/resources/2021_10/order.rb +469 -0
  190. data/lib/shopify_api/rest/resources/2021_10/order_risk.rb +131 -0
  191. data/lib/shopify_api/rest/resources/2021_10/page.rb +190 -0
  192. data/lib/shopify_api/rest/resources/2021_10/payment.rb +136 -0
  193. data/lib/shopify_api/rest/resources/2021_10/payment_gateway.rb +139 -0
  194. data/lib/shopify_api/rest/resources/2021_10/payment_transaction.rb +103 -0
  195. data/lib/shopify_api/rest/resources/2021_10/payout.rb +93 -0
  196. data/lib/shopify_api/rest/resources/2021_10/policy.rb +65 -0
  197. data/lib/shopify_api/rest/resources/2021_10/price_rule.rb +219 -0
  198. data/lib/shopify_api/rest/resources/2021_10/product.rb +219 -0
  199. data/lib/shopify_api/rest/resources/2021_10/product_listing.rb +192 -0
  200. data/lib/shopify_api/rest/resources/2021_10/product_resource_feedback.rb +84 -0
  201. data/lib/shopify_api/rest/resources/2021_10/province.rb +128 -0
  202. data/lib/shopify_api/rest/resources/2021_10/recurring_application_charge.rb +163 -0
  203. data/lib/shopify_api/rest/resources/2021_10/redirect.rb +135 -0
  204. data/lib/shopify_api/rest/resources/2021_10/refund.rb +147 -0
  205. data/lib/shopify_api/rest/resources/2021_10/report.rb +117 -0
  206. data/lib/shopify_api/rest/resources/2021_10/resource_feedback.rb +69 -0
  207. data/lib/shopify_api/rest/resources/2021_10/script_tag.rb +151 -0
  208. data/lib/shopify_api/rest/resources/2021_10/shipping_zone.rb +79 -0
  209. data/lib/shopify_api/rest/resources/2021_10/shop.rb +214 -0
  210. data/lib/shopify_api/rest/resources/2021_10/smart_collection.rb +212 -0
  211. data/lib/shopify_api/rest/resources/2021_10/storefront_access_token.rb +83 -0
  212. data/lib/shopify_api/rest/resources/2021_10/tender_transaction.rb +89 -0
  213. data/lib/shopify_api/rest/resources/2021_10/theme.rb +116 -0
  214. data/lib/shopify_api/rest/resources/2021_10/transaction.rb +177 -0
  215. data/lib/shopify_api/rest/resources/2021_10/usage_charge.rb +93 -0
  216. data/lib/shopify_api/rest/resources/2021_10/user.rb +134 -0
  217. data/lib/shopify_api/rest/resources/2021_10/variant.rb +204 -0
  218. data/lib/shopify_api/rest/resources/2021_10/webhook.rb +164 -0
  219. data/lib/shopify_api/rest/resources/2022_01/abandoned_checkout.rb +186 -0
  220. data/lib/shopify_api/rest/resources/2022_01/access_scope.rb +54 -0
  221. data/lib/shopify_api/rest/resources/2022_01/android_pay_key.rb +73 -0
  222. data/lib/shopify_api/rest/resources/2022_01/apple_pay_certificate.rb +101 -0
  223. data/lib/shopify_api/rest/resources/2022_01/application_charge.rb +100 -0
  224. data/lib/shopify_api/rest/resources/2022_01/application_credit.rb +83 -0
  225. data/lib/shopify_api/rest/resources/2022_01/article.rb +254 -0
  226. data/lib/shopify_api/rest/resources/2022_01/asset.rb +114 -0
  227. data/lib/shopify_api/rest/resources/2022_01/assigned_fulfillment_order.rb +75 -0
  228. data/lib/shopify_api/rest/resources/2022_01/balance.rb +46 -0
  229. data/lib/shopify_api/rest/resources/2022_01/blog.rb +158 -0
  230. data/lib/shopify_api/rest/resources/2022_01/cancellation_request.rb +79 -0
  231. data/lib/shopify_api/rest/resources/2022_01/carrier_service.rb +112 -0
  232. data/lib/shopify_api/rest/resources/2022_01/checkout.rb +205 -0
  233. data/lib/shopify_api/rest/resources/2022_01/collect.rb +138 -0
  234. data/lib/shopify_api/rest/resources/2022_01/collection.rb +106 -0
  235. data/lib/shopify_api/rest/resources/2022_01/collection_listing.rb +151 -0
  236. data/lib/shopify_api/rest/resources/2022_01/comment.rb +279 -0
  237. data/lib/shopify_api/rest/resources/2022_01/country.rb +133 -0
  238. data/lib/shopify_api/rest/resources/2022_01/currency.rb +53 -0
  239. data/lib/shopify_api/rest/resources/2022_01/custom_collection.rb +183 -0
  240. data/lib/shopify_api/rest/resources/2022_01/customer.rb +288 -0
  241. data/lib/shopify_api/rest/resources/2022_01/customer_address.rb +197 -0
  242. data/lib/shopify_api/rest/resources/2022_01/customer_saved_search.rb +165 -0
  243. data/lib/shopify_api/rest/resources/2022_01/deprecated_api_call.rb +53 -0
  244. data/lib/shopify_api/rest/resources/2022_01/discount_code.rb +215 -0
  245. data/lib/shopify_api/rest/resources/2022_01/dispute.rb +107 -0
  246. data/lib/shopify_api/rest/resources/2022_01/draft_order.rb +269 -0
  247. data/lib/shopify_api/rest/resources/2022_01/event.rb +144 -0
  248. data/lib/shopify_api/rest/resources/2022_01/fulfillment.rb +194 -0
  249. data/lib/shopify_api/rest/resources/2022_01/fulfillment_event.rb +162 -0
  250. data/lib/shopify_api/rest/resources/2022_01/fulfillment_order.rb +277 -0
  251. data/lib/shopify_api/rest/resources/2022_01/fulfillment_request.rb +79 -0
  252. data/lib/shopify_api/rest/resources/2022_01/fulfillment_service.rb +126 -0
  253. data/lib/shopify_api/rest/resources/2022_01/gift_card.rb +203 -0
  254. data/lib/shopify_api/rest/resources/2022_01/gift_card_adjustment.rb +114 -0
  255. data/lib/shopify_api/rest/resources/2022_01/image.rb +153 -0
  256. data/lib/shopify_api/rest/resources/2022_01/inventory_item.rb +104 -0
  257. data/lib/shopify_api/rest/resources/2022_01/inventory_level.rb +175 -0
  258. data/lib/shopify_api/rest/resources/2022_01/location.rb +163 -0
  259. data/lib/shopify_api/rest/resources/2022_01/locations_for_move.rb +52 -0
  260. data/lib/shopify_api/rest/resources/2022_01/marketing_event.rb +205 -0
  261. data/lib/shopify_api/rest/resources/2022_01/metafield.rb +338 -0
  262. data/lib/shopify_api/rest/resources/2022_01/mobile_platform_application.rb +106 -0
  263. data/lib/shopify_api/rest/resources/2022_01/order.rb +469 -0
  264. data/lib/shopify_api/rest/resources/2022_01/order_risk.rb +131 -0
  265. data/lib/shopify_api/rest/resources/2022_01/page.rb +190 -0
  266. data/lib/shopify_api/rest/resources/2022_01/payment.rb +136 -0
  267. data/lib/shopify_api/rest/resources/2022_01/payment_gateway.rb +139 -0
  268. data/lib/shopify_api/rest/resources/2022_01/payment_transaction.rb +103 -0
  269. data/lib/shopify_api/rest/resources/2022_01/payout.rb +93 -0
  270. data/lib/shopify_api/rest/resources/2022_01/policy.rb +65 -0
  271. data/lib/shopify_api/rest/resources/2022_01/price_rule.rb +219 -0
  272. data/lib/shopify_api/rest/resources/2022_01/product.rb +219 -0
  273. data/lib/shopify_api/rest/resources/2022_01/product_listing.rb +192 -0
  274. data/lib/shopify_api/rest/resources/2022_01/product_resource_feedback.rb +84 -0
  275. data/lib/shopify_api/rest/resources/2022_01/province.rb +128 -0
  276. data/lib/shopify_api/rest/resources/2022_01/recurring_application_charge.rb +163 -0
  277. data/lib/shopify_api/rest/resources/2022_01/redirect.rb +135 -0
  278. data/lib/shopify_api/rest/resources/2022_01/refund.rb +147 -0
  279. data/lib/shopify_api/rest/resources/2022_01/report.rb +117 -0
  280. data/lib/shopify_api/rest/resources/2022_01/resource_feedback.rb +69 -0
  281. data/lib/shopify_api/rest/resources/2022_01/script_tag.rb +151 -0
  282. data/lib/shopify_api/rest/resources/2022_01/shipping_zone.rb +79 -0
  283. data/lib/shopify_api/rest/resources/2022_01/shop.rb +214 -0
  284. data/lib/shopify_api/rest/resources/2022_01/smart_collection.rb +212 -0
  285. data/lib/shopify_api/rest/resources/2022_01/storefront_access_token.rb +83 -0
  286. data/lib/shopify_api/rest/resources/2022_01/tender_transaction.rb +89 -0
  287. data/lib/shopify_api/rest/resources/2022_01/theme.rb +116 -0
  288. data/lib/shopify_api/rest/resources/2022_01/transaction.rb +177 -0
  289. data/lib/shopify_api/rest/resources/2022_01/usage_charge.rb +93 -0
  290. data/lib/shopify_api/rest/resources/2022_01/user.rb +134 -0
  291. data/lib/shopify_api/rest/resources/2022_01/variant.rb +204 -0
  292. data/lib/shopify_api/rest/resources/2022_01/webhook.rb +164 -0
  293. data/lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb +186 -0
  294. data/lib/shopify_api/rest/resources/2022_04/access_scope.rb +54 -0
  295. data/lib/shopify_api/rest/resources/2022_04/android_pay_key.rb +73 -0
  296. data/lib/shopify_api/rest/resources/2022_04/apple_pay_certificate.rb +101 -0
  297. data/lib/shopify_api/rest/resources/2022_04/application_charge.rb +100 -0
  298. data/lib/shopify_api/rest/resources/2022_04/application_credit.rb +83 -0
  299. data/lib/shopify_api/rest/resources/2022_04/article.rb +254 -0
  300. data/lib/shopify_api/rest/resources/2022_04/asset.rb +114 -0
  301. data/lib/shopify_api/rest/resources/2022_04/assigned_fulfillment_order.rb +75 -0
  302. data/lib/shopify_api/rest/resources/2022_04/balance.rb +46 -0
  303. data/lib/shopify_api/rest/resources/2022_04/blog.rb +158 -0
  304. data/lib/shopify_api/rest/resources/2022_04/cancellation_request.rb +79 -0
  305. data/lib/shopify_api/rest/resources/2022_04/carrier_service.rb +112 -0
  306. data/lib/shopify_api/rest/resources/2022_04/checkout.rb +205 -0
  307. data/lib/shopify_api/rest/resources/2022_04/collect.rb +138 -0
  308. data/lib/shopify_api/rest/resources/2022_04/collection.rb +106 -0
  309. data/lib/shopify_api/rest/resources/2022_04/collection_listing.rb +151 -0
  310. data/lib/shopify_api/rest/resources/2022_04/comment.rb +279 -0
  311. data/lib/shopify_api/rest/resources/2022_04/country.rb +133 -0
  312. data/lib/shopify_api/rest/resources/2022_04/currency.rb +53 -0
  313. data/lib/shopify_api/rest/resources/2022_04/custom_collection.rb +183 -0
  314. data/lib/shopify_api/rest/resources/2022_04/customer.rb +291 -0
  315. data/lib/shopify_api/rest/resources/2022_04/customer_address.rb +197 -0
  316. data/lib/shopify_api/rest/resources/2022_04/customer_saved_search.rb +165 -0
  317. data/lib/shopify_api/rest/resources/2022_04/deprecated_api_call.rb +53 -0
  318. data/lib/shopify_api/rest/resources/2022_04/discount_code.rb +215 -0
  319. data/lib/shopify_api/rest/resources/2022_04/dispute.rb +107 -0
  320. data/lib/shopify_api/rest/resources/2022_04/draft_order.rb +269 -0
  321. data/lib/shopify_api/rest/resources/2022_04/event.rb +144 -0
  322. data/lib/shopify_api/rest/resources/2022_04/fulfillment.rb +194 -0
  323. data/lib/shopify_api/rest/resources/2022_04/fulfillment_event.rb +162 -0
  324. data/lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb +277 -0
  325. data/lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb +79 -0
  326. data/lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb +126 -0
  327. data/lib/shopify_api/rest/resources/2022_04/gift_card.rb +203 -0
  328. data/lib/shopify_api/rest/resources/2022_04/gift_card_adjustment.rb +114 -0
  329. data/lib/shopify_api/rest/resources/2022_04/image.rb +153 -0
  330. data/lib/shopify_api/rest/resources/2022_04/inventory_item.rb +104 -0
  331. data/lib/shopify_api/rest/resources/2022_04/inventory_level.rb +175 -0
  332. data/lib/shopify_api/rest/resources/2022_04/location.rb +163 -0
  333. data/lib/shopify_api/rest/resources/2022_04/locations_for_move.rb +52 -0
  334. data/lib/shopify_api/rest/resources/2022_04/marketing_event.rb +205 -0
  335. data/lib/shopify_api/rest/resources/2022_04/metafield.rb +338 -0
  336. data/lib/shopify_api/rest/resources/2022_04/mobile_platform_application.rb +106 -0
  337. data/lib/shopify_api/rest/resources/2022_04/order.rb +469 -0
  338. data/lib/shopify_api/rest/resources/2022_04/order_risk.rb +131 -0
  339. data/lib/shopify_api/rest/resources/2022_04/page.rb +190 -0
  340. data/lib/shopify_api/rest/resources/2022_04/payment.rb +136 -0
  341. data/lib/shopify_api/rest/resources/2022_04/payment_gateway.rb +139 -0
  342. data/lib/shopify_api/rest/resources/2022_04/payment_transaction.rb +103 -0
  343. data/lib/shopify_api/rest/resources/2022_04/payout.rb +93 -0
  344. data/lib/shopify_api/rest/resources/2022_04/policy.rb +65 -0
  345. data/lib/shopify_api/rest/resources/2022_04/price_rule.rb +219 -0
  346. data/lib/shopify_api/rest/resources/2022_04/product.rb +219 -0
  347. data/lib/shopify_api/rest/resources/2022_04/product_listing.rb +192 -0
  348. data/lib/shopify_api/rest/resources/2022_04/product_resource_feedback.rb +84 -0
  349. data/lib/shopify_api/rest/resources/2022_04/province.rb +128 -0
  350. data/lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb +163 -0
  351. data/lib/shopify_api/rest/resources/2022_04/redirect.rb +135 -0
  352. data/lib/shopify_api/rest/resources/2022_04/refund.rb +147 -0
  353. data/lib/shopify_api/rest/resources/2022_04/report.rb +117 -0
  354. data/lib/shopify_api/rest/resources/2022_04/resource_feedback.rb +69 -0
  355. data/lib/shopify_api/rest/resources/2022_04/script_tag.rb +151 -0
  356. data/lib/shopify_api/rest/resources/2022_04/shipping_zone.rb +79 -0
  357. data/lib/shopify_api/rest/resources/2022_04/shop.rb +214 -0
  358. data/lib/shopify_api/rest/resources/2022_04/smart_collection.rb +212 -0
  359. data/lib/shopify_api/rest/resources/2022_04/storefront_access_token.rb +83 -0
  360. data/lib/shopify_api/rest/resources/2022_04/tender_transaction.rb +89 -0
  361. data/lib/shopify_api/rest/resources/2022_04/theme.rb +116 -0
  362. data/lib/shopify_api/rest/resources/2022_04/transaction.rb +177 -0
  363. data/lib/shopify_api/rest/resources/2022_04/usage_charge.rb +93 -0
  364. data/lib/shopify_api/rest/resources/2022_04/user.rb +134 -0
  365. data/lib/shopify_api/rest/resources/2022_04/variant.rb +204 -0
  366. data/lib/shopify_api/rest/resources/2022_04/webhook.rb +164 -0
  367. data/lib/shopify_api/utils/graphql_proxy.rb +52 -0
  368. data/lib/shopify_api/utils/hmac_validator.rb +34 -0
  369. data/lib/shopify_api/utils/http_utils.rb +17 -0
  370. data/lib/shopify_api/utils/session_utils.rb +135 -0
  371. data/lib/shopify_api/utils/verifiable_query.rb +18 -0
  372. data/lib/shopify_api/version.rb +3 -1
  373. data/lib/shopify_api/webhooks/handler.rb +15 -0
  374. data/lib/shopify_api/webhooks/register_result.rb +14 -0
  375. data/lib/shopify_api/webhooks/registration.rb +73 -0
  376. data/lib/shopify_api/webhooks/registrations/event_bridge.rb +61 -0
  377. data/lib/shopify_api/webhooks/registrations/http.rb +66 -0
  378. data/lib/shopify_api/webhooks/registrations/pub_sub.rb +65 -0
  379. data/lib/shopify_api/webhooks/registry.rb +216 -0
  380. data/lib/shopify_api/webhooks/request.rb +56 -0
  381. data/lib/shopify_api.rb +18 -40
  382. data/service.yml +0 -3
  383. data/shipit.rubygems.yml +1 -1
  384. data/shopify_api.gemspec +28 -23
  385. data/sorbet/config +3 -0
  386. data/sorbet/rbi/gems/activesupport@7.0.1.rbi +654 -0
  387. data/sorbet/rbi/gems/addressable@2.8.0.rbi +290 -0
  388. data/sorbet/rbi/gems/ast@2.4.2.rbi +54 -0
  389. data/sorbet/rbi/gems/coderay@1.1.3.rbi +8 -0
  390. data/sorbet/rbi/gems/concurrent-ruby@1.1.9.rbi +2401 -0
  391. data/sorbet/rbi/gems/crack@0.4.5.rbi +57 -0
  392. data/sorbet/rbi/gems/diff-lcs@1.5.0.rbi +185 -0
  393. data/sorbet/rbi/gems/fakefs@1.4.1.rbi +571 -0
  394. data/sorbet/rbi/gems/hash_diff@1.0.0.rbi +47 -0
  395. data/sorbet/rbi/gems/hashdiff@1.0.1.rbi +82 -0
  396. data/sorbet/rbi/gems/httparty@0.20.0.rbi +573 -0
  397. data/sorbet/rbi/gems/i18n@1.8.11.rbi +25 -0
  398. data/sorbet/rbi/gems/jwt@2.3.0.rbi +437 -0
  399. data/sorbet/rbi/gems/method_source@1.0.0.rbi +8 -0
  400. data/sorbet/rbi/gems/mime-types-data@3.2022.0105.rbi +73 -0
  401. data/sorbet/rbi/gems/mime-types@3.4.1.rbi +295 -0
  402. data/sorbet/rbi/gems/minitest@5.15.0.rbi +541 -0
  403. data/sorbet/rbi/gems/mocha@1.13.0.rbi +986 -0
  404. data/sorbet/rbi/gems/multi_xml@0.6.0.rbi +36 -0
  405. data/sorbet/rbi/gems/oj@3.13.11.rbi +274 -0
  406. data/sorbet/rbi/gems/openssl@3.0.0.rbi +581 -0
  407. data/sorbet/rbi/gems/parallel@1.21.0.rbi +113 -0
  408. data/sorbet/rbi/gems/parser@3.1.0.0.rbi +1741 -0
  409. data/sorbet/rbi/gems/pry@0.14.1.rbi +8 -0
  410. data/sorbet/rbi/gems/public_suffix@4.0.6.rbi +145 -0
  411. data/sorbet/rbi/gems/rainbow@3.1.1.rbi +157 -0
  412. data/sorbet/rbi/gems/rake@13.0.6.rbi +814 -0
  413. data/sorbet/rbi/gems/rbi@0.0.11.rbi +1646 -0
  414. data/sorbet/rbi/gems/regexp_parser@2.2.0.rbi +1130 -0
  415. data/sorbet/rbi/gems/rexml@3.2.5.rbi +709 -0
  416. data/sorbet/rbi/gems/rubocop-ast@1.15.1.rbi +1921 -0
  417. data/sorbet/rbi/gems/rubocop-shopify@2.4.0.rbi +8 -0
  418. data/sorbet/rbi/gems/rubocop-sorbet@0.6.5.rbi +295 -0
  419. data/sorbet/rbi/gems/rubocop@1.25.1.rbi +13507 -0
  420. data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +405 -0
  421. data/sorbet/rbi/gems/securerandom@0.1.1.rbi +10 -0
  422. data/sorbet/rbi/gems/spoom@1.1.8.rbi +1252 -0
  423. data/sorbet/rbi/gems/tapioca@0.6.3.rbi +1238 -0
  424. data/sorbet/rbi/gems/thor@1.2.1.rbi +844 -0
  425. data/sorbet/rbi/gems/tzinfo@2.0.4.rbi +858 -0
  426. data/sorbet/rbi/gems/unicode-display_width@2.1.0.rbi +26 -0
  427. data/sorbet/rbi/gems/unparser@0.6.3.rbi +1816 -0
  428. data/sorbet/rbi/gems/webmock@3.14.0.rbi +683 -0
  429. data/sorbet/rbi/gems/webrick@1.7.0.rbi +601 -0
  430. data/sorbet/rbi/gems/yard-sorbet@0.6.1.rbi +199 -0
  431. data/sorbet/rbi/gems/yard@0.9.27.rbi +4145 -0
  432. data/sorbet/rbi/gems/zeitwerk@2.5.4.rbi +200 -0
  433. data/sorbet/rbi/shims/fakefs.rbi +1 -0
  434. data/sorbet/rbi/shims/openssl.rb +3 -0
  435. data/sorbet/rbi/todo.rbi +9 -0
  436. data/sorbet/tapioca/config.yml +4 -0
  437. data/sorbet/tapioca/require.rb +20 -0
  438. metadata +511 -356
  439. data/.document +0 -5
  440. data/.gitignore +0 -14
  441. data/.rubocop_todo.yml +0 -75
  442. data/CONTRIBUTORS +0 -3
  443. data/Gemfile_ar41 +0 -5
  444. data/Gemfile_ar50 +0 -5
  445. data/Gemfile_ar51 +0 -5
  446. data/Gemfile_ar60 +0 -5
  447. data/Gemfile_ar_main +0 -5
  448. data/docker-compose.yml +0 -13
  449. data/docs/_config.yml +0 -1
  450. data/docs/_includes/footer.html +0 -28
  451. data/docs/_includes/head.html +0 -28
  452. data/docs/_layouts/index.html +0 -57
  453. data/docs/graphql.md +0 -241
  454. data/docs/index.md +0 -639
  455. data/lib/active_resource/connection_ext.rb +0 -11
  456. data/lib/active_resource/detailed_log_subscriber.rb +0 -55
  457. data/lib/active_resource/json_errors.rb +0 -37
  458. data/lib/shopify_api/api_access.rb +0 -57
  459. data/lib/shopify_api/api_version.rb +0 -206
  460. data/lib/shopify_api/connection.rb +0 -36
  461. data/lib/shopify_api/countable.rb +0 -15
  462. data/lib/shopify_api/disable_prefix_check.rb +0 -31
  463. data/lib/shopify_api/events.rb +0 -8
  464. data/lib/shopify_api/graphql/http_client.rb +0 -22
  465. data/lib/shopify_api/graphql/railtie.rb +0 -17
  466. data/lib/shopify_api/graphql/task.rake +0 -100
  467. data/lib/shopify_api/graphql.rb +0 -103
  468. data/lib/shopify_api/hmac_params.rb +0 -33
  469. data/lib/shopify_api/limits.rb +0 -77
  470. data/lib/shopify_api/message_enricher.rb +0 -25
  471. data/lib/shopify_api/meta.rb +0 -14
  472. data/lib/shopify_api/metafields.rb +0 -21
  473. data/lib/shopify_api/paginated_collection.rb +0 -69
  474. data/lib/shopify_api/pagination_link_headers.rb +0 -34
  475. data/lib/shopify_api/resources/abandoned_checkout.rb +0 -7
  476. data/lib/shopify_api/resources/access_scope.rb +0 -10
  477. data/lib/shopify_api/resources/access_token.rb +0 -9
  478. data/lib/shopify_api/resources/address.rb +0 -5
  479. data/lib/shopify_api/resources/announcement.rb +0 -5
  480. data/lib/shopify_api/resources/api_permission.rb +0 -9
  481. data/lib/shopify_api/resources/application_charge.rb +0 -16
  482. data/lib/shopify_api/resources/application_credit.rb +0 -5
  483. data/lib/shopify_api/resources/array_base.rb +0 -13
  484. data/lib/shopify_api/resources/article.rb +0 -22
  485. data/lib/shopify_api/resources/asset.rb +0 -101
  486. data/lib/shopify_api/resources/assigned_fulfillment_order.rb +0 -16
  487. data/lib/shopify_api/resources/base.rb +0 -166
  488. data/lib/shopify_api/resources/billing_address.rb +0 -5
  489. data/lib/shopify_api/resources/blog.rb +0 -11
  490. data/lib/shopify_api/resources/carrier_service.rb +0 -5
  491. data/lib/shopify_api/resources/cart.rb +0 -5
  492. data/lib/shopify_api/resources/checkout.rb +0 -30
  493. data/lib/shopify_api/resources/collect.rb +0 -7
  494. data/lib/shopify_api/resources/collection.rb +0 -14
  495. data/lib/shopify_api/resources/collection_listing.rb +0 -19
  496. data/lib/shopify_api/resources/collection_publication.rb +0 -10
  497. data/lib/shopify_api/resources/comment.rb +0 -24
  498. data/lib/shopify_api/resources/country.rb +0 -5
  499. data/lib/shopify_api/resources/currency.rb +0 -6
  500. data/lib/shopify_api/resources/custom_collection.rb +0 -20
  501. data/lib/shopify_api/resources/customer.rb +0 -30
  502. data/lib/shopify_api/resources/customer_group.rb +0 -6
  503. data/lib/shopify_api/resources/customer_invite.rb +0 -5
  504. data/lib/shopify_api/resources/customer_saved_search.rb +0 -12
  505. data/lib/shopify_api/resources/discount_code.rb +0 -10
  506. data/lib/shopify_api/resources/discount_code_batch.rb +0 -34
  507. data/lib/shopify_api/resources/draft_order.rb +0 -15
  508. data/lib/shopify_api/resources/draft_order_invoice.rb +0 -5
  509. data/lib/shopify_api/resources/event.rb +0 -9
  510. data/lib/shopify_api/resources/fulfillment.rb +0 -56
  511. data/lib/shopify_api/resources/fulfillment_event.rb +0 -16
  512. data/lib/shopify_api/resources/fulfillment_order.rb +0 -151
  513. data/lib/shopify_api/resources/fulfillment_order_locations_for_move.rb +0 -5
  514. data/lib/shopify_api/resources/fulfillment_request.rb +0 -16
  515. data/lib/shopify_api/resources/fulfillment_service.rb +0 -5
  516. data/lib/shopify_api/resources/fulfillment_v2.rb +0 -21
  517. data/lib/shopify_api/resources/gift_card.rb +0 -8
  518. data/lib/shopify_api/resources/image.rb +0 -17
  519. data/lib/shopify_api/resources/inventory_item.rb +0 -6
  520. data/lib/shopify_api/resources/inventory_level.rb +0 -54
  521. data/lib/shopify_api/resources/line_item.rb +0 -15
  522. data/lib/shopify_api/resources/location.rb +0 -8
  523. data/lib/shopify_api/resources/marketing_event.rb +0 -11
  524. data/lib/shopify_api/resources/metafield.rb +0 -14
  525. data/lib/shopify_api/resources/note_attribute.rb +0 -5
  526. data/lib/shopify_api/resources/option.rb +0 -5
  527. data/lib/shopify_api/resources/order.rb +0 -44
  528. data/lib/shopify_api/resources/order_risk.rb +0 -9
  529. data/lib/shopify_api/resources/page.rb +0 -7
  530. data/lib/shopify_api/resources/payment.rb +0 -7
  531. data/lib/shopify_api/resources/payment_details.rb +0 -5
  532. data/lib/shopify_api/resources/ping.rb +0 -3
  533. data/lib/shopify_api/resources/policy.rb +0 -8
  534. data/lib/shopify_api/resources/price_rule.rb +0 -8
  535. data/lib/shopify_api/resources/product.rb +0 -59
  536. data/lib/shopify_api/resources/product_listing.rb +0 -17
  537. data/lib/shopify_api/resources/product_publication.rb +0 -10
  538. data/lib/shopify_api/resources/province.rb +0 -6
  539. data/lib/shopify_api/resources/publication.rb +0 -5
  540. data/lib/shopify_api/resources/receipt.rb +0 -5
  541. data/lib/shopify_api/resources/recurring_application_charge.rb +0 -34
  542. data/lib/shopify_api/resources/redirect.rb +0 -5
  543. data/lib/shopify_api/resources/refund.rb +0 -15
  544. data/lib/shopify_api/resources/report.rb +0 -5
  545. data/lib/shopify_api/resources/resource_feedback.rb +0 -19
  546. data/lib/shopify_api/resources/rule.rb +0 -5
  547. data/lib/shopify_api/resources/script_tag.rb +0 -5
  548. data/lib/shopify_api/resources/shipping_address.rb +0 -5
  549. data/lib/shopify_api/resources/shipping_line.rb +0 -5
  550. data/lib/shopify_api/resources/shipping_rate.rb +0 -7
  551. data/lib/shopify_api/resources/shipping_zone.rb +0 -5
  552. data/lib/shopify_api/resources/shop.rb +0 -26
  553. data/lib/shopify_api/resources/smart_collection.rb +0 -15
  554. data/lib/shopify_api/resources/storefront_access_token.rb +0 -5
  555. data/lib/shopify_api/resources/tax_line.rb +0 -5
  556. data/lib/shopify_api/resources/tax_service.rb +0 -5
  557. data/lib/shopify_api/resources/tender_transaction.rb +0 -6
  558. data/lib/shopify_api/resources/theme.rb +0 -5
  559. data/lib/shopify_api/resources/transaction.rb +0 -6
  560. data/lib/shopify_api/resources/usage_charge.rb +0 -6
  561. data/lib/shopify_api/resources/user.rb +0 -5
  562. data/lib/shopify_api/resources/variant.rb +0 -43
  563. data/lib/shopify_api/resources/webhook.rb +0 -5
  564. data/lib/shopify_api/resources.rb +0 -4
  565. data/lib/shopify_api/session.rb +0 -203
  566. data/lib/verify_docs.rb +0 -8
  567. data/test/abandoned_checkouts_test.rb +0 -29
  568. data/test/access_scope_test.rb +0 -23
  569. data/test/access_token_test.rb +0 -20
  570. data/test/active_resource/json_errors_test.rb +0 -19
  571. data/test/api_access_test.rb +0 -153
  572. data/test/api_permission_test.rb +0 -9
  573. data/test/api_version_test.rb +0 -157
  574. data/test/application_charge_test.rb +0 -82
  575. data/test/application_credit_test.rb +0 -36
  576. data/test/article_test.rb +0 -72
  577. data/test/asset_test.rb +0 -26
  578. data/test/assigned_fulfillment_order_test.rb +0 -78
  579. data/test/base_test.rb +0 -213
  580. data/test/blog_test.rb +0 -9
  581. data/test/carrier_service_test.rb +0 -18
  582. data/test/cart_test.rb +0 -14
  583. data/test/checkouts_test.rb +0 -77
  584. data/test/collect_test.rb +0 -10
  585. data/test/collection_listing_test.rb +0 -84
  586. data/test/collection_publication_test.rb +0 -40
  587. data/test/collection_test.rb +0 -50
  588. data/test/countable_test.rb +0 -14
  589. data/test/currency_test.rb +0 -21
  590. data/test/custom_collection_test.rb +0 -10
  591. data/test/customer_saved_search_test.rb +0 -37
  592. data/test/customer_test.rb +0 -58
  593. data/test/detailed_log_subscriber_test.rb +0 -143
  594. data/test/discount_code_batch_test.rb +0 -41
  595. data/test/discount_code_test.rb +0 -59
  596. data/test/draft_order_test.rb +0 -167
  597. data/test/fixtures/abandoned_checkout.json +0 -184
  598. data/test/fixtures/abandoned_checkouts.json +0 -186
  599. data/test/fixtures/access_scopes.json +0 -10
  600. data/test/fixtures/access_token_delegate.json +0 -4
  601. data/test/fixtures/api_versions.json +0 -38
  602. data/test/fixtures/apis.json +0 -42
  603. data/test/fixtures/application_charge.json +0 -16
  604. data/test/fixtures/application_charges.json +0 -57
  605. data/test/fixtures/application_credit.json +0 -12
  606. data/test/fixtures/application_credits.json +0 -24
  607. data/test/fixtures/article.json +0 -15
  608. data/test/fixtures/articles.json +0 -39
  609. data/test/fixtures/asset.json +0 -9
  610. data/test/fixtures/assets.json +0 -136
  611. data/test/fixtures/assigned_fulfillment_orders.json +0 -80
  612. data/test/fixtures/authors.json +0 -1
  613. data/test/fixtures/blog.json +0 -13
  614. data/test/fixtures/blogs.json +0 -13
  615. data/test/fixtures/carrier_service.json +0 -9
  616. data/test/fixtures/carts.json +0 -43
  617. data/test/fixtures/checkout.json +0 -160
  618. data/test/fixtures/checkouts.json +0 -162
  619. data/test/fixtures/collect.json +0 -12
  620. data/test/fixtures/collection.json +0 -17
  621. data/test/fixtures/collection_listing.json +0 -11
  622. data/test/fixtures/collection_listing_product_ids.json +0 -1
  623. data/test/fixtures/collection_listing_product_ids2.json +0 -1
  624. data/test/fixtures/collection_listings.json +0 -13
  625. data/test/fixtures/collection_products.json +0 -47
  626. data/test/fixtures/collection_publication.json +0 -11
  627. data/test/fixtures/collection_publications.json +0 -13
  628. data/test/fixtures/currencies.json +0 -25
  629. data/test/fixtures/custom_collection.json +0 -17
  630. data/test/fixtures/customer_invite.json +0 -9
  631. data/test/fixtures/customer_saved_search.json +0 -9
  632. data/test/fixtures/customer_saved_search_customers.json +0 -60
  633. data/test/fixtures/customers.json +0 -59
  634. data/test/fixtures/customers_account_activation_url.json +0 -3
  635. data/test/fixtures/customers_search.json +0 -60
  636. data/test/fixtures/discount_code.json +0 -10
  637. data/test/fixtures/discount_code_batch.json +0 -14
  638. data/test/fixtures/discount_code_batch_discount_codes.json +0 -21
  639. data/test/fixtures/discount_codes.json +0 -12
  640. data/test/fixtures/draft_order.json +0 -159
  641. data/test/fixtures/draft_order_completed.json +0 -159
  642. data/test/fixtures/draft_order_invoice.json +0 -9
  643. data/test/fixtures/draft_orders.json +0 -161
  644. data/test/fixtures/engagement.json +0 -15
  645. data/test/fixtures/events.json +0 -31
  646. data/test/fixtures/fulfillment.json +0 -49
  647. data/test/fixtures/fulfillment_event.json +0 -12
  648. data/test/fixtures/fulfillment_order.json +0 -39
  649. data/test/fixtures/fulfillment_order_locations_for_move.json +0 -18
  650. data/test/fixtures/fulfillment_orders.json +0 -80
  651. data/test/fixtures/fulfillment_request.json +0 -28
  652. data/test/fixtures/fulfillment_service.json +0 -10
  653. data/test/fixtures/fulfillments.json +0 -53
  654. data/test/fixtures/gift_card.json +0 -20
  655. data/test/fixtures/gift_card_disabled.json +0 -20
  656. data/test/fixtures/graphql/2019-10.json +0 -1083
  657. data/test/fixtures/graphql/dummy_schema.rb +0 -16
  658. data/test/fixtures/graphql/unstable.json +0 -1083
  659. data/test/fixtures/image.json +0 -10
  660. data/test/fixtures/images.json +0 -20
  661. data/test/fixtures/inventory_level.json +0 -7
  662. data/test/fixtures/inventory_levels.json +0 -24
  663. data/test/fixtures/marketing_event.json +0 -28
  664. data/test/fixtures/marketing_events.json +0 -54
  665. data/test/fixtures/metafield.json +0 -12
  666. data/test/fixtures/metafields.json +0 -34
  667. data/test/fixtures/order.json +0 -297
  668. data/test/fixtures/order_risk.json +0 -14
  669. data/test/fixtures/order_risks.json +0 -28
  670. data/test/fixtures/order_with_properties.json +0 -373
  671. data/test/fixtures/orders.json +0 -299
  672. data/test/fixtures/payment.json +0 -7
  673. data/test/fixtures/payments.json +0 -9
  674. data/test/fixtures/ping/conversation.json +0 -1
  675. data/test/fixtures/ping/failed_delivery_confirmation.json +0 -1
  676. data/test/fixtures/ping/message.json +0 -1
  677. data/test/fixtures/ping/successful_delivery_confirmation.json +0 -1
  678. data/test/fixtures/policies.json +0 -8
  679. data/test/fixtures/price_rule.json +0 -27
  680. data/test/fixtures/price_rules.json +0 -28
  681. data/test/fixtures/product.json +0 -116
  682. data/test/fixtures/product_listing.json +0 -86
  683. data/test/fixtures/product_listing_product_ids.json +0 -1
  684. data/test/fixtures/product_listing_product_ids2.json +0 -1
  685. data/test/fixtures/product_listings.json +0 -174
  686. data/test/fixtures/product_publication.json +0 -11
  687. data/test/fixtures/product_publications.json +0 -13
  688. data/test/fixtures/publications.json +0 -9
  689. data/test/fixtures/recurring_application_charge.json +0 -22
  690. data/test/fixtures/recurring_application_charge_adjustment.json +0 -5
  691. data/test/fixtures/recurring_application_charges.json +0 -106
  692. data/test/fixtures/redirect.json +0 -7
  693. data/test/fixtures/refund.json +0 -112
  694. data/test/fixtures/report.json +0 -9
  695. data/test/fixtures/reports.json +0 -11
  696. data/test/fixtures/script_tag.json +0 -10
  697. data/test/fixtures/script_tags.json +0 -18
  698. data/test/fixtures/shipping_rates.json +0 -12
  699. data/test/fixtures/shipping_zones.json +0 -315
  700. data/test/fixtures/shop.json +0 -26
  701. data/test/fixtures/smart_collection.json +0 -21
  702. data/test/fixtures/smart_collection_products.json +0 -155
  703. data/test/fixtures/storefront_access_token.json +0 -9
  704. data/test/fixtures/storefront_access_tokens.json +0 -18
  705. data/test/fixtures/tags.json +0 -1
  706. data/test/fixtures/tax_service.json +0 -9
  707. data/test/fixtures/tender_transactions.json +0 -52
  708. data/test/fixtures/transaction.json +0 -29
  709. data/test/fixtures/usage_charge.json +0 -11
  710. data/test/fixtures/usage_charges.json +0 -23
  711. data/test/fixtures/user.json +0 -21
  712. data/test/fixtures/users.json +0 -42
  713. data/test/fixtures/variant.json +0 -23
  714. data/test/fixtures/variants.json +0 -88
  715. data/test/fixtures/webhook.json +0 -10
  716. data/test/fixtures/webhooks.json +0 -18
  717. data/test/fulfillment_event_test.rb +0 -74
  718. data/test/fulfillment_order_test.rb +0 -530
  719. data/test/fulfillment_order_test_helper.rb +0 -8
  720. data/test/fulfillment_request_test.rb +0 -35
  721. data/test/fulfillment_service_test.rb +0 -18
  722. data/test/fulfillment_test.rb +0 -239
  723. data/test/fulfillment_v2_test.rb +0 -66
  724. data/test/gift_card_test.rb +0 -24
  725. data/test/graphql/http_client_test.rb +0 -26
  726. data/test/graphql_test.rb +0 -190
  727. data/test/hmac_params_test.rb +0 -25
  728. data/test/image_test.rb +0 -41
  729. data/test/inventory_level_test.rb +0 -68
  730. data/test/lib/webmock_extensions/last_request.rb +0 -16
  731. data/test/limits_test.rb +0 -39
  732. data/test/location_test.rb +0 -15
  733. data/test/marketing_event_test.rb +0 -68
  734. data/test/message_enricher_test.rb +0 -45
  735. data/test/meta_test.rb +0 -47
  736. data/test/metafield_test.rb +0 -56
  737. data/test/order_risk_test.rb +0 -47
  738. data/test/order_test.rb +0 -140
  739. data/test/pagination_test.rb +0 -290
  740. data/test/payment_test.rb +0 -19
  741. data/test/policy_test.rb +0 -20
  742. data/test/price_rule_test.rb +0 -70
  743. data/test/product_listing_test.rb +0 -97
  744. data/test/product_publication_test.rb +0 -40
  745. data/test/product_test.rb +0 -111
  746. data/test/publication_test.rb +0 -12
  747. data/test/recurring_application_charge_test.rb +0 -204
  748. data/test/redirect_test.rb +0 -10
  749. data/test/refund_test.rb +0 -37
  750. data/test/report_test.rb +0 -37
  751. data/test/resource_feedback_test.rb +0 -43
  752. data/test/script_tag_test.rb +0 -31
  753. data/test/session_test.rb +0 -640
  754. data/test/shipping_rate_test.rb +0 -17
  755. data/test/shipping_zone_test.rb +0 -11
  756. data/test/shop_test.rb +0 -82
  757. data/test/smart_collection_test.rb +0 -11
  758. data/test/storefront_access_token_test.rb +0 -30
  759. data/test/tax_service_test.rb +0 -12
  760. data/test/tender_transaction_test.rb +0 -18
  761. data/test/test_helper.rb +0 -126
  762. data/test/transaction_test.rb +0 -18
  763. data/test/usage_charge_test.rb +0 -25
  764. data/test/user_test.rb +0 -18
  765. data/test/variant_test.rb +0 -73
  766. data/test/webhook_test.rb +0 -24
@@ -1,55 +0,0 @@
1
- # frozen_string_literal: true
2
- module ActiveResource
3
- class DetailedLogSubscriber < ActiveSupport::LogSubscriber
4
- VERSION_EOL_WARNING_HEADER = 'x-shopify-api-version-warning'
5
- VERSION_DEPRECATION_HEADER = 'x-shopify-api-deprecated-reason'
6
- SHOPIFY_ACCESS_TOKEN = 'X-Shopify-Access-Token'
7
- FILTERED = '[FILTERED]'
8
-
9
- def request(event)
10
- log_request_response_details(event)
11
- warn_on_deprecated_header_or_version_eol_header(event)
12
- end
13
-
14
- def logger
15
- ActiveResource::Base.logger
16
- end
17
-
18
- private
19
-
20
- def log_request_response_details(event)
21
- data = event.payload[:data]
22
- headers = data.extract_options!
23
- headers[SHOPIFY_ACCESS_TOKEN] = FILTERED
24
- request_body = data.first
25
-
26
- info("Request:\n#{request_body}") if request_body
27
- info("Headers: #{headers.inspect}")
28
- info("Response:\n#{event.payload[:response].body}")
29
- end
30
-
31
- def warn_on_deprecated_header_or_version_eol_header(event)
32
- payload = event.payload
33
-
34
- payload[:response].each do |header_name, header_value|
35
- case header_name.downcase
36
- when VERSION_DEPRECATION_HEADER
37
- warning_message = <<-MSG
38
- [DEPRECATED] ShopifyAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call made
39
- use of a deprecated endpoint, behaviour, or parameter. See #{header_value} for more details.
40
- MSG
41
-
42
- warn(warning_message)
43
-
44
- when VERSION_EOL_WARNING_HEADER
45
- warning_message = <<-MSG
46
- [API Version Warning] ShopifyAPI made a call to #{payload[:method].upcase} #{payload[:path]}, and this call used
47
- an API version that is unsupported or will become unsupported within 30 days. See #{header_value} for more details.
48
- MSG
49
-
50
- warn(warning_message)
51
- end
52
- end
53
- end
54
- end
55
- end
@@ -1,37 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'active_resource/base'
3
-
4
- module ActiveResource
5
- class Errors < ActiveModel::Errors
6
- def from_json(json, save_cache = false)
7
- data =
8
- begin
9
- ActiveSupport::JSON.decode(json)['errors'] || {}
10
- rescue
11
- {}
12
- end
13
- case data
14
- when String
15
- from_string(data, save_cache)
16
- else
17
- from_hash(data, save_cache)
18
- end
19
- end
20
-
21
- def from_hash(messages, save_cache = false)
22
- clear unless save_cache
23
-
24
- messages.each do |key, errors|
25
- errors.each do |error|
26
- add(key, error)
27
- end
28
- end
29
- end
30
-
31
- def from_string(error, save_cache = false)
32
- clear unless save_cache
33
-
34
- add(:base, error)
35
- end
36
- end
37
- end
@@ -1,57 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module ShopifyAPI
4
- class ApiAccess
5
- SCOPE_DELIMITER = ','
6
-
7
- def initialize(scope_names)
8
- if scope_names.is_a?(String)
9
- scope_names = scope_names.to_s.split(SCOPE_DELIMITER)
10
- end
11
-
12
- store_scopes(scope_names)
13
- end
14
-
15
- def covers?(scopes)
16
- scopes.compressed_scopes <= expanded_scopes
17
- end
18
-
19
- def to_s
20
- to_a.join(SCOPE_DELIMITER)
21
- end
22
-
23
- def to_a
24
- compressed_scopes.to_a
25
- end
26
-
27
- def ==(other)
28
- other.class == self.class &&
29
- compressed_scopes == other.compressed_scopes
30
- end
31
-
32
- alias :eql? :==
33
-
34
- def hash
35
- compressed_scopes.hash
36
- end
37
-
38
- protected
39
-
40
- attr_reader :compressed_scopes, :expanded_scopes
41
-
42
- private
43
-
44
- def store_scopes(scope_names)
45
- scopes = scope_names.map(&:strip).reject(&:empty?).to_set
46
- implied_scopes = scopes.map { |scope| implied_scope(scope) }.compact
47
-
48
- @compressed_scopes = scopes - implied_scopes
49
- @expanded_scopes = scopes + implied_scopes
50
- end
51
-
52
- def implied_scope(scope)
53
- is_write_scope = scope =~ /\A(unauthenticated_)?write_(.*)\z/
54
- "#{$1}read_#{$2}" if is_write_scope
55
- end
56
- end
57
- end
@@ -1,206 +0,0 @@
1
- # frozen_string_literal: true
2
- module ShopifyAPI
3
- class ApiVersion
4
- class UnknownVersion < StandardError; end
5
- class ApiVersionNotSetError < StandardError; end
6
- include Comparable
7
-
8
- UNSTABLE_HANDLE = 'unstable'
9
- HANDLE_FORMAT = /((\d{4}-\d{2})|#{UNSTABLE_HANDLE})/.freeze
10
- UNSTABLE_AS_DATE = Time.utc(3000, 1, 1)
11
- API_PREFIX = '/admin/api/'
12
- LOOKUP_MODES = [:raise_on_unknown, :define_on_unknown].freeze
13
-
14
- class << self
15
- attr_reader :versions
16
-
17
- def version_lookup_mode
18
- @version_lookup_mode ||= :define_on_unknown
19
- end
20
-
21
- def version_lookup_mode=(mode)
22
- raise ArgumentError, "Mode must be one of #{LOOKUP_MODES}" unless LOOKUP_MODES.include?(mode)
23
- sanitize_known_versions if mode == :raise_on_unknown
24
- @version_lookup_mode = mode
25
- end
26
-
27
- def find_version(version_or_handle)
28
- raise ArgumentError, "NullVersion is not a valid version or version handle." if version_or_handle == NullVersion
29
- return version_or_handle if version_or_handle.is_a?(ApiVersion)
30
- handle = version_or_handle.to_s
31
- @versions ||= {}
32
- @versions.fetch(handle) do
33
- if @version_lookup_mode == :raise_on_unknown
34
- raise UnknownVersion, unknown_version_error_message(handle)
35
- else
36
- add_to_known_versions(ApiVersion.new(handle: handle))
37
- end
38
- end
39
- end
40
-
41
- def coerce_to_version(version_or_handle)
42
- warn(
43
- '[DEPRECATED] ShopifyAPI::ApiVersion.coerce_to_version be removed in a future version. ' \
44
- 'Use `find_version` instead.'
45
- )
46
- find_version(version_or_handle)
47
- end
48
-
49
- def fetch_known_versions
50
- @versions = Meta.admin_versions.map do |version|
51
- [version.handle, ApiVersion.new(version.attributes.merge(verified: version.persisted?))]
52
- end.to_h
53
- end
54
-
55
- def define_known_versions
56
- warn(
57
- '[DEPRECATED] ShopifyAPI::ApiVersion.define_known_versions is deprecated and will be ' \
58
- 'removed in a future version. Use `fetch_known_versions` instead.'
59
- )
60
- fetch_known_versions
61
- end
62
-
63
- def add_to_known_versions(version)
64
- @versions[version.handle] = version
65
- end
66
-
67
- def clear_known_versions
68
- @versions = {}
69
- end
70
-
71
- def clear_defined_versions
72
- warn(
73
- '[DEPRECATED] ShopifyAPI::ApiVersion.clear_defined_versions is deprecated and will be ' \
74
- 'removed in a future version. Use `clear_known_versions` instead.'
75
- )
76
- clear_known_versions
77
- end
78
-
79
- def latest_stable_version
80
- warn(
81
- '[DEPRECATED] ShopifyAPI::ApiVersion.latest_stable_version is deprecated and will be ' \
82
- 'removed in a future version.'
83
- )
84
- versions.values.find(&:latest_supported?)
85
- end
86
-
87
- private
88
-
89
- def sanitize_known_versions
90
- return if @versions.nil?
91
- @versions = @versions.keys.map do |handle|
92
- next unless @versions[handle].verified?
93
- [handle, @versions[handle]]
94
- end.compact.to_h
95
- end
96
-
97
- def unknown_version_error_message(handle)
98
- msg = "ApiVersion.version_lookup_mode is set to `:raise_on_unknown`. \n"
99
- return msg + "No versions defined. You must call `ApiVersion.fetch_known_versions` first." if @versions.empty?
100
- msg + "`#{handle}` is not in the defined version set. Available versions: #{@versions.keys}"
101
- end
102
- end
103
-
104
- attr_reader :handle, :display_name, :supported, :latest_supported, :verified
105
-
106
- def initialize(attributes)
107
- attributes = ActiveSupport::HashWithIndifferentAccess.new(attributes)
108
- @handle = attributes[:handle].to_s
109
- @display_name = attributes.fetch(:display_name, attributes[:handle].to_s)
110
- @supported = attributes.fetch(:supported, false)
111
- @latest_supported = attributes.fetch(:latest_supported, false)
112
- @verified = attributes.fetch(:verified, false)
113
- end
114
-
115
- def to_s
116
- handle
117
- end
118
-
119
- def latest_supported?
120
- latest_supported
121
- end
122
-
123
- def supported?
124
- supported
125
- end
126
-
127
- def verified?
128
- verified
129
- end
130
-
131
- def <=>(other)
132
- handle_as_date <=> other.handle_as_date
133
- end
134
-
135
- def ==(other)
136
- other.class == self.class && handle == other.handle
137
- end
138
-
139
- def hash
140
- handle.hash
141
- end
142
-
143
- def construct_api_path(path)
144
- "#{API_PREFIX}#{handle}/#{path}"
145
- end
146
-
147
- def construct_graphql_path
148
- construct_api_path('graphql.json')
149
- end
150
-
151
- def name
152
- warn(
153
- '[DEPRECATED] ShopifyAPI::ApiVersion#name is deprecated and will be removed in a future version. ' \
154
- 'Use `handle` instead.'
155
- )
156
- handle
157
- end
158
-
159
- def stable?
160
- warn(
161
- '[DEPRECATED] ShopifyAPI::ApiVersion#stable? is deprecated and will be removed in a future version. ' \
162
- 'Use `supported?` instead.'
163
- )
164
- supported?
165
- end
166
-
167
- def unstable?
168
- handle == UNSTABLE_HANDLE
169
- end
170
-
171
- def handle_as_date
172
- return UNSTABLE_AS_DATE if unstable?
173
- year, month, day = handle.split('-')
174
- Time.utc(year, month, day)
175
- end
176
-
177
- class NullVersion
178
- class << self
179
- def new(*_args)
180
- raise NoMethodError, "NullVersion is an abstract class and cannot be instantiated."
181
- end
182
-
183
- def matches?(version)
184
- version.nil? || version == self
185
- end
186
-
187
- def raise_not_set_error(*_args)
188
- raise ApiVersionNotSetError, "You must set ShopifyAPI::Base.api_version before making a request."
189
- end
190
- alias_method :stable?, :raise_not_set_error
191
- alias_method :construct_api_path, :raise_not_set_error
192
- alias_method :construct_graphql_path, :raise_not_set_error
193
- alias_method :latest_supported?, :raise_not_set_error
194
- alias_method :supported?, :raise_not_set_error
195
- alias_method :verified?, :raise_not_set_error
196
- alias_method :unstable?, :raise_not_set_error
197
- alias_method :handle, :raise_not_set_error
198
- alias_method :display_name, :raise_not_set_error
199
- alias_method :supported, :raise_not_set_error
200
- alias_method :verified, :raise_not_set_error
201
- alias_method :latest_supported, :raise_not_set_error
202
- alias_method :name, :raise_not_set_error
203
- end
204
- end
205
- end
206
- end
@@ -1,36 +0,0 @@
1
- # frozen_string_literal: true
2
- module ShopifyAPI
3
- class Connection < ActiveResource::Connection
4
- attr_reader :response
5
-
6
- module ResponseCapture
7
- def handle_response(response)
8
- @response = super(ShopifyAPI::MessageEnricher.new(response))
9
- end
10
- end
11
-
12
- include ResponseCapture
13
-
14
- module RequestNotification
15
- def request(method, path, *arguments)
16
- super.tap do |response|
17
- notify_about_request(method, path, response, arguments)
18
- end
19
- rescue => e
20
- notify_about_request(method, path, e.response, arguments) if e.respond_to?(:response)
21
- raise
22
- end
23
-
24
- def notify_about_request(method, path, response, arguments)
25
- ActiveSupport::Notifications.instrument("request.active_resource_detailed") do |payload|
26
- payload[:method] = method
27
- payload[:path] = path
28
- payload[:response] = response
29
- payload[:data] = arguments
30
- end
31
- end
32
- end
33
-
34
- include RequestNotification
35
- end
36
- end
@@ -1,15 +0,0 @@
1
- # frozen_string_literal: true
2
- module ShopifyAPI
3
- module Countable
4
- def count(options = {})
5
- data = get(:count, options)
6
-
7
- count = case data
8
- when Hash then data["count"]
9
- else data
10
- end
11
-
12
- Integer(count)
13
- end
14
- end
15
- end
@@ -1,31 +0,0 @@
1
- # frozen_string_literal: true
2
- module ShopifyAPI
3
- module DisablePrefixCheck
4
- extend ActiveSupport::Concern
5
-
6
- module ClassMethods
7
- def check_prefix_options(options)
8
- end
9
-
10
- # `flexible = true` is hack to allow multiple things through the same AR class
11
- def conditional_prefix(resource, flexible = false)
12
- resource_id = "#{resource}_id".to_sym
13
- resource_type = flexible ? ":#{resource}" : resource.to_s.pluralize
14
-
15
- init_prefix_explicit(resource_type, resource_id)
16
-
17
- define_singleton_method(:resource_prefix) do |options = {}|
18
- resource_type = options[resource] if flexible
19
-
20
- options[resource_id].nil? ? '' : "#{resource_type}/#{options[resource_id]}/"
21
- end
22
-
23
- define_singleton_method(:instantiate_record) do |record, prefix_options = {}|
24
- new(record, true).tap do |resource_instance|
25
- resource_instance.prefix_options = prefix_options unless prefix_options.blank?
26
- end
27
- end
28
- end
29
- end
30
- end
31
- end
@@ -1,8 +0,0 @@
1
- # frozen_string_literal: true
2
- module ShopifyAPI
3
- module Events
4
- def events
5
- Event.find(:all, params: { resource: self.class.collection_name, resource_id: id })
6
- end
7
- end
8
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'graphql/client/http'
3
-
4
- module ShopifyAPI
5
- module GraphQL
6
- class HTTPClient < ::GraphQL::Client::HTTP
7
- def initialize(api_version)
8
- @api_version = api_version
9
- end
10
-
11
- def headers(_context)
12
- ShopifyAPI::Base.headers
13
- end
14
-
15
- def uri
16
- ShopifyAPI::Base.site.dup.tap do |uri|
17
- uri.path = @api_version.construct_graphql_path
18
- end
19
- end
20
- end
21
- end
22
- end
@@ -1,17 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'rails/railtie'
3
-
4
- module ShopifyAPI
5
- module GraphQL
6
- class Railtie < Rails::Railtie
7
- initializer 'shopify_api.initialize_graphql_clients' do |app|
8
- ShopifyAPI::GraphQL.schema_location = app.root.join('db', ShopifyAPI::GraphQL.schema_location)
9
- ShopifyAPI::GraphQL.initialize_clients
10
- end
11
-
12
- rake_tasks do
13
- load 'shopify_api/graphql/task.rake'
14
- end
15
- end
16
- end
17
- end
@@ -1,100 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'fileutils'
3
-
4
- namespace :shopify_api do
5
- namespace :graphql do
6
- desc 'Dumps a local JSON schema file of the Shopify Admin API'
7
- task :dump do
8
- usage = <<~USAGE
9
-
10
- Usage: rake shopify_api:graphql:dump [<args>]
11
-
12
- Dumps a local JSON schema file of the Shopify Admin API. The schema is specific to an
13
- API version and authentication is required (either OAuth or private app).
14
-
15
- Dump the schema file for the 2020-01 API version using private app authentication:
16
- $ rake shopify_api:graphql:dump SHOP_URL="https://API_KEY:PASSWORD@SHOP_NAME.myshopify.com" API_VERSION=2020-01
17
-
18
- Dump the schema file for the unstable API version using an OAuth access token:
19
- $ rake shopify_api:graphql:dump SHOP_DOMAIN=SHOP_NAME.myshopify.com ACCESS_TOKEN=abc API_VERSION=unstable
20
-
21
- See https://github.com/Shopify/shopify_api#getting-started for more
22
- details on getting started with authenticated API calls.
23
-
24
- Arguments:
25
- ACCESS_TOKEN OAuth access token (shop specific)
26
- API_VERSION API version handle [example: 2020-01]
27
- SHOP_DOMAIN Shop domain (without path) [example: SHOP_NAME.myshopify.com]
28
- SHOP_URL Shop URL for private apps [example: https://API_KEY:PASSWORD@SHOP_NAME.myshopify.com]
29
- USAGE
30
-
31
- access_token = ENV['ACCESS_TOKEN'] || ENV['access_token']
32
- api_version = ENV['API_VERSION'] || ENV['api_version']
33
- shop_url = ENV['SHOP_URL'] || ENV['shop_url']
34
- shop_domain = ENV['SHOP_DOMAIN'] || ENV['shop_domain']
35
-
36
- unless access_token || api_version || shop_url || shop_domain
37
- puts usage
38
- exit(1)
39
- end
40
-
41
- unless shop_url || shop_domain
42
- puts 'Error: either SHOP_DOMAIN or SHOP_URL is required for authentication'
43
- puts usage
44
- exit(1)
45
- end
46
-
47
- if shop_url && shop_domain
48
- puts 'Error: SHOP_DOMAIN and SHOP_URL cannot be used together. Use one or the other for authentication.'
49
- puts usage
50
- exit(1)
51
- end
52
-
53
- if shop_domain && !access_token
54
- puts 'Error: ACCESS_TOKEN required when SHOP_DOMAIN is used'
55
- puts usage
56
- exit(1)
57
- end
58
-
59
- unless api_version
60
- puts 'Error: API_VERSION required. Example: 2020-01'
61
- puts usage
62
- exit(1)
63
- end
64
-
65
- Rake::Task['environment'].invoke if Rake::Task.task_defined?('environment')
66
-
67
- ShopifyAPI::ApiVersion.fetch_known_versions
68
- ShopifyAPI::ApiVersion.version_lookup_mode = :raise_on_unknown
69
-
70
- shopify_session = ShopifyAPI::Session.new(domain: shop_domain, token: access_token, api_version: api_version)
71
- ShopifyAPI::Base.activate_session(shopify_session)
72
-
73
- if shop_url
74
- ShopifyAPI::Base.site = shop_url
75
- end
76
-
77
- puts "Fetching schema for #{ShopifyAPI::Base.api_version.handle} API version..."
78
-
79
- client = ShopifyAPI::GraphQL::HTTPClient.new(ShopifyAPI::Base.api_version)
80
- document = GraphQL.parse('{ __schema { queryType { name } } }')
81
- response = client.execute(document: document).to_h
82
-
83
- unless response['data'].present?
84
- puts "Error: failed to query the API."
85
- puts "Response: #{response}"
86
- puts 'Ensure your SHOP_DOMAIN or SHOP_URL are valid and you have valid authentication credentials.'
87
- puts usage
88
- exit(1)
89
- end
90
-
91
- schema_location = ShopifyAPI::GraphQL.schema_location
92
- FileUtils.mkdir_p(schema_location) unless Dir.exist?(schema_location)
93
-
94
- schema_file = schema_location.join("#{api_version}.json")
95
- GraphQL::Client.dump_schema(client, schema_file.to_s)
96
-
97
- puts "Wrote file #{schema_file}"
98
- end
99
- end
100
- end
@@ -1,103 +0,0 @@
1
- # frozen_string_literal: true
2
- require 'graphql/client'
3
- require 'shopify_api/graphql/http_client'
4
-
5
- module ShopifyAPI
6
- module GraphQL
7
- DEFAULT_SCHEMA_LOCATION_PATH = Pathname('shopify_graphql_schemas')
8
- DEFAULT_EXECUTION_ADAPTER = HTTPClient
9
- DEFAULT_GRAPHQL_CLIENT = ::GraphQL::Client
10
-
11
- InvalidSchema = Class.new(StandardError)
12
- InvalidClient = Class.new(StandardError)
13
-
14
- class << self
15
- delegate :parse, :query, to: :client
16
-
17
- def client(api_version = ShopifyAPI::Base.api_version.handle)
18
- initialize_client_cache
19
- cached_client = @_client_cache[api_version]
20
-
21
- if cached_client
22
- cached_client
23
- else
24
- schema_file = schema_location.join("#{api_version}.json")
25
-
26
- if !schema_file.exist?
27
- raise InvalidClient, <<~MSG
28
- Client for API version #{api_version} does not exist because no schema file exists at `#{schema_file}`.
29
-
30
- To dump the schema file, use the `rake shopify_api:graphql:dump` task.
31
- MSG
32
- else
33
- puts(
34
- '[WARNING] Client was not pre-initialized. Ensure `ShopifyAPI::GraphQL.initialize_clients` ' \
35
- 'is called during app initialization.'
36
- )
37
- initialize_clients
38
- @_client_cache[api_version]
39
- end
40
- end
41
- end
42
-
43
- def clear_clients
44
- @_client_cache = {}
45
- end
46
-
47
- def initialize_clients(raise_on_invalid_schema: true)
48
- initialize_client_cache
49
-
50
- Dir.glob(schema_location.join("*.json")).each do |schema_file|
51
- schema_file = Pathname(schema_file)
52
- matches = schema_file.basename.to_s.match(/^#{ShopifyAPI::ApiVersion::HANDLE_FORMAT}\.json$/)
53
-
54
- if matches
55
- api_version = ShopifyAPI::ApiVersion.new(handle: matches[1])
56
- elsif raise_on_invalid_schema
57
- raise InvalidSchema,
58
- "Invalid schema file name `#{schema_file}`. Does not match format of: `<version>.json`."
59
- else
60
- next
61
- end
62
-
63
- schema = graphql_client.load_schema(schema_file.to_s)
64
- client = graphql_client.new(schema: schema, execute: execution_adapter.new(api_version)).tap do |c|
65
- c.allow_dynamic_queries = true
66
- end
67
-
68
- @_client_cache[api_version.handle] = client
69
- end
70
- end
71
-
72
- def schema_location
73
- @schema_location || DEFAULT_SCHEMA_LOCATION_PATH
74
- end
75
-
76
- def schema_location=(path)
77
- @schema_location = Pathname(path)
78
- end
79
-
80
- def execution_adapter
81
- @execution_adapter || DEFAULT_EXECUTION_ADAPTER
82
- end
83
-
84
- def execution_adapter=(executor)
85
- @execution_adapter = executor
86
- end
87
-
88
- def graphql_client
89
- @graphql_client || DEFAULT_GRAPHQL_CLIENT
90
- end
91
-
92
- def graphql_client=(client)
93
- @graphql_client = client
94
- end
95
-
96
- private
97
-
98
- def initialize_client_cache
99
- @_client_cache ||= {}
100
- end
101
- end
102
- end
103
- end