shopify_api 14.1.0 → 14.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (194) hide show
  1. checksums.yaml +4 -4
  2. data/BREAKING_CHANGES_FOR_V15.md +42 -0
  3. data/CHANGELOG.md +36 -1
  4. data/Gemfile.lock +15 -11
  5. data/README.md +3 -0
  6. data/docs/getting_started.md +17 -2
  7. data/docs/usage/custom_apps.md +32 -1
  8. data/docs/usage/oauth.md +88 -16
  9. data/docs/usage/webhooks.md +3 -2
  10. data/lib/shopify_api/admin_versions.rb +3 -1
  11. data/lib/shopify_api/auth/jwt_payload.rb +11 -3
  12. data/lib/shopify_api/auth/session.rb +11 -0
  13. data/lib/shopify_api/clients/graphql/client.rb +14 -3
  14. data/lib/shopify_api/clients/graphql/storefront.rb +12 -2
  15. data/lib/shopify_api/rest/base.rb +7 -1
  16. data/lib/shopify_api/rest/resources/2022_04/customer.rb +1 -0
  17. data/lib/shopify_api/rest/resources/2022_04/recurring_application_charge.rb +9 -0
  18. data/lib/shopify_api/rest/resources/2022_04/shop.rb +14 -4
  19. data/lib/shopify_api/rest/resources/2022_07/customer.rb +1 -0
  20. data/lib/shopify_api/rest/resources/2022_07/recurring_application_charge.rb +9 -0
  21. data/lib/shopify_api/rest/resources/2022_07/shop.rb +14 -4
  22. data/lib/shopify_api/rest/resources/2022_10/customer.rb +1 -0
  23. data/lib/shopify_api/rest/resources/2022_10/recurring_application_charge.rb +9 -0
  24. data/lib/shopify_api/rest/resources/2022_10/shop.rb +14 -4
  25. data/lib/shopify_api/rest/resources/2023_01/customer.rb +1 -0
  26. data/lib/shopify_api/rest/resources/2023_01/recurring_application_charge.rb +9 -0
  27. data/lib/shopify_api/rest/resources/2023_01/shop.rb +14 -4
  28. data/lib/shopify_api/rest/resources/2023_04/customer.rb +1 -0
  29. data/lib/shopify_api/rest/resources/2023_04/recurring_application_charge.rb +9 -0
  30. data/lib/shopify_api/rest/resources/2023_04/shop.rb +14 -4
  31. data/lib/shopify_api/rest/resources/2023_07/customer.rb +1 -0
  32. data/lib/shopify_api/rest/resources/2023_07/recurring_application_charge.rb +9 -0
  33. data/lib/shopify_api/rest/resources/2023_07/shop.rb +14 -4
  34. data/lib/shopify_api/rest/resources/2023_10/customer.rb +1 -0
  35. data/lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb +9 -0
  36. data/lib/shopify_api/rest/resources/2023_10/shop.rb +14 -4
  37. data/lib/shopify_api/rest/resources/2024_01/customer.rb +1 -0
  38. data/lib/shopify_api/rest/resources/2024_01/recurring_application_charge.rb +9 -0
  39. data/lib/shopify_api/rest/resources/2024_01/shop.rb +14 -4
  40. data/lib/shopify_api/rest/resources/2024_04/customer.rb +1 -0
  41. data/lib/shopify_api/rest/resources/2024_04/recurring_application_charge.rb +9 -0
  42. data/lib/shopify_api/rest/resources/2024_04/shop.rb +14 -4
  43. data/lib/shopify_api/rest/resources/2024_07/abandoned_checkout.rb +194 -0
  44. data/lib/shopify_api/rest/resources/2024_07/access_scope.rb +62 -0
  45. data/lib/shopify_api/rest/resources/2024_07/apple_pay_certificate.rb +109 -0
  46. data/lib/shopify_api/rest/resources/2024_07/application_charge.rb +113 -0
  47. data/lib/shopify_api/rest/resources/2024_07/application_credit.rb +95 -0
  48. data/lib/shopify_api/rest/resources/2024_07/article.rb +269 -0
  49. data/lib/shopify_api/rest/resources/2024_07/asset.rb +122 -0
  50. data/lib/shopify_api/rest/resources/2024_07/assigned_fulfillment_order.rb +92 -0
  51. data/lib/shopify_api/rest/resources/2024_07/balance.rb +58 -0
  52. data/lib/shopify_api/rest/resources/2024_07/blog.rb +166 -0
  53. data/lib/shopify_api/rest/resources/2024_07/cancellation_request.rb +87 -0
  54. data/lib/shopify_api/rest/resources/2024_07/carrier_service.rb +120 -0
  55. data/lib/shopify_api/rest/resources/2024_07/checkout.rb +213 -0
  56. data/lib/shopify_api/rest/resources/2024_07/collect.rb +146 -0
  57. data/lib/shopify_api/rest/resources/2024_07/collection.rb +114 -0
  58. data/lib/shopify_api/rest/resources/2024_07/collection_listing.rb +159 -0
  59. data/lib/shopify_api/rest/resources/2024_07/comment.rb +287 -0
  60. data/lib/shopify_api/rest/resources/2024_07/country.rb +141 -0
  61. data/lib/shopify_api/rest/resources/2024_07/currency.rb +61 -0
  62. data/lib/shopify_api/rest/resources/2024_07/custom_collection.rb +191 -0
  63. data/lib/shopify_api/rest/resources/2024_07/customer.rb +335 -0
  64. data/lib/shopify_api/rest/resources/2024_07/customer_address.rb +215 -0
  65. data/lib/shopify_api/rest/resources/2024_07/deprecated_api_call.rb +61 -0
  66. data/lib/shopify_api/rest/resources/2024_07/discount_code.rb +226 -0
  67. data/lib/shopify_api/rest/resources/2024_07/dispute.rb +115 -0
  68. data/lib/shopify_api/rest/resources/2024_07/dispute_evidence.rb +121 -0
  69. data/lib/shopify_api/rest/resources/2024_07/dispute_file_upload.rb +85 -0
  70. data/lib/shopify_api/rest/resources/2024_07/draft_order.rb +279 -0
  71. data/lib/shopify_api/rest/resources/2024_07/event.rb +152 -0
  72. data/lib/shopify_api/rest/resources/2024_07/fulfillment.rb +235 -0
  73. data/lib/shopify_api/rest/resources/2024_07/fulfillment_event.rb +167 -0
  74. data/lib/shopify_api/rest/resources/2024_07/fulfillment_order.rb +326 -0
  75. data/lib/shopify_api/rest/resources/2024_07/fulfillment_request.rb +101 -0
  76. data/lib/shopify_api/rest/resources/2024_07/fulfillment_service.rb +134 -0
  77. data/lib/shopify_api/rest/resources/2024_07/gift_card.rb +222 -0
  78. data/lib/shopify_api/rest/resources/2024_07/gift_card_adjustment.rb +122 -0
  79. data/lib/shopify_api/rest/resources/2024_07/image.rb +161 -0
  80. data/lib/shopify_api/rest/resources/2024_07/inventory_item.rb +112 -0
  81. data/lib/shopify_api/rest/resources/2024_07/inventory_level.rb +183 -0
  82. data/lib/shopify_api/rest/resources/2024_07/location.rb +171 -0
  83. data/lib/shopify_api/rest/resources/2024_07/locations_for_move.rb +60 -0
  84. data/lib/shopify_api/rest/resources/2024_07/marketing_event.rb +213 -0
  85. data/lib/shopify_api/rest/resources/2024_07/metafield.rb +348 -0
  86. data/lib/shopify_api/rest/resources/2024_07/mobile_platform_application.rb +114 -0
  87. data/lib/shopify_api/rest/resources/2024_07/order.rb +489 -0
  88. data/lib/shopify_api/rest/resources/2024_07/order_risk.rb +148 -0
  89. data/lib/shopify_api/rest/resources/2024_07/page.rb +198 -0
  90. data/lib/shopify_api/rest/resources/2024_07/payment.rb +144 -0
  91. data/lib/shopify_api/rest/resources/2024_07/payment_gateway.rb +147 -0
  92. data/lib/shopify_api/rest/resources/2024_07/payment_transaction.rb +114 -0
  93. data/lib/shopify_api/rest/resources/2024_07/payout.rb +101 -0
  94. data/lib/shopify_api/rest/resources/2024_07/policy.rb +73 -0
  95. data/lib/shopify_api/rest/resources/2024_07/price_rule.rb +227 -0
  96. data/lib/shopify_api/rest/resources/2024_07/product.rb +227 -0
  97. data/lib/shopify_api/rest/resources/2024_07/product_listing.rb +200 -0
  98. data/lib/shopify_api/rest/resources/2024_07/product_resource_feedback.rb +92 -0
  99. data/lib/shopify_api/rest/resources/2024_07/province.rb +136 -0
  100. data/lib/shopify_api/rest/resources/2024_07/recurring_application_charge.rb +184 -0
  101. data/lib/shopify_api/rest/resources/2024_07/redirect.rb +143 -0
  102. data/lib/shopify_api/rest/resources/2024_07/refund.rb +155 -0
  103. data/lib/shopify_api/rest/resources/2024_07/resource_feedback.rb +77 -0
  104. data/lib/shopify_api/rest/resources/2024_07/script_tag.rb +159 -0
  105. data/lib/shopify_api/rest/resources/2024_07/shipping_zone.rb +87 -0
  106. data/lib/shopify_api/rest/resources/2024_07/shop.rb +232 -0
  107. data/lib/shopify_api/rest/resources/2024_07/smart_collection.rb +220 -0
  108. data/lib/shopify_api/rest/resources/2024_07/storefront_access_token.rb +91 -0
  109. data/lib/shopify_api/rest/resources/2024_07/tender_transaction.rb +97 -0
  110. data/lib/shopify_api/rest/resources/2024_07/theme.rb +127 -0
  111. data/lib/shopify_api/rest/resources/2024_07/transaction.rb +188 -0
  112. data/lib/shopify_api/rest/resources/2024_07/usage_charge.rb +106 -0
  113. data/lib/shopify_api/rest/resources/2024_07/user.rb +142 -0
  114. data/lib/shopify_api/rest/resources/2024_07/variant.rb +212 -0
  115. data/lib/shopify_api/rest/resources/2024_07/webhook.rb +172 -0
  116. data/lib/shopify_api/rest/resources/2024_10/abandoned_checkout.rb +194 -0
  117. data/lib/shopify_api/rest/resources/2024_10/access_scope.rb +62 -0
  118. data/lib/shopify_api/rest/resources/2024_10/apple_pay_certificate.rb +109 -0
  119. data/lib/shopify_api/rest/resources/2024_10/application_charge.rb +113 -0
  120. data/lib/shopify_api/rest/resources/2024_10/application_credit.rb +95 -0
  121. data/lib/shopify_api/rest/resources/2024_10/article.rb +269 -0
  122. data/lib/shopify_api/rest/resources/2024_10/asset.rb +122 -0
  123. data/lib/shopify_api/rest/resources/2024_10/assigned_fulfillment_order.rb +92 -0
  124. data/lib/shopify_api/rest/resources/2024_10/balance.rb +58 -0
  125. data/lib/shopify_api/rest/resources/2024_10/blog.rb +166 -0
  126. data/lib/shopify_api/rest/resources/2024_10/cancellation_request.rb +87 -0
  127. data/lib/shopify_api/rest/resources/2024_10/carrier_service.rb +120 -0
  128. data/lib/shopify_api/rest/resources/2024_10/checkout.rb +213 -0
  129. data/lib/shopify_api/rest/resources/2024_10/collect.rb +146 -0
  130. data/lib/shopify_api/rest/resources/2024_10/collection.rb +114 -0
  131. data/lib/shopify_api/rest/resources/2024_10/collection_listing.rb +159 -0
  132. data/lib/shopify_api/rest/resources/2024_10/comment.rb +287 -0
  133. data/lib/shopify_api/rest/resources/2024_10/country.rb +141 -0
  134. data/lib/shopify_api/rest/resources/2024_10/currency.rb +61 -0
  135. data/lib/shopify_api/rest/resources/2024_10/custom_collection.rb +191 -0
  136. data/lib/shopify_api/rest/resources/2024_10/customer.rb +335 -0
  137. data/lib/shopify_api/rest/resources/2024_10/customer_address.rb +215 -0
  138. data/lib/shopify_api/rest/resources/2024_10/deprecated_api_call.rb +61 -0
  139. data/lib/shopify_api/rest/resources/2024_10/discount_code.rb +226 -0
  140. data/lib/shopify_api/rest/resources/2024_10/dispute.rb +115 -0
  141. data/lib/shopify_api/rest/resources/2024_10/dispute_evidence.rb +121 -0
  142. data/lib/shopify_api/rest/resources/2024_10/dispute_file_upload.rb +85 -0
  143. data/lib/shopify_api/rest/resources/2024_10/draft_order.rb +279 -0
  144. data/lib/shopify_api/rest/resources/2024_10/event.rb +152 -0
  145. data/lib/shopify_api/rest/resources/2024_10/fulfillment.rb +235 -0
  146. data/lib/shopify_api/rest/resources/2024_10/fulfillment_event.rb +167 -0
  147. data/lib/shopify_api/rest/resources/2024_10/fulfillment_order.rb +326 -0
  148. data/lib/shopify_api/rest/resources/2024_10/fulfillment_request.rb +101 -0
  149. data/lib/shopify_api/rest/resources/2024_10/fulfillment_service.rb +134 -0
  150. data/lib/shopify_api/rest/resources/2024_10/gift_card.rb +222 -0
  151. data/lib/shopify_api/rest/resources/2024_10/gift_card_adjustment.rb +122 -0
  152. data/lib/shopify_api/rest/resources/2024_10/image.rb +161 -0
  153. data/lib/shopify_api/rest/resources/2024_10/inventory_item.rb +112 -0
  154. data/lib/shopify_api/rest/resources/2024_10/inventory_level.rb +183 -0
  155. data/lib/shopify_api/rest/resources/2024_10/location.rb +171 -0
  156. data/lib/shopify_api/rest/resources/2024_10/locations_for_move.rb +60 -0
  157. data/lib/shopify_api/rest/resources/2024_10/marketing_event.rb +213 -0
  158. data/lib/shopify_api/rest/resources/2024_10/metafield.rb +348 -0
  159. data/lib/shopify_api/rest/resources/2024_10/mobile_platform_application.rb +114 -0
  160. data/lib/shopify_api/rest/resources/2024_10/order.rb +490 -0
  161. data/lib/shopify_api/rest/resources/2024_10/order_risk.rb +148 -0
  162. data/lib/shopify_api/rest/resources/2024_10/page.rb +198 -0
  163. data/lib/shopify_api/rest/resources/2024_10/payment.rb +144 -0
  164. data/lib/shopify_api/rest/resources/2024_10/payment_gateway.rb +147 -0
  165. data/lib/shopify_api/rest/resources/2024_10/payment_transaction.rb +114 -0
  166. data/lib/shopify_api/rest/resources/2024_10/payout.rb +101 -0
  167. data/lib/shopify_api/rest/resources/2024_10/policy.rb +73 -0
  168. data/lib/shopify_api/rest/resources/2024_10/price_rule.rb +227 -0
  169. data/lib/shopify_api/rest/resources/2024_10/product.rb +227 -0
  170. data/lib/shopify_api/rest/resources/2024_10/product_listing.rb +200 -0
  171. data/lib/shopify_api/rest/resources/2024_10/product_resource_feedback.rb +92 -0
  172. data/lib/shopify_api/rest/resources/2024_10/province.rb +136 -0
  173. data/lib/shopify_api/rest/resources/2024_10/recurring_application_charge.rb +184 -0
  174. data/lib/shopify_api/rest/resources/2024_10/redirect.rb +143 -0
  175. data/lib/shopify_api/rest/resources/2024_10/refund.rb +155 -0
  176. data/lib/shopify_api/rest/resources/2024_10/resource_feedback.rb +77 -0
  177. data/lib/shopify_api/rest/resources/2024_10/script_tag.rb +159 -0
  178. data/lib/shopify_api/rest/resources/2024_10/shipping_zone.rb +87 -0
  179. data/lib/shopify_api/rest/resources/2024_10/shop.rb +232 -0
  180. data/lib/shopify_api/rest/resources/2024_10/smart_collection.rb +220 -0
  181. data/lib/shopify_api/rest/resources/2024_10/storefront_access_token.rb +91 -0
  182. data/lib/shopify_api/rest/resources/2024_10/tender_transaction.rb +97 -0
  183. data/lib/shopify_api/rest/resources/2024_10/theme.rb +127 -0
  184. data/lib/shopify_api/rest/resources/2024_10/transaction.rb +189 -0
  185. data/lib/shopify_api/rest/resources/2024_10/usage_charge.rb +106 -0
  186. data/lib/shopify_api/rest/resources/2024_10/user.rb +142 -0
  187. data/lib/shopify_api/rest/resources/2024_10/variant.rb +212 -0
  188. data/lib/shopify_api/rest/resources/2024_10/webhook.rb +172 -0
  189. data/lib/shopify_api/utils/attributes_comparator.rb +21 -4
  190. data/lib/shopify_api/utils/session_utils.rb +24 -17
  191. data/lib/shopify_api/version.rb +1 -1
  192. data/lib/shopify_api/webhooks/registry.rb +5 -4
  193. data/sorbet/rbi/shims/hash.rb +3 -0
  194. metadata +154 -6
