Class: ShopifyAPI::Asset

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

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, read_only_attributes, request, #respond_to_missing?, #save, #save!, #to_hash

Constructor Details

#initialize(session: ShopifyAPI::Context.active_session) ⇒ Asset

Returns a new instance of Asset.


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

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

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ShopifyAPI::Rest::Base

Instance Attribute Details

#attachmentObject (readonly)

Returns the value of attribute attachment.


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

def attachment
  @attachment
end

#checksumObject (readonly)

Returns the value of attribute checksum.


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

def checksum
  @checksum
end

#content_typeObject (readonly)

Returns the value of attribute content_type.


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

def content_type
  @content_type
end

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#keyObject (readonly)

Returns the value of attribute key.


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

def key
  @key
end

#public_urlObject (readonly)

Returns the value of attribute public_url.


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

def public_url
  @public_url
end

#sizeObject (readonly)

Returns the value of attribute size.


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

def size
  @size
end

#theme_idObject (readonly)

Returns the value of attribute theme_id.


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

def theme_id
  @theme_id
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

#valueObject (readonly)

Returns the value of attribute value.


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

def value
  @value
end

Class Method Details

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


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/shopify_api/rest/resources/2021_07/asset.rb', line 95

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


72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/shopify_api/rest/resources/2021_07/asset.rb', line 72

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_keyObject


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

def primary_key()
  "key"
end