class ShopifyAPI::DiscountCode
Attributes
Public Class Methods
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 112 def all( price_rule_id: nil, batch_id: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {price_rule_id: price_rule_id, batch_id: batch_id}, params: {}.merge(kwargs).compact, ) T.cast(response, T::Array[DiscountCode]) end
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 136 def count( times_used: nil, times_used_min: nil, times_used_max: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :count, session: session, ids: {}, params: {times_used: times_used, times_used_min: times_used_min, times_used_max: times_used_max}.merge(kwargs).compact, body: {}, entity: nil, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 90 def delete( id:, price_rule_id: nil, session: ShopifyAPI::Context.active_session ) request( http_method: :delete, operation: :delete, session: session, ids: {id: id, price_rule_id: price_rule_id}, params: {}, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 70 def find( id:, price_rule_id: nil, session: ShopifyAPI::Context.active_session ) result = base_find( session: session, ids: {id: id, price_rule_id: price_rule_id}, params: {}, ) T.cast(result[0], T.nilable(DiscountCode)) end
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 162 def get_all( price_rule_id: nil, batch_id: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :get_all, session: session, ids: {price_rule_id: price_rule_id, batch_id: batch_id}, params: {}.merge(kwargs).compact, body: {}, entity: nil, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 186 def lookup( code: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :lookup, session: session, ids: {}, params: {code: code}.merge(kwargs).compact, body: {}, entity: nil, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 19 def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) @code = T.let(nil, T.nilable(String)) @created_at = T.let(nil, T.nilable(String)) @errors = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped])) @id = T.let(nil, T.nilable(Integer)) @price_rule_id = T.let(nil, T.nilable(Integer)) @updated_at = T.let(nil, T.nilable(String)) @usage_count = T.let(nil, T.nilable(Integer)) super(session: session, from_hash: from_hash) end
Calls superclass method
ShopifyAPI::Rest::Base::new
Public Instance Methods
Source
# File lib/shopify_api/rest/resources/2022_04/discount_code.rb, line 210 def batch( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :batch, session: @session, ids: {price_rule_id: @price_rule_id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end