shopify_api 13.1.0 → 13.3.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 (136) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS +1 -1
  3. data/.github/workflows/build.yml +4 -0
  4. data/BREAKING_CHANGES_FOR_V10.md +231 -0
  5. data/CHANGELOG.md +14 -1
  6. data/CONTRIBUTING.md +25 -0
  7. data/Gemfile.lock +8 -15
  8. data/README.md +10 -34
  9. data/ROADMAP.md +10 -0
  10. data/docs/README.md +0 -1
  11. data/docs/getting_started.md +20 -3
  12. data/docs/usage/custom_apps.md +75 -0
  13. data/docs/usage/graphql.md +63 -18
  14. data/docs/usage/oauth.md +160 -27
  15. data/docs/usage/rest.md +204 -62
  16. data/docs/usage/webhooks.md +22 -4
  17. data/lib/shopify_api/admin_versions.rb +2 -1
  18. data/lib/shopify_api/auth/jwt_payload.rb +2 -2
  19. data/lib/shopify_api/auth/oauth.rb +15 -5
  20. data/lib/shopify_api/clients/http_client.rb +5 -1
  21. data/lib/shopify_api/context.rb +11 -5
  22. data/lib/shopify_api/rest/base.rb +22 -14
  23. data/lib/shopify_api/rest/resources/2022_10/assigned_fulfillment_order.rb +5 -3
  24. data/lib/shopify_api/rest/resources/2022_10/customer_address.rb +10 -0
  25. data/lib/shopify_api/rest/resources/2022_10/fulfillment_request.rb +10 -0
  26. data/lib/shopify_api/rest/resources/2022_10/order_risk.rb +5 -3
  27. data/lib/shopify_api/rest/resources/2023_01/assigned_fulfillment_order.rb +5 -3
  28. data/lib/shopify_api/rest/resources/2023_01/balance.rb +4 -0
  29. data/lib/shopify_api/rest/resources/2023_01/customer_address.rb +10 -0
  30. data/lib/shopify_api/rest/resources/2023_01/fulfillment_request.rb +10 -0
  31. data/lib/shopify_api/rest/resources/2023_01/order.rb +3 -0
  32. data/lib/shopify_api/rest/resources/2023_01/order_risk.rb +5 -3
  33. data/lib/shopify_api/rest/resources/2023_01/shop.rb +0 -3
  34. data/lib/shopify_api/rest/resources/2023_01/variant.rb +1 -5
  35. data/lib/shopify_api/rest/resources/2023_04/assigned_fulfillment_order.rb +5 -3
  36. data/lib/shopify_api/rest/resources/2023_04/balance.rb +4 -0
  37. data/lib/shopify_api/rest/resources/2023_04/customer_address.rb +10 -0
  38. data/lib/shopify_api/rest/resources/2023_04/fulfillment_request.rb +10 -0
  39. data/lib/shopify_api/rest/resources/2023_04/order.rb +3 -0
  40. data/lib/shopify_api/rest/resources/2023_04/order_risk.rb +5 -3
  41. data/lib/shopify_api/rest/resources/2023_04/shop.rb +0 -3
  42. data/lib/shopify_api/rest/resources/2023_04/variant.rb +1 -5
  43. data/lib/shopify_api/rest/resources/2023_07/assigned_fulfillment_order.rb +5 -3
  44. data/lib/shopify_api/rest/resources/2023_07/balance.rb +4 -0
  45. data/lib/shopify_api/rest/resources/2023_07/customer_address.rb +10 -0
  46. data/lib/shopify_api/rest/resources/2023_07/fulfillment_request.rb +10 -0
  47. data/lib/shopify_api/rest/resources/2023_07/order.rb +3 -0
  48. data/lib/shopify_api/rest/resources/2023_07/order_risk.rb +5 -3
  49. data/lib/shopify_api/rest/resources/2023_07/report.rb +121 -0
  50. data/lib/shopify_api/rest/resources/2023_07/shop.rb +0 -3
  51. data/lib/shopify_api/rest/resources/2023_07/variant.rb +1 -5
  52. data/lib/shopify_api/rest/resources/2023_10/abandoned_checkout.rb +190 -0
  53. data/lib/shopify_api/rest/resources/2023_10/access_scope.rb +58 -0
  54. data/lib/shopify_api/rest/resources/2023_10/apple_pay_certificate.rb +105 -0
  55. data/lib/shopify_api/rest/resources/2023_10/application_charge.rb +109 -0
  56. data/lib/shopify_api/rest/resources/2023_10/application_credit.rb +91 -0
  57. data/lib/shopify_api/rest/resources/2023_10/article.rb +265 -0
  58. data/lib/shopify_api/rest/resources/2023_10/asset.rb +118 -0
  59. data/lib/shopify_api/rest/resources/2023_10/assigned_fulfillment_order.rb +88 -0
  60. data/lib/shopify_api/rest/resources/2023_10/balance.rb +54 -0
  61. data/lib/shopify_api/rest/resources/2023_10/blog.rb +162 -0
  62. data/lib/shopify_api/rest/resources/2023_10/cancellation_request.rb +83 -0
  63. data/lib/shopify_api/rest/resources/2023_10/carrier_service.rb +116 -0
  64. data/lib/shopify_api/rest/resources/2023_10/checkout.rb +209 -0
  65. data/lib/shopify_api/rest/resources/2023_10/collect.rb +142 -0
  66. data/lib/shopify_api/rest/resources/2023_10/collection.rb +110 -0
  67. data/lib/shopify_api/rest/resources/2023_10/collection_listing.rb +155 -0
  68. data/lib/shopify_api/rest/resources/2023_10/comment.rb +283 -0
  69. data/lib/shopify_api/rest/resources/2023_10/country.rb +137 -0
  70. data/lib/shopify_api/rest/resources/2023_10/currency.rb +57 -0
  71. data/lib/shopify_api/rest/resources/2023_10/custom_collection.rb +187 -0
  72. data/lib/shopify_api/rest/resources/2023_10/customer.rb +329 -0
  73. data/lib/shopify_api/rest/resources/2023_10/customer_address.rb +211 -0
  74. data/lib/shopify_api/rest/resources/2023_10/deprecated_api_call.rb +57 -0
  75. data/lib/shopify_api/rest/resources/2023_10/discount_code.rb +222 -0
  76. data/lib/shopify_api/rest/resources/2023_10/dispute.rb +111 -0
  77. data/lib/shopify_api/rest/resources/2023_10/dispute_evidence.rb +117 -0
  78. data/lib/shopify_api/rest/resources/2023_10/dispute_file_upload.rb +81 -0
  79. data/lib/shopify_api/rest/resources/2023_10/draft_order.rb +275 -0
  80. data/lib/shopify_api/rest/resources/2023_10/event.rb +148 -0
  81. data/lib/shopify_api/rest/resources/2023_10/fulfillment.rb +231 -0
  82. data/lib/shopify_api/rest/resources/2023_10/fulfillment_event.rb +166 -0
  83. data/lib/shopify_api/rest/resources/2023_10/fulfillment_order.rb +312 -0
  84. data/lib/shopify_api/rest/resources/2023_10/fulfillment_request.rb +97 -0
  85. data/lib/shopify_api/rest/resources/2023_10/fulfillment_service.rb +130 -0
  86. data/lib/shopify_api/rest/resources/2023_10/gift_card.rb +218 -0
  87. data/lib/shopify_api/rest/resources/2023_10/gift_card_adjustment.rb +118 -0
  88. data/lib/shopify_api/rest/resources/2023_10/image.rb +157 -0
  89. data/lib/shopify_api/rest/resources/2023_10/inventory_item.rb +108 -0
  90. data/lib/shopify_api/rest/resources/2023_10/inventory_level.rb +179 -0
  91. data/lib/shopify_api/rest/resources/2023_10/location.rb +167 -0
  92. data/lib/shopify_api/rest/resources/2023_10/locations_for_move.rb +56 -0
  93. data/lib/shopify_api/rest/resources/2023_10/marketing_event.rb +209 -0
  94. data/lib/shopify_api/rest/resources/2023_10/metafield.rb +344 -0
  95. data/lib/shopify_api/rest/resources/2023_10/mobile_platform_application.rb +110 -0
  96. data/lib/shopify_api/rest/resources/2023_10/order.rb +491 -0
  97. data/lib/shopify_api/rest/resources/2023_10/order_risk.rb +144 -0
  98. data/lib/shopify_api/rest/resources/2023_10/page.rb +194 -0
  99. data/lib/shopify_api/rest/resources/2023_10/payment.rb +140 -0
  100. data/lib/shopify_api/rest/resources/2023_10/payment_gateway.rb +143 -0
  101. data/lib/shopify_api/rest/resources/2023_10/payment_transaction.rb +107 -0
  102. data/lib/shopify_api/rest/resources/2023_10/payout.rb +97 -0
  103. data/lib/shopify_api/rest/resources/2023_10/policy.rb +69 -0
  104. data/lib/shopify_api/rest/resources/2023_10/price_rule.rb +223 -0
  105. data/lib/shopify_api/rest/resources/2023_10/product.rb +223 -0
  106. data/lib/shopify_api/rest/resources/2023_10/product_listing.rb +196 -0
  107. data/lib/shopify_api/rest/resources/2023_10/product_resource_feedback.rb +88 -0
  108. data/lib/shopify_api/rest/resources/2023_10/province.rb +132 -0
  109. data/lib/shopify_api/rest/resources/2023_10/recurring_application_charge.rb +172 -0
  110. data/lib/shopify_api/rest/resources/2023_10/redirect.rb +139 -0
  111. data/lib/shopify_api/rest/resources/2023_10/refund.rb +151 -0
  112. data/lib/shopify_api/rest/resources/2023_10/report.rb +121 -0
  113. data/lib/shopify_api/rest/resources/2023_10/resource_feedback.rb +73 -0
  114. data/lib/shopify_api/rest/resources/2023_10/script_tag.rb +155 -0
  115. data/lib/shopify_api/rest/resources/2023_10/shipping_zone.rb +83 -0
  116. data/lib/shopify_api/rest/resources/2023_10/shop.rb +218 -0
  117. data/lib/shopify_api/rest/resources/2023_10/smart_collection.rb +216 -0
  118. data/lib/shopify_api/rest/resources/2023_10/storefront_access_token.rb +87 -0
  119. data/lib/shopify_api/rest/resources/2023_10/tender_transaction.rb +93 -0
  120. data/lib/shopify_api/rest/resources/2023_10/theme.rb +123 -0
  121. data/lib/shopify_api/rest/resources/2023_10/transaction.rb +184 -0
  122. data/lib/shopify_api/rest/resources/2023_10/usage_charge.rb +102 -0
  123. data/lib/shopify_api/rest/resources/2023_10/user.rb +138 -0
  124. data/lib/shopify_api/rest/resources/2023_10/variant.rb +208 -0
  125. data/lib/shopify_api/rest/resources/2023_10/webhook.rb +168 -0
  126. data/lib/shopify_api/version.rb +1 -1
  127. data/lib/shopify_api/webhooks/registration.rb +19 -4
  128. data/lib/shopify_api/webhooks/registrations/event_bridge.rb +1 -1
  129. data/lib/shopify_api/webhooks/registrations/http.rb +1 -1
  130. data/lib/shopify_api/webhooks/registrations/pub_sub.rb +2 -1
  131. data/lib/shopify_api/webhooks/registry.rb +25 -5
  132. data/shopify_api.gemspec +0 -1
  133. metadata +81 -20
  134. data/.github/workflows/stale.yml +0 -43
  135. data/docs/issues.md +0 -39
  136. data/docs/usage/session_storage.md +0 -46
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -51,10 +51,12 @@ module ShopifyAPI
51
51
 
