class ShopifyAPI::Location

Attributes

active[R]
address1[R]
address2[R]
city[R]
country[R]
country_code[R]
created_at[R]
id[R]
legacy[R]
localized_country_name[R]
localized_province_name[R]
name[R]
phone[R]
province[R]
province_code[R]
updated_at[R]
zip[R]

Public Class Methods

all( session: ShopifyAPI::Context.active_session, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/location.rb, line 111
def all(
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[Location])
end
count( session: ShopifyAPI::Context.active_session, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/location.rb, line 130
def count(
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :count,
    session: session,
    ids: {},
    params: {}.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/location.rb, line 93
def find(
  id:,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id},
    params: {},
  )
  T.cast(result[0], T.nilable(Location))
end
inventory_levels( id:, session: ShopifyAPI::Context.active_session, **kwargs ) click to toggle source
# File lib/shopify_api/rest/resources/2022_04/location.rb, line 152
def inventory_levels(
  id:,
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  request(
    http_method: :get,
    operation: :inventory_levels,
    session: session,
    ids: {id: id},
    params: {}.merge(kwargs).compact,
    body: {},
    entity: nil,
  )
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/location.rb, line 19
def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

  @active = T.let(nil, T.nilable(T::Boolean))
  @address1 = T.let(nil, T.nilable(String))
  @address2 = T.let(nil, T.nilable(String))
  @city = T.let(nil, T.nilable(String))
  @country = T.let(nil, T.nilable(String))
  @country_code = T.let(nil, T.nilable(String))
  @created_at = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @legacy = T.let(nil, T.nilable(T::Boolean))
  @localized_country_name = T.let(nil, T.nilable(String))
  @localized_province_name = T.let(nil, T.nilable(String))
  @name = T.let(nil, T.nilable(String))
  @phone = T.let(nil, T.nilable(String))
  @province = T.let(nil, T.nilable(String))
  @province_code = T.let(nil, T.nilable(String))
  @updated_at = T.let(nil, T.nilable(String))
  @zip = T.let(nil, T.nilable(String))

  super(session: session, from_hash: from_hash)
end