Class: ShopifyAPI::CollectionListing

Inherits:
Rest::Base show all
Extended by:
T::Sig
Defined in:
lib/shopify_api/rest/resources/2022_04/collection_listing.rb,
lib/shopify_api/rest/resources/2022_07/collection_listing.rb,
lib/shopify_api/rest/resources/2022_10/collection_listing.rb,
lib/shopify_api/rest/resources/2023_01/collection_listing.rb,
lib/shopify_api/rest/resources/2023_04/collection_listing.rb,
lib/shopify_api/rest/resources/2023_07/collection_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, json_response_body_names, #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) ⇒ CollectionListing

Returns a new instance of CollectionListing.



16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 16

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

  @body_html = T.let(nil, T.nilable(String))
  @collection_id = T.let(nil, T.nilable(Integer))
  @default_product_image = T.let(nil, T.nilable(T::Array[T.untyped]))
  @handle = T.let(nil, T.nilable(String))
  @image = T.let(nil, T.nilable(Image))
  @published_at = T.let(nil, T.nilable(String))
  @sort_order = T.let(nil, T.nilable(String))
  @title = T.let(nil, T.nilable(String))
  @updated_at = 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_html ⇒ Object (readonly)

Returns the value of attribute body_html.



43
44
45
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 43

def body_html
  @body_html
end

#collection_id ⇒ Object (readonly)

Returns the value of attribute collection_id.



45
46
47
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 45

def collection_id
  @collection_id
end

#default_product_image ⇒ Object (readonly)

Returns the value of attribute default_product_image.



47
48
49
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 47

def default_product_image
  @default_product_image
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



49
50
51
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 49

def handle
  @handle
end

#image ⇒ Object (readonly)

Returns the value of attribute image.



51
52
53
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 51

def image
  @image
end

#published_at ⇒ Object (readonly)

Returns the value of attribute published_at.



53
54
55
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 53

def published_at
  @published_at
end

#sort_order ⇒ Object (readonly)

Returns the value of attribute sort_order.



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

def sort_order
  @sort_order
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



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

def title
  @title
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



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

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

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

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



93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 93

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

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



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 75

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

.primary_key ⇒ Object 



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

def primary_key()
  "collection_id"
end

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/shopify_api/rest/resources/2022_04/collection_listing.rb', line 135

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