52
52
  class << self
53
53
  sig do
54
- returns(String)
54
+ returns(T::Array[String])
55
55
  end
56
- def json_response_body_name()
57
- "fulfillment_order"
56
+ def json_response_body_names()
57
+ [
58
+ "fulfillment_order"
59
+ ]
58
60
  end
59
61
 
60
62
  sig do
@@ -16,6 +16,7 @@ module ShopifyAPI
16
16
  def initialize(session: ShopifyAPI::Context.active_session)
17
17
  super(session: session)
18
18
 
19
+ @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
19
20
  end
20
21
 
21
22
  @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
24
25
  {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
25
26
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
26
27
 
28
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
29
+ attr_reader :balance
30
+
27
31
  class << self
28
32
  sig do
29
33
  params(
@@ -87,6 +87,16 @@ module ShopifyAPI
87
87
  "address"
88
88
  end
89
89
 
90
+ sig do
91
+ returns(T::Array[String])
92
+ end
93
+ def json_response_body_names()
94
+ [
95
+ "customer_address",
96
+ "address"
97
+ ]
98
+ end
99
+
90
100
  sig do
91
101
  params(
92
102
  id: T.any(Integer, String),
@@ -31,6 +31,16 @@ module ShopifyAPI
31
31
  attr_reader :fulfillment_order_id
32
32
 
33
33
  class << self
34
+ sig do
35
+ returns(T::Array[String])
36
+ end
37
+ def json_response_body_names()
38
+ [
39
+ "submitted_fulfillment_order",
40
+ "fulfillment_order"
41
+ ]
42
+ end
43
+
34
44
  end
35
45
 
36
46
  sig do
@@ -28,6 +28,7 @@ module ShopifyAPI
28
28
  @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
29
29
  @closed_at = T.let(nil, T.nilable(String))
30
30
  @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
31
+ @confirmation_number = T.let(nil, T.nilable(String))
31
32
  @created_at = T.let(nil, T.nilable(String))
32
33
  @currency = T.let(nil, T.nilable(String))
33
34
  @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -142,6 +143,8 @@ module ShopifyAPI
142
143
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
143
144
  attr_reader :company
144
145
  sig { returns(T.nilable(String)) }
146
+ attr_reader :confirmation_number
147
+ sig { returns(T.nilable(String)) }
145
148
  attr_reader :created_at
146
149
  sig { returns(T.nilable(String)) }
147
150
  attr_reader :currency
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -20,7 +20,6 @@ module ShopifyAPI
20
20
  @address2 = T.let(nil, T.nilable(String))
21
21
  @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
22
22
  @city = T.let(nil, T.nilable(String))
23
- @cookie_consent_level = T.let(nil, T.nilable(String))
24
23
  @country = T.let(nil, T.nilable(String))
25
24
  @country_code = T.let(nil, T.nilable(String))
26
25
  @country_name = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
89
88
  sig { returns(T.nilable(String)) }
90
89
  attr_reader :city
91
90
  sig { returns(T.nilable(String)) }
92
- attr_reader :cookie_consent_level
93
- sig { returns(T.nilable(String)) }
94
91
  attr_reader :country
95
92
  sig { returns(T.nilable(String)) }
96
93
  attr_reader :country_code
@@ -27,7 +27,6 @@ module ShopifyAPI
27
27
  @inventory_management = T.let(nil, T.nilable(String))
28
28
  @inventory_policy = T.let(nil, T.nilable(String))
29
29
  @inventory_quantity = T.let(nil, T.nilable(Integer))
30
- @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
31
30
  @old_inventory_quantity = T.let(nil, T.nilable(Integer))
32
31
  @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
33
32
  @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
55
54
  {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
56
55
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
57
56
  @read_only_attributes = T.let([
58
- :inventory_quantity,
59
- :inventory_quantity_adjustment
57
+ :inventory_quantity
60
58
  ], T::Array[Symbol])
61
59
 
62
60
  sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
82
80
  sig { returns(T.nilable(Integer)) }
83
81
  attr_reader :inventory_quantity
84
82
  sig { returns(T.nilable(Integer)) }
85
- attr_reader :inventory_quantity_adjustment
86
- sig { returns(T.nilable(Integer)) }
87
83
  attr_reader :old_inventory_quantity
88
84
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
89
85
  attr_reader :option
@@ -51,10 +51,12 @@ module ShopifyAPI
51
51
 
52
52
  class << self
53
53
  sig do
54
- returns(String)
54
+ returns(T::Array[String])
55
55
  end
56
- def json_response_body_name()
57
- "fulfillment_order"
56
+ def json_response_body_names()
57
+ [
58
+ "fulfillment_order"
59
+ ]
58
60
  end
59
61
 
60
62
  sig do
@@ -16,6 +16,7 @@ module ShopifyAPI
16
16
  def initialize(session: ShopifyAPI::Context.active_session)
17
17
  super(session: session)
18
18
 
19
+ @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
19
20
  end
20
21
 
21
22
  @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
24
25
  {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
25
26
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
26
27
 
28
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
29
+ attr_reader :balance
30
+
27
31
  class << self
28
32
  sig do
29
33
  params(
@@ -87,6 +87,16 @@ module ShopifyAPI
87
87
  "address"
88
88
  end
89
89
 
90
+ sig do
91
+ returns(T::Array[String])
92
+ end
93
+ def json_response_body_names()
94
+ [
95
+ "customer_address",
96
+ "address"
97
+ ]
98
+ end
99
+
90
100
  sig do
91
101
  params(
92
102
  id: T.any(Integer, String),
@@ -31,6 +31,16 @@ module ShopifyAPI
31
31
  attr_reader :fulfillment_order_id
32
32
 
33
33
  class << self
34
+ sig do
35
+ returns(T::Array[String])
36
+ end
37
+ def json_response_body_names()
38
+ [
39
+ "submitted_fulfillment_order",
40
+ "fulfillment_order"
41
+ ]
42
+ end
43
+
34
44
  end
35
45
 
36
46
  sig do
@@ -28,6 +28,7 @@ module ShopifyAPI
28
28
  @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
29
29
  @closed_at = T.let(nil, T.nilable(String))
30
30
  @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
31
+ @confirmation_number = T.let(nil, T.nilable(String))
31
32
  @created_at = T.let(nil, T.nilable(String))
32
33
  @currency = T.let(nil, T.nilable(String))
33
34
  @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -144,6 +145,8 @@ module ShopifyAPI
144
145
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
145
146
  attr_reader :company
146
147
  sig { returns(T.nilable(String)) }
148
+ attr_reader :confirmation_number
149
+ sig { returns(T.nilable(String)) }
147
150
  attr_reader :created_at
148
151
  sig { returns(T.nilable(String)) }
149
152
  attr_reader :currency
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -20,7 +20,6 @@ module ShopifyAPI
20
20
  @address2 = T.let(nil, T.nilable(String))
21
21
  @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
22
22
  @city = T.let(nil, T.nilable(String))
23
- @cookie_consent_level = T.let(nil, T.nilable(String))
24
23
  @country = T.let(nil, T.nilable(String))
25
24
  @country_code = T.let(nil, T.nilable(String))
26
25
  @country_name = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
89
88
  sig { returns(T.nilable(String)) }
90
89
  attr_reader :city
91
90
  sig { returns(T.nilable(String)) }
92
- attr_reader :cookie_consent_level
93
- sig { returns(T.nilable(String)) }
94
91
  attr_reader :country
95
92
  sig { returns(T.nilable(String)) }
96
93
  attr_reader :country_code
@@ -27,7 +27,6 @@ module ShopifyAPI
27
27
  @inventory_management = T.let(nil, T.nilable(String))
28
28
  @inventory_policy = T.let(nil, T.nilable(String))
29
29
  @inventory_quantity = T.let(nil, T.nilable(Integer))
30
- @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
31
30
  @old_inventory_quantity = T.let(nil, T.nilable(Integer))
32
31
  @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
33
32
  @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
55
54
  {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
56
55
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
57
56
  @read_only_attributes = T.let([
58
- :inventory_quantity,
59
- :inventory_quantity_adjustment
57
+ :inventory_quantity
60
58
  ], T::Array[Symbol])
61
59
 
62
60
  sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
82
80
  sig { returns(T.nilable(Integer)) }
83
81
  attr_reader :inventory_quantity
84
82
  sig { returns(T.nilable(Integer)) }
85
- attr_reader :inventory_quantity_adjustment
86
- sig { returns(T.nilable(Integer)) }
87
83
  attr_reader :old_inventory_quantity
88
84
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
89
85
  attr_reader :option
@@ -51,10 +51,12 @@ module ShopifyAPI
51
51
 
52
52
  class << self
53
53
  sig do
54
- returns(String)
54
+ returns(T::Array[String])
55
55
  end
56
- def json_response_body_name()
57
- "fulfillment_order"
56
+ def json_response_body_names()
57
+ [
58
+ "fulfillment_order"
59
+ ]
58
60
  end
59
61
 
60
62
  sig do
@@ -16,6 +16,7 @@ module ShopifyAPI
16
16
  def initialize(session: ShopifyAPI::Context.active_session)
17
17
  super(session: session)
18
18
 
19
+ @balance = T.let(nil, T.nilable(T::Array[T.untyped]))
19
20
  end
20
21
 
21
22
  @has_one = T.let({}, T::Hash[Symbol, Class])
@@ -24,6 +25,9 @@ module ShopifyAPI
24
25
  {http_method: :get, operation: :get, ids: [], path: "shopify_payments/balance.json"}
25
26
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
26
27
 
28
+ sig { returns(T.nilable(T::Array[T::Hash[T.untyped, T.untyped]])) }
29
+ attr_reader :balance
30
+
27
31
  class << self
28
32
  sig do
29
33
  params(
@@ -87,6 +87,16 @@ module ShopifyAPI
87
87
  "address"
88
88
  end
89
89
 
90
+ sig do
91
+ returns(T::Array[String])
92
+ end
93
+ def json_response_body_names()
94
+ [
95
+ "customer_address",
96
+ "address"
97
+ ]
98
+ end
99
+
90
100
  sig do
91
101
  params(
92
102
  id: T.any(Integer, String),
@@ -31,6 +31,16 @@ module ShopifyAPI
31
31
  attr_reader :fulfillment_order_id
32
32
 
33
33
  class << self
34
+ sig do
35
+ returns(T::Array[String])
36
+ end
37
+ def json_response_body_names()
38
+ [
39
+ "submitted_fulfillment_order",
40
+ "fulfillment_order"
41
+ ]
42
+ end
43
+
34
44
  end
35
45
 
36
46
  sig do
@@ -28,6 +28,7 @@ module ShopifyAPI
28
28
  @client_details = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
29
29
  @closed_at = T.let(nil, T.nilable(String))
30
30
  @company = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
31
+ @confirmation_number = T.let(nil, T.nilable(String))
31
32
  @created_at = T.let(nil, T.nilable(String))
32
33
  @currency = T.let(nil, T.nilable(String))
33
34
  @current_subtotal_price = T.let(nil, T.nilable(String))
@@ -145,6 +146,8 @@ module ShopifyAPI
145
146
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
146
147
  attr_reader :company
147
148
  sig { returns(T.nilable(String)) }
149
+ attr_reader :confirmation_number
150
+ sig { returns(T.nilable(String)) }
148
151
  attr_reader :created_at
149
152
  sig { returns(T.nilable(String)) }
150
153
  attr_reader :currency
@@ -68,10 +68,12 @@ module ShopifyAPI
68
68
  end
69
69
 
70
70
  sig do
71
- returns(String)
71
+ returns(T::Array[String])
72
72
  end
73
- def json_response_body_name()
74
- "risk"
73
+ def json_response_body_names()
74
+ [
75
+ "risk"
76
+ ]
75
77
  end
76
78
 
77
79
  sig do
@@ -0,0 +1,121 @@
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 Report < ShopifyAPI::Rest::Base
10
+ extend T::Sig
11
+
12
+ @prev_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
13
+ @next_page_info = T.let(Concurrent::ThreadLocalVar.new { nil }, Concurrent::ThreadLocalVar)
14
+
15
+ sig { params(session: T.nilable(ShopifyAPI::Auth::Session)).void }
16
+ def initialize(session: ShopifyAPI::Context.active_session)
17
+ super(session: session)
18
+
19
+ @category = T.let(nil, T.nilable(String))
20
+ @id = T.let(nil, T.nilable(Integer))
21
+ @name = T.let(nil, T.nilable(String))
22
+ @shopify_ql = T.let(nil, T.nilable(String))
23
+ @updated_at = T.let(nil, T.nilable(String))
24
+ end
25
+
26
+ @has_one = T.let({}, T::Hash[Symbol, Class])
27
+ @has_many = T.let({}, T::Hash[Symbol, Class])
28
+ @paths = T.let([
29
+ {http_method: :delete, operation: :delete, ids: [:id], path: "reports/<id>.json"},
30
+ {http_method: :get, operation: :get, ids: [], path: "reports.json"},
31
+ {http_method: :get, operation: :get, ids: [:id], path: "reports/<id>.json"},
32
+ {http_method: :post, operation: :post, ids: [], path: "reports.json"},
33
+ {http_method: :put, operation: :put, ids: [:id], path: "reports/<id>.json"}
34
+ ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
35
+
36
+ sig { returns(T.nilable(String)) }
37
+ attr_reader :category
38
+ sig { returns(T.nilable(Integer)) }
39
+ attr_reader :id
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :name
42
+ sig { returns(T.nilable(String)) }
43
+ attr_reader :shopify_ql
44
+ sig { returns(T.nilable(String)) }
45
+ attr_reader :updated_at
46
+
47
+ class << self
48
+ sig do
49
+ params(
50
+ id: T.any(Integer, String),
51
+ fields: T.untyped,
52
+ session: Auth::Session
53
+ ).returns(T.nilable(Report))
54
+ end
55
+ def find(
56
+ id:,
57
+ fields: nil,
58
+ session: ShopifyAPI::Context.active_session
59
+ )
60
+ result = base_find(
61
+ session: session,
62
+ ids: {id: id},
63
+ params: {fields: fields},
64
+ )
65
+ T.cast(result[0], T.nilable(Report))
66
+ end
67
+
68
+ sig do
69
+ params(
70
+ id: T.any(Integer, String),
71
+ session: Auth::Session
72
+ ).returns(T.untyped)
73
+ end
74
+ def delete(
75
+ id:,
76
+ session: ShopifyAPI::Context.active_session
77
+ )
78
+ request(
79
+ http_method: :delete,
80
+ operation: :delete,
81
+ session: session,
82
+ ids: {id: id},
83
+ params: {},
84
+ )
85
+ end
86
+
87
+ sig do
88
+ params(
89
+ ids: T.untyped,
90
+ limit: T.untyped,
91
+ since_id: T.untyped,
92
+ updated_at_min: T.untyped,
93
+ updated_at_max: T.untyped,
94
+ fields: T.untyped,
95
+ session: Auth::Session,
96
+ kwargs: T.untyped
97
+ ).returns(T::Array[Report])
98
+ end
99
+ def all(
100
+ ids: nil,
101
+ limit: nil,
102
+ since_id: nil,
103
+ updated_at_min: nil,
104
+ updated_at_max: nil,
105
+ fields: nil,
106
+ session: ShopifyAPI::Context.active_session,
107
+ **kwargs
108
+ )
109
+ response = base_find(
110
+ session: session,
111
+ ids: {},
112
+ params: {ids: ids, limit: limit, since_id: since_id, updated_at_min: updated_at_min, updated_at_max: updated_at_max, fields: fields}.merge(kwargs).compact,
113
+ )
114
+
115
+ T.cast(response, T::Array[Report])
116
+ end
117
+
118
+ end
119
+
120
+ end
121
+ end
@@ -20,7 +20,6 @@ module ShopifyAPI
20
20
  @address2 = T.let(nil, T.nilable(String))
21
21
  @checkout_api_supported = T.let(nil, T.nilable(T::Boolean))
22
22
  @city = T.let(nil, T.nilable(String))
23
- @cookie_consent_level = T.let(nil, T.nilable(String))
24
23
  @country = T.let(nil, T.nilable(String))
25
24
  @country_code = T.let(nil, T.nilable(String))
26
25
  @country_name = T.let(nil, T.nilable(String))
@@ -89,8 +88,6 @@ module ShopifyAPI
89
88
  sig { returns(T.nilable(String)) }
90
89
  attr_reader :city
91
90
  sig { returns(T.nilable(String)) }
92
- attr_reader :cookie_consent_level
93
- sig { returns(T.nilable(String)) }
94
91
  attr_reader :country
95
92
  sig { returns(T.nilable(String)) }
96
93
  attr_reader :country_code
@@ -27,7 +27,6 @@ module ShopifyAPI
27
27
  @inventory_management = T.let(nil, T.nilable(String))
28
28
  @inventory_policy = T.let(nil, T.nilable(String))
29
29
  @inventory_quantity = T.let(nil, T.nilable(Integer))
30
- @inventory_quantity_adjustment = T.let(nil, T.nilable(Integer))
31
30
  @old_inventory_quantity = T.let(nil, T.nilable(Integer))
32
31
  @option = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped]))
33
32
  @position = T.let(nil, T.nilable(Integer))
@@ -55,8 +54,7 @@ module ShopifyAPI
55
54
  {http_method: :put, operation: :put, ids: [:id], path: "variants/<id>.json"}
56
55
  ], T::Array[T::Hash[String, T.any(T::Array[Symbol], String, Symbol)]])
57
56
  @read_only_attributes = T.let([
58
- :inventory_quantity,
59
- :inventory_quantity_adjustment
57
+ :inventory_quantity
60
58
  ], T::Array[Symbol])
61
59
 
62
60
  sig { returns(T.nilable(String)) }
@@ -82,8 +80,6 @@ module ShopifyAPI
82
80
  sig { returns(T.nilable(Integer)) }
83
81
  attr_reader :inventory_quantity
84
82
  sig { returns(T.nilable(Integer)) }
85
- attr_reader :inventory_quantity_adjustment
86
- sig { returns(T.nilable(Integer)) }
87
83
  attr_reader :old_inventory_quantity
88
84
  sig { returns(T.nilable(T::Hash[T.untyped, T.untyped])) }
89
85
  attr_reader :option