Class: ShopifyAPI::ScriptTag

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

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

Returns a new instance of ScriptTag.



19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/shopify_api/rest/resources/2022_04/script_tag.rb', line 19

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

  @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))

  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

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



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

def cache
  @cache
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#display_scope ⇒ Object (readonly)

Returns the value of attribute display_scope.



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

def display_scope
  @display_scope
end

#event ⇒ Object (readonly)

Returns the value of attribute event.



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

def event
  @event
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#src ⇒ Object (readonly)

Returns the value of attribute src.



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

def src
  @src
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

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 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/shopify_api/rest/resources/2022_04/script_tag.rb', line 112

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 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/shopify_api/rest/resources/2022_04/script_tag.rb', line 140

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 



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

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 



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shopify_api/rest/resources/2022_04/script_tag.rb', line 66

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