Class: ShopifyAPI::Product

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/product.rb,
lib/shopify_api/rest/resources/2022_07/product.rb,
lib/shopify_api/rest/resources/2022_10/product.rb,
lib/shopify_api/rest/resources/2023_01/product.rb,
lib/shopify_api/rest/resources/2023_04/product.rb,
lib/shopify_api/rest/resources/2023_07/product.rb,
lib/shopify_api/rest/resources/2023_10/product.rb,
lib/shopify_api/rest/resources/2024_01/product.rb,
lib/shopify_api/rest/resources/2024_04/product.rb,
lib/shopify_api/rest/resources/2024_07/product.rb,
lib/shopify_api/rest/resources/2024_10/product.rb

Instance Attribute Summary collapse

Attributes inherited from Rest::Base

#errors, #original_state

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rest::Base

api_call_limit, base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, get_path_ids, has_many?, has_one?, inherited, json_body_name, json_response_body_names, #method_missing, next_page?, next_page_info, prev_page?, prev_page_info, primary_key, read_only_attributes, request, #respond_to_missing?, retry_request_after, #save, #save!, #to_hash

Constructor Details

#initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) ⇒ Product

Returns a new instance of Product.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 19

def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @title = T.let(nil, T.nilable(String))
  @body_html = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @handle = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @images = T.let(nil, T.nilable(T::Array[T.untyped]))
  @options = T.let(nil, T.nilable(T.any(T::Hash[T.untyped, T.untyped], T::Array[T.untyped])))
  @product_type = T.let(nil, T.nilable(String))
  @published_at = T.let(nil, T.nilable(String))
  @published_scope = T.let(nil, T.nilable(String))
  @status = T.let(nil, T.nilable(String))
  @tags = T.let(nil, T.nilable(T.any(String, T::Array[T.untyped])))
  @template_suffix = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))
  @variants = T.let(nil, T.nilable(T::Array[T.untyped]))
  @vendor = T.let(nil, T.nilable(String))

  super(session: session, from_hash: from_hash)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base

Instance Attribute Details

#body_html ⇒ Object (readonly)

Returns the value of attribute body_html.



58
59
60
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 58

def body_html
  @body_html
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



60
61
62
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 60

def created_at
  @created_at
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



62
63
64
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 62

def handle
  @handle
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



64
65
66
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 64

def id
  @id
end

#images ⇒ Object (readonly)

Returns the value of attribute images.



66
67
68
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 66

def images
  @images
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



68
69
70
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 68

def options
  @options
end

#product_type ⇒ Object (readonly)

Returns the value of attribute product_type.



70
71
72
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 70

def product_type
  @product_type
end

#published_at ⇒ Object (readonly)

Returns the value of attribute published_at.



72
73
74
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 72

def published_at
  @published_at
end

#published_scope ⇒ Object (readonly)

Returns the value of attribute published_scope.



74
75
76
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 74

def published_scope
  @published_scope
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



76
77
78
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 76

def status
  @status
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



78
79
80
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 78

def tags
  @tags
end

#template_suffix ⇒ Object (readonly)

Returns the value of attribute template_suffix.



80
81
82
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 80

def template_suffix
  @template_suffix
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



56
57
58
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 56

def title
  @title
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



82
83
84
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 82

def updated_at
  @updated_at
end

#variants ⇒ Object (readonly)

Returns the value of attribute variants.



84
85
86
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 84

def variants
  @variants
end

#vendor ⇒ Object (readonly)

Returns the value of attribute vendor.



86
87
88
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 86

def vendor
  @vendor
end

Class Method Details

.all(ids: nil, limit: nil, since_id: nil, title: nil, vendor: nil, handle: nil, product_type: nil, status: nil, collection_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, published_at_min: nil, published_at_max: nil, published_status: nil, fields: nil, presentment_currencies: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 152

def all(
  ids: nil,
  limit: nil,
  since_id: nil,
  title: nil,
  vendor: nil,
  handle: nil,
  product_type: nil,
  status: nil,
  collection_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  published_at_min: nil,
  published_at_max: nil,
  published_status: nil,
  fields: nil,
  presentment_currencies: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    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,
  )

  T.cast(response, T::Array[Product])
end

.count(vendor: nil, product_type: nil, collection_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, published_at_min: nil, published_at_max: nil, published_status: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 199

def count(
  vendor: nil,
  product_type: nil,
  collection_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  published_at_min: nil,
  published_at_max: nil,
  published_status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    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,
    body: {},
    entity: nil,
  )
end

.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 115

def delete(
  id:,
  session: ShopifyAPI::Context.active_session
)
  request(
    http_method: :delete,
    operation: :delete,
    session: session,
    ids: {id: id},
    params: {},
  )
end

.find(id:, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/shopify_api/rest/resources/2022_04/product.rb', line 96

def find(
  id:,
  fields: nil,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id},
    params: {fields: fields},
  )
  T.cast(result[0], T.nilable(Product))
end