class ShopifyAPI::GiftCard
Attributes
api_client_id[R]
balance[R]
code[R]
created_at[R]
currency[R]
customer_id[R]
disabled_at[R]
expires_on[R]
id[R]
initial_value[R]
last_characters[R]
line_item_id[R]
note[R]
order_id[R]
template_suffix[R]
updated_at[R]
user_id[R]
Public Class Methods
all( status: nil, limit: nil, since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs )
click to toggle source
# File lib/shopify_api/rest/resources/2022_04/gift_card.rb, line 121 def all( status: nil, limit: nil, since_id: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {}, params: {status: status, limit: limit, since_id: since_id, fields: fields}.merge(kwargs).compact, ) T.cast(response, T::Array[GiftCard]) end
count( status: nil, session: ShopifyAPI::Context.active_session, **kwargs )
click to toggle source
# File lib/shopify_api/rest/resources/2022_04/gift_card.rb, line 145 def count( status: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :count, session: session, ids: {}, params: {status: status}.merge(kwargs).compact, body: {}, entity: nil, ) end
find( id:, session: ShopifyAPI::Context.active_session )
click to toggle source
# File lib/shopify_api/rest/resources/2022_04/gift_card.rb, line 99 def find( id:, session: ShopifyAPI::Context.active_session ) result = base_find( session: session, ids: {id: id}, params: {}, ) T.cast(result[0], T.nilable(GiftCard)) end
new(session: ShopifyAPI::Context.active_session, from_hash: nil)
click to toggle source
Calls superclass method
ShopifyAPI::Rest::Base::new
# File lib/shopify_api/rest/resources/2022_04/gift_card.rb, line 19 def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) @api_client_id = T.let(nil, T.nilable(Integer)) @balance = T.let(nil, T.nilable(Balance)) @code = T.let(nil, T.nilable(String)) @created_at = T.let(nil, T.nilable(String)) @currency = T.let(nil, T.nilable(Currency)) @customer_id = T.let(nil, T.nilable(Integer)) @disabled_at = T.let(nil, T.nilable(String)) @expires_on = T.let(nil, T.nilable(String)) @id = T.let(nil, T.nilable(Integer)) @initial_value = T.let(nil, T.nilable(String)) @last_characters = T.let(nil, T.nilable(String)) @line_item_id = T.let(nil, T.nilable(Integer)) @note = T.let(nil, T.nilable(String)) @order_id = T.let(nil, T.nilable(Integer)) @template_suffix = T.let(nil, T.nilable(String)) @updated_at = T.let(nil, T.nilable(String)) @user_id = T.let(nil, T.nilable(Integer)) super(session: session, from_hash: from_hash) end
search( order: nil, query: nil, limit: nil, fields: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs )
click to toggle source
# File lib/shopify_api/rest/resources/2022_04/gift_card.rb, line 175 def search( order: nil, query: nil, limit: nil, fields: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :search, session: session, ids: {}, params: {order: order, query: query, limit: limit, fields: fields, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max}.merge(kwargs).compact, body: {}, entity: nil, ) end
Public Instance Methods
disable( body: nil, **kwargs )
click to toggle source
# File lib/shopify_api/rest/resources/2022_04/gift_card.rb, line 206 def disable( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :disable, session: @session, ids: {id: @id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end