Class: ShopifyAPI::Theme

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

Returns a new instance of Theme.


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

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

  @created_at = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @previewable = T.let(nil, T.nilable(T::Boolean))
  @processing = T.let(nil, T.nilable(T::Boolean))
  @role = T.let(nil, T.nilable(String))
  @theme_store_id = T.let(nil, T.nilable(Integer))
  @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

#created_atObject (readonly)

Returns the value of attribute created_at.


36
37
38
# File 'lib/shopify_api/rest/resources/2021_07/theme.rb', line 36

def created_at
  @created_at
end

#idObject (readonly)

Returns the value of attribute id.


38
39
40
# File 'lib/shopify_api/rest/resources/2021_07/theme.rb', line 38

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.


40
41
42
# File 'lib/shopify_api/rest/resources/2021_07/theme.rb', line 40

def name
  @name
end

#previewableObject (readonly)

Returns the value of attribute previewable.


42
43
44
# File 'lib/shopify_api/rest/resources/2021_07/theme.rb', line 42

def previewable
  @previewable
end

#processingObject (readonly)

Returns the value of attribute processing.


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

def processing
  @processing
end

#roleObject (readonly)

Returns the value of attribute role.


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

def role
  @role
end

#theme_store_idObject (readonly)

Returns the value of attribute theme_store_id.


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

def theme_store_id
  @theme_store_id
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

Class Method Details

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


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

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

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

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


79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/shopify_api/rest/resources/2021_07/theme.rb', line 79

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


60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/shopify_api/rest/resources/2021_07/theme.rb', line 60

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