Class: ShopifyAPI::CustomerSavedSearch

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

Returns a new instance of CustomerSavedSearch.


12
13
14
15
16
17
18
19
20
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 12

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

  @created_at = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @query = 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

#created_atObject (readonly)

Returns the value of attribute created_at.


35
36
37
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 35

def created_at
  @created_at
end

#idObject (readonly)

Returns the value of attribute id.


37
38
39
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 37

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.


39
40
41
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 39

def name
  @name
end

#queryObject (readonly)

Returns the value of attribute query.


41
42
43
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 41

def query
  @query
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


43
44
45
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 43

def updated_at
  @updated_at
end

Class Method Details

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


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 94

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[CustomerSavedSearch])
end

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


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 117

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

.customers(id:, order: nil, limit: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 143

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

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


72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 72

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


53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/shopify_api/rest/resources/2021_07/customer_saved_search.rb', line 53

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