shopify_api 13.0.0 → 13.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (202) hide show
  1. checksums.yaml +4 -4
  2. data/BREAKING_CHANGES_FOR_V10.md +231 -0
  3. data/CHANGELOG.md +14 -1
  4. data/Gemfile.lock +8 -8
  5. data/README.md +10 -41
  6. data/docs/README.md +0 -1
  7. data/docs/getting_started.md +21 -11
  8. data/docs/usage/custom_apps.md +75 -0
  9. data/docs/usage/graphql.md +63 -18
  10. data/docs/usage/oauth.md +160 -27
  11. data/docs/usage/rest.md +204 -62
  12. data/docs/usage/webhooks.md +22 -4
  13. data/lib/shopify_api/admin_versions.rb +3 -1
  14. data/lib/shopify_api/context.rb +6 -3
  15. data/lib/shopify_api/rest/base.rb +27 -15
  16. data/lib/shopify_api/rest/resources/2022_04/fulfillment_order.rb +3 -7
  17. data/lib/shopify_api/rest/resources/2022_04/shop.rb +2 -2
  18. data/lib/shopify_api/rest/resources/2022_07/fulfillment_order.rb +3 -7
  19. data/lib/shopify_api/rest/resources/2022_07/shop.rb +2 -2
  20. data/lib/shopify_api/rest/resources/2022_10/assigned_fulfillment_order.rb +5 -3
  21. data/lib/shopify_api/rest/resources/2022_10/customer_address.rb +10 -0
  22. data/lib/shopify_api/rest/resources/2022_10/fulfillment_order.rb +3 -7
  23. data/lib/shopify_api/rest/resources/2022_10/fulfillment_request.rb +10 -0
  24. data/lib/shopify_api/rest/resources/2022_10/order_risk.rb +5 -3
  25. data/lib/shopify_api/rest/resources/2022_10/shop.rb +2 -2
  26. data/lib/shopify_api/rest/resources/2023_01/assigned_fulfillment_order.rb +5 -3
  27. data/lib/shopify_api/rest/resources/2023_01/balance.rb +4 -0
  28. data/lib/shopify_api/rest/resources/2023_01/customer_address.rb +10 -0
  29. data/lib/shopify_api/rest/resources/2023_01/fulfillment_order.rb +3 -7
  30. data/lib/shopify_api/rest/resources/2023_01/fulfillment_request.rb +10 -0
  31. data/lib/shopify_api/rest/resources/2023_01/order.rb +3 -0
  32. data/lib/shopify_api/rest/resources/2023_01/order_risk.rb +5 -3
  33. data/lib/shopify_api/rest/resources/2023_01/shop.rb +2 -5
  34. data/lib/shopify_api/rest/resources/2023_01/variant.rb +1 -5
  35. data/lib/shopify_api/rest/resources/2023_04/assigned_fulfillment_order.rb +5 -3
  36. data/lib/shopify_api/rest/resources/2023_04/balance.rb +4 -0
  37. data/lib/shopify_api/rest/resources/2023_04/customer_address.rb +10 -0
  38. data/lib/shopify_api/rest/resources/2023_04/fulfillment_request.rb +10 -0
  39. data/lib/shopify_api/rest/resources/2023_04/order.rb +3 -0
  40. data/lib/shopify_api/rest/resources/2023_04/order_risk.rb +5 -3
  41. data/lib/shopify_api/rest/resources/2023_04/shop.rb +2 -5
  42. data/lib/shopify_api/rest/resources/2023_04/variant.rb +1 -5
  43. data/lib/shopify_api/rest/resources/2023_07/abandoned_checkout.rb +190 -0
  44. data/lib/shopify_api/rest/resources/2023_07/access_scope.rb +58 -0
  45. data/lib/shopify_api/rest/resources/2023_07/apple_pay_certificate.rb +105 -0
  46. data/lib/shopify_api/rest/resources/2023_07/application_charge.rb +109 -0
  47. data/lib/shopify_api/rest/resources/2023_07/application_credit.rb +91 -0
  48. data/lib/shopify_api/rest/resources/2023_07/article.rb +265 -0
  49. data/lib/shopify_api/rest/resources/2023_07/asset.rb +118 -0
  50. data/lib/shopify_api/rest/resources/2023_07/assigned_fulfillment_order.rb +88 -0
  51. data/lib/shopify_api/rest/resources/2023_07/balance.rb +54 -0
  52. data/lib/shopify_api/rest/resources/2023_07/blog.rb +162 -0
  53. data/lib/shopify_api/rest/resources/2023_07/cancellation_request.rb +83 -0
  54. data/lib/shopify_api/rest/resources/2023_07/carrier_service.rb +116 -0
  55. data/lib/shopify_api/rest/resources/2023_07/checkout.rb +209 -0
  56. data/lib/shopify_api/rest/resources/2023_07/collect.rb +142 -0
  57. data/lib/shopify_api/rest/resources/2023_07/collection.rb +110 -0
  58. data/lib/shopify_api/rest/resources/2023_07/collection_listing.rb +155 -0
  59. data/lib/shopify_api/rest/resources/2023_07/comment.rb +283 -0
  60. data/lib/shopify_api/rest/resources/2023_07/country.rb +137 -0
  61. data/lib/shopify_api/rest/resources/2023_07/currency.rb +57 -0
  62. data/lib/shopify_api/rest/resources/2023_07/custom_collection.rb +187 -0
  63. data/lib/shopify_api/rest/resources/2023_07/customer.rb +329 -0
  64. data/lib/shopify_api/rest/resources/2023_07/customer_address.rb +211 -0
  65. data/lib/shopify_api/rest/resources/2023_07/customer_saved_search.rb +169 -0
  66. data/lib/shopify_api/rest/resources/2023_07/deprecated_api_call.rb +57 -0
  67. data/lib/shopify_api/rest/resources/2023_07/discount_code.rb +222 -0
  68. data/lib/shopify_api/rest/resources/2023_07/dispute.rb +111 -0
  69. data/lib/shopify_api/rest/resources/2023_07/dispute_evidence.rb +117 -0
  70. data/lib/shopify_api/rest/resources/2023_07/dispute_file_upload.rb +81 -0
  71. data/lib/shopify_api/rest/resources/2023_07/draft_order.rb +275 -0
  72. data/lib/shopify_api/rest/resources/2023_07/event.rb +148 -0
  73. data/lib/shopify_api/rest/resources/2023_07/fulfillment.rb +231 -0
  74. data/lib/shopify_api/rest/resources/2023_07/fulfillment_event.rb +166 -0
  75. data/lib/shopify_api/rest/resources/2023_07/fulfillment_order.rb +312 -0
  76. data/lib/shopify_api/rest/resources/2023_07/fulfillment_request.rb +97 -0
  77. data/lib/shopify_api/rest/resources/2023_07/fulfillment_service.rb +130 -0
  78. data/lib/shopify_api/rest/resources/2023_07/gift_card.rb +218 -0
  79. data/lib/shopify_api/rest/resources/2023_07/gift_card_adjustment.rb +118 -0
  80. data/lib/shopify_api/rest/resources/2023_07/image.rb +157 -0
  81. data/lib/shopify_api/rest/resources/2023_07/inventory_item.rb +108 -0
  82. data/lib/shopify_api/rest/resources/2023_07/inventory_level.rb +179 -0
  83. data/lib/shopify_api/rest/resources/2023_07/location.rb +167 -0
  84. data/lib/shopify_api/rest/resources/2023_07/locations_for_move.rb +56 -0
  85. data/lib/shopify_api/rest/resources/2023_07/marketing_event.rb +209 -0
  86. data/lib/shopify_api/rest/resources/2023_07/metafield.rb +344 -0
  87. data/lib/shopify_api/rest/resources/2023_07/mobile_platform_application.rb +110 -0
  88. data/lib/shopify_api/rest/resources/2023_07/order.rb +491 -0
  89. data/lib/shopify_api/rest/resources/2023_07/order_risk.rb +144 -0
  90. data/lib/shopify_api/rest/resources/2023_07/page.rb +194 -0
  91. data/lib/shopify_api/rest/resources/2023_07/payment.rb +140 -0
  92. data/lib/shopify_api/rest/resources/2023_07/payment_gateway.rb +143 -0
  93. data/lib/shopify_api/rest/resources/2023_07/payment_transaction.rb +107 -0
  94. data/lib/shopify_api/rest/resources/2023_07/payout.rb +97 -0
  95. data/lib/shopify_api/rest/resources/2023_07/policy.rb +69 -0
  96. data/lib/shopify_api/rest/resources/2023_07/price_rule.rb +223 -0
  97. data/lib/shopify_api/rest/resources/2023_07/product.rb +223 -0
  98. data/lib/shopify_api/rest/resources/2023_07/product_listing.rb +196 -0
  99. data/lib/shopify_api/rest/resources/2023_07/product_resource_feedback.rb +88 -0
  100. data/lib/shopify_api/rest/resources/2023_07/province.rb +132 -0
  101. data/lib/shopify_api/rest/resources/2023_07/recurring_application_charge.rb +172 -0
  102. data/lib/shopify_api/rest/resources/2023_07/redirect.rb +139 -0
  103. data/lib/shopify_api/rest/resources/2023_07/refund.rb +151 -0
  104. data/lib/shopify_api/rest/resources/2023_07/report.rb +121 -0
  105. data/lib/shopify_api/rest/resources/2023_07/resource_feedback.rb +73 -0
  106. data/lib/shopify_api/rest/resources/2023_07/script_tag.rb +155 -0
  107. data/lib/shopify_api/rest/resources/2023_07/shipping_zone.rb +83 -0
  108. data/lib/shopify_api/rest/resources/2023_07/shop.rb +218 -0
  109. data/lib/shopify_api/rest/resources/2023_07/smart_collection.rb +216 -0
  110. data/lib/shopify_api/rest/resources/2023_07/storefront_access_token.rb +87 -0
  111. data/lib/shopify_api/rest/resources/2023_07/tender_transaction.rb +93 -0
  112. data/lib/shopify_api/rest/resources/2023_07/theme.rb +123 -0
  113. data/lib/shopify_api/rest/resources/2023_07/transaction.rb +184 -0
  114. data/lib/shopify_api/rest/resources/2023_07/usage_charge.rb +102 -0
  115. data/lib/shopify_api/rest/resources/2023_07/user.rb +138 -0
  116. data/lib/shopify_api/rest/resources/2023_07/variant.rb +208 -0
  117. data/lib/shopify_api/rest/resources/2023_07/webhook.rb +168 -0
  118. data/lib/shopify_api/rest/resources/2023_10/abandoned_checkout.rb +190 -0
  119. data/lib/shopify_api/rest/resources/2023_10/access_scope.rb +58 -0
  120. data/lib/shopify_api/rest/resources/2023_10/apple_pay_certificate.rb +105 -0
  121. data/lib/shopify_api/rest/resources/2023_10/application_charge.rb +109 -0
  122. data/lib/shopify_api/rest/resources/2023_10/application_credit.rb +91 -0
  123. data/lib/shopify_api/rest/resources/2023_10/article.rb +265 -0
  124. data/lib/shopify_api/rest/resources/2023_10/asset.rb +118 -0
  125. data/lib/shopify_api/rest/resources/2023_10/assigned_fulfillment_order.rb +88 -0
  126. data/lib/shopify_api/rest/resources/2023_10/balance.rb +54 -0
  127. data/lib/shopify_api/rest/resources/2023_10/blog.rb +162 -0
  128. data/lib/shopify_api/rest/resources/2023_10/cancellation_request.rb +83 -0
  129. data/lib/shopify_api/rest/resources/2023_10/carrier_service.rb +116 -0
  130. data/lib/shopify_api/rest/resources/2023_10/checkout.rb +209 -0
  131. data/lib/shopify_api/rest/resources/2023_10/collect.rb +142 -0
  132. data/lib/shopify_api/rest/resources/2023_10/collection.rb +110 -0
  133. data/lib/shopify_api/rest/resources/2023_10/collection_listing.rb +155 -0
  134. data/lib/shopify_api/rest/resources/2023_10/comment.rb +283 -0
  135. data/lib/shopify_api/rest/resources/2023_10/country.rb +137 -0
  136. data/lib/shopify_api/rest/resources/2023_10/currency.rb +57 -0
  137. data/lib/shopify_api/rest/resources/2023_10/custom_collection.rb +187 -0
  138. data/lib/shopify_api/rest/resources/2023_10/customer.rb +329 -0
  139. data/lib/shopify_api/rest/resources/2023_10/customer_address.rb +211 -0
  140. data/lib/shopify_api/rest/resources/2023_10/deprecated_api_call.rb +57 -0
  141. data/lib/shopify_api/rest/resources/2023_10/discount_code.rb +222 -0
  142. data/lib/shopify_api/rest/resources/2023_10/dispute.rb +111 -0
  143. data/lib/shopify_api/rest/resources/2023_10/dispute_evidence.rb +117 -0
  144. data/lib/shopify_api/rest/resources/2023_10/dispute_file_upload.rb +81 -0
  145. data/lib/shopify_api/rest/resources/2023_10/draft_order.rb +275 -0
  146. data/lib/shopify_api/rest/resources/2023_10/event.rb +148 -0
  147. data/lib/shopify_api/rest/resources/2023_10/fulfillment.rb +231 -0
  148. data/lib/shopify_api/rest/resources/2023_10/fulfillment_event.rb +166 -0
  149. data/lib/shopify_api/rest/resources/2023_10/fulfillment_order.rb +312 -0
  150. data/lib/shopify_api/rest/resources/2023_10/fulfillment_request.rb +97 -0
  151. data/lib/shopify_api/rest/resources/2023_10/fulfillment_service.rb +130 -0
  152. data/lib/shopify_api/rest/resources/2023_10/gift_card.rb +218 -0
  153. data/lib/shopify_api/rest/resources/2023_10/gift_card_adjustment.rb +118 -0
  154. data/lib/shopify_api/rest/resources/2023_10/image.rb +157 -0
  155. data/lib/shopify_api/rest/resources/2023_10/inventory_item.rb +108 -0
  156. data/lib/shopify_api/rest/resources/2023_10/inventory_level.rb +179 -0
  157. data/lib/shopify_api/rest/resources/2023_10/location.rb +167 -0
  158. data/lib/shopify_api/rest/resources/2023_10/locations_for_move.rb +56 -0
  159. data/lib/shopify_api/rest/resources/2023_10/marketing_event.rb +209 -0
  160. data/lib/shopify_api/rest/resources/2023_10/metafield.rb +344 -0
  161. data/lib/shopify_api/rest/resources/2023_10/mobile_platform_application.rb +110 -0
  162. data/lib/shopify_api/rest/resources/2023_10/order.rb +491 -0
  163. data/lib/shopify_api/rest/resources/2023_10/order_risk.rb +144 -0
  164. data/lib/shopify_api/rest/resources/2023_10/page.rb +194 -0
  165. data/lib/shopify_api/rest/resources/2023_10/payment.rb +140 -0
  166. data/lib/shopify_api/rest/resources/2023_10/payment_gateway.rb +143 -0
  167. data/lib/shopify_api/rest/resources/2023_10/payment_transaction.rb +107 -0
  168. data/lib/shopify_api/rest/resources/2023_10/payout.rb +97 -0
  169. data/lib/shopify_api/rest/resources/2023_10/policy.rb +69 -0
  170. data/lib/shopify_api/rest/resources/2023_10/price_rule.rb +223 -0
  171. data/lib/shopify_api/rest/resources/2023_10/product.rb +223 -0
  172. data/lib/shopify_api/rest/resources/2023_10/product_listing.rb +196 -0
  173. data/lib/shopify_api/rest/resources/2023_10/product_resource_feedback.rb +88 -0
  174. data/lib/shopify_api/rest/resources/2023_10/province.rb +132 -0
  175. data/lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb +172 -0
  176. data/lib/shopify_api/rest/resources/2023_10/redirect.rb +139 -0
  177. data/lib/shopify_api/rest/resources/2023_10/refund.rb +151 -0
  178. data/lib/shopify_api/rest/resources/2023_10/report.rb +121 -0
  179. data/lib/shopify_api/rest/resources/2023_10/resource_feedback.rb +73 -0
  180. data/lib/shopify_api/rest/resources/2023_10/script_tag.rb +155 -0
  181. data/lib/shopify_api/rest/resources/2023_10/shipping_zone.rb +83 -0
  182. data/lib/shopify_api/rest/resources/2023_10/shop.rb +218 -0
  183. data/lib/shopify_api/rest/resources/2023_10/smart_collection.rb +216 -0
  184. data/lib/shopify_api/rest/resources/2023_10/storefront_access_token.rb +87 -0
  185. data/lib/shopify_api/rest/resources/2023_10/tender_transaction.rb +93 -0
  186. data/lib/shopify_api/rest/resources/2023_10/theme.rb +123 -0
  187. data/lib/shopify_api/rest/resources/2023_10/transaction.rb +184 -0
  188. data/lib/shopify_api/rest/resources/2023_10/usage_charge.rb +102 -0
  189. data/lib/shopify_api/rest/resources/2023_10/user.rb +138 -0
  190. data/lib/shopify_api/rest/resources/2023_10/variant.rb +208 -0
  191. data/lib/shopify_api/rest/resources/2023_10/webhook.rb +168 -0
  192. data/lib/shopify_api/version.rb +1 -1
  193. data/lib/shopify_api/webhooks/registration.rb +19 -4
  194. data/lib/shopify_api/webhooks/registrations/event_bridge.rb +1 -1
  195. data/lib/shopify_api/webhooks/registrations/http.rb +1 -1
  196. data/lib/shopify_api/webhooks/registrations/pub_sub.rb +2 -1
  197. data/lib/shopify_api/webhooks/registry.rb +9 -5
  198. data/shopify_api.gemspec +1 -1
  199. metadata +154 -12
  200. data/.github/workflows/stale.yml +0 -43
  201. data/docs/issues.md +0 -39
  202. data/docs/usage/session_storage.md +0 -46
