Class: ShopifyAPI::Image

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

Returns a new instance of Image.



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

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

  @created_at = T.let(nil, T.nilable(String))
  @height = T.let(nil, T.nilable(Integer))
  @id = T.let(nil, T.nilable(Integer))
  @position = T.let(nil, T.nilable(Integer))
  @product_id = T.let(nil, T.nilable(Integer))
  @src = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))
  @variant_ids = T.let(nil, T.nilable(T::Array[T.untyped]))
  @width = T.let(nil, T.nilable(Integer))

  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

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#height ⇒ Object (readonly)

Returns the value of attribute height.



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

def height
  @height
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#position ⇒ Object (readonly)

Returns the value of attribute position.



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

def position
  @position
end

#product_id ⇒ Object (readonly)

Returns the value of attribute product_id.



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

def product_id
  @product_id
end

#src ⇒ Object (readonly)

Returns the value of attribute src.



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

def src
  @src
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#variant_ids ⇒ Object (readonly)

Returns the value of attribute variant_ids.



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

def variant_ids
  @variant_ids
end

#width ⇒ Object (readonly)

Returns the value of attribute width.



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

def width
  @width
end

Class Method Details

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



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

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

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

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



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

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

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



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/shopify_api/rest/resources/2022_04/image.rb', line 94

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

.find(id:, product_id: nil, fields: nil, session: ShopifyAPI::Context.active_session) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/shopify_api/rest/resources/2022_04/image.rb', line 73

def find(
  id:,
  product_id: nil,
  fields: nil,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id, product_id: product_id},
    params: {fields: fields},
  )
  T.cast(result[0], T.nilable(Image))
end