shopify_api 14.5.0 → 14.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -1
- data/Gemfile.lock +20 -11
- data/docs/usage/oauth.md +14 -0
- data/docs/usage/webhooks.md +11 -0
- data/lib/shopify_api/admin_versions.rb +2 -1
- data/lib/shopify_api/context.rb +2 -2
- data/lib/shopify_api/rest/resources/2022_04/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2022_07/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2022_10/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2023_01/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2023_04/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2023_07/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2023_10/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2024_01/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2024_04/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2024_07/shop.rb +2 -2
- data/lib/shopify_api/rest/resources/2024_07/webhook.rb +1 -0
- data/lib/shopify_api/rest/resources/2024_10/abandoned_checkout.rb +194 -0
- data/lib/shopify_api/rest/resources/2024_10/access_scope.rb +62 -0
- data/lib/shopify_api/rest/resources/2024_10/apple_pay_certificate.rb +109 -0
- data/lib/shopify_api/rest/resources/2024_10/application_charge.rb +113 -0
- data/lib/shopify_api/rest/resources/2024_10/application_credit.rb +95 -0
- data/lib/shopify_api/rest/resources/2024_10/article.rb +269 -0
- data/lib/shopify_api/rest/resources/2024_10/asset.rb +122 -0
- data/lib/shopify_api/rest/resources/2024_10/assigned_fulfillment_order.rb +92 -0
- data/lib/shopify_api/rest/resources/2024_10/balance.rb +58 -0
- data/lib/shopify_api/rest/resources/2024_10/blog.rb +166 -0
- data/lib/shopify_api/rest/resources/2024_10/cancellation_request.rb +87 -0
- data/lib/shopify_api/rest/resources/2024_10/carrier_service.rb +120 -0
- data/lib/shopify_api/rest/resources/2024_10/checkout.rb +213 -0
- data/lib/shopify_api/rest/resources/2024_10/collect.rb +146 -0
- data/lib/shopify_api/rest/resources/2024_10/collection.rb +114 -0
- data/lib/shopify_api/rest/resources/2024_10/collection_listing.rb +159 -0
- data/lib/shopify_api/rest/resources/2024_10/comment.rb +287 -0
- data/lib/shopify_api/rest/resources/2024_10/country.rb +141 -0
- data/lib/shopify_api/rest/resources/2024_10/currency.rb +61 -0
- data/lib/shopify_api/rest/resources/2024_10/custom_collection.rb +191 -0
- data/lib/shopify_api/rest/resources/2024_10/customer.rb +335 -0
- data/lib/shopify_api/rest/resources/2024_10/customer_address.rb +215 -0
- data/lib/shopify_api/rest/resources/2024_10/deprecated_api_call.rb +61 -0
- data/lib/shopify_api/rest/resources/2024_10/discount_code.rb +226 -0
- data/lib/shopify_api/rest/resources/2024_10/dispute.rb +115 -0
- data/lib/shopify_api/rest/resources/2024_10/dispute_evidence.rb +121 -0
- data/lib/shopify_api/rest/resources/2024_10/dispute_file_upload.rb +85 -0
- data/lib/shopify_api/rest/resources/2024_10/draft_order.rb +279 -0
- data/lib/shopify_api/rest/resources/2024_10/event.rb +152 -0
- data/lib/shopify_api/rest/resources/2024_10/fulfillment.rb +235 -0
- data/lib/shopify_api/rest/resources/2024_10/fulfillment_event.rb +167 -0
- data/lib/shopify_api/rest/resources/2024_10/fulfillment_order.rb +326 -0
- data/lib/shopify_api/rest/resources/2024_10/fulfillment_request.rb +101 -0
- data/lib/shopify_api/rest/resources/2024_10/fulfillment_service.rb +134 -0
- data/lib/shopify_api/rest/resources/2024_10/gift_card.rb +222 -0
- data/lib/shopify_api/rest/resources/2024_10/gift_card_adjustment.rb +122 -0
- data/lib/shopify_api/rest/resources/2024_10/image.rb +161 -0
- data/lib/shopify_api/rest/resources/2024_10/inventory_item.rb +112 -0
- data/lib/shopify_api/rest/resources/2024_10/inventory_level.rb +183 -0
- data/lib/shopify_api/rest/resources/2024_10/location.rb +171 -0
- data/lib/shopify_api/rest/resources/2024_10/locations_for_move.rb +60 -0
- data/lib/shopify_api/rest/resources/2024_10/marketing_event.rb +213 -0
- data/lib/shopify_api/rest/resources/2024_10/metafield.rb +348 -0
- data/lib/shopify_api/rest/resources/2024_10/mobile_platform_application.rb +114 -0
- data/lib/shopify_api/rest/resources/2024_10/order.rb +490 -0
- data/lib/shopify_api/rest/resources/2024_10/order_risk.rb +148 -0
- data/lib/shopify_api/rest/resources/2024_10/page.rb +198 -0
- data/lib/shopify_api/rest/resources/2024_10/payment.rb +144 -0
- data/lib/shopify_api/rest/resources/2024_10/payment_gateway.rb +147 -0
- data/lib/shopify_api/rest/resources/2024_10/payment_transaction.rb +114 -0
- data/lib/shopify_api/rest/resources/2024_10/payout.rb +101 -0
- data/lib/shopify_api/rest/resources/2024_10/policy.rb +73 -0
- data/lib/shopify_api/rest/resources/2024_10/price_rule.rb +227 -0
- data/lib/shopify_api/rest/resources/2024_10/product.rb +227 -0
- data/lib/shopify_api/rest/resources/2024_10/product_listing.rb +200 -0
- data/lib/shopify_api/rest/resources/2024_10/product_resource_feedback.rb +92 -0
- data/lib/shopify_api/rest/resources/2024_10/province.rb +136 -0
- data/lib/shopify_api/rest/resources/2024_10/recurring_application_charge.rb +184 -0
- data/lib/shopify_api/rest/resources/2024_10/redirect.rb +143 -0
- data/lib/shopify_api/rest/resources/2024_10/refund.rb +155 -0
- data/lib/shopify_api/rest/resources/2024_10/resource_feedback.rb +77 -0
- data/lib/shopify_api/rest/resources/2024_10/script_tag.rb +159 -0
- data/lib/shopify_api/rest/resources/2024_10/shipping_zone.rb +87 -0
- data/lib/shopify_api/rest/resources/2024_10/shop.rb +232 -0
- data/lib/shopify_api/rest/resources/2024_10/smart_collection.rb +220 -0
- data/lib/shopify_api/rest/resources/2024_10/storefront_access_token.rb +91 -0
- data/lib/shopify_api/rest/resources/2024_10/tender_transaction.rb +97 -0
- data/lib/shopify_api/rest/resources/2024_10/theme.rb +127 -0
- data/lib/shopify_api/rest/resources/2024_10/transaction.rb +189 -0
- data/lib/shopify_api/rest/resources/2024_10/usage_charge.rb +106 -0
- data/lib/shopify_api/rest/resources/2024_10/user.rb +142 -0
- data/lib/shopify_api/rest/resources/2024_10/variant.rb +212 -0
- data/lib/shopify_api/rest/resources/2024_10/webhook.rb +173 -0
- data/lib/shopify_api/version.rb +1 -1
- data/lib/shopify_api/webhooks/registration.rb +17 -3
- data/lib/shopify_api/webhooks/registrations/event_bridge.rb +22 -3
- data/lib/shopify_api/webhooks/registrations/http.rb +22 -3
- data/lib/shopify_api/webhooks/registrations/pub_sub.rb +23 -4
- data/lib/shopify_api/webhooks/registry.rb +15 -5
- metadata +76 -3
@@ -0,0 +1,109 @@
|
|
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 ApplePayCertificate < 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
|
+
@id = T.let(nil, T.nilable(Integer))
|
22
|
+
@merchant_id = T.let(nil, T.nilable(String))
|
23
|
+
@status = T.let(nil, T.nilable(String))
|
24
|
+
|
25
|
+
super(session: session, from_hash: from_hash)
|
26
|
+
end
|
27
|
+
|
28
|
+
@has_one = T.let({}, T::Hash[Symbol, Class])
|
29
|
+
@has_many = T.let({}, T::Hash[Symbol, Class])
|
30
|
+
@paths = T.let([
|
31
|
+
{http_method: :delete, operation: :delete, ids: [:id], path: "apple_pay_certificates/<id>.json"},
|
32
|
+
{http_method: :get, operation: :csr, ids: [:id], path: "apple_pay_certificates/<id>/csr.json"},
|
33
|
+
{http_method: :get, operation: :get, ids: [:id], path: "apple_pay_certificates/<id>.json"},
|
34
|
+
{http_method: :post, operation: :post, ids: [], path: "apple_pay_certificates.json"},
|
35
|
+
{http_method: :put, operation: :put, ids: [:id], path: "apple_pay_certificates/<id>.json"}
|
36
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
37
|
+
|
38
|
+
sig { returns(T.nilable(Integer)) }
|
39
|
+
attr_reader :id
|
40
|
+
sig { returns(T.nilable(String)) }
|
41
|
+
attr_reader :merchant_id
|
42
|
+
sig { returns(T.nilable(String)) }
|
43
|
+
attr_reader :status
|
44
|
+
|
45
|
+
class << self
|
46
|
+
sig do
|
47
|
+
params(
|
48
|
+
id: T.any(Integer, String),
|
49
|
+
session: Auth::Session
|
50
|
+
).returns(T.nilable(ApplePayCertificate))
|
51
|
+
end
|
52
|
+
def find(
|
53
|
+
id:,
|
54
|
+
session: ShopifyAPI::Context.active_session
|
55
|
+
)
|
56
|
+
result = base_find(
|
57
|
+
session: session,
|
58
|
+
ids: {id: id},
|
59
|
+
params: {},
|
60
|
+
)
|
61
|
+
T.cast(result[0], T.nilable(ApplePayCertificate))
|
62
|
+
end
|
63
|
+
|
64
|
+
sig do
|
65
|
+
params(
|
66
|
+
id: T.any(Integer, String),
|
67
|
+
session: Auth::Session
|
68
|
+
).returns(T.untyped)
|
69
|
+
end
|
70
|
+
def delete(
|
71
|
+
id:,
|
72
|
+
session: ShopifyAPI::Context.active_session
|
73
|
+
)
|
74
|
+
request(
|
75
|
+
http_method: :delete,
|
76
|
+
operation: :delete,
|
77
|
+
session: session,
|
78
|
+
ids: {id: id},
|
79
|
+
params: {},
|
80
|
+
)
|
81
|
+
end
|
82
|
+
|
83
|
+
sig do
|
84
|
+
params(
|
85
|
+
id: T.any(Integer, String),
|
86
|
+
session: Auth::Session,
|
87
|
+
kwargs: T.untyped
|
88
|
+
).returns(T.untyped)
|
89
|
+
end
|
90
|
+
def csr(
|
91
|
+
id:,
|
92
|
+
session: ShopifyAPI::Context.active_session,
|
93
|
+
**kwargs
|
94
|
+
)
|
95
|
+
request(
|
96
|
+
http_method: :get,
|
97
|
+
operation: :csr,
|
98
|
+
session: session,
|
99
|
+
ids: {id: id},
|
100
|
+
params: {}.merge(kwargs).compact,
|
101
|
+
body: {},
|
102
|
+
entity: nil,
|
103
|
+
)
|
104
|
+
end
|
105
|
+
|
106
|
+
end
|
107
|
+
|
108
|
+
end
|
109
|
+
end
|
@@ -0,0 +1,113 @@
|
|
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 ApplicationCharge < 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
|
+
@confirmation_url = T.let(nil, T.nilable(String))
|
22
|
+
@created_at = T.let(nil, T.nilable(String))
|
23
|
+
@currency = T.let(nil, T.nilable(Currency))
|
24
|
+
@id = T.let(nil, T.nilable(Integer))
|
25
|
+
@name = T.let(nil, T.nilable(String))
|
26
|
+
@price = T.let(nil, T.nilable(T.any(String, Float)))
|
27
|
+
@return_url = T.let(nil, T.nilable(String))
|
28
|
+
@status = T.let(nil, T.nilable(String))
|
29
|
+
@test = T.let(nil, T.nilable(T::Boolean))
|
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({
|
36
|
+
currency: Currency
|
37
|
+
}, T::Hash[Symbol, Class])
|
38
|
+
@has_many = T.let({}, T::Hash[Symbol, Class])
|
39
|
+
@paths = T.let([
|
40
|
+
{http_method: :get, operation: :get, ids: [], path: "application_charges.json"},
|
41
|
+
{http_method: :get, operation: :get, ids: [:id], path: "application_charges/<id>.json"},
|
42
|
+
{http_method: :post, operation: :post, ids: [], path: "application_charges.json"}
|
43
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
44
|
+
|
45
|
+
sig { returns(T.nilable(String)) }
|
46
|
+
attr_reader :confirmation_url
|
47
|
+
sig { returns(T.nilable(String)) }
|
48
|
+
attr_reader :created_at
|
49
|
+
sig { returns(T.nilable(Currency)) }
|
50
|
+
attr_reader :currency
|
51
|
+
sig { returns(T.nilable(Integer)) }
|
52
|
+
attr_reader :id
|
53
|
+
sig { returns(T.nilable(String)) }
|
54
|
+
attr_reader :name
|
55
|
+
sig { returns(T.nilable(T.any(String, Float))) }
|
56
|
+
attr_reader :price
|
57
|
+
sig { returns(T.nilable(String)) }
|
58
|
+
attr_reader :return_url
|
59
|
+
sig { returns(T.nilable(String)) }
|
60
|
+
attr_reader :status
|
61
|
+
sig { returns(T.nilable(T::Boolean)) }
|
62
|
+
attr_reader :test
|
63
|
+
sig { returns(T.nilable(String)) }
|
64
|
+
attr_reader :updated_at
|
65
|
+
|
66
|
+
class << self
|
67
|
+
sig do
|
68
|
+
params(
|
69
|
+
id: T.any(Integer, String),
|
70
|
+
fields: T.untyped,
|
71
|
+
session: Auth::Session
|
72
|
+
).returns(T.nilable(ApplicationCharge))
|
73
|
+
end
|
74
|
+
def find(
|
75
|
+
id:,
|
76
|
+
fields: nil,
|
77
|
+
session: ShopifyAPI::Context.active_session
|
78
|
+
)
|
79
|
+
result = base_find(
|
80
|
+
session: session,
|
81
|
+
ids: {id: id},
|
82
|
+
params: {fields: fields},
|
83
|
+
)
|
84
|
+
T.cast(result[0], T.nilable(ApplicationCharge))
|
85
|
+
end
|
86
|
+
|
87
|
+
sig do
|
88
|
+
params(
|
89
|
+
since_id: T.untyped,
|
90
|
+
fields: T.untyped,
|
91
|
+
session: Auth::Session,
|
92
|
+
kwargs: T.untyped
|
93
|
+
).returns(T::Array[ApplicationCharge])
|
94
|
+
end
|
95
|
+
def all(
|
96
|
+
since_id: nil,
|
97
|
+
fields: nil,
|
98
|
+
session: ShopifyAPI::Context.active_session,
|
99
|
+
**kwargs
|
100
|
+
)
|
101
|
+
response = base_find(
|
102
|
+
session: session,
|
103
|
+
ids: {},
|
104
|
+
params: {since_id: since_id, fields: fields}.merge(kwargs).compact,
|
105
|
+
)
|
106
|
+
|
107
|
+
T.cast(response, T::Array[ApplicationCharge])
|
108
|
+
end
|
109
|
+
|
110
|
+
end
|
111
|
+
|
112
|
+
end
|
113
|
+
end
|
@@ -0,0 +1,95 @@
|
|
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 ApplicationCredit < 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
|
+
@amount = T.let(nil, T.nilable(String))
|
22
|
+
@currency = T.let(nil, T.nilable(Currency))
|
23
|
+
@description = T.let(nil, T.nilable(String))
|
24
|
+
@id = T.let(nil, T.nilable(Integer))
|
25
|
+
@test = T.let(nil, T.nilable(T::Boolean))
|
26
|
+
|
27
|
+
super(session: session, from_hash: from_hash)
|
28
|
+
end
|
29
|
+
|
30
|
+
@has_one = T.let({
|
31
|
+
currency: Currency
|
32
|
+
}, T::Hash[Symbol, Class])
|
33
|
+
@has_many = T.let({}, T::Hash[Symbol, Class])
|
34
|
+
@paths = T.let([
|
35
|
+
{http_method: :get, operation: :get, ids: [], path: "application_credits.json"},
|
36
|
+
{http_method: :get, operation: :get, ids: [:id], path: "application_credits/<id>.json"}
|
37
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
38
|
+
|
39
|
+
sig { returns(T.nilable(String)) }
|
40
|
+
attr_reader :amount
|
41
|
+
sig { returns(T.nilable(Currency)) }
|
42
|
+
attr_reader :currency
|
43
|
+
sig { returns(T.nilable(String)) }
|
44
|
+
attr_reader :description
|
45
|
+
sig { returns(T.nilable(Integer)) }
|
46
|
+
attr_reader :id
|
47
|
+
sig { returns(T.nilable(T::Boolean)) }
|
48
|
+
attr_reader :test
|
49
|
+
|
50
|
+
class << self
|
51
|
+
sig do
|
52
|
+
params(
|
53
|
+
id: T.any(Integer, String),
|
54
|
+
fields: T.untyped,
|
55
|
+
session: Auth::Session
|
56
|
+
).returns(T.nilable(ApplicationCredit))
|
57
|
+
end
|
58
|
+
def find(
|
59
|
+
id:,
|
60
|
+
fields: nil,
|
61
|
+
session: ShopifyAPI::Context.active_session
|
62
|
+
)
|
63
|
+
result = base_find(
|
64
|
+
session: session,
|
65
|
+
ids: {id: id},
|
66
|
+
params: {fields: fields},
|
67
|
+
)
|
68
|
+
T.cast(result[0], T.nilable(ApplicationCredit))
|
69
|
+
end
|
70
|
+
|
71
|
+
sig do
|
72
|
+
params(
|
73
|
+
fields: T.untyped,
|
74
|
+
session: Auth::Session,
|
75
|
+
kwargs: T.untyped
|
76
|
+
).returns(T::Array[ApplicationCredit])
|
77
|
+
end
|
78
|
+
def all(
|
79
|
+
fields: nil,
|
80
|
+
session: ShopifyAPI::Context.active_session,
|
81
|
+
**kwargs
|
82
|
+
)
|
83
|
+
response = base_find(
|
84
|
+
session: session,
|
85
|
+
ids: {},
|
86
|
+
params: {fields: fields}.merge(kwargs).compact,
|
87
|
+
)
|
88
|
+
|
89
|
+
T.cast(response, T::Array[ApplicationCredit])
|
90
|
+
end
|
91
|
+
|
92
|
+
end
|
93
|
+
|
94
|
+
end
|
95
|
+
end
|
@@ -0,0 +1,269 @@
|
|
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 Article < 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
|
+
@author = T.let(nil, T.nilable(String))
|
22
|
+
@blog_id = T.let(nil, T.nilable(Integer))
|
23
|
+
@body_html = T.let(nil, T.nilable(String))
|
24
|
+
@created_at = T.let(nil, T.nilable(String))
|
25
|
+
@handle = T.let(nil, T.nilable(String))
|
26
|
+
@id = T.let(nil, T.nilable(Integer))
|
27
|
+
@image = T.let(nil, T.nilable(T.any(String, T::Hash[T.untyped, T.untyped])))
|
28
|
+
@metafields = T.let(nil, T.nilable(T::Array[T.untyped]))
|
29
|
+
@published = T.let(nil, T.nilable(T::Boolean))
|
30
|
+
@published_at = T.let(nil, T.nilable(String))
|
31
|
+
@summary_html = T.let(nil, T.nilable(String))
|
32
|
+
@tags = T.let(nil, T.nilable(String))
|
33
|
+
@template_suffix = T.let(nil, T.nilable(String))
|
34
|
+
@title = T.let(nil, T.nilable(String))
|
35
|
+
@updated_at = T.let(nil, T.nilable(String))
|
36
|
+
@user_id = T.let(nil, T.nilable(Integer))
|
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
|
+
metafields: Metafield
|
44
|
+
}, T::Hash[Symbol, Class])
|
45
|
+
@paths = T.let([
|
46
|
+
{http_method: :delete, operation: :delete, ids: [:blog_id, :id], path: "blogs/<blog_id>/articles/<id>.json"},
|
47
|
+
{http_method: :get, operation: :authors, ids: [], path: "articles/authors.json"},
|
48
|
+
{http_method: :get, operation: :count, ids: [:blog_id], path: "blogs/<blog_id>/articles/count.json"},
|
49
|
+
{http_method: :get, operation: :get, ids: [:blog_id], path: "blogs/<blog_id>/articles.json"},
|
50
|
+
{http_method: :get, operation: :get, ids: [:blog_id, :id], path: "blogs/<blog_id>/articles/<id>.json"},
|
51
|
+
{http_method: :get, operation: :tags, ids: [], path: "articles/tags.json"},
|
52
|
+
{http_method: :get, operation: :tags, ids: [:blog_id], path: "blogs/<blog_id>/articles/tags.json"},
|
53
|
+
{http_method: :post, operation: :post, ids: [:blog_id], path: "blogs/<blog_id>/articles.json"},
|
54
|
+
{http_method: :put, operation: :put, ids: [:blog_id, :id], path: "blogs/<blog_id>/articles/<id>.json"}
|
55
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
56
|
+
|
57
|
+
sig { returns(T.nilable(String)) }
|
58
|
+
attr_reader :author
|
59
|
+
sig { returns(T.nilable(Integer)) }
|
60
|
+
attr_reader :blog_id
|
61
|
+
sig { returns(T.nilable(String)) }
|
62
|
+
attr_reader :body_html
|
63
|
+
sig { returns(T.nilable(String)) }
|
64
|
+
attr_reader :created_at
|
65
|
+
sig { returns(T.nilable(String)) }
|
66
|
+
attr_reader :handle
|
67
|
+
sig { returns(T.nilable(Integer)) }
|
68
|
+
attr_reader :id
|
69
|
+
sig { returns(T.nilable(T.any(String, T::Hash[T.untyped, T.untyped]))) }
|
70
|
+
attr_reader :image
|
71
|
+
sig { returns(T.nilable(T::Array[Metafield])) }
|
72
|
+
attr_reader :metafields
|
73
|
+
sig { returns(T.nilable(T::Boolean)) }
|
74
|
+
attr_reader :published
|
75
|
+
sig { returns(T.nilable(String)) }
|
76
|
+
attr_reader :published_at
|
77
|
+
sig { returns(T.nilable(String)) }
|
78
|
+
attr_reader :summary_html
|
79
|
+
sig { returns(T.nilable(String)) }
|
80
|
+
attr_reader :tags
|
81
|
+
sig { returns(T.nilable(String)) }
|
82
|
+
attr_reader :template_suffix
|
83
|
+
sig { returns(T.nilable(String)) }
|
84
|
+
attr_reader :title
|
85
|
+
sig { returns(T.nilable(String)) }
|
86
|
+
attr_reader :updated_at
|
87
|
+
sig { returns(T.nilable(Integer)) }
|
88
|
+
attr_reader :user_id
|
89
|
+
|
90
|
+
class << self
|
91
|
+
sig do
|
92
|
+
params(
|
93
|
+
id: T.any(Integer, String),
|
94
|
+
blog_id: T.nilable(T.any(Integer, String)),
|
95
|
+
fields: T.untyped,
|
96
|
+
session: Auth::Session
|
97
|
+
).returns(T.nilable(Article))
|
98
|
+
end
|
99
|
+
def find(
|
100
|
+
id:,
|
101
|
+
blog_id: nil,
|
102
|
+
fields: nil,
|
103
|
+
session: ShopifyAPI::Context.active_session
|
104
|
+
)
|
105
|
+
result = base_find(
|
106
|
+
session: session,
|
107
|
+
ids: {id: id, blog_id: blog_id},
|
108
|
+
params: {fields: fields},
|
109
|
+
)
|
110
|
+
T.cast(result[0], T.nilable(Article))
|
111
|
+
end
|
112
|
+
|
113
|
+
sig do
|
114
|
+
params(
|
115
|
+
id: T.any(Integer, String),
|
116
|
+
blog_id: T.nilable(T.any(Integer, String)),
|
117
|
+
session: Auth::Session
|
118
|
+
).returns(T.untyped)
|
119
|
+
end
|
120
|
+
def delete(
|
121
|
+
id:,
|
122
|
+
blog_id: nil,
|
123
|
+
session: ShopifyAPI::Context.active_session
|
124
|
+
)
|
125
|
+
request(
|
126
|
+
http_method: :delete,
|
127
|
+
operation: :delete,
|
128
|
+
session: session,
|
129
|
+
ids: {id: id, blog_id: blog_id},
|
130
|
+
params: {},
|
131
|
+
)
|
132
|
+
end
|
133
|
+
|
134
|
+
sig do
|
135
|
+
params(
|
136
|
+
blog_id: T.nilable(T.any(Integer, String)),
|
137
|
+
limit: T.untyped,
|
138
|
+
since_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
|
+
handle: T.untyped,
|
147
|
+
tag: T.untyped,
|
148
|
+
author: T.untyped,
|
149
|
+
fields: T.untyped,
|
150
|
+
session: Auth::Session,
|
151
|
+
kwargs: T.untyped
|
152
|
+
).returns(T::Array[Article])
|
153
|
+
end
|
154
|
+
def all(
|
155
|
+
blog_id: nil,
|
156
|
+
limit: nil,
|
157
|
+
since_id: nil,
|
158
|
+
created_at_min: nil,
|
159
|
+
created_at_max: nil,
|
160
|
+
updated_at_min: nil,
|
161
|
+
updated_at_max: nil,
|
162
|
+
published_at_min: nil,
|
163
|
+
published_at_max: nil,
|
164
|
+
published_status: nil,
|
165
|
+
handle: nil,
|
166
|
+
tag: nil,
|
167
|
+
author: nil,
|
168
|
+
fields: nil,
|
169
|
+
session: ShopifyAPI::Context.active_session,
|
170
|
+
**kwargs
|
171
|
+
)
|
172
|
+
response = base_find(
|
173
|
+
session: session,
|
174
|
+
ids: {blog_id: blog_id},
|
175
|
+
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, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status, handle: handle, tag: tag, author: author, fields: fields}.merge(kwargs).compact,
|
176
|
+
)
|
177
|
+
|
178
|
+
T.cast(response, T::Array[Article])
|
179
|
+
end
|
180
|
+
|
181
|
+
sig do
|
182
|
+
params(
|
183
|
+
session: Auth::Session,
|
184
|
+
kwargs: T.untyped
|
185
|
+
).returns(T.untyped)
|
186
|
+
end
|
187
|
+
def authors(
|
188
|
+
session: ShopifyAPI::Context.active_session,
|
189
|
+
**kwargs
|
190
|
+
)
|
191
|
+
request(
|
192
|
+
http_method: :get,
|
193
|
+
operation: :authors,
|
194
|
+
session: session,
|
195
|
+
ids: {},
|
196
|
+
params: {}.merge(kwargs).compact,
|
197
|
+
body: {},
|
198
|
+
entity: nil,
|
199
|
+
)
|
200
|
+
end
|
201
|
+
|
202
|
+
sig do
|
203
|
+
params(
|
204
|
+
blog_id: T.nilable(T.any(Integer, String)),
|
205
|
+
created_at_min: T.untyped,
|
206
|
+
created_at_max: T.untyped,
|
207
|
+
updated_at_min: T.untyped,
|
208
|
+
updated_at_max: T.untyped,
|
209
|
+
published_at_min: T.untyped,
|
210
|
+
published_at_max: T.untyped,
|
211
|
+
published_status: T.untyped,
|
212
|
+
session: Auth::Session,
|
213
|
+
kwargs: T.untyped
|
214
|
+
).returns(T.untyped)
|
215
|
+
end
|
216
|
+
def count(
|
217
|
+
blog_id: nil,
|
218
|
+
created_at_min: nil,
|
219
|
+
created_at_max: nil,
|
220
|
+
updated_at_min: nil,
|
221
|
+
updated_at_max: nil,
|
222
|
+
published_at_min: nil,
|
223
|
+
published_at_max: nil,
|
224
|
+
published_status: nil,
|
225
|
+
session: ShopifyAPI::Context.active_session,
|
226
|
+
**kwargs
|
227
|
+
)
|
228
|
+
request(
|
229
|
+
http_method: :get,
|
230
|
+
operation: :count,
|
231
|
+
session: session,
|
232
|
+
ids: {blog_id: blog_id},
|
233
|
+
params: {created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, published_at_min: published_at_min, published_at_max: published_at_max, published_status: published_status}.merge(kwargs).compact,
|
234
|
+
body: {},
|
235
|
+
entity: nil,
|
236
|
+
)
|
237
|
+
end
|
238
|
+
|
239
|
+
sig do
|
240
|
+
params(
|
241
|
+
blog_id: T.nilable(T.any(Integer, String)),
|
242
|
+
limit: T.untyped,
|
243
|
+
popular: T.untyped,
|
244
|
+
session: Auth::Session,
|
245
|
+
kwargs: T.untyped
|
246
|
+
).returns(T.untyped)
|
247
|
+
end
|
248
|
+
def tags(
|
249
|
+
blog_id: nil,
|
250
|
+
limit: nil,
|
251
|
+
popular: nil,
|
252
|
+
session: ShopifyAPI::Context.active_session,
|
253
|
+
**kwargs
|
254
|
+
)
|
255
|
+
request(
|
256
|
+
http_method: :get,
|
257
|
+
operation: :tags,
|
258
|
+
session: session,
|
259
|
+
ids: {blog_id: blog_id},
|
260
|
+
params: {limit: limit, popular: popular}.merge(kwargs).compact,
|
261
|
+
body: {},
|
262
|
+
entity: nil,
|
263
|
+
)
|
264
|
+
end
|
265
|
+
|
266
|
+
end
|
267
|
+
|
268
|
+
end
|
269
|
+
end
|
@@ -0,0 +1,122 @@
|
|
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 Asset < 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
|
+
@attachment = T.let(nil, T.nilable(String))
|
22
|
+
@checksum = T.let(nil, T.nilable(String))
|
23
|
+
@content_type = T.let(nil, T.nilable(String))
|
24
|
+
@created_at = T.let(nil, T.nilable(String))
|
25
|
+
@key = T.let(nil, T.nilable(String))
|
26
|
+
@public_url = T.let(nil, T.nilable(String))
|
27
|
+
@size = T.let(nil, T.nilable(Integer))
|
28
|
+
@theme_id = T.let(nil, T.nilable(Integer))
|
29
|
+
@updated_at = T.let(nil, T.nilable(String))
|
30
|
+
@value = 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: [:theme_id], path: "themes/<theme_id>/assets.json"},
|
39
|
+
{http_method: :get, operation: :get, ids: [:theme_id], path: "themes/<theme_id>/assets.json"},
|
40
|
+
{http_method: :get, operation: :get, ids: [:theme_id], path: "themes/<theme_id>/assets.json"},
|
41
|
+
{http_method: :put, operation: :put, ids: [:theme_id], path: "themes/<theme_id>/assets.json"}
|
42
|
+
], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
|
43
|
+
|
44
|
+
sig { returns(T.nilable(String)) }
|
45
|
+
attr_reader :attachment
|
46
|
+
sig { returns(T.nilable(String)) }
|
47
|
+
attr_reader :checksum
|
48
|
+
sig { returns(T.nilable(String)) }
|
49
|
+
attr_reader :content_type
|
50
|
+
sig { returns(T.nilable(String)) }
|
51
|
+
attr_reader :created_at
|
52
|
+
sig { returns(T.nilable(String)) }
|
53
|
+
attr_reader :key
|
54
|
+
sig { returns(T.nilable(String)) }
|
55
|
+
attr_reader :public_url
|
56
|
+
sig { returns(T.nilable(Integer)) }
|
57
|
+
attr_reader :size
|
58
|
+
sig { returns(T.nilable(Integer)) }
|
59
|
+
attr_reader :theme_id
|
60
|
+
sig { returns(T.nilable(String)) }
|
61
|
+
attr_reader :updated_at
|
62
|
+
sig { returns(T.nilable(String)) }
|
63
|
+
attr_reader :value
|
64
|
+
|
65
|
+
class << self
|
66
|
+
sig do
|
67
|
+
returns(String)
|
68
|
+
end
|
69
|
+
def primary_key()
|
70
|
+
"key"
|
71
|
+
end
|
72
|
+
|
73
|
+
sig do
|
74
|
+
params(
|
75
|
+
theme_id: T.nilable(T.any(Integer, String)),
|
76
|
+
asset: T.nilable(T::Hash[T.untyped, T.untyped]),
|
77
|
+
session: Auth::Session
|
78
|
+
).returns(T.untyped)
|
79
|
+
end
|
80
|
+
def delete(
|
81
|
+
theme_id: nil,
|
82
|
+
asset: nil,
|
83
|
+
session: ShopifyAPI::Context.active_session
|
84
|
+
)
|
85
|
+
request(
|
86
|
+
http_method: :delete,
|
87
|
+
operation: :delete,
|
88
|
+
session: session,
|
89
|
+
ids: {theme_id: theme_id},
|
90
|
+
params: {asset: asset},
|
91
|
+
)
|
92
|
+
end
|
93
|
+
|
94
|
+
sig do
|
95
|
+
params(
|
96
|
+
theme_id: T.nilable(T.any(Integer, String)),
|
97
|
+
fields: T.untyped,
|
98
|
+
asset: T.nilable(T::Hash[T.untyped, T.untyped]),
|
99
|
+
session: Auth::Session,
|
100
|
+
kwargs: T.untyped
|
101
|
+
).returns(T::Array[Asset])
|
102
|
+
end
|
103
|
+
def all(
|
104
|
+
theme_id: nil,
|
105
|
+
fields: nil,
|
106
|
+
asset: nil,
|
107
|
+
session: ShopifyAPI::Context.active_session,
|
108
|
+
**kwargs
|
109
|
+
)
|
110
|
+
response = base_find(
|
111
|
+
session: session,
|
112
|
+
ids: {theme_id: theme_id},
|
113
|
+
params: {fields: fields, asset: asset}.merge(kwargs).compact,
|
114
|
+
)
|
115
|
+
|
116
|
+
T.cast(response, T::Array[Asset])
|
117
|
+
end
|
118
|
+
|
119
|
+
end
|
120
|
+
|
121
|
+
end
|
122
|
+
end
|