@@ -170,17 +170,13 @@ module ShopifyAPI
170
170
 
171
171
  sig do
172
172
  params(
173
- reason: T.untyped,
174
- reason_notes: T.untyped,
175
- notify_merchant: T.untyped,
173
+ fulfillment_hold: T.untyped,
176
174
  body: T.untyped,
177
175
  kwargs: T.untyped
178
176
  ).returns(T.untyped)
179
177
  end
180
178
  def hold(
181
- reason: nil,
182
- reason_notes: nil,
183
- notify_merchant: nil,
179
+ fulfillment_hold: nil,
184
180
  body: nil,
185
181
  **kwargs
186
182
  )
@@ -189,7 +185,7 @@ module ShopifyAPI
189
185
  operation: :hold,
190
186
  session: @session,
191
187
  ids: {id: @id},
192
- params: {reason: reason, reason_notes: reason_notes, notify_merchant: notify_merchant}.merge(kwargs).compact,
188
+ params: {fulfillment_hold: fulfillment_hold}.merge(kwargs).compact,
193
189
  body: body,
194
190
  entity: self,
195
191
  )
@@ -31,6 +31,16 @@ module ShopifyAPI
31
31
  attr_reader :fulfillment_order_id
32
32
 
33
33
  class << self
34
+ sig do
35
+ returns(T::Array[String])
36
+ end
37
+ def json_response_body_names()
38
+ [
39
+ "submitted_fulfillment_order",
40
+ "fulfillment_order"
41
+ ]
42
+ end
43
+
34
44
  end
