shopify_api 14.11.1 → 15.0.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.
- checksums.yaml +4 -4
- data/.github/workflows/api_update_reminder.yml +2 -2
- data/.github/workflows/api_update_reminder_on_release.yml +2 -2
- data/.github/workflows/build.yml +2 -2
- data/.github/workflows/close-waiting-for-response-issues.yml +1 -1
- data/.github/workflows/remove-labels-on-activity.yml +1 -1
- data/BREAKING_CHANGES_FOR_V15.md +98 -3
- data/CHANGELOG.md +9 -0
- data/Gemfile.lock +1 -1
- data/RELEASING.md +108 -17
- data/REST_RESOURCES.md +161 -0
- data/docs/usage/webhooks.md +0 -17
- data/lib/shopify_api/admin_versions.rb +1 -5
- data/lib/shopify_api/clients/graphql/storefront.rb +5 -11
- data/lib/shopify_api/context.rb +4 -4
- data/lib/shopify_api/rest/resources/2025_10/abandoned_checkout.rb +194 -0
- data/lib/shopify_api/rest/resources/2025_10/access_scope.rb +62 -0
- data/lib/shopify_api/rest/resources/2025_10/apple_pay_certificate.rb +109 -0
- data/lib/shopify_api/rest/resources/2025_10/application_charge.rb +113 -0
- data/lib/shopify_api/rest/resources/2025_10/application_credit.rb +95 -0
- data/lib/shopify_api/rest/resources/2025_10/article.rb +269 -0
- data/lib/shopify_api/rest/resources/2025_10/asset.rb +122 -0
- data/lib/shopify_api/rest/resources/2025_10/assigned_fulfillment_order.rb +92 -0
- data/lib/shopify_api/rest/resources/2025_10/balance.rb +58 -0
- data/lib/shopify_api/rest/resources/2025_10/blog.rb +166 -0
- data/lib/shopify_api/rest/resources/2025_10/cancellation_request.rb +87 -0
- data/lib/shopify_api/rest/resources/2025_10/carrier_service.rb +120 -0
- data/lib/shopify_api/rest/resources/2025_10/checkout.rb +213 -0
- data/lib/shopify_api/rest/resources/2025_10/collect.rb +146 -0
- data/lib/shopify_api/rest/resources/2025_10/collection.rb +114 -0
- data/lib/shopify_api/rest/resources/2025_10/collection_listing.rb +159 -0
- data/lib/shopify_api/rest/resources/2025_10/comment.rb +287 -0
- data/lib/shopify_api/rest/resources/2025_10/country.rb +141 -0
- data/lib/shopify_api/rest/resources/2025_10/currency.rb +61 -0
- data/lib/shopify_api/rest/resources/2025_10/custom_collection.rb +191 -0
- data/lib/shopify_api/rest/resources/2025_10/customer.rb +328 -0
- data/lib/shopify_api/rest/resources/2025_10/deprecated_api_call.rb +61 -0
- data/lib/shopify_api/rest/resources/2025_10/discount_code.rb +226 -0
- data/lib/shopify_api/rest/resources/2025_10/dispute.rb +115 -0
- data/lib/shopify_api/rest/resources/2025_10/dispute_evidence.rb +121 -0
- data/lib/shopify_api/rest/resources/2025_10/dispute_file_upload.rb +85 -0
- data/lib/shopify_api/rest/resources/2025_10/draft_order.rb +279 -0
- data/lib/shopify_api/rest/resources/2025_10/event.rb +152 -0
- data/lib/shopify_api/rest/resources/2025_10/fulfillment.rb +235 -0
- data/lib/shopify_api/rest/resources/2025_10/fulfillment_event.rb +167 -0
- data/lib/shopify_api/rest/resources/2025_10/fulfillment_order.rb +326 -0
- data/lib/shopify_api/rest/resources/2025_10/fulfillment_request.rb +116 -0
- data/lib/shopify_api/rest/resources/2025_10/fulfillment_service.rb +134 -0
- data/lib/shopify_api/rest/resources/2025_10/gift_card.rb +222 -0
- data/lib/shopify_api/rest/resources/2025_10/gift_card_adjustment.rb +122 -0
- data/lib/shopify_api/rest/resources/2025_10/image.rb +161 -0
- data/lib/shopify_api/rest/resources/2025_10/inventory_item.rb +112 -0
- data/lib/shopify_api/rest/resources/2025_10/inventory_level.rb +183 -0
- data/lib/shopify_api/rest/resources/2025_10/location.rb +171 -0
- data/lib/shopify_api/rest/resources/2025_10/locations_for_move.rb +60 -0
- data/lib/shopify_api/rest/resources/2025_10/marketing_event.rb +213 -0
- data/lib/shopify_api/rest/resources/2025_10/metafield.rb +348 -0
- data/lib/shopify_api/rest/resources/2025_10/mobile_platform_application.rb +120 -0
- data/lib/shopify_api/rest/resources/2025_10/order.rb +503 -0
- data/lib/shopify_api/rest/resources/2025_10/order_risk.rb +148 -0
- data/lib/shopify_api/rest/resources/2025_10/page.rb +198 -0
- data/lib/shopify_api/rest/resources/2025_10/payment.rb +98 -0
- data/lib/shopify_api/rest/resources/2025_10/payment_gateway.rb +147 -0
- data/lib/shopify_api/rest/resources/2025_10/payment_transaction.rb +117 -0
- data/lib/shopify_api/rest/resources/2025_10/payout.rb +101 -0
- data/lib/shopify_api/rest/resources/2025_10/policy.rb +73 -0
- data/lib/shopify_api/rest/resources/2025_10/price_rule.rb +227 -0
- data/lib/shopify_api/rest/resources/2025_10/product.rb +227 -0
- data/lib/shopify_api/rest/resources/2025_10/product_listing.rb +200 -0
- data/lib/shopify_api/rest/resources/2025_10/product_resource_feedback.rb +92 -0
- data/lib/shopify_api/rest/resources/2025_10/province.rb +136 -0
- data/lib/shopify_api/rest/resources/2025_10/recurring_application_charge.rb +184 -0
- data/lib/shopify_api/rest/resources/2025_10/redirect.rb +143 -0
- data/lib/shopify_api/rest/resources/2025_10/refund.rb +158 -0
- data/lib/shopify_api/rest/resources/2025_10/resource_feedback.rb +77 -0
- data/lib/shopify_api/rest/resources/2025_10/script_tag.rb +159 -0
- data/lib/shopify_api/rest/resources/2025_10/shipping_zone.rb +87 -0
- data/lib/shopify_api/rest/resources/2025_10/shop.rb +231 -0
- data/lib/shopify_api/rest/resources/2025_10/smart_collection.rb +220 -0
- data/lib/shopify_api/rest/resources/2025_10/storefront_access_token.rb +91 -0
- data/lib/shopify_api/rest/resources/2025_10/tender_transaction.rb +97 -0
- data/lib/shopify_api/rest/resources/2025_10/theme.rb +127 -0
- data/lib/shopify_api/rest/resources/2025_10/transaction.rb +194 -0
- data/lib/shopify_api/rest/resources/2025_10/usage_charge.rb +106 -0
- data/lib/shopify_api/rest/resources/2025_10/user.rb +142 -0
- data/lib/shopify_api/rest/resources/2025_10/variant.rb +212 -0
- data/lib/shopify_api/rest/resources/2025_10/webhook.rb +173 -0
- data/lib/shopify_api/version.rb +1 -1
- data/lib/shopify_api/webhooks/registration.rb +3 -3
- data/lib/shopify_api/webhooks/registry.rb +3 -13
- data/lib/shopify_api/webhooks/{handler.rb → webhook_handler.rb} +0 -12
- data/lib/shopify_api.rb +1 -1
- metadata +76 -3
|
@@ -0,0 +1,73 @@
|
|
|
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 Policy < 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
|
+
@body = T.let(nil, T.nilable(String))
|
|
22
|
+
@created_at = T.let(nil, T.nilable(String))
|
|
23
|
+
@handle = T.let(nil, T.nilable(String))
|
|
24
|
+
@title = T.let(nil, T.nilable(String))
|
|
25
|
+
@updated_at = T.let(nil, T.nilable(String))
|
|
26
|
+
@url = T.let(nil, T.nilable(String))
|
|
27
|
+
|
|
28
|
+
super(session: session, from_hash: from_hash)
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
@has_one = T.let({}, T::Hash[Symbol, Class])
|
|
32
|
+
@has_many = T.let({}, T::Hash[Symbol, Class])
|
|
33
|
+
@paths = T.let([
|
|
34
|
+
{http_method: :get, operation: :get, ids: [], path: "policies.json"}
|
|
35
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
|
36
|
+
|
|
37
|
+
sig { returns(T.nilable(String)) }
|
|
38
|
+
attr_reader :body
|
|
39
|
+
sig { returns(T.nilable(String)) }
|
|
40
|
+
attr_reader :created_at
|
|
41
|
+
sig { returns(T.nilable(String)) }
|
|
42
|
+
attr_reader :handle
|
|
43
|
+
sig { returns(T.nilable(String)) }
|
|
44
|
+
attr_reader :title
|
|
45
|
+
sig { returns(T.nilable(String)) }
|
|
46
|
+
attr_reader :updated_at
|
|
47
|
+
sig { returns(T.nilable(String)) }
|
|
48
|
+
attr_reader :url
|
|
49
|
+
|
|
50
|
+
class << self
|
|
51
|
+
sig do
|
|
52
|
+
params(
|
|
53
|
+
session: Auth::Session,
|
|
54
|
+
kwargs: T.untyped
|
|
55
|
+
).returns(T::Array[Policy])
|
|
56
|
+
end
|
|
57
|
+
def all(
|
|
58
|
+
session: ShopifyAPI::Context.active_session,
|
|
59
|
+
**kwargs
|
|
60
|
+
)
|
|
61
|
+
response = base_find(
|
|
62
|
+
session: session,
|
|
63
|
+
ids: {},
|
|
64
|
+
params: {}.merge(kwargs).compact,
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
T.cast(response, T::Array[Policy])
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
end
|
|
73
|
+
end
|
|
@@ -0,0 +1,227 @@
|
|
|
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 PriceRule < 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
|
+
@allocation_limit = T.let(nil, T.nilable(Integer))
|
|
22
|
+
@allocation_method = T.let(nil, T.nilable(String))
|
|
23
|
+
@created_at = T.let(nil, T.nilable(String))
|
|
24
|
+
@customer_segment_prerequisite_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
25
|
+
@customer_selection = T.let(nil, T.nilable(String))
|
|
26
|
+
@ends_at = T.let(nil, T.nilable(String))
|
|
27
|
+
@entitled_collection_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
28
|
+
@entitled_country_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
29
|
+
@entitled_product_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
30
|
+
@entitled_variant_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
31
|
+
@id = T.let(nil, T.nilable(Integer))
|
|
32
|
+
@once_per_customer = T.let(nil, T.nilable(T::Boolean))
|
|
33
|
+
@prerequisite_collection_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
34
|
+
@prerequisite_customer_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
35
|
+
@prerequisite_product_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
36
|
+
@prerequisite_quantity_range = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
|
|
37
|
+
@prerequisite_shipping_price_range = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
|
|
38
|
+
@prerequisite_subtotal_range = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
|
|
39
|
+
@prerequisite_to_entitlement_purchase = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
|
|
40
|
+
@prerequisite_to_entitlement_quantity_ratio = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
|
|
41
|
+
@prerequisite_variant_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
42
|
+
@starts_at = T.let(nil, T.nilable(String))
|
|
43
|
+
@target_selection = T.let(nil, T.nilable(String))
|
|
44
|
+
@target_type = T.let(nil, T.nilable(String))
|
|
45
|
+
@title = T.let(nil, T.nilable(String))
|
|
46
|
+
@updated_at = T.let(nil, T.nilable(String))
|
|
47
|
+
@usage_limit = T.let(nil, T.nilable(Integer))
|
|
48
|
+
@value = T.let(nil, T.nilable(String))
|
|
49
|
+
@value_type = T.let(nil, T.nilable(String))
|
|
50
|
+
|
|
51
|
+
super(session: session, from_hash: from_hash)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
@has_one = T.let({}, T::Hash[Symbol, Class])
|
|
55
|
+
@has_many = T.let({}, T::Hash[Symbol, Class])
|
|
56
|
+
@paths = T.let([
|
|
57
|
+
{http_method: :delete, operation: :delete, ids: [:id], path: "price_rules/<id>.json"},
|
|
58
|
+
{http_method: :get, operation: :count, ids: [], path: "price_rules/count.json"},
|
|
59
|
+
{http_method: :get, operation: :get, ids: [], path: "price_rules.json"},
|
|
60
|
+
{http_method: :get, operation: :get, ids: [:id], path: "price_rules/<id>.json"},
|
|
61
|
+
{http_method: :post, operation: :post, ids: [], path: "price_rules.json"},
|
|
62
|
+
{http_method: :put, operation: :put, ids: [:id], path: "price_rules/<id>.json"}
|
|
63
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
|
64
|
+
|
|
65
|
+
sig { returns(T.nilable(Integer)) }
|
|
66
|
+
attr_reader :allocation_limit
|
|
67
|
+
sig { returns(T.nilable(String)) }
|
|
68
|
+
attr_reader :allocation_method
|
|
69
|
+
sig { returns(T.nilable(String)) }
|
|
70
|
+
attr_reader :created_at
|
|
71
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
72
|
+
attr_reader :customer_segment_prerequisite_ids
|
|
73
|
+
sig { returns(T.nilable(String)) }
|
|
74
|
+
attr_reader :customer_selection
|
|
75
|
+
sig { returns(T.nilable(String)) }
|
|
76
|
+
attr_reader :ends_at
|
|
77
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
78
|
+
attr_reader :entitled_collection_ids
|
|
79
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
80
|
+
attr_reader :entitled_country_ids
|
|
81
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
82
|
+
attr_reader :entitled_product_ids
|
|
83
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
84
|
+
attr_reader :entitled_variant_ids
|
|
85
|
+
sig { returns(T.nilable(Integer)) }
|
|
86
|
+
attr_reader :id
|
|
87
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
88
|
+
attr_reader :once_per_customer
|
|
89
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
90
|
+
attr_reader :prerequisite_collection_ids
|
|
91
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
92
|
+
attr_reader :prerequisite_customer_ids
|
|
93
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
94
|
+
attr_reader :prerequisite_product_ids
|
|
95
|
+
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
|
|
96
|
+
attr_reader :prerequisite_quantity_range
|
|
97
|
+
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
|
|
98
|
+
attr_reader :prerequisite_shipping_price_range
|
|
99
|
+
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
|
|
100
|
+
attr_reader :prerequisite_subtotal_range
|
|
101
|
+
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
|
|
102
|
+
attr_reader :prerequisite_to_entitlement_purchase
|
|
103
|
+
sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
|
|
104
|
+
attr_reader :prerequisite_to_entitlement_quantity_ratio
|
|
105
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
106
|
+
attr_reader :prerequisite_variant_ids
|
|
107
|
+
sig { returns(T.nilable(String)) }
|
|
108
|
+
attr_reader :starts_at
|
|
109
|
+
sig { returns(T.nilable(String)) }
|
|
110
|
+
attr_reader :target_selection
|
|
111
|
+
sig { returns(T.nilable(String)) }
|
|
112
|
+
attr_reader :target_type
|
|
113
|
+
sig { returns(T.nilable(String)) }
|
|
114
|
+
attr_reader :title
|
|
115
|
+
sig { returns(T.nilable(String)) }
|
|
116
|
+
attr_reader :updated_at
|
|
117
|
+
sig { returns(T.nilable(Integer)) }
|
|
118
|
+
attr_reader :usage_limit
|
|
119
|
+
sig { returns(T.nilable(String)) }
|
|
120
|
+
attr_reader :value
|
|
121
|
+
sig { returns(T.nilable(String)) }
|
|
122
|
+
attr_reader :value_type
|
|
123
|
+
|
|
124
|
+
class << self
|
|
125
|
+
sig do
|
|
126
|
+
params(
|
|
127
|
+
id: T.any(Integer, String),
|
|
128
|
+
session: Auth::Session
|
|
129
|
+
).returns(T.nilable(PriceRule))
|
|
130
|
+
end
|
|
131
|
+
def find(
|
|
132
|
+
id:,
|
|
133
|
+
session: ShopifyAPI::Context.active_session
|
|
134
|
+
)
|
|
135
|
+
result = base_find(
|
|
136
|
+
session: session,
|
|
137
|
+
ids: {id: id},
|
|
138
|
+
params: {},
|
|
139
|
+
)
|
|
140
|
+
T.cast(result[0], T.nilable(PriceRule))
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
sig do
|
|
144
|
+
params(
|
|
145
|
+
id: T.any(Integer, String),
|
|
146
|
+
session: Auth::Session
|
|
147
|
+
).returns(T.untyped)
|
|
148
|
+
end
|
|
149
|
+
def delete(
|
|
150
|
+
id:,
|
|
151
|
+
session: ShopifyAPI::Context.active_session
|
|
152
|
+
)
|
|
153
|
+
request(
|
|
154
|
+
http_method: :delete,
|
|
155
|
+
operation: :delete,
|
|
156
|
+
session: session,
|
|
157
|
+
ids: {id: id},
|
|
158
|
+
params: {},
|
|
159
|
+
)
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
sig do
|
|
163
|
+
params(
|
|
164
|
+
limit: T.untyped,
|
|
165
|
+
since_id: T.untyped,
|
|
166
|
+
created_at_min: T.untyped,
|
|
167
|
+
created_at_max: T.untyped,
|
|
168
|
+
updated_at_min: T.untyped,
|
|
169
|
+
updated_at_max: T.untyped,
|
|
170
|
+
starts_at_min: T.untyped,
|
|
171
|
+
starts_at_max: T.untyped,
|
|
172
|
+
ends_at_min: T.untyped,
|
|
173
|
+
ends_at_max: T.untyped,
|
|
174
|
+
times_used: T.untyped,
|
|
175
|
+
session: Auth::Session,
|
|
176
|
+
kwargs: T.untyped
|
|
177
|
+
).returns(T::Array[PriceRule])
|
|
178
|
+
end
|
|
179
|
+
def all(
|
|
180
|
+
limit: nil,
|
|
181
|
+
since_id: nil,
|
|
182
|
+
created_at_min: nil,
|
|
183
|
+
created_at_max: nil,
|
|
184
|
+
updated_at_min: nil,
|
|
185
|
+
updated_at_max: nil,
|
|
186
|
+
starts_at_min: nil,
|
|
187
|
+
starts_at_max: nil,
|
|
188
|
+
ends_at_min: nil,
|
|
189
|
+
ends_at_max: nil,
|
|
190
|
+
times_used: nil,
|
|
191
|
+
session: ShopifyAPI::Context.active_session,
|
|
192
|
+
**kwargs
|
|
193
|
+
)
|
|
194
|
+
response = base_find(
|
|
195
|
+
session: session,
|
|
196
|
+
ids: {},
|
|
197
|
+
params: {limit: limit, 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, starts_at_min: starts_at_min, starts_at_max: starts_at_max, ends_at_min: ends_at_min, ends_at_max: ends_at_max, times_used: times_used}.merge(kwargs).compact,
|
|
198
|
+
)
|
|
199
|
+
|
|
200
|
+
T.cast(response, T::Array[PriceRule])
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
sig do
|
|
204
|
+
params(
|
|
205
|
+
session: Auth::Session,
|
|
206
|
+
kwargs: T.untyped
|
|
207
|
+
).returns(T.untyped)
|
|
208
|
+
end
|
|
209
|
+
def count(
|
|
210
|
+
session: ShopifyAPI::Context.active_session,
|
|
211
|
+
**kwargs
|
|
212
|
+
)
|
|
213
|
+
request(
|
|
214
|
+
http_method: :get,
|
|
215
|
+
operation: :count,
|
|
216
|
+
session: session,
|
|
217
|
+
ids: {},
|
|
218
|
+
params: {}.merge(kwargs).compact,
|
|
219
|
+
body: {},
|
|
220
|
+
entity: nil,
|
|
221
|
+
)
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
end
|
|
225
|
+
|
|
226
|
+
end
|
|
227
|
+
end
|
|
@@ -0,0 +1,227 @@
|
|
|
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 Product < 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
|
+
@title = T.let(nil, T.nilable(String))
|
|
22
|
+
@body_html = T.let(nil, T.nilable(String))
|
|
23
|
+
@created_at = T.let(nil, T.nilable(String))
|
|
24
|
+
@handle = T.let(nil, T.nilable(String))
|
|
25
|
+
@id = T.let(nil, T.nilable(Integer))
|
|
26
|
+
@images = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
27
|
+
@options = T.let(nil, T.nilable(T.any(T::Hash[T.untyped, T.untyped], T::Array[T.untyped])))
|
|
28
|
+
@product_type = T.let(nil, T.nilable(String))
|
|
29
|
+
@published_at = T.let(nil, T.nilable(String))
|
|
30
|
+
@published_scope = T.let(nil, T.nilable(String))
|
|
31
|
+
@status = T.let(nil, T.nilable(String))
|
|
32
|
+
@tags = T.let(nil, T.nilable(T.any(String, T::Array[T.untyped])))
|
|
33
|
+
@template_suffix = T.let(nil, T.nilable(String))
|
|
34
|
+
@updated_at = T.let(nil, T.nilable(String))
|
|
35
|
+
@variants = T.let(nil, T.nilable(T::Array[T.untyped]))
|
|
36
|
+
@vendor = T.let(nil, T.nilable(String))
|
|
37
|
+
|
|
38
|
+
super(session: session, from_hash: from_hash)
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
@has_one = T.let({}, T::Hash[Symbol, Class])
|
|
42
|
+
@has_many = T.let({
|
|
43
|
+
images: Image,
|
|
44
|
+
variants: Variant
|
|
45
|
+
}, T::Hash[Symbol, Class])
|
|
46
|
+
@paths = T.let([
|
|
47
|
+
{http_method: :delete, operation: :delete, ids: [:id], path: "products/<id>.json"},
|
|
48
|
+
{http_method: :get, operation: :count, ids: [], path: "products/count.json"},
|
|
49
|
+
{http_method: :get, operation: :get, ids: [], path: "products.json"},
|
|
50
|
+
{http_method: :get, operation: :get, ids: [:id], path: "products/<id>.json"},
|
|
51
|
+
{http_method: :post, operation: :post, ids: [], path: "products.json"},
|
|
52
|
+
{http_method: :put, operation: :put, ids: [:id], path: "products/<id>.json"}
|
|
53
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
|
54
|
+
|
|
55
|
+
sig { returns(T.nilable(String)) }
|
|
56
|
+
attr_reader :title
|
|
57
|
+
sig { returns(T.nilable(String)) }
|
|
58
|
+
attr_reader :body_html
|
|
59
|
+
sig { returns(T.nilable(String)) }
|
|
60
|
+
attr_reader :created_at
|
|
61
|
+
sig { returns(T.nilable(String)) }
|
|
62
|
+
attr_reader :handle
|
|
63
|
+
sig { returns(T.nilable(Integer)) }
|
|
64
|
+
attr_reader :id
|
|
65
|
+
sig { returns(T.nilable(T::Array[Image])) }
|
|
66
|
+
attr_reader :images
|
|
67
|
+
sig { returns(T.nilable(T.any(T::Hash[T.untyped, T.untyped], T::Array[T::Hash[T.untyped, T.untyped]]))) }
|
|
68
|
+
attr_reader :options
|
|
69
|
+
sig { returns(T.nilable(String)) }
|
|
70
|
+
attr_reader :product_type
|
|
71
|
+
sig { returns(T.nilable(String)) }
|
|
72
|
+
attr_reader :published_at
|
|
73
|
+
sig { returns(T.nilable(String)) }
|
|
74
|
+
attr_reader :published_scope
|
|
75
|
+
sig { returns(T.nilable(String)) }
|
|
76
|
+
attr_reader :status
|
|
77
|
+
sig { returns(T.nilable(T.any(String, T::Array[String]))) }
|
|
78
|
+
attr_reader :tags
|
|
79
|
+
sig { returns(T.nilable(String)) }
|
|
80
|
+
attr_reader :template_suffix
|
|
81
|
+
sig { returns(T.nilable(String)) }
|
|
82
|
+
attr_reader :updated_at
|
|
83
|
+
sig { returns(T.nilable(T::Array[Variant])) }
|
|
84
|
+
attr_reader :variants
|
|
85
|
+
sig { returns(T.nilable(String)) }
|
|
86
|
+
attr_reader :vendor
|
|
87
|
+
|
|
88
|
+
class << self
|
|
89
|
+
sig do
|
|
90
|
+
params(
|
|
91
|
+
id: T.any(Integer, String),
|
|
92
|
+
fields: T.untyped,
|
|
93
|
+
session: Auth::Session
|
|
94
|
+
).returns(T.nilable(Product))
|
|
95
|
+
end
|
|
96
|
+
def find(
|
|
97
|
+
id:,
|
|
98
|
+
fields: nil,
|
|
99
|
+
session: ShopifyAPI::Context.active_session
|
|
100
|
+
)
|
|
101
|
+
result = base_find(
|
|
102
|
+
session: session,
|
|
103
|
+
ids: {id: id},
|
|
104
|
+
params: {fields: fields},
|
|
105
|
+
)
|
|
106
|
+
T.cast(result[0], T.nilable(Product))
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
sig do
|
|
110
|
+
params(
|
|
111
|
+
id: T.any(Integer, String),
|
|
112
|
+
session: Auth::Session
|
|
113
|
+
).returns(T.untyped)
|
|
114
|
+
end
|
|
115
|
+
def delete(
|
|
116
|
+
id:,
|
|
117
|
+
session: ShopifyAPI::Context.active_session
|
|
118
|
+
)
|
|
119
|
+
request(
|
|
120
|
+
http_method: :delete,
|
|
121
|
+
operation: :delete,
|
|
122
|
+
session: session,
|
|
123
|
+
ids: {id: id},
|
|
124
|
+
params: {},
|
|
125
|
+
)
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
sig do
|
|
129
|
+
params(
|
|
130
|
+
ids: T.untyped,
|
|
131
|
+
limit: T.untyped,
|
|
132
|
+
since_id: T.untyped,
|
|
133
|
+
title: T.untyped,
|
|
134
|
+
vendor: T.untyped,
|
|
135
|
+
handle: T.untyped,
|
|
136
|
+
product_type: T.untyped,
|
|
137
|
+
status: T.untyped,
|
|
138
|
+
collection_id: T.untyped,
|
|
139
|
+
created_at_min: T.untyped,
|
|
140
|
+
created_at_max: T.untyped,
|
|
141
|
+
updated_at_min: T.untyped,
|
|
142
|
+
updated_at_max: T.untyped,
|
|
143
|
+
published_at_min: T.untyped,
|
|
144
|
+
published_at_max: T.untyped,
|
|
145
|
+
published_status: T.untyped,
|
|
146
|
+
fields: T.untyped,
|
|
147
|
+
presentment_currencies: T.untyped,
|
|
148
|
+
session: Auth::Session,
|
|
149
|
+
kwargs: T.untyped
|
|
150
|
+
).returns(T::Array[Product])
|
|
151
|
+
end
|
|
152
|
+
def all(
|
|
153
|
+
ids: nil,
|
|
154
|
+
limit: nil,
|
|
155
|
+
since_id: nil,
|
|
156
|
+
title: nil,
|
|
157
|
+
vendor: nil,
|
|
158
|
+
handle: nil,
|
|
159
|
+
product_type: nil,
|
|
160
|
+
status: nil,
|
|
161
|
+
collection_id: nil,
|
|
162
|
+
created_at_min: nil,
|
|
163
|
+
created_at_max: nil,
|
|
164
|
+
updated_at_min: nil,
|
|
165
|
+
updated_at_max: nil,
|
|
166
|
+
published_at_min: nil,
|
|
167
|
+
published_at_max: nil,
|
|
168
|
+
published_status: nil,
|
|
169
|
+
fields: nil,
|
|
170
|
+
presentment_currencies: nil,
|
|
171
|
+
session: ShopifyAPI::Context.active_session,
|
|
172
|
+
**kwargs
|
|
173
|
+
)
|
|
174
|
+
response = base_find(
|
|
175
|
+
session: session,
|
|
176
|
+
ids: {},
|
|
177
|
+
params: {ids: ids, limit: limit, since_id: since_id, title: title, vendor: vendor, handle: handle, product_type: product_type, status: status, collection_id: collection_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, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status, fields: fields, presentment_currencies: presentment_currencies}.merge(kwargs).compact,
|
|
178
|
+
)
|
|
179
|
+
|
|
180
|
+
T.cast(response, T::Array[Product])
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
sig do
|
|
184
|
+
params(
|
|
185
|
+
vendor: T.untyped,
|
|
186
|
+
product_type: T.untyped,
|
|
187
|
+
collection_id: T.untyped,
|
|
188
|
+
created_at_min: T.untyped,
|
|
189
|
+
created_at_max: T.untyped,
|
|
190
|
+
updated_at_min: T.untyped,
|
|
191
|
+
updated_at_max: T.untyped,
|
|
192
|
+
published_at_min: T.untyped,
|
|
193
|
+
published_at_max: T.untyped,
|
|
194
|
+
published_status: T.untyped,
|
|
195
|
+
session: Auth::Session,
|
|
196
|
+
kwargs: T.untyped
|
|
197
|
+
).returns(T.untyped)
|
|
198
|
+
end
|
|
199
|
+
def count(
|
|
200
|
+
vendor: nil,
|
|
201
|
+
product_type: nil,
|
|
202
|
+
collection_id: nil,
|
|
203
|
+
created_at_min: nil,
|
|
204
|
+
created_at_max: nil,
|
|
205
|
+
updated_at_min: nil,
|
|
206
|
+
updated_at_max: nil,
|
|
207
|
+
published_at_min: nil,
|
|
208
|
+
published_at_max: nil,
|
|
209
|
+
published_status: nil,
|
|
210
|
+
session: ShopifyAPI::Context.active_session,
|
|
211
|
+
**kwargs
|
|
212
|
+
)
|
|
213
|
+
request(
|
|
214
|
+
http_method: :get,
|
|
215
|
+
operation: :count,
|
|
216
|
+
session: session,
|
|
217
|
+
ids: {},
|
|
218
|
+
params: {vendor: vendor, product_type: product_type, collection_id: collection_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, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status}.merge(kwargs).compact,
|
|
219
|
+
body: {},
|
|
220
|
+
entity: nil,
|
|
221
|
+
)
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
end
|
|
225
|
+
|
|
226
|
+
end
|
|
227
|
+
end
|