@@ -0,0 +1,212 @@
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 Variant < 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
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @barcode = T.let(nil, T.nilable(String))
22
+ @compare_at_price = T.let(nil, T.nilable(String))
23
+ @created_at = T.let(nil, T.nilable(String))
24
+ @fulfillment_service = T.let(nil, T.nilable(String))
25
+ @grams = T.let(nil, T.nilable(Integer))
26
+ @id = T.let(nil, T.nilable(Integer))
27
+ @image_id = T.let(nil, T.nilable(Integer))
28
+ @inventory_item_id = T.let(nil, T.nilable(Integer))
29
+ @inventory_management = T.let(nil, T.nilable(String))
30
+ @inventory_policy = T.let(nil, T.nilable(String))
31
+ @inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
32
+ @old_inventory_quantity = T.let(nil, T.nilable(T.any(Integer, String)))
33
+ @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
34
+ @position = T.let(nil, T.nilable(Integer))
35
+ @presentment_prices = T.let(nil, T.nilable(T::Array[T.untyped]))
36
+ @price = T.let(nil, T.nilable(String))
37
+ @product_id = T.let(nil, T.nilable(Integer))
38
+ @requires_shipping = T.let(nil, T.nilable(T::Boolean))
39
+ @sku = T.let(nil, T.nilable(String))
40
+ @tax_code = T.let(nil, T.nilable(String))
41
+ @taxable = T.let(nil, T.nilable(T::Boolean))
42
+ @title = T.let(nil, T.nilable(String))
43
+ @updated_at = T.let(nil, T.nilable(String))
44
+ @weight = T.let(nil, T.nilable(Float))
45
+ @weight_unit = T.let(nil, T.nilable(String))
46
+
47
+ super(session: session, from_hash: from_hash)
48
+ end
49
+
50
+ @has_one = T.let({}, T::Hash[Symbol, Class])
51
+ @has_many = T.let({}, T::Hash[Symbol, Class])
52
+ @paths = T.let([
53
+ {http_method: :delete, operation: :delete, ids: [:product_id, :id], path: "products/<product_id>/variants/<id>.json"},
54
+ {http_method: :get, operation: :count, ids: [:product_id], path: "products/<product_id>/variants/count.json"},
55
+ {http_method: :get, operation: :get, ids: [:product_id], path: "products/<product_id>/variants.json"},
56
+ {http_method: :get, operation: :get, ids: [:id], path: "variants/<id>.json"},
57
+ {http_method: :post, operation: :post, ids: [:product_id], path: "products/<product_id>/variants.json"},
58
+ {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
59
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
60
+ @read_only_attributes = T.let([
61
+ :inventory_quantity
62
+ ], T::Array[Symbol])
63
+
64
+ sig { returns(T.nilable(String)) }
65
+ attr_reader :barcode
66
+ sig { returns(T.nilable(String)) }
67
+ attr_reader :compare_at_price
68
+ sig { returns(T.nilable(String)) }
69
+ attr_reader :created_at
70
+ sig { returns(T.nilable(String)) }
71
+ attr_reader :fulfillment_service
72
+ sig { returns(T.nilable(Integer)) }
73
+ attr_reader :grams
74
+ sig { returns(T.nilable(Integer)) }
75
+ attr_reader :id
76
+ sig { returns(T.nilable(Integer)) }
77
+ attr_reader :image_id
78
+ sig { returns(T.nilable(Integer)) }
79
+ attr_reader :inventory_item_id
80
+ sig { returns(T.nilable(String)) }
81
+ attr_reader :inventory_management
82
+ sig { returns(T.nilable(String)) }
83
+ attr_reader :inventory_policy
84
+ sig { returns(T.nilable(T.any(Integer, String))) }
85
+ attr_reader :inventory_quantity
86
+ sig { returns(T.nilable(T.any(Integer, String))) }
87
+ attr_reader :old_inventory_quantity
88
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
89
+ attr_reader :option
90
+ sig { returns(T.nilable(Integer)) }
91
+ attr_reader :position
92
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
93
+ attr_reader :presentment_prices
94
+ sig { returns(T.nilable(String)) }
95
+ attr_reader :price
96
+ sig { returns(T.nilable(Integer)) }
97
+ attr_reader :product_id
98
+ sig { returns(T.nilable(T::Boolean)) }
99
+ attr_reader :requires_shipping
100
+ sig { returns(T.nilable(String)) }
101
+ attr_reader :sku
102
+ sig { returns(T.nilable(String)) }
103
+ attr_reader :tax_code
104
+ sig { returns(T.nilable(T::Boolean)) }
105
+ attr_reader :taxable
106
+ sig { returns(T.nilable(String)) }
107
+ attr_reader :title
108
+ sig { returns(T.nilable(String)) }
109
+ attr_reader :updated_at
110
+ sig { returns(T.nilable(Float)) }
111
+ attr_reader :weight
112
+ sig { returns(T.nilable(String)) }
113
+ attr_reader :weight_unit
114
+
115
+ class << self
116
+ sig do
117
+ params(
118
+ id: T.any(Integer, String),
119
+ fields: T.untyped,
120
+ session: Auth::Session
121
+ ).returns(T.nilable(Variant))
122
+ end
123
+ def find(
124
+ id:,
125
+ fields: nil,
126
+ session: ShopifyAPI::Context.active_session
127
+ )
128
+ result = base_find(
129
+ session: session,
130
+ ids: {id: id},
131
+ params: {fields: fields},
132
+ )
133
+ T.cast(result[0], T.nilable(Variant))
134
+ end
135
+
136
+ sig do
137
+ params(
138
+ id: T.any(Integer, String),
139
+ product_id: T.nilable(T.any(Integer, String)),
140
+ session: Auth::Session
141
+ ).returns(T.untyped)
142
+ end
143
+ def delete(
144
+ id:,
145
+ product_id: nil,
146
+ session: ShopifyAPI::Context.active_session
147
+ )
148
+ request(
149
+ http_method: :delete,
150
+ operation: :delete,
151
+ session: session,
152
+ ids: {id: id, product_id: product_id},
153
+ params: {},
154
+ )
155
+ end
156
+
157
+ sig do
158
+ params(
159
+ product_id: T.nilable(T.any(Integer, String)),
160
+ limit: T.untyped,
161
+ presentment_currencies: T.untyped,
162
+ since_id: T.untyped,
163
+ fields: T.untyped,
164
+ session: Auth::Session,
165
+ kwargs: T.untyped
166
+ ).returns(T::Array[Variant])
167
+ end
168
+ def all(
169
+ product_id: nil,
170
+ limit: nil,
171
+ presentment_currencies: nil,
172
+ since_id: nil,
173
+ fields: nil,
174
+ session: ShopifyAPI::Context.active_session,
175
+ **kwargs
176
+ )
177
+ response = base_find(
178
+ session: session,
179
+ ids: {product_id: product_id},
180
+ params: {limit: limit, presentment_currencies: presentment_currencies, since_id: since_id, fields: fields}.merge(kwargs).compact,
181
+ )
182
+
183
+ T.cast(response, T::Array[Variant])
184
+ end
185
+
186
+ sig do
187
+ params(
188
+ product_id: T.nilable(T.any(Integer, String)),
189
+ session: Auth::Session,
190
+ kwargs: T.untyped
191
+ ).returns(T.untyped)
192
+ end
193
+ def count(
194
+ product_id: nil,
195
+ session: ShopifyAPI::Context.active_session,
196
+ **kwargs
197
+ )
198
+ request(
199
+ http_method: :get,
200
+ operation: :count,
201
+ session: session,
202
+ ids: {product_id: product_id},
203
+ params: {}.merge(kwargs).compact,
204
+ body: {},
205
+ entity: nil,
206
+ )
207
+ end
208
+
209
+ end
210
+
211
+ end
212
+ end
@@ -0,0 +1,172 @@
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 Webhook < 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
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @address = T.let(nil, T.nilable(String))
22
+ @topic = T.let(nil, T.nilable(String))
23
+ @api_version = T.let(nil, T.nilable(String))
24
+ @created_at = T.let(nil, T.nilable(String))
25
+ @fields = T.let(nil, T.nilable(T::Array[T.untyped]))
26
+ @format = T.let(nil, T.nilable(String))
27
+ @id = T.let(nil, T.nilable(Integer))
28
+ @metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))
29
+ @private_metafield_namespaces = T.let(nil, T.nilable(T::Array[T.untyped]))
30
+ @updated_at = T.let(nil, T.nilable(String))
31
+
32
+ super(session: session, from_hash: from_hash)
33
+ end
34
+
35
+ @has_one = T.let({}, T::Hash[Symbol, Class])
36
+ @has_many = T.let({}, T::Hash[Symbol, Class])
37
+ @paths = T.let([
38
+ {http_method: :delete, operation: :delete, ids: [:id], path: "webhooks/<id>.json"},
39
+ {http_method: :get, operation: :count, ids: [], path: "webhooks/count.json"},
40
+ {http_method: :get, operation: :get, ids: [], path: "webhooks.json"},
41
+ {http_method: :get, operation: :get, ids: [:id], path: "webhooks/<id>.json"},
42
+ {http_method: :post, operation: :post, ids: [], path: "webhooks.json"},
43
+ {http_method: :put, operation: :put, ids: [:id], path: "webhooks/<id>.json"}
44
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
45
+
46
+ sig { returns(T.nilable(String)) }
47
+ attr_reader :address
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :topic
50
+ sig { returns(T.nilable(String)) }
51
+ attr_reader :api_version
52
+ sig { returns(T.nilable(String)) }
53
+ attr_reader :created_at
54
+ sig { returns(T.nilable(T::Array[String])) }
55
+ attr_reader :fields
56
+ sig { returns(T.nilable(String)) }
57
+ attr_reader :format
58
+ sig { returns(T.nilable(Integer)) }
59
+ attr_reader :id
60
+ sig { returns(T.nilable(T::Array[String])) }
61
+ attr_reader :metafield_namespaces
62
+ sig { returns(T.nilable(T::Array[String])) }
63
+ attr_reader :private_metafield_namespaces
64
+ sig { returns(T.nilable(String)) }
65
+ attr_reader :updated_at
66
+
67
+ class << self
68
+ sig do
69
+ params(
70
+ id: T.any(Integer, String),
71
+ fields: T.untyped,
72
+ session: Auth::Session
73
+ ).returns(T.nilable(Webhook))
74
+ end
75
+ def find(
76
+ id:,
77
+ fields: nil,
78
+ session: ShopifyAPI::Context.active_session
79
+ )
80
+ result = base_find(
81
+ session: session,
82
+ ids: {id: id},
83
+ params: {fields: fields},
84
+ )
85
+ T.cast(result[0], T.nilable(Webhook))
86
+ end
87
+
88
+ sig do
89
+ params(
90
+ id: T.any(Integer, String),
91
+ session: Auth::Session
92
+ ).returns(T.untyped)
93
+ end
94
+ def delete(
95
+ id:,
96
+ session: ShopifyAPI::Context.active_session
97
+ )
98
+ request(
99
+ http_method: :delete,
100
+ operation: :delete,
101
+ session: session,
102
+ ids: {id: id},
103
+ params: {},
104
+ )
105
+ end
106
+
107
+ sig do
108
+ params(
109
+ address: T.untyped,
110
+ created_at_max: T.untyped,
111
+ created_at_min: T.untyped,
112
+ fields: T.untyped,
113
+ limit: T.untyped,
114
+ since_id: T.untyped,
115
+ topic: T.untyped,
116
+ updated_at_min: T.untyped,
117
+ updated_at_max: T.untyped,
118
+ session: Auth::Session,
119
+ kwargs: T.untyped
120
+ ).returns(T::Array[Webhook])
121
+ end
122
+ def all(
123
+ address: nil,
124
+ created_at_max: nil,
125
+ created_at_min: nil,
126
+ fields: nil,
127
+ limit: nil,
128
+ since_id: nil,
129
+ topic: nil,
130
+ updated_at_min: nil,
131
+ updated_at_max: nil,
132
+ session: ShopifyAPI::Context.active_session,
133
+ **kwargs
134
+ )
135
+ response = base_find(
136
+ session: session,
137
+ ids: {},
138
+ params: {address: address, created_at_max: created_at_max, created_at_min: created_at_min, fields: fields, limit: limit, since_id: since_id, topic: topic, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact,
139
+ )
140
+
141
+ T.cast(response, T::Array[Webhook])
142
+ end
143
+
144
+ sig do
145
+ params(
146
+ address: T.untyped,
147
+ topic: T.untyped,
148
+ session: Auth::Session,
149
+ kwargs: T.untyped
150
+ ).returns(T.untyped)
151
+ end
152
+ def count(
153
+ address: nil,
154
+ topic: nil,
155
+ session: ShopifyAPI::Context.active_session,
156
+ **kwargs
157
+ )
158
+ request(
159
+ http_method: :get,
160
+ operation: :count,
161
+ session: session,
162
+ ids: {},
163
+ params: {address: address, topic: topic}.merge(kwargs).compact,
164
+ body: {},
165
+ entity: nil,
166
+ )
167
+ end
168
+
169
+ end
170
+
171
+ end
172
+ end
@@ -0,0 +1,194 @@
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
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @abandoned_checkout_url = T.let(nil, T.nilable(String))
22
+ @billing_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
23
+ @buyer_accepts_marketing = T.let(nil, T.nilable(T::Boolean))
24
+ @buyer_accepts_sms_marketing = T.let(nil, T.nilable(T::Boolean))
25
+ @cart_token = T.let(nil, T.nilable(String))
26
+ @closed_at = T.let(nil, T.nilable(String))
27
+ @completed_at = T.let(nil, T.nilable(String))
28
+ @created_at = T.let(nil, T.nilable(String))
29
+ @currency = T.let(nil, T.nilable(Currency))
30
+ @customer = T.let(nil, T.nilable(Customer))
31
+ @customer_locale = T.let(nil, T.nilable(String))
32
+ @device_id = T.let(nil, T.nilable(Integer))
33
+ @discount_codes = T.let(nil, T.nilable(T::Array[T.untyped]))
34
+ @email = T.let(nil, T.nilable(String))
35
+ @gateway = T.let(nil, T.nilable(String))
36
+ @id = T.let(nil, T.nilable(Integer))
37
+ @landing_site = T.let(nil, T.nilable(String))
38
+ @line_items = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
39
+ @location_id = T.let(nil, T.nilable(Integer))
40
+ @note = T.let(nil, T.nilable(String))
41
+ @phone = T.let(nil, T.nilable(String))
42
+ @presentment_currency = T.let(nil, T.nilable(String))
43
+ @referring_site = T.let(nil, T.nilable(String))
44
+ @shipping_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
45
+ @shipping_lines = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
46
+ @sms_marketing_phone = T.let(nil, T.nilable(String))
47
+ @source_name = T.let(nil, T.nilable(String))
48
+ @subtotal_price = T.let(nil, T.nilable(String))
49
+ @tax_lines = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
50
+ @taxes_included = T.let(nil, T.nilable(T::Boolean))
51
+ @token = T.let(nil, T.nilable(String))
52
+ @total_discounts = T.let(nil, T.nilable(String))
53
+ @total_duties = T.let(nil, T.nilable(String))
54
+ @total_line_items_price = T.let(nil, T.nilable(String))
55
+ @total_price = T.let(nil, T.nilable(String))
56
+ @total_tax = T.let(nil, T.nilable(String))
57
+ @total_weight = T.let(nil, T.nilable(Integer))
58
+ @updated_at = T.let(nil, T.nilable(String))
59
+ @user_id = T.let(nil, T.nilable(Integer))
60
+
61
+ super(session: session, from_hash: from_hash)
62
+ end
63
+
64
+ @has_one = T.let({
65
+ currency: Currency,
66
+ customer: Customer
67
+ }, T::Hash[Symbol, Class])
68
+ @has_many = T.let({
69
+ discount_codes: DiscountCode
70
+ }, T::Hash[Symbol, Class])
71
+ @paths = T.let([
72
+ {http_method: :get, operation: :checkouts, ids: [], path: "checkouts.json"},
73
+ {http_method: :get, operation: :checkouts, ids: [], path: "checkouts.json"}
74
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
75
+
76
+ sig { returns(T.nilable(String)) }
77
+ attr_reader :abandoned_checkout_url
78
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
79
+ attr_reader :billing_address
80
+ sig { returns(T.nilable(T::Boolean)) }
81
+ attr_reader :buyer_accepts_marketing
82
+ sig { returns(T.nilable(T::Boolean)) }
83
+ attr_reader :buyer_accepts_sms_marketing
84
+ sig { returns(T.nilable(String)) }
85
+ attr_reader :cart_token
86
+ sig { returns(T.nilable(String)) }
87
+ attr_reader :closed_at
88
+ sig { returns(T.nilable(String)) }
89
+ attr_reader :completed_at
90
+ sig { returns(T.nilable(String)) }
91
+ attr_reader :created_at
92
+ sig { returns(T.nilable(Currency)) }
93
+ attr_reader :currency
94
+ sig { returns(T.nilable(Customer)) }
95
+ attr_reader :customer
96
+ sig { returns(T.nilable(String)) }
97
+ attr_reader :customer_locale
98
+ sig { returns(T.nilable(Integer)) }
99
+ attr_reader :device_id
100
+ sig { returns(T.nilable(T::Array[DiscountCode])) }
101
+ attr_reader :discount_codes
102
+ sig { returns(T.nilable(String)) }
103
+ attr_reader :email
104
+ sig { returns(T.nilable(String)) }
105
+ attr_reader :gateway
106
+ sig { returns(T.nilable(Integer)) }
107
+ attr_reader :id
108
+ sig { returns(T.nilable(String)) }
109
+ attr_reader :landing_site
110
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
111
+ attr_reader :line_items
112
+ sig { returns(T.nilable(Integer)) }
113
+ attr_reader :location_id
114
+ sig { returns(T.nilable(String)) }
115
+ attr_reader :note
116
+ sig { returns(T.nilable(String)) }
117
+ attr_reader :phone
118
+ sig { returns(T.nilable(String)) }
119
+ attr_reader :presentment_currency
120
+ sig { returns(T.nilable(String)) }
121
+ attr_reader :referring_site
122
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
123
+ attr_reader :shipping_address
124
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
125
+ attr_reader :shipping_lines
126
+ sig { returns(T.nilable(String)) }
127
+ attr_reader :sms_marketing_phone
128
+ sig { returns(T.nilable(String)) }
129
+ attr_reader :source_name
130
+ sig { returns(T.nilable(String)) }
131
+ attr_reader :subtotal_price
132
+ sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
133
+ attr_reader :tax_lines
134
+ sig { returns(T.nilable(T::Boolean)) }
135
+ attr_reader :taxes_included
136
+ sig { returns(T.nilable(String)) }
137
+ attr_reader :token
138
+ sig { returns(T.nilable(String)) }
139
+ attr_reader :total_discounts
140
+ sig { returns(T.nilable(String)) }
141
+ attr_reader :total_duties
142
+ sig { returns(T.nilable(String)) }
143
+ attr_reader :total_line_items_price
144
+ sig { returns(T.nilable(String)) }
145
+ attr_reader :total_price
146
+ sig { returns(T.nilable(String)) }
147
+ attr_reader :total_tax
148
+ sig { returns(T.nilable(Integer)) }
149
+ attr_reader :total_weight
150
+ sig { returns(T.nilable(String)) }
151
+ attr_reader :updated_at
152
+ sig { returns(T.nilable(Integer)) }
153
+ attr_reader :user_id
154
+
155
+ class << self
156
+ sig do
157
+ params(
158
+ since_id: T.untyped,
159
+ created_at_min: T.untyped,
160
+ created_at_max: T.untyped,
161
+ updated_at_min: T.untyped,
162
+ updated_at_max: T.untyped,
163
+ status: T.untyped,
164
+ limit: T.untyped,
165
+ session: Auth::Session,
166
+ kwargs: T.untyped
167
+ ).returns(T.untyped)
168
+ end
169
+ def checkouts(
170
+ since_id: nil,
171
+ created_at_min: nil,
172
+ created_at_max: nil,
173
+ updated_at_min: nil,
174
+ updated_at_max: nil,
175
+ status: nil,
176
+ limit: nil,
177
+ session: ShopifyAPI::Context.active_session,
178
+ **kwargs
179
+ )
180
+ request(
181
+ http_method: :get,
182
+ operation: :checkouts,
183
+ session: session,
184
+ ids: {},
185
+ 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,
186
+ body: {},
187
+ entity: nil,
188
+ )
189
+ end
190
+
191
+ end
192
+
193
+ end
194
+ end
@@ -0,0 +1,62 @@
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 AccessScope < 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
+ @api_call_limit = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
16
+ @retry_request_after = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
17
+
18
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session), from_hash: T.nilable(T::Hash[T.untyped, T.untyped])).void }
19
+ def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)
20
+
21
+ @handle = T.let(nil, T.nilable(String))
22
+ @access_scopes = T.let(nil, T.nilable(T::Array[T.untyped]))
23
+
24
+ super(session: session, from_hash: from_hash)
25
+ end
26
+
27
+ @has_one = T.let({}, T::Hash[Symbol, Class])
28
+ @has_many = T.let({}, T::Hash[Symbol, Class])
29
+ @custom_prefix = T.let("/admin/oauth", T.nilable(String))
30
+ @paths = T.let([
31
+ {http_method: :get, operation: :get, ids: [], path: "access_scopes.json"}
32
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
33
+
34
+ sig { returns(T.nilable(String)) }
35
+ attr_reader :handle
36
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
37
+ attr_reader :access_scopes
38
+
39
+ class << self
40
+ sig do
41
+ params(
42
+ session: Auth::Session,
43
+ kwargs: T.untyped
44
+ ).returns(T::Array[AccessScope])
45
+ end
46
+ def all(
47
+ session: ShopifyAPI::Context.active_session,
48
+ **kwargs
49
+ )
50
+ response = base_find(
51
+ session: session,
52
+ ids: {},
53
+ params: {}.merge(kwargs).compact,
54
+ )
55
+
56
+ T.cast(response, T::Array[AccessScope])
57
+ end
58
+
59
+ end
60
+
61
+ end
62
+ end