Class: ShopifyAPI::Blog

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

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

Returns a new instance of Blog.


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

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

  @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))
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/blog.rb', line 43

def admin_graphql_api_id
  @admin_graphql_api_id
end

#commentableObject (readonly)

Returns the value of attribute commentable.


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

def commentable
  @commentable
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#feedburnerObject (readonly)

Returns the value of attribute feedburner.


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

def feedburner
  @feedburner
end

#feedburner_locationObject (readonly)

Returns the value of attribute feedburner_location.


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

def feedburner_location
  @feedburner_location
end

#handleObject (readonly)

Returns the value of attribute handle.


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

def handle
  @handle
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#metafieldsObject (readonly)

Returns the value of attribute metafields.


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

def metafields
  @metafields
end

#tagsObject (readonly)

Returns the value of attribute tags.


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

def tags
  @tags
end

#template_suffixObject (readonly)

Returns the value of attribute template_suffix.


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

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


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/shopify_api/rest/resources/2021_07/blog.rb', line 117

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


140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/shopify_api/rest/resources/2021_07/blog.rb', line 140

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


94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/shopify_api/rest/resources/2021_07/blog.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/blog.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(Blog))
end