Class: ShopifyAPI::Collect

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

Returns a new instance of Collect.



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/shopify_api/rest/resources/2022_04/collect.rb', line 19

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

  @collection_id = T.let(nil, T.nilable(Integer))
  @created_at = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @position = T.let(nil, T.nilable(Integer))
  @product_id = T.let(nil, T.nilable(Integer))
  @sort_value = T.let(nil, T.nilable(String))
  @updated_at = 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

#collection_id ⇒ Object (readonly)

Returns the value of attribute collection_id.



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

def collection_id
  @collection_id
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#position ⇒ Object (readonly)

Returns the value of attribute position.



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

def position
  @position
end

#product_id ⇒ Object (readonly)

Returns the value of attribute product_id.



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

def product_id
  @product_id
end

#sort_value ⇒ Object (readonly)

Returns the value of attribute sort_value.



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

def sort_value
  @sort_value
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/shopify_api/rest/resources/2022_04/collect.rb', line 106

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

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

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/shopify_api/rest/resources/2022_04/collect.rb', line 128

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(id:, session: ShopifyAPI::Context.active_session) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/shopify_api/rest/resources/2022_04/collect.rb', line 84

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 



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/shopify_api/rest/resources/2022_04/collect.rb', line 65

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(Collect))
end