shopify_api 12.4.0 → 12.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (200) hide show
  1. checksums.yaml +4 -4
  2. data/.github/api_update_reminder.md +25 -0
  3. data/.github/api_update_reminder_on_release.md +19 -0
  4. data/.github/workflows/api_update_reminder.yml +16 -0
  5. data/.github/workflows/api_update_reminder_on_release.yml +16 -0
  6. data/.github/workflows/stale.yml +20 -10
  7. data/CHANGELOG.md +11 -4
  8. data/CONTRIBUTING.md +2 -2
  9. data/Gemfile.lock +6 -6
  10. data/README.md +10 -10
  11. data/docs/getting_started.md +2 -2
  12. data/docs/usage/graphql.md +6 -0
  13. data/docs/usage/graphql_storefront.md +8 -2
  14. data/docs/usage/oauth.md +1 -1
  15. data/docs/usage/rest.md +9 -2
  16. data/docs/usage/webhooks.md +1 -1
  17. data/lib/shopify_api/admin_versions.rb +2 -1
  18. data/lib/shopify_api/clients/graphql/admin.rb +3 -3
  19. data/lib/shopify_api/clients/graphql/client.rb +13 -3
  20. data/lib/shopify_api/clients/graphql/storefront.rb +3 -3
  21. data/lib/shopify_api/clients/http_client.rb +8 -1
  22. data/lib/shopify_api/clients/rest/admin.rb +14 -3
  23. data/lib/shopify_api/rest/base.rb +3 -1
  24. data/lib/shopify_api/rest/resources/2022_07/application_charge.rb +6 -1
  25. data/lib/shopify_api/rest/resources/2022_07/application_credit.rb +6 -1
  26. data/lib/shopify_api/rest/resources/2022_07/gift_card.rb +4 -4
  27. data/lib/shopify_api/rest/resources/2022_07/metafield.rb +2 -2
  28. data/lib/shopify_api/rest/resources/2022_07/order.rb +2 -2
  29. data/lib/shopify_api/rest/resources/2022_07/recurring_application_charge.rb +6 -1
  30. data/lib/shopify_api/rest/resources/2022_07/shipping_zone.rb +6 -6
  31. data/lib/shopify_api/rest/resources/2022_07/usage_charge.rb +6 -1
  32. data/lib/shopify_api/rest/resources/2022_10/application_charge.rb +6 -1
  33. data/lib/shopify_api/rest/resources/2022_10/application_credit.rb +6 -1
  34. data/lib/shopify_api/rest/resources/2022_10/gift_card.rb +4 -4
  35. data/lib/shopify_api/rest/resources/2022_10/metafield.rb +2 -2
  36. data/lib/shopify_api/rest/resources/2022_10/order.rb +2 -2
  37. data/lib/shopify_api/rest/resources/2022_10/recurring_application_charge.rb +6 -1
  38. data/lib/shopify_api/rest/resources/2022_10/shipping_zone.rb +6 -6
  39. data/lib/shopify_api/rest/resources/2022_10/usage_charge.rb +6 -1
  40. data/lib/shopify_api/rest/resources/2023_01/application_charge.rb +6 -1
  41. data/lib/shopify_api/rest/resources/2023_01/application_credit.rb +6 -1
  42. data/lib/shopify_api/rest/resources/2023_01/dispute_evidence.rb +117 -0
  43. data/lib/shopify_api/rest/resources/{2022_04/storefront_access_token.rb → 2023_01/dispute_file_upload.rb} +27 -33
  44. data/lib/shopify_api/rest/resources/2023_01/gift_card.rb +4 -4
  45. data/lib/shopify_api/rest/resources/2023_01/metafield.rb +2 -2
  46. data/lib/shopify_api/rest/resources/2023_01/order.rb +2 -2
  47. data/lib/shopify_api/rest/resources/2023_01/recurring_application_charge.rb +6 -1
  48. data/lib/shopify_api/rest/resources/2023_01/shipping_zone.rb +6 -6
  49. data/lib/shopify_api/rest/resources/2023_01/usage_charge.rb +6 -1
  50. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/application_charge.rb +6 -1
  51. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/application_credit.rb +6 -1
  52. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/carrier_service.rb +0 -3
  53. data/lib/shopify_api/rest/resources/2023_04/dispute_evidence.rb +117 -0
  54. data/lib/shopify_api/rest/resources/{2022_04/android_pay_key.rb → 2023_04/dispute_file_upload.rb} +29 -25
  55. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/fulfillment.rb +2 -49
  56. data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/fulfillment_order.rb +36 -8
  57. data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/fulfillment_service.rb +3 -3
  58. data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/gift_card.rb +4 -4
  59. data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/metafield.rb +2 -2
  60. data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/order.rb +14 -2
  61. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/recurring_application_charge.rb +6 -1
  62. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/shipping_zone.rb +6 -6
  63. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/shop.rb +3 -0
  64. data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/transaction.rb +3 -0
  65. data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/usage_charge.rb +6 -1
  66. data/lib/shopify_api/version.rb +1 -1
  67. data/shopify_api.gemspec +1 -1
  68. metadata +85 -152
  69. data/lib/shopify_api/rest/resources/2022_01/android_pay_key.rb +0 -77
  70. data/lib/shopify_api/rest/resources/2022_01/customer.rb +0 -326
  71. data/lib/shopify_api/rest/resources/2022_01/fulfillment_order.rb +0 -281
  72. data/lib/shopify_api/rest/resources/2022_01/fulfillment_service.rb +0 -130
  73. data/lib/shopify_api/rest/resources/2022_01/gift_card.rb +0 -215
  74. data/lib/shopify_api/rest/resources/2022_01/metafield.rb +0 -349
  75. data/lib/shopify_api/rest/resources/2022_01/order.rb +0 -473
  76. data/lib/shopify_api/rest/resources/2022_01/price_rule.rb +0 -223
  77. data/lib/shopify_api/rest/resources/2022_01/usage_charge.rb +0 -97
  78. data/lib/shopify_api/rest/resources/2022_04/abandoned_checkout.rb +0 -190
  79. data/lib/shopify_api/rest/resources/2022_04/access_scope.rb +0 -58
  80. data/lib/shopify_api/rest/resources/2022_04/apple_pay_certificate.rb +0 -105
  81. data/lib/shopify_api/rest/resources/2022_04/application_charge.rb +0 -104
  82. data/lib/shopify_api/rest/resources/2022_04/application_credit.rb +0 -87
  83. data/lib/shopify_api/rest/resources/2022_04/article.rb +0 -265
  84. data/lib/shopify_api/rest/resources/2022_04/asset.rb +0 -118
  85. data/lib/shopify_api/rest/resources/2022_04/assigned_fulfillment_order.rb +0 -86
  86. data/lib/shopify_api/rest/resources/2022_04/balance.rb +0 -50
  87. data/lib/shopify_api/rest/resources/2022_04/blog.rb +0 -162
  88. data/lib/shopify_api/rest/resources/2022_04/cancellation_request.rb +0 -83
  89. data/lib/shopify_api/rest/resources/2022_04/carrier_service.rb +0 -116
  90. data/lib/shopify_api/rest/resources/2022_04/checkout.rb +0 -209
  91. data/lib/shopify_api/rest/resources/2022_04/collect.rb +0 -142
  92. data/lib/shopify_api/rest/resources/2022_04/collection.rb +0 -110
  93. data/lib/shopify_api/rest/resources/2022_04/collection_listing.rb +0 -155
  94. data/lib/shopify_api/rest/resources/2022_04/comment.rb +0 -283
  95. data/lib/shopify_api/rest/resources/2022_04/country.rb +0 -137
  96. data/lib/shopify_api/rest/resources/2022_04/currency.rb +0 -57
  97. data/lib/shopify_api/rest/resources/2022_04/custom_collection.rb +0 -187
  98. data/lib/shopify_api/rest/resources/2022_04/customer_address.rb +0 -201
  99. data/lib/shopify_api/rest/resources/2022_04/customer_saved_search.rb +0 -169
  100. data/lib/shopify_api/rest/resources/2022_04/deprecated_api_call.rb +0 -57
  101. data/lib/shopify_api/rest/resources/2022_04/discount_code.rb +0 -219
  102. data/lib/shopify_api/rest/resources/2022_04/dispute.rb +0 -111
  103. data/lib/shopify_api/rest/resources/2022_04/draft_order.rb +0 -275
  104. data/lib/shopify_api/rest/resources/2022_04/event.rb +0 -148
  105. data/lib/shopify_api/rest/resources/2022_04/fulfillment.rb +0 -272
  106. data/lib/shopify_api/rest/resources/2022_04/fulfillment_event.rb +0 -166
  107. data/lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb +0 -87
  108. data/lib/shopify_api/rest/resources/2022_04/gift_card_adjustment.rb +0 -118
  109. data/lib/shopify_api/rest/resources/2022_04/image.rb +0 -157
  110. data/lib/shopify_api/rest/resources/2022_04/inventory_item.rb +0 -108
  111. data/lib/shopify_api/rest/resources/2022_04/inventory_level.rb +0 -179
  112. data/lib/shopify_api/rest/resources/2022_04/location.rb +0 -167
  113. data/lib/shopify_api/rest/resources/2022_04/locations_for_move.rb +0 -56
  114. data/lib/shopify_api/rest/resources/2022_04/marketing_event.rb +0 -209
  115. data/lib/shopify_api/rest/resources/2022_04/mobile_platform_application.rb +0 -110
  116. data/lib/shopify_api/rest/resources/2022_04/order_risk.rb +0 -135
  117. data/lib/shopify_api/rest/resources/2022_04/page.rb +0 -194
  118. data/lib/shopify_api/rest/resources/2022_04/payment.rb +0 -140
  119. data/lib/shopify_api/rest/resources/2022_04/payment_gateway.rb +0 -143
  120. data/lib/shopify_api/rest/resources/2022_04/payment_transaction.rb +0 -107
  121. data/lib/shopify_api/rest/resources/2022_04/payout.rb +0 -97
  122. data/lib/shopify_api/rest/resources/2022_04/policy.rb +0 -69
  123. data/lib/shopify_api/rest/resources/2022_04/product.rb +0 -223
  124. data/lib/shopify_api/rest/resources/2022_04/product_listing.rb +0 -196
  125. data/lib/shopify_api/rest/resources/2022_04/product_resource_feedback.rb +0 -88
  126. data/lib/shopify_api/rest/resources/2022_04/province.rb +0 -132
  127. data/lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb +0 -167
  128. data/lib/shopify_api/rest/resources/2022_04/redirect.rb +0 -139
  129. data/lib/shopify_api/rest/resources/2022_04/refund.rb +0 -151
  130. data/lib/shopify_api/rest/resources/2022_04/report.rb +0 -121
  131. data/lib/shopify_api/rest/resources/2022_04/resource_feedback.rb +0 -73
  132. data/lib/shopify_api/rest/resources/2022_04/script_tag.rb +0 -155
  133. data/lib/shopify_api/rest/resources/2022_04/shipping_zone.rb +0 -83
  134. data/lib/shopify_api/rest/resources/2022_04/shop.rb +0 -218
  135. data/lib/shopify_api/rest/resources/2022_04/smart_collection.rb +0 -216
  136. data/lib/shopify_api/rest/resources/2022_04/tender_transaction.rb +0 -93
  137. data/lib/shopify_api/rest/resources/2022_04/theme.rb +0 -120
  138. data/lib/shopify_api/rest/resources/2022_04/transaction.rb +0 -181
  139. data/lib/shopify_api/rest/resources/2022_04/user.rb +0 -138
  140. data/lib/shopify_api/rest/resources/2022_04/variant.rb +0 -212
  141. data/lib/shopify_api/rest/resources/2022_04/webhook.rb +0 -168
  142. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/abandoned_checkout.rb +0 -0
  143. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/access_scope.rb +0 -0
  144. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/apple_pay_certificate.rb +0 -0
  145. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/article.rb +0 -0
  146. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/asset.rb +0 -0
  147. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/assigned_fulfillment_order.rb +0 -0
  148. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/balance.rb +0 -0
  149. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/blog.rb +0 -0
  150. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/cancellation_request.rb +0 -0
  151. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/checkout.rb +0 -0
  152. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/collect.rb +0 -0
  153. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/collection.rb +0 -0
  154. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/collection_listing.rb +0 -0
  155. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/comment.rb +0 -0
  156. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/country.rb +0 -0
  157. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/currency.rb +0 -0
  158. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/custom_collection.rb +0 -0
  159. /data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/customer.rb +0 -0
  160. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/customer_address.rb +0 -0
  161. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/customer_saved_search.rb +0 -0
  162. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/deprecated_api_call.rb +0 -0
  163. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/discount_code.rb +0 -0
  164. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/dispute.rb +0 -0
  165. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/draft_order.rb +0 -0
  166. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/event.rb +0 -0
  167. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/fulfillment_event.rb +0 -0
  168. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/fulfillment_request.rb +0 -0
  169. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/gift_card_adjustment.rb +0 -0
  170. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/image.rb +0 -0
  171. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/inventory_item.rb +0 -0
  172. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/inventory_level.rb +0 -0
  173. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/location.rb +0 -0
  174. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/locations_for_move.rb +0 -0
  175. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/marketing_event.rb +0 -0
  176. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/mobile_platform_application.rb +0 -0
  177. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/order_risk.rb +0 -0
  178. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/page.rb +0 -0
  179. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/payment.rb +0 -0
  180. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/payment_gateway.rb +0 -0
  181. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/payment_transaction.rb +0 -0
  182. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/payout.rb +0 -0
  183. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/policy.rb +0 -0
  184. /data/lib/shopify_api/rest/resources/{2022_04 → 2023_04}/price_rule.rb +0 -0
  185. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/product.rb +0 -0
  186. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/product_listing.rb +0 -0
  187. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/product_resource_feedback.rb +0 -0
  188. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/province.rb +0 -0
  189. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/redirect.rb +0 -0
  190. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/refund.rb +0 -0
  191. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/report.rb +0 -0
  192. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/resource_feedback.rb +0 -0
  193. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/script_tag.rb +0 -0
  194. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/smart_collection.rb +0 -0
  195. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/storefront_access_token.rb +0 -0
  196. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/tender_transaction.rb +0 -0
  197. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/theme.rb +0 -0
  198. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/user.rb +0 -0
  199. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/variant.rb +0 -0
  200. /data/lib/shopify_api/rest/resources/{2022_01 → 2023_04}/webhook.rb +0 -0
