Class: ShopifyAPI::Image

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

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

Returns a new instance of Image.


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

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

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

Dynamic Method Handling

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

Instance Attribute Details

#created_atObject (readonly)

Returns the value of attribute created_at.


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

def created_at
  @created_at
end

#heightObject (readonly)

Returns the value of attribute height.


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

def height
  @height
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#positionObject (readonly)

Returns the value of attribute position.


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

def position
  @position
end

#product_idObject (readonly)

Returns the value of attribute product_id.


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

def product_id
  @product_id
end

#srcObject (readonly)

Returns the value of attribute src.


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

def src
  @src
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


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

def updated_at
  @updated_at
end

#variant_idsObject (readonly)

Returns the value of attribute variant_ids.


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

def variant_ids
  @variant_ids
end

#widthObject (readonly)

Returns the value of attribute width.


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

def width
  @width
end

Class Method Details

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


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

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


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

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


86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/shopify_api/rest/resources/2021_07/image.rb', line 86

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


65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/shopify_api/rest/resources/2021_07/image.rb', line 65

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