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, 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

#author ⇒ Object (readonly)

Returns the value of attribute author.



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

def author
  @author
end

#blog_id ⇒ Object (readonly)

Returns the value of attribute blog_id.



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

def blog_id
  @blog_id
end

#body_html ⇒ Object (readonly)

Returns the value of attribute body_html.



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

def body_html
  @body_html
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



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

def handle
  @handle
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#image ⇒ Object (readonly)

Returns the value of attribute image.



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

def image
  @image
end

#metafields ⇒ Object (readonly)

Returns the value of attribute metafields.



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

def metafields
  @metafields
end

#published ⇒ Object (readonly)

Returns the value of attribute published.



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

def published
  @published
end

#published_at ⇒ Object (readonly)

Returns the value of attribute published_at.



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

def published_at
  @published_at
end

#summary_html ⇒ Object (readonly)

Returns the value of attribute summary_html.



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

def summary_html
  @summary_html
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



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

def tags
  @tags
end

#template_suffix ⇒ Object (readonly)

Returns the value of attribute template_suffix.



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

def template_suffix
  @template_suffix
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



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

def title
  @title
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



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

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 



145
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
 
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 145

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 



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

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 



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

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 



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

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 



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

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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/shopify_api/rest/resources/2021_07/article.rb', line 236

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