Class: ShopifyAPI::Asset

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

Returns a new instance of Asset.



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

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

  @attachment = T.let(nil, T.nilable(String))
  @checksum = T.let(nil, T.nilable(String))
  @content_type = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @key = T.let(nil, T.nilable(String))
  @public_url = T.let(nil, T.nilable(String))
  @size = T.let(nil, T.nilable(Integer))
  @theme_id = T.let(nil, T.nilable(Integer))
  @updated_at = T.let(nil, T.nilable(String))
  @value = 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

#attachment ⇒ Object (readonly)

Returns the value of attribute attachment.



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

def attachment
  @attachment
end

#checksum ⇒ Object (readonly)

Returns the value of attribute checksum.



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

def checksum
  @checksum
end

#content_type ⇒ Object (readonly)

Returns the value of attribute content_type.



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

def content_type
  @content_type
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#key ⇒ Object (readonly)

Returns the value of attribute key.



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

def key
  @key
end

#public_url ⇒ Object (readonly)

Returns the value of attribute public_url.



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

def public_url
  @public_url
end

#size ⇒ Object (readonly)

Returns the value of attribute size.



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

def size
  @size
end

#theme_id ⇒ Object (readonly)

Returns the value of attribute theme_id.



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

def theme_id
  @theme_id
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#value ⇒ Object (readonly)

Returns the value of attribute value.



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

def value
  @value
end

Class Method Details

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/shopify_api/rest/resources/2022_04/asset.rb', line 103

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

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

.delete(theme_id: nil, asset: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/shopify_api/rest/resources/2022_04/asset.rb', line 80

def delete(
  theme_id: nil,
  asset: nil,
  session: ShopifyAPI::Context.active_session
)
  request(
    http_method: :delete,
    operation: :delete,
    session: session,
    ids: {theme_id: theme_id},
    params: {asset: asset},
  )
end

.primary_key ⇒ Object 



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

def primary_key()
  "key"
end