Class: ShopifyAPI::Product

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2021_07/product.rb,
lib/shopify_api/rest/resources/2021_10/product.rb,
lib/shopify_api/rest/resources/2022_01/product.rb,
lib/shopify_api/rest/resources/2022_04/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

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

Constructor Details

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

Returns a new instance of Product.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 12

def initialize(session: ShopifyAPI::Context.active_session)
  super(session: session)

  @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))
end

Dynamic Method Handling

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

Instance Attribute Details

#body_htmlObject (readonly)

Returns the value of attribute body_html.


50
51
52
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 50

def body_html
  @body_html
end

#created_atObject (readonly)

Returns the value of attribute created_at.


52
53
54
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 52

def created_at
  @created_at
end

#handleObject (readonly)

Returns the value of attribute handle.


54
55
56
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 54

def handle
  @handle
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#imagesObject (readonly)

Returns the value of attribute images.


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

def images
  @images
end

#optionsObject (readonly)

Returns the value of attribute options.


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

def options
  @options
end

#product_typeObject (readonly)

Returns the value of attribute product_type.


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

def product_type
  @product_type
end

#published_atObject (readonly)

Returns the value of attribute published_at.


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

def published_at
  @published_at
end

#published_scopeObject (readonly)

Returns the value of attribute published_scope.


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

def published_scope
  @published_scope
end

#statusObject (readonly)

Returns the value of attribute status.


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

def status
  @status
end

#tagsObject (readonly)

Returns the value of attribute tags.


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

def tags
  @tags
end

#template_suffixObject (readonly)

Returns the value of attribute template_suffix.


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

def template_suffix
  @template_suffix
end

#titleObject (readonly)

Returns the value of attribute title.


48
49
50
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 48

def title
  @title
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

#variantsObject (readonly)

Returns the value of attribute variants.


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

def variants
  @variants
end

#vendorObject (readonly)

Returns the value of attribute vendor.


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

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


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 144

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


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 191

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


107
108
109
110
111
112
113
114
115
116
117
118
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 107

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


88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/shopify_api/rest/resources/2021_07/product.rb', line 88

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