@@ -1,326 +0,0 @@
1
- # typed: false
2
- # frozen_string_literal: true
3
-
4
- ########################################################################################################################
5
- # This file is auto-generated. If you have an issue, please create a GitHub issue. #
6
- ########################################################################################################################
7
-
8
- module ShopifyAPI
9
- class Customer < ShopifyAPI::Rest::Base
10
- extend T::Sig
11
-
12
- @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
13
- @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
14
-
15
- sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
- def initialize(session: ShopifyAPI::Context.active_session)
17
- super(session: session)
18
-
19
- @accepts_marketing = T.let(nil, T.nilable(T::Boolean))
20
- @accepts_marketing_updated_at = T.let(nil, T.nilable(String))
21
- @addresses = T.let(nil, T.nilable(T::Array[T.untyped]))
22
- @created_at = T.let(nil, T.nilable(String))
23
- @currency = T.let(nil, T.nilable(String))
24
- @default_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
25
- @email = T.let(nil, T.nilable(String))
26
- @first_name = T.let(nil, T.nilable(String))
27
- @id = T.let(nil, T.nilable(Integer))
28
- @last_name = T.let(nil, T.nilable(String))
29
- @last_order_id = T.let(nil, T.nilable(Integer))
30
- @last_order_name = T.let(nil, T.nilable(String))
31
- @marketing_opt_in_level = T.let(nil, T.nilable(String))
32
- @metafield = T.let(nil, T.nilable(Metafield))
33
- @multipass_identifier = T.let(nil, T.nilable(String))
34
- @note = T.let(nil, T.nilable(String))
35
- @orders_count = T.let(nil, T.nilable(Integer))
36
- @password = T.let(nil, T.nilable(String))
37
- @password_confirmation = T.let(nil, T.nilable(String))
38
- @phone = T.let(nil, T.nilable(String))
39
- @sms_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
40
- @state = T.let(nil, T.nilable(String))
41
- @tags = T.let(nil, T.nilable(String))
42
- @tax_exempt = T.let(nil, T.nilable(T::Boolean))
43
- @tax_exemptions = T.let(nil, T.nilable(T::Array[T.untyped]))
44
- @total_spent = T.let(nil, T.nilable(String))
45
- @updated_at = T.let(nil, T.nilable(String))
46
- @verified_email = T.let(nil, T.nilable(T::Boolean))
47
- end
48
-
49
- @has_one = T.let({
50
- metafield: Metafield
51
- }, T::Hash[Symbol, Class])
52
- @has_many = T.let({}, T::Hash[Symbol, Class])
53
- @paths = T.let([
54
- {http_method: :delete, operation: :delete, ids: [:id], path: "customers/<id>.json"},
55
- {http_method: :get, operation: :count, ids: [], path: "customers/count.json"},
56
- {http_method: :get, operation: :get, ids: [], path: "customers.json"},
57
- {http_method: :get, operation: :get, ids: [:id], path: "customers/<id>.json"},
58
- {http_method: :get, operation: :orders, ids: [:id], path: "customers/<id>/orders.json"},
59
- {http_method: :get, operation: :search, ids: [], path: "customers/search.json"},
60
- {http_method: :post, operation: :account_activation_url, ids: [:id], path: "customers/<id>/account_activation_url.json"},
61
- {http_method: :post, operation: :post, ids: [], path: "customers.json"},
62
- {http_method: :post, operation: :send_invite, ids: [:id], path: "customers/<id>/send_invite.json"},
63
- {http_method: :put, operation: :put, ids: [:id], path: "customers/<id>.json"}
64
- ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
65
-
66
- sig { returns(T.nilable(T::Boolean)) }
67
- attr_reader :accepts_marketing
68
- sig { returns(T.nilable(String)) }
69
- attr_reader :accepts_marketing_updated_at
70
- sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
71
- attr_reader :addresses
72
- sig { returns(T.nilable(String)) }
73
- attr_reader :created_at
74
- sig { returns(T.nilable(String)) }
75
- attr_reader :currency
76
- sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
77
- attr_reader :default_address
78
- sig { returns(T.nilable(String)) }
79
- attr_reader :email
80
- sig { returns(T.nilable(String)) }
81
- attr_reader :first_name
82
- sig { returns(T.nilable(Integer)) }
83
- attr_reader :id
84
- sig { returns(T.nilable(String)) }
85
- attr_reader :last_name
86
- sig { returns(T.nilable(Integer)) }
87
- attr_reader :last_order_id
88
- sig { returns(T.nilable(String)) }
89
- attr_reader :last_order_name
90
- sig { returns(T.nilable(String)) }
91
- attr_reader :marketing_opt_in_level
92
- sig { returns(T.nilable(Metafield)) }
93
- attr_reader :metafield
94
- sig { returns(T.nilable(String)) }
95
- attr_reader :multipass_identifier
96
- sig { returns(T.nilable(String)) }
97
- attr_reader :note
98
- sig { returns(T.nilable(Integer)) }
99
- attr_reader :orders_count
100
- sig { returns(T.nilable(String)) }
101
- attr_reader :password
102
- sig { returns(T.nilable(String)) }
103
- attr_reader :password_confirmation
104
- sig { returns(T.nilable(String)) }
105
- attr_reader :phone
106
- sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
107
- attr_reader :sms_marketing_consent
108
- sig { returns(T.nilable(String)) }
109
- attr_reader :state
110
- sig { returns(T.nilable(String)) }
111
- attr_reader :tags
112
- sig { returns(T.nilable(T::Boolean)) }
113
- attr_reader :tax_exempt
114
- sig { returns(T.nilable(T::Array[String])) }
115
- attr_reader :tax_exemptions
116
- sig { returns(T.nilable(String)) }
117
- attr_reader :total_spent
118
- sig { returns(T.nilable(String)) }
119
- attr_reader :updated_at
120
- sig { returns(T.nilable(T::Boolean)) }
121
- attr_reader :verified_email
122
-
123
- class << self
124
- sig do
125
- params(
126
- id: T.any(Integer, String),
127
- fields: T.untyped,
128
- session: Auth::Session
129
- ).returns(T.nilable(Customer))
130
- end
131
- def find(
132
- id:,
133
- fields: nil,
134
- session: ShopifyAPI::Context.active_session
135
- )
136
- result = base_find(
137
- session: session,
138
- ids: {id: id},
139
- params: {fields: fields},
140
- )
141
- T.cast(result[0], T.nilable(Customer))
142
- end
143
-
144
- sig do
145
- params(
146
- id: T.any(Integer, String),
147
- session: Auth::Session
148
- ).returns(T.untyped)
149
- end
150
- def delete(
151
- id:,
152
- session: ShopifyAPI::Context.active_session
153
- )
154
- request(
155
- http_method: :delete,
156
- operation: :delete,
157
- session: session,
158
- ids: {id: id},
159
- params: {},
160
- )
161
- end
162
-
163
- sig do
164
- params(
165
- ids: T.untyped,
166
- since_id: T.untyped,
167
- created_at_min: T.untyped,
168
- created_at_max: T.untyped,
169
- updated_at_min: T.untyped,
170
- updated_at_max: T.untyped,
171
- limit: T.untyped,
172
- fields: T.untyped,
173
- session: Auth::Session,
174
- kwargs: T.untyped
175
- ).returns(T::Array[Customer])
176
- end
177
- def all(
178
- ids: nil,
179
- since_id: nil,
180
- created_at_min: nil,
181
- created_at_max: nil,
182
- updated_at_min: nil,
183
- updated_at_max: nil,
184
- limit: nil,
185
- fields: nil,
186
- session: ShopifyAPI::Context.active_session,
187
- **kwargs
188
- )
189
- response = base_find(
190
- session: session,
191
- ids: {},
192
- params: {ids: ids, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, limit: limit, fields: fields}.merge(kwargs).compact,
193
- )
194
-
195
- T.cast(response, T::Array[Customer])
196
- end
197
-
198
- sig do
199
- params(
200
- created_at_min: T.untyped,
201
- created_at_max: T.untyped,
202
- updated_at_min: T.untyped,
203
- updated_at_max: T.untyped,
204
- session: Auth::Session,
205
- kwargs: T.untyped
206
- ).returns(T.untyped)
207
- end
208
- def count(
209
- created_at_min: nil,
210
- created_at_max: nil,
211
- updated_at_min: nil,
212
- updated_at_max: nil,
213
- session: ShopifyAPI::Context.active_session,
214
- **kwargs
215
- )
216
- request(
217
- http_method: :get,
218
- operation: :count,
219
- session: session,
220
- ids: {},
221
- params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
222
- body: {},
223
- entity: nil,
224
- )
225
- end
226
-
227
- sig do
228
- params(
229
- id: T.any(Integer, String),
230
- status: T.untyped,
231
- session: Auth::Session,
232
- kwargs: T.untyped
233
- ).returns(T.untyped)
234
- end
235
- def orders(
236
- id:,
237
- status: nil,
238
- session: ShopifyAPI::Context.active_session,
239
- **kwargs
240
- )
241
- request(
242
- http_method: :get,
243
- operation: :orders,
244
- session: session,
245
- ids: {id: id},
246
- params: {status: status}.merge(kwargs).compact,
247
- body: {},
248
- entity: nil,
249
- )
250
- end
251
-
252
- sig do
253
- params(
254
- order: T.untyped,
255
- query: T.untyped,
256
- limit: T.untyped,
257
- fields: T.untyped,
258
- session: Auth::Session,
259
- kwargs: T.untyped
260
- ).returns(T.untyped)
261
- end
262
- def search(
263
- order: nil,
264
- query: nil,
265
- limit: nil,
266
- fields: nil,
267
- session: ShopifyAPI::Context.active_session,
268
- **kwargs
269
- )
270
- request(
271
- http_method: :get,
272
- operation: :search,
273
- session: session,
274
- ids: {},
275
- params: {order: order, query: query, limit: limit, fields: fields}.merge(kwargs).compact,
276
- body: {},
277
- entity: nil,
278
- )
279
- end
280
-
281
- end
282
-
283
- sig do
284
- params(
285
- body: T.untyped,
286
- kwargs: T.untyped
287
- ).returns(T.untyped)
288
- end
289
- def account_activation_url(
290
- body: nil,
291
- **kwargs
292
- )
293
- self.class.request(
294
- http_method: :post,
295
- operation: :account_activation_url,
296
- session: @session,
297
- ids: {id: @id},
298
- params: {}.merge(kwargs).compact,
299
- body: body,
300
- entity: self,
301
- )
302
- end
303
-
304
- sig do
305
- params(
306
- body: T.untyped,
307
- kwargs: T.untyped
308
- ).returns(T.untyped)
309
- end
310
- def send_invite(
311
- body: nil,
312
- **kwargs
313
- )
314
- self.class.request(
315
- http_method: :post,
316
- operation: :send_invite,
317
- session: @session,
318
- ids: {id: @id},
319
- params: {}.merge(kwargs).compact,
320
- body: body,
321
- entity: self,
322
- )
323
- end
324
-
325
- end
326
- end
@@ -1,281 +0,0 @@
1
- # typed: false
2
- # frozen_string_literal: true
3
-
4
- ########################################################################################################################
5
- # This file is auto-generated. If you have an issue, please create a GitHub issue. #
6
- ########################################################################################################################
7
-
8
- module ShopifyAPI
9
- class FulfillmentOrder < ShopifyAPI::Rest::Base
10
- extend T::Sig
11
-
12
- @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
13
- @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
14
-
15
- sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
- def initialize(session: ShopifyAPI::Context.active_session)
17
- super(session: session)
18
-
19
- @assigned_location = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
20
- @assigned_location_id = T.let(nil, T.nilable(Integer))
21
- @delivery_method = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
22
- @destination = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
23
- @fulfill_at = T.let(nil, T.nilable(String))
24
- @fulfillment_holds = T.let(nil, T.nilable(T::Array[T.untyped]))
25
- @id = T.let(nil, T.nilable(Integer))
26
- @international_duties = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
27
- @line_items = T.let(nil, T.nilable(T::Array[T.untyped]))
28
- @merchant_requests = T.let(nil, T.nilable(T::Array[T.untyped]))
29
- @order_id = T.let(nil, T.nilable(Integer))
30
- @request_status = T.let(nil, T.nilable(String))
31
- @shop_id = T.let(nil, T.nilable(Integer))
32
- @status = T.let(nil, T.nilable(String))
33
- @supported_actions = T.let(nil, T.nilable(T::Array[T.untyped]))
34
- end
35
-
36
- @has_one = T.let({}, T::Hash[Symbol, Class])
37
- @has_many = T.let({}, T::Hash[Symbol, Class])
38
- @paths = T.let([
39
- {http_method: :get, operation: :get, ids: [:id], path: "fulfillment_orders/<id>.json"},
40
- {http_method: :get, operation: :get, ids: [:order_id], path: "orders/<order_id>/fulfillment_orders.json"},
41
- {http_method: :post, operation: :cancel, ids: [:id], path: "fulfillment_orders/<id>/cancel.json"},
42
- {http_method: :post, operation: :close, ids: [:id], path: "fulfillment_orders/<id>/close.json"},
43
- {http_method: :post, operation: :hold, ids: [:id], path: "fulfillment_orders/<id>/hold.json"},
44
- {http_method: :post, operation: :move, ids: [:id], path: "fulfillment_orders/<id>/move.json"},
45
- {http_method: :post, operation: :open, ids: [:id], path: "fulfillment_orders/<id>/open.json"},
46
- {http_method: :post, operation: :release_hold, ids: [:id], path: "fulfillment_orders/<id>/release_hold.json"},
47
- {http_method: :post, operation: :reschedule, ids: [:id], path: "fulfillment_orders/<id>/reschedule.json"}
48
- ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
49
-
50
- sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
51
- attr_reader :assigned_location
52
- sig { returns(T.nilable(Integer)) }
53
- attr_reader :assigned_location_id
54
- sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
55
- attr_reader :delivery_method
56
- sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
57
- attr_reader :destination
58
- sig { returns(T.nilable(String)) }
59
- attr_reader :fulfill_at
60
- sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
61
- attr_reader :fulfillment_holds
62
- sig { returns(T.nilable(Integer)) }
63
- attr_reader :id
64
- sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
65
- attr_reader :international_duties
66
- sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
67
- attr_reader :line_items
68
- sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
69
- attr_reader :merchant_requests
70
- sig { returns(T.nilable(Integer)) }
71
- attr_reader :order_id
72
- sig { returns(T.nilable(String)) }
73
- attr_reader :request_status
74
- sig { returns(T.nilable(Integer)) }
75
- attr_reader :shop_id
76
- sig { returns(T.nilable(String)) }
77
- attr_reader :status
78
- sig { returns(T.nilable(T::Array[String])) }
79
- attr_reader :supported_actions
80
-
81
- class << self
82
- sig do
83
- params(
84
- id: T.any(Integer, String),
85
- session: Auth::Session
86
- ).returns(T.nilable(FulfillmentOrder))
87
- end
88
- def find(
89
- id:,
90
- session: ShopifyAPI::Context.active_session
91
- )
92
- result = base_find(
93
- session: session,
94
- ids: {id: id},
95
- params: {},
96
- )
97
- T.cast(result[0], T.nilable(FulfillmentOrder))
98
- end
99
-
100
- sig do
101
- params(
102
- order_id: T.nilable(T.any(Integer, String)),
103
- session: Auth::Session,
104
- kwargs: T.untyped
105
- ).returns(T::Array[FulfillmentOrder])
106
- end
107
- def all(
108
- order_id: nil,
109
- session: ShopifyAPI::Context.active_session,
110
- **kwargs
111
- )
112
- response = base_find(
113
- session: session,
114
- ids: {order_id: order_id},
115
- params: {}.merge(kwargs).compact,
116
- )
117
-
118
- T.cast(response, T::Array[FulfillmentOrder])
119
- end
120
-
121
- end
122
-
123
- sig do
124
- params(
125
- body: T.untyped,
126
- kwargs: T.untyped
127
- ).returns(T.untyped)
128
- end
129
- def cancel(
130
- body: nil,
131
- **kwargs
132
- )
133
- self.class.request(
134
- http_method: :post,
135
- operation: :cancel,
136
- session: @session,
137
- ids: {id: @id},
138
- params: {}.merge(kwargs).compact,
139
- body: body,
140
- entity: self,
141
- )
142
- end
143
-
144
- sig do
145
- params(
146
- message: T.untyped,
147
- body: T.untyped,
148
- kwargs: T.untyped
149
- ).returns(T.untyped)
150
- end
151
- def close(
152
- message: nil,
153
- body: nil,
154
- **kwargs
155
- )
156
- self.class.request(
157
- http_method: :post,
158
- operation: :close,
159
- session: @session,
160
- ids: {id: @id},
161
- params: {message: message}.merge(kwargs).compact,
162
- body: body,
163
- entity: self,
164
- )
165
- end
166
-
167
- sig do
168
- params(
169
- reason: T.untyped,
170
- reason_notes: T.untyped,
171
- notify_merchant: T.untyped,
172
- body: T.untyped,
173
- kwargs: T.untyped
174
- ).returns(T.untyped)
175
- end
176
- def hold(
177
- reason: nil,
178
- reason_notes: nil,
179
- notify_merchant: nil,
180
- body: nil,
181
- **kwargs
182
- )
183
- self.class.request(
184
- http_method: :post,
185
- operation: :hold,
186
- session: @session,
187
- ids: {id: @id},
188
- params: {reason: reason, reason_notes: reason_notes, notify_merchant: notify_merchant}.merge(kwargs).compact,
189
- body: body,
190
- entity: self,
191
- )
192
- end
193
-
194
- sig do
195
- params(
196
- fulfillment_order: T.untyped,
197
- body: T.untyped,
198
- kwargs: T.untyped
199
- ).returns(T.untyped)
200
- end
201
- def move(
202
- fulfillment_order: nil,
203
- body: nil,
204
- **kwargs
205
- )
206
- self.class.request(
207
- http_method: :post,
208
- operation: :move,
209
- session: @session,
210
- ids: {id: @id},
211
- params: {fulfillment_order: fulfillment_order}.merge(kwargs).compact,
212
- body: body,
213
- entity: self,
214
- )
215
- end
216
-
217
- sig do
218
- params(
219
- body: T.untyped,
220
- kwargs: T.untyped
221
- ).returns(T.untyped)
222
- end
223
- def open(
224
- body: nil,
225
- **kwargs
226
- )
227
- self.class.request(
228
- http_method: :post,
229
- operation: :open,
230
- session: @session,
231
- ids: {id: @id},
232
- params: {}.merge(kwargs).compact,
233
- body: body,
234
- entity: self,
235
- )
236
- end
237
-
238
- sig do
239
- params(
240
- body: T.untyped,
241
- kwargs: T.untyped
242
- ).returns(T.untyped)
243
- end
244
- def release_hold(
245
- body: nil,
246
- **kwargs
247
- )
248
- self.class.request(
249
- http_method: :post,
250
- operation: :release_hold,
251
- session: @session,
252
- ids: {id: @id},
253
- params: {}.merge(kwargs).compact,
254
- body: body,
255
- entity: self,
256
- )
257
- end
258
-
259
- sig do
260
- params(
261
- body: T.untyped,
262
- kwargs: T.untyped
263
- ).returns(T.untyped)
264
- end
265
- def reschedule(
266
- body: nil,
267
- **kwargs
268
- )
269
- self.class.request(
270
- http_method: :post,
271
- operation: :reschedule,
272
- session: @session,
273
- ids: {id: @id},
274
- params: {}.merge(kwargs).compact,
275
- body: body,
276
- entity: self,
277
- )
278
- end
279
-
280
- end
281
- end