35
45
 
36
46
  sig do
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -66,7 +66,7 @@ module ShopifyAPI
66
66
  @shop_owner = T.let(nil, T.nilable(String))
67
67
  @source = T.let(nil, T.nilable(String))
68
68
  @tax_shipping = T.let(nil, T.nilable(String))
69
- @taxes_included = T.let(nil, T.nilable(String))
69
+ @taxes_included = T.let(nil, T.nilable(T::Boolean))
70
70
  @timezone = T.let(nil, T.nilable(String))
71
71
  @transactional_sms_disabled = T.let(nil, T.nilable(T::Boolean))
72
72
  @updated_at = T.let(nil, T.nilable(String))
@@ -180,7 +180,7 @@ module ShopifyAPI
180
180
  attr_reader :source
181
181
  sig { returns(T.nilable(String)) }
182
182
  attr_reader :tax_shipping
183
- sig { returns(T.nilable(String)) }
183
+ sig { returns(T.nilable(T::Boolean)) }
184
184
  attr_reader :taxes_included
185
185
  sig { returns(T.nilable(String)) }
186
186
  attr_reader :timezone
@@ -51,10 +51,12 @@ module ShopifyAPI
51
51
 
52
52
  class << self
53
53
  sig do
54
- returns(String)
54
+ returns(T::Array[String])
55
55
  end
