Class: ShopifyAPI::ScriptTag

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

Returns a new instance of ScriptTag.


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

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

  @event = T.let(nil, T.nilable(String))
  @src = T.let(nil, T.nilable(String))
  @cache = T.let(nil, T.nilable(T::Boolean))
  @created_at = T.let(nil, T.nilable(String))
  @display_scope = T.let(nil, T.nilable(String))
  @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

#cacheObject (readonly)

Returns the value of attribute cache.


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

def cache
  @cache
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#display_scopeObject (readonly)

Returns the value of attribute display_scope.


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

def display_scope
  @display_scope
end

#eventObject (readonly)

Returns the value of attribute event.


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

def event
  @event
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#srcObject (readonly)

Returns the value of attribute src.


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

def src
  @src
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

Class Method Details

.all(limit: nil, since_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, src: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/shopify_api/rest/resources/2021_07/script_tag.rb', line 104

def all(
  limit: nil,
  since_id: nil,
  created_at_min: nil,
  created_at_max: nil,
  updated_at_min: nil,
  updated_at_max: nil,
  src: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    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, src: src, fields: fields}.merge(kwargs).compact,
  )

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

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


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/shopify_api/rest/resources/2021_07/script_tag.rb', line 132

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

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


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

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


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

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