Class: ShopifyAPI::ProductListing

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2021_07/product_listing.rb,
lib/shopify_api/rest/resources/2021_10/product_listing.rb,
lib/shopify_api/rest/resources/2022_01/product_listing.rb,
lib/shopify_api/rest/resources/2022_04/product_listing.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, read_only_attributes, request, #respond_to_missing?, #save, #save!, #to_hash

Constructor Details

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

Returns a new instance of ProductListing.


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

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

  @body_html = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @handle = T.let(nil, T.nilable(String))
  @images = T.let(nil, T.nilable(T::Array[T.untyped]))
  @options = T.let(nil, T.nilable(T::Array[T.untyped]))
  @product_id = T.let(nil, T.nilable(Integer))
  @product_type = T.let(nil, T.nilable(String))
  @published_at = T.let(nil, T.nilable(String))
  @tags = T.let(nil, T.nilable(String))
  @title = 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.


45
46
47
# File 'lib/shopify_api/rest/resources/2021_07/product_listing.rb', line 45

def body_html
  @body_html
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#handleObject (readonly)

Returns the value of attribute handle.


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

def handle
  @handle
end

#imagesObject (readonly)

Returns the value of attribute images.


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

def images
  @images
end

#optionsObject (readonly)

Returns the value of attribute options.


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

def options
  @options
end

#product_idObject (readonly)

Returns the value of attribute product_id.


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

def product_id
  @product_id
end

#product_typeObject (readonly)

Returns the value of attribute product_type.


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

def product_type
  @product_type
end

#published_atObject (readonly)

Returns the value of attribute published_at.


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

def published_at
  @published_at
end

#tagsObject (readonly)

Returns the value of attribute tags.


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

def tags
  @tags
end

#titleObject (readonly)

Returns the value of attribute title.


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

def title
  @title
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

#variantsObject (readonly)

Returns the value of attribute variants.


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

def variants
  @variants
end

#vendorObject (readonly)

Returns the value of attribute vendor.


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

def vendor
  @vendor
end

Class Method Details

.all(product_ids: nil, limit: nil, collection_id: nil, updated_at_min: nil, handle: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/shopify_api/rest/resources/2021_07/product_listing.rb', line 127

def all(
  product_ids: nil,
  limit: nil,
  collection_id: nil,
  updated_at_min: nil,
  handle: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {product_ids: product_ids, limit: limit, collection_id: collection_id, updated_at_min: updated_at_min, handle: handle}.merge(kwargs).compact,
  )

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

.count(session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/shopify_api/rest/resources/2021_07/product_listing.rb', line 151

def count(
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    params: {}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end

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


103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/shopify_api/rest/resources/2021_07/product_listing.rb', line 103

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

.find(product_id:, session: ShopifyAPI::Context.active_session) ⇒ Object


85
86
87
88
89
90
91
92
93
94
95
# File 'lib/shopify_api/rest/resources/2021_07/product_listing.rb', line 85

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

.primary_keyObject


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

def primary_key()
  "product_id"
end

.product_ids(limit: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/shopify_api/rest/resources/2021_07/product_listing.rb', line 173

def product_ids(
  limit: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :product_ids,
    session: session,
    ids: {},
    params: {limit: limit}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
end