Class: ShopifyAPI::Blog

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

Returns a new instance of Blog.



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

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

  @admin_graphql_api_id = T.let(nil, T.nilable(String))
  @commentable = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @feedburner = T.let(nil, T.nilable(String))
  @feedburner_location = T.let(nil, T.nilable(String))
  @handle = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @metafields = T.let(nil, T.nilable(T::Array[T.untyped]))
  @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))

  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

#admin_graphql_api_id ⇒ Object (readonly)

Returns the value of attribute admin_graphql_api_id.



51
52
53
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 51

def admin_graphql_api_id
  @admin_graphql_api_id
end

#commentable ⇒ Object (readonly)

Returns the value of attribute commentable.



53
54
55
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 53

def commentable
  @commentable
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



55
56
57
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 55

def created_at
  @created_at
end

#feedburner ⇒ Object (readonly)

Returns the value of attribute feedburner.



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

def feedburner
  @feedburner
end

#feedburner_location ⇒ Object (readonly)

Returns the value of attribute feedburner_location.



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

def feedburner_location
  @feedburner_location
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



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

def handle
  @handle
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#metafields ⇒ Object (readonly)

Returns the value of attribute metafields.



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

def metafields
  @metafields
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



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

def tags
  @tags
end

#template_suffix ⇒ Object (readonly)

Returns the value of attribute template_suffix.



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

def template_suffix
  @template_suffix
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



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

def title
  @title
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 125

def all(
  limit: nil,
  since_id: nil,
  handle: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {limit: limit, since_id: since_id, handle: handle, fields: fields}.merge(kwargs).compact,
  )

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

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 148

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

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



102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 102

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 



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/shopify_api/rest/resources/2022_04/blog.rb', line 83

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