class ShopifyAPI::Customer
Attributes
Public Class Methods
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 185 def all( ids: nil, since_id: nil, created_at_min: nil, created_at_max: nil, updated_at_min: nil, updated_at_max: nil, limit: nil, fields: nil, session: ShopifyAPI::Context.active_session, **kwargs ) response = base_find( session: session, ids: {}, params: {ids: ids, since_id: since_id, created_at_min: created_at_min, created_at_max: created_at_max, updated_at_min: updated_at_min, updated_at_max: updated_at_max, limit: limit, fields: fields}.merge(kwargs).compact, ) T.cast(response, T::Array[Customer]) end
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 216 def count( 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: :count, session: session, ids: {}, params: {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
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 158 def delete( id:, session: ShopifyAPI::Context.active_session ) request( http_method: :delete, operation: :delete, session: session, ids: {id: id}, params: {}, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 139 def find( id:, fields: nil, session: ShopifyAPI::Context.active_session ) result = base_find( session: session, ids: {id: id}, params: {fields: fields}, ) T.cast(result[0], T.nilable(Customer)) end
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 19 def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) @accepts_marketing = T.let(nil, T.nilable(T::Boolean)) @accepts_marketing_updated_at = T.let(nil, T.nilable(String)) @addresses = T.let(nil, T.nilable(T::Array[T.untyped])) @created_at = T.let(nil, T.nilable(String)) @currency = T.let(nil, T.nilable(String)) @default_address = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped])) @email = T.let(nil, T.nilable(String)) @email_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped])) @first_name = T.let(nil, T.nilable(String)) @id = T.let(nil, T.nilable(Integer)) @last_name = T.let(nil, T.nilable(String)) @last_order_id = T.let(nil, T.nilable(Integer)) @last_order_name = T.let(nil, T.nilable(String)) @marketing_opt_in_level = T.let(nil, T.nilable(String)) @metafield = T.let(nil, T.nilable(Metafield)) @multipass_identifier = T.let(nil, T.nilable(String)) @note = T.let(nil, T.nilable(String)) @orders_count = T.let(nil, T.nilable(Integer)) @password = T.let(nil, T.nilable(String)) @password_confirmation = T.let(nil, T.nilable(String)) @phone = T.let(nil, T.nilable(String)) @sms_marketing_consent = T.let(nil, T.nilable(T::Hash[T.untyped, T.untyped])) @state = T.let(nil, T.nilable(String)) @tags = T.let(nil, T.nilable(String)) @tax_exempt = T.let(nil, T.nilable(T::Boolean)) @tax_exemptions = T.let(nil, T.nilable(T::Array[T.untyped])) @total_spent = T.let(nil, T.nilable(String)) @updated_at = T.let(nil, T.nilable(String)) @verified_email = T.let(nil, T.nilable(T::Boolean)) super(session: session, from_hash: from_hash) end
Calls superclass method
ShopifyAPI::Rest::Base::new
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 243 def orders( id:, status: nil, session: ShopifyAPI::Context.active_session, **kwargs ) request( http_method: :get, operation: :orders, session: session, ids: {id: id}, params: {status: status}.merge(kwargs).compact, body: {}, entity: nil, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 270 def search( order: nil, query: nil, limit: nil, fields: 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}.merge(kwargs).compact, body: {}, entity: nil, ) end
Public Instance Methods
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 297 def account_activation_url( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :account_activation_url, session: @session, ids: {id: @id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end
Source
# File lib/shopify_api/rest/resources/2022_04/customer.rb, line 318 def send_invite( body: nil, **kwargs ) self.class.request( http_method: :post, operation: :send_invite, session: @session, ids: {id: @id}, params: {}.merge(kwargs).compact, body: body, entity: self, ) end