Class: ShopifyAPI::Article

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

Returns a new instance of Article.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 19

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

  @author = T.let(nil, T.nilable(String))
  @blog_id = T.let(nil, T.nilable(Integer))
  @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))
  @image = T.let(nil, T.nilable(T.any(String, T::Hash[T.untyped, T.untyped])))
  @metafields = T.let(nil, T.nilable(T::Array[T.untyped]))
  @published = T.let(nil, T.nilable(T::Boolean))
  @published_at = T.let(nil, T.nilable(String))
  @summary_html = T.let(nil, T.nilable(String))
  @tags = T.let(nil, T.nilable(String))
  @template_suffix = T.let(nil, T.nilable(String))
  @title = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))
  @user_id = T.let(nil, T.nilable(Integer))

  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

#author ⇒ Object (readonly)

Returns the value of attribute author.



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

def author
  @author
end

#blog_id ⇒ Object (readonly)

Returns the value of attribute blog_id.



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

def blog_id
  @blog_id
end

#body_html ⇒ Object (readonly)

Returns the value of attribute body_html.



62
63
64
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 62

def body_html
  @body_html
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



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

def handle
  @handle
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



68
69
70
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 68

def id
  @id
end

#image ⇒ Object (readonly)

Returns the value of attribute image.



70
71
72
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 70

def image
  @image
end

#metafields ⇒ Object (readonly)

Returns the value of attribute metafields.



72
73
74
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 72

def metafields
  @metafields
end

#published ⇒ Object (readonly)

Returns the value of attribute published.



74
75
76
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 74

def published
  @published
end

#published_at ⇒ Object (readonly)

Returns the value of attribute published_at.



76
77
78
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 76

def published_at
  @published_at
end

#summary_html ⇒ Object (readonly)

Returns the value of attribute summary_html.



78
79
80
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 78

def summary_html
  @summary_html
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



80
81
82
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 80

def tags
  @tags
end

#template_suffix ⇒ Object (readonly)

Returns the value of attribute template_suffix.



82
83
84
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 82

def template_suffix
  @template_suffix
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



84
85
86
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 84

def title
  @title
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



86
87
88
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 86

def updated_at
  @updated_at
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



88
89
90
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 88

def user_id
  @user_id
end

Class Method Details

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 154

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

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

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 187

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

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 216

def count(
  blog_id: 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: {blog_id: blog_id},
    params: {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:, blog_id: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 120

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

.find(id:, blog_id: nil, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 99

def find(
  id:,
  blog_id: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id, blog_id: blog_id},
    params: {fields: fields},
  )
  T.cast(result[0], T.nilable(Article))
end

.tags(blog_id: nil, limit: nil, popular: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/shopify_api/rest/resources/2022_04/article.rb', line 248

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