Class: ShopifyAPI::Article

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

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) ⇒ Article

Returns a new instance of Article.


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

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

  @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))
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base

Instance Attribute Details

#authorObject (readonly)

Returns the value of attribute author.


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

def author
  @author
end

#blog_idObject (readonly)

Returns the value of attribute blog_id.


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

def blog_id
  @blog_id
end

#body_htmlObject (readonly)

Returns the value of attribute body_html.


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

def body_html
  @body_html
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#handleObject (readonly)

Returns the value of attribute handle.


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

def handle
  @handle
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#imageObject (readonly)

Returns the value of attribute image.


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

def image
  @image
end

#metafieldsObject (readonly)

Returns the value of attribute metafields.


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

def metafields
  @metafields
end

#publishedObject (readonly)

Returns the value of attribute published.


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

def published
  @published
end

#published_atObject (readonly)

Returns the value of attribute published_at.


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

def published_at
  @published_at
end

#summary_htmlObject (readonly)

Returns the value of attribute summary_html.


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

def summary_html
  @summary_html
end

#tagsObject (readonly)

Returns the value of attribute tags.


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

def tags
  @tags
end

#template_suffixObject (readonly)

Returns the value of attribute template_suffix.


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

def template_suffix
  @template_suffix
end

#titleObject (readonly)

Returns the value of attribute title.


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

def title
  @title
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

#user_idObject (readonly)

Returns the value of attribute user_id.


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

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


146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 146

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


179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 179

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


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 208

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


112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 112

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


91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 91

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


240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 240

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