Class: ShopifyAPI::Page

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

Returns a new instance of Page.


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

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

  @admin_graphql_api_id = T.let(nil, T.nilable(String))
  @author = 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))
  @metafield = T.let(nil, T.nilable(Metafield))
  @published_at = T.let(nil, T.nilable(String))
  @shop_id = T.let(nil, T.nilable(Integer))
  @template_suffix = 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

#admin_graphql_api_idObject (readonly)

Returns the value of attribute admin_graphql_api_id.


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

def admin_graphql_api_id
  @admin_graphql_api_id
end

#authorObject (readonly)

Returns the value of attribute author.


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

def author
  @author
end

#body_htmlObject (readonly)

Returns the value of attribute body_html.


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

def body_html
  @body_html
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#handleObject (readonly)

Returns the value of attribute handle.


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

def handle
  @handle
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#metafieldObject (readonly)

Returns the value of attribute metafield.


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

def metafield
  @metafield
end

#published_atObject (readonly)

Returns the value of attribute published_at.


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

def published_at
  @published_at
end

#shop_idObject (readonly)

Returns the value of attribute shop_id.


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

def shop_id
  @shop_id
end

#template_suffixObject (readonly)

Returns the value of attribute template_suffix.


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

def template_suffix
  @template_suffix
end

#titleObject (readonly)

Returns the value of attribute title.


63
64
65
# File 'lib/shopify_api/rest/resources/2021_07/page.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/page.rb', line 65

def updated_at
  @updated_at
end

Class Method Details

.all(limit: nil, since_id: nil, title: nil, handle: 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, fields: nil, published_status: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/shopify_api/rest/resources/2021_07/page.rb', line 125

def all(
  limit: nil,
  since_id: nil,
  title: nil,
  handle: 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,
  fields: nil,
  published_status: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {limit: limit, since_id: since_id, title: title, handle: handle, 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, fields: fields, published_status: published_status}.merge(kwargs).compact,
  )

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

.count(title: 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


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/shopify_api/rest/resources/2021_07/page.rb', line 164

def count(
  title: 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: {title: title, 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


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

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


75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/shopify_api/rest/resources/2021_07/page.rb', line 75

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