56
- def json_response_body_name()
57
- "fulfillment_order"
56
+ def json_response_body_names()
57
+ [
58
+ "fulfillment_order"
59
+ ]
58
60
  end
59
61
 
60
62
  sig do
@@ -16,6 +16,7 @@ module ShopifyAPI
16
16
  def initialize(session: ShopifyAPI::Context.active_session)
17
17
  super(session: session)
18
18
 
19
+ @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
19
20
  end
20
21
 
21
22
  @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
24
25
  {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
25
26
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
26
27
 
28
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
29
+ attr_reader :balance
30
+
27
31
  class << self
28
32
  sig do
29
33
  params(
@@ -87,6 +87,16 @@ module ShopifyAPI
87
87
  "address"
88
88
  end
89
89
 
90
+ sig do
91
+ returns(T::Array[String])
92
+ end
93
+ def json_response_body_names()
94
+ [
95
+ "customer_address",
96
+ "address"
97
+ ]
98
+ end
99
+
90
100
  sig do
91
101
  params(
92
102
  id: T.any(Integer, String),
@@ -176,17 +176,13 @@ module ShopifyAPI
176
176
 
177
177
  sig do
178
178
  params(
179
- reason: T.untyped,
180
- reason_notes: T.untyped,
181
- notify_merchant: T.untyped,
179
+ fulfillment_hold: T.untyped,
182
180
  body: T.untyped,
183
181
  kwargs: T.untyped
184
182
  ).returns(T.untyped)
185
183
  end
186
184
  def hold(
187
- reason: nil,
188
- reason_notes: nil,
189
- notify_merchant: nil,
185
+ fulfillment_hold: nil,
190
186
  body: nil,
191
187
  **kwargs
192
188
  )
@@ -195,7 +191,7 @@ module ShopifyAPI
195
191
  operation: :hold,
196
192
  session: @session,
197
193
  ids: {id: @id},
198
- params: {reason: reason, reason_notes: reason_notes, notify_merchant: notify_merchant}.merge(kwargs).compact,
194
+ params: {fulfillment_hold: fulfillment_hold}.merge(kwargs).compact,
199
195
  body: body,
200
196
  entity: self,
201
197
  )
@@ -31,6 +31,16 @@ module ShopifyAPI
31
31
  attr_reader :fulfillment_order_id
32
32
 
33
33
  class << self
34
+ sig do
35
+ returns(T::Array[String])
36
+ end
37
+ def json_response_body_names()
38
+ [
39
+ "submitted_fulfillment_order",
40
+ "fulfillment_order"
41
+ ]
42
+ end
43
+
34
44
  end
35
45
 
36
46
  sig do
@@ -28,6 +28,7 @@ module ShopifyAPI
28
28
  @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
29
29
  @closed_at = T.let(nil, T.nilable(String))
30
30
  @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
31
+ @confirmation_number = T.let(nil, T.nilable(String))
31
32
  @created_at = T.let(nil, T.nilable(String))
32
33
  @currency = T.let(nil, T.nilable(String))
33
34
  @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -142,6 +143,8 @@ module ShopifyAPI
142
143
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
143
144
  attr_reader :company
144
145
  sig { returns(T.nilable(String)) }
146
+ attr_reader :confirmation_number
147
+ sig { returns(T.nilable(String)) }
145
148
  attr_reader :created_at
146
149
  sig { returns(T.nilable(String)) }
147
150
  attr_reader :currency
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -20,7 +20,6 @@ module ShopifyAPI
20
20
  @address2 = T.let(nil, T.nilable(String))
21
21
  @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
22
22
  @city = T.let(nil, T.nilable(String))
23
- @cookie_consent_level = T.let(nil, T.nilable(String))
24
23
  @country = T.let(nil, T.nilable(String))
25
24
  @country_code = T.let(nil, T.nilable(String))
26
25
  @country_name = T.let(nil, T.nilable(String))
@@ -66,7 +65,7 @@ module ShopifyAPI
66
65
  @shop_owner = T.let(nil, T.nilable(String))
67
66
  @source = T.let(nil, T.nilable(String))
68
67
  @tax_shipping = T.let(nil, T.nilable(String))
69
- @taxes_included = T.let(nil, T.nilable(String))
68
+ @taxes_included = T.let(nil, T.nilable(T::Boolean))
70
69
  @timezone = T.let(nil, T.nilable(String))
71
70
  @transactional_sms_disabled = T.let(nil, T.nilable(T::Boolean))
72
71
  @updated_at = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
89
88
  sig { returns(T.nilable(String)) }
90
89
  attr_reader :city
91
90
  sig { returns(T.nilable(String)) }
92
- attr_reader :cookie_consent_level
93
- sig { returns(T.nilable(String)) }
94
91
  attr_reader :country
95
92
  sig { returns(T.nilable(String)) }
96
93
  attr_reader :country_code
@@ -180,7 +177,7 @@ module ShopifyAPI
180
177
  attr_reader :source
181
178
  sig { returns(T.nilable(String)) }
182
179
  attr_reader :tax_shipping
183
- sig { returns(T.nilable(String)) }
180
+ sig { returns(T.nilable(T::Boolean)) }
184
181
  attr_reader :taxes_included
185
182
  sig { returns(T.nilable(String)) }
186
183
  attr_reader :timezone
@@ -27,7 +27,6 @@ module ShopifyAPI
27
27
  @inventory_management = T.let(nil, T.nilable(String))
28
28
  @inventory_policy = T.let(nil, T.nilable(String))
29
29
  @inventory_quantity = T.let(nil, T.nilable(Integer))
30
- @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
31
30
  @old_inventory_quantity = T.let(nil, T.nilable(Integer))
32
31
  @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
33
32
  @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
55
54
  {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
56
55
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
57
56
  @read_only_attributes = T.let([
58
- :inventory_quantity,
59
- :inventory_quantity_adjustment
57
+ :inventory_quantity
60
58
  ], T::Array[Symbol])
61
59
 
62
60
  sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
82
80
  sig { returns(T.nilable(Integer)) }
83
81
  attr_reader :inventory_quantity
84
82
  sig { returns(T.nilable(Integer)) }
85
- attr_reader :inventory_quantity_adjustment
86
- sig { returns(T.nilable(Integer)) }
87
83
  attr_reader :old_inventory_quantity
88
84
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
89
85
  attr_reader :option
@@ -51,10 +51,12 @@ module ShopifyAPI
51
51
 
52
52
  class << self
53
53
  sig do
54
- returns(String)
54
+ returns(T::Array[String])
55
55
  end
56
- def json_response_body_name()
57
- "fulfillment_order"
56
+ def json_response_body_names()
57
+ [
58
+ "fulfillment_order"
59
+ ]
58
60
  end
59
61
 
60
62
  sig do
@@ -16,6 +16,7 @@ module ShopifyAPI
16
16
  def initialize(session: ShopifyAPI::Context.active_session)
17
17
  super(session: session)
18
18
 
19
+ @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
19
20
  end
20
21
 
21
22
  @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
24
25
  {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
25
26
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
26
27
 
28
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
29
+ attr_reader :balance
30
+
27
31
  class << self
28
32
  sig do
29
33
  params(
@@ -87,6 +87,16 @@ module ShopifyAPI
87
87
  "address"
88
88
  end
89
89
 
90
+ sig do
91
+ returns(T::Array[String])
92
+ end
93
+ def json_response_body_names()
94
+ [
95
+ "customer_address",
96
+ "address"
97
+ ]
98
+ end
99
+
90
100
  sig do
91
101
  params(
92
102
  id: T.any(Integer, String),
@@ -31,6 +31,16 @@ module ShopifyAPI
31
31
  attr_reader :fulfillment_order_id
32
32
 
33
33
  class << self
34
+ sig do
35
+ returns(T::Array[String])
36
+ end
37
+ def json_response_body_names()
38
+ [
39
+ "submitted_fulfillment_order",
40
+ "fulfillment_order"
41
+ ]
42
+ end
43
+
34
44
  end
35
45
 
36
46
  sig do
@@ -28,6 +28,7 @@ module ShopifyAPI
28
28
  @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
29
29
  @closed_at = T.let(nil, T.nilable(String))
30
30
  @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
31
+ @confirmation_number = T.let(nil, T.nilable(String))
31
32
  @created_at = T.let(nil, T.nilable(String))
32
33
  @currency = T.let(nil, T.nilable(String))
33
34
  @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -144,6 +145,8 @@ module ShopifyAPI
144
145
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
145
146
  attr_reader :company
146
147
  sig { returns(T.nilable(String)) }
148
+ attr_reader :confirmation_number
149
+ sig { returns(T.nilable(String)) }
147
150
  attr_reader :created_at
148
151
  sig { returns(T.nilable(String)) }
149
152
  attr_reader :currency
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -20,7 +20,6 @@ module ShopifyAPI
20
20
  @address2 = T.let(nil, T.nilable(String))
21
21
  @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
22
22
  @city = T.let(nil, T.nilable(String))
23
- @cookie_consent_level = T.let(nil, T.nilable(String))
24
23
  @country = T.let(nil, T.nilable(String))
25
24
  @country_code = T.let(nil, T.nilable(String))
26
25
  @country_name = T.let(nil, T.nilable(String))
@@ -66,7 +65,7 @@ module ShopifyAPI
66
65
  @shop_owner = T.let(nil, T.nilable(String))
67
66
  @source = T.let(nil, T.nilable(String))
68
67
  @tax_shipping = T.let(nil, T.nilable(String))
69
- @taxes_included = T.let(nil, T.nilable(String))
68
+ @taxes_included = T.let(nil, T.nilable(T::Boolean))
70
69
  @timezone = T.let(nil, T.nilable(String))
71
70
  @transactional_sms_disabled = T.let(nil, T.nilable(T::Boolean))
72
71
  @updated_at = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
89
88
  sig { returns(T.nilable(String)) }
90
89
  attr_reader :city
91
90
  sig { returns(T.nilable(String)) }
92
- attr_reader :cookie_consent_level
93
- sig { returns(T.nilable(String)) }
94
91
  attr_reader :country
95
92
  sig { returns(T.nilable(String)) }
96
93
  attr_reader :country_code
@@ -180,7 +177,7 @@ module ShopifyAPI
180
177
  attr_reader :source
181
178
  sig { returns(T.nilable(String)) }
182
179
  attr_reader :tax_shipping
183
- sig { returns(T.nilable(String)) }
180
+ sig { returns(T.nilable(T::Boolean)) }
184
181
  attr_reader :taxes_included
185
182
  sig { returns(T.nilable(String)) }
186
183
  attr_reader :timezone
@@ -27,7 +27,6 @@ module ShopifyAPI
27
27
  @inventory_management = T.let(nil, T.nilable(String))
28
28
  @inventory_policy = T.let(nil, T.nilable(String))
29
29
  @inventory_quantity = T.let(nil, T.nilable(Integer))
30
- @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
31
30
  @old_inventory_quantity = T.let(nil, T.nilable(Integer))
32
31
  @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
33
32
  @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
55
54
  {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
56
55
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
57
56
  @read_only_attributes = T.let([
58
- :inventory_quantity,
59
- :inventory_quantity_adjustment
57
+ :inventory_quantity
60
58
  ], T::Array[Symbol])
61
59
 
62
60
  sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
82
80
  sig { returns(T.nilable(Integer)) }
83
81
  attr_reader :inventory_quantity
84
82
  sig { returns(T.nilable(Integer)) }
85
- attr_reader :inventory_quantity_adjustment
86
- sig { returns(T.nilable(Integer)) }
87
83
  attr_reader :old_inventory_quantity
88
84
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
89
85
  attr_reader :option
@@ -0,0 +1,190 @@
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 AbandonedCheckout < 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
+ @abandoned_checkout_url = T.let(nil, T.nilable(String))
20
+ @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
21
+ @buyer_accepts_marketing = T.let(nil, T.nilable(T::Boolean))
22
+ @buyer_accepts_sms_marketing = T.let(nil, T.nilable(T::Boolean))
23
+ @cart_token = T.let(nil, T.nilable(String))
24
+ @closed_at = T.let(nil, T.nilable(String))
25
+ @completed_at = T.let(nil, T.nilable(String))
26
+ @created_at = T.let(nil, T.nilable(String))
27
+ @currency = T.let(nil, T.nilable(Currency))
28
+ @customer = T.let(nil, T.nilable(Customer))
29
+ @customer_locale = T.let(nil, T.nilable(String))
30
+ @device_id = T.let(nil, T.nilable(Integer))
31
+ @discount_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
32
+ @email = T.let(nil, T.nilable(String))
33
+ @gateway = T.let(nil, T.nilable(String))
34
+ @id = T.let(nil, T.nilable(Integer))
35
+ @landing_site = T.let(nil, T.nilable(String))
36
+ @line_items = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
37
+ @location_id = T.let(nil, T.nilable(Integer))
38
+ @note = T.let(nil, T.nilable(String))
39
+ @phone = T.let(nil, T.nilable(String))
40
+ @presentment_currency = T.let(nil, T.nilable(String))
41
+ @referring_site = T.let(nil, T.nilable(String))
42
+ @shipping_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
43
+ @shipping_lines = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
44
+ @sms_marketing_phone = T.let(nil, T.nilable(String))
45
+ @source_name = T.let(nil, T.nilable(String))
46
+ @subtotal_price = T.let(nil, T.nilable(String))
47
+ @tax_lines = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
48
+ @taxes_included = T.let(nil, T.nilable(T::Boolean))
49
+ @token = T.let(nil, T.nilable(String))
50
+ @total_discounts = T.let(nil, T.nilable(String))
51
+ @total_duties = T.let(nil, T.nilable(String))
52
+ @total_line_items_price = T.let(nil, T.nilable(String))
53
+ @total_price = T.let(nil, T.nilable(String))
54
+ @total_tax = T.let(nil, T.nilable(String))
55
+ @total_weight = T.let(nil, T.nilable(Integer))
56
+ @updated_at = T.let(nil, T.nilable(String))
57
+ @user_id = T.let(nil, T.nilable(Integer))
58
+ end
59
+
60
+ @has_one = T.let({
61
+ currency: Currency,
62
+ customer: Customer
63
+ }, T::Hash[Symbol, Class])
64
+ @has_many = T.let({
65
+ discount_codes: DiscountCode
66
+ }, T::Hash[Symbol, Class])
67
+ @paths = T.let([
68
+ {http_method: :get, operation: :checkouts, ids: [], path: "checkouts.json"},
69
+ {http_method: :get, operation: :checkouts, ids: [], path: "checkouts.json"}
70
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
71
+
72
+ sig { returns(T.nilable(String)) }
73
+ attr_reader :abandoned_checkout_url
74
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
75
+ attr_reader :billing_address
76
+ sig { returns(T.nilable(T::Boolean)) }
77
+ attr_reader :buyer_accepts_marketing
78
+ sig { returns(T.nilable(T::Boolean)) }
79
+ attr_reader :buyer_accepts_sms_marketing
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :cart_token
82
+ sig { returns(T.nilable(String)) }
83
+ attr_reader :closed_at
84
+ sig { returns(T.nilable(String)) }
85
+ attr_reader :completed_at
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :created_at
88
+ sig { returns(T.nilable(Currency)) }
89
+ attr_reader :currency
90
+ sig { returns(T.nilable(Customer)) }
91
+ attr_reader :customer
92
+ sig { returns(T.nilable(String)) }
93
+ attr_reader :customer_locale
94
+ sig { returns(T.nilable(Integer)) }
95
+ attr_reader :device_id
96
+ sig { returns(T.nilable(T::Array[DiscountCode])) }
97
+ attr_reader :discount_codes
98
+ sig { returns(T.nilable(String)) }
99
+ attr_reader :email
100
+ sig { returns(T.nilable(String)) }
101
+ attr_reader :gateway
102
+ sig { returns(T.nilable(Integer)) }
103
+ attr_reader :id
104
+ sig { returns(T.nilable(String)) }
105
+ attr_reader :landing_site
106
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
107
+ attr_reader :line_items
108
+ sig { returns(T.nilable(Integer)) }
109
+ attr_reader :location_id
110
+ sig { returns(T.nilable(String)) }
111
+ attr_reader :note
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :phone
114
+ sig { returns(T.nilable(String)) }
115
+ attr_reader :presentment_currency
116
+ sig { returns(T.nilable(String)) }
117
+ attr_reader :referring_site
118
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
119
+ attr_reader :shipping_address
120
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
121
+ attr_reader :shipping_lines
122
+ sig { returns(T.nilable(String)) }
123
+ attr_reader :sms_marketing_phone
124
+ sig { returns(T.nilable(String)) }
125
+ attr_reader :source_name
126
+ sig { returns(T.nilable(String)) }
127
+ attr_reader :subtotal_price
128
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
129
+ attr_reader :tax_lines
130
+ sig { returns(T.nilable(T::Boolean)) }
131
+ attr_reader :taxes_included
132
+ sig { returns(T.nilable(String)) }
133
+ attr_reader :token
134
+ sig { returns(T.nilable(String)) }
135
+ attr_reader :total_discounts
136
+ sig { returns(T.nilable(String)) }
137
+ attr_reader :total_duties
138
+ sig { returns(T.nilable(String)) }
139
+ attr_reader :total_line_items_price
140
+ sig { returns(T.nilable(String)) }
141
+ attr_reader :total_price
142
+ sig { returns(T.nilable(String)) }
143
+ attr_reader :total_tax
144
+ sig { returns(T.nilable(Integer)) }
145
+ attr_reader :total_weight
146
+ sig { returns(T.nilable(String)) }
147
+ attr_reader :updated_at
148
+ sig { returns(T.nilable(Integer)) }
149
+ attr_reader :user_id
150
+
151
+ class << self
152
+ sig do
153
+ params(
154
+ since_id: T.untyped,
155
+ created_at_min: T.untyped,
156
+ created_at_max: T.untyped,
157
+ updated_at_min: T.untyped,
158
+ updated_at_max: T.untyped,
159
+ status: T.untyped,
160
+ limit: T.untyped,
161
+ session: Auth::Session,
162
+ kwargs: T.untyped
163
+ ).returns(T.untyped)
164
+ end
165
+ def checkouts(
166
+ since_id: nil,
167
+ created_at_min: nil,
168
+ created_at_max: nil,
169
+ updated_at_min: nil,
170
+ updated_at_max: nil,
171
+ status: nil,
172
+ limit: nil,
173
+ session: ShopifyAPI::Context.active_session,
174
+ **kwargs
175
+ )
176
+ request(
177
+ http_method: :get,
178
+ operation: :checkouts,
179
+ session: session,
180
+ ids: {},
181
+ params: {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, status: status, limit: limit}.merge(kwargs).compact,
182
+ body: {},
183
+ entity: nil,
184
+ )
185
+ end
186
+
187
+ end
188
+
189
+ end
190
+ end