Class: ShopifyAPI::Location

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

Returns a new instance of Location.


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 12

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

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

Dynamic Method Handling

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

Instance Attribute Details

#activeObject (readonly)

Returns the value of attribute active.


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

def active
  @active
end

#address1Object (readonly)

Returns the value of attribute address1.


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

def address1
  @address1
end

#address2Object (readonly)

Returns the value of attribute address2.


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

def address2
  @address2
end

#cityObject (readonly)

Returns the value of attribute city.


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

def city
  @city
end

#countryObject (readonly)

Returns the value of attribute country.


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

def country
  @country
end

#country_codeObject (readonly)

Returns the value of attribute country_code.


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

def country_code
  @country_code
end

#created_atObject (readonly)

Returns the value of attribute created_at.


56
57
58
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 56

def created_at
  @created_at
end

#idObject (readonly)

Returns the value of attribute id.


58
59
60
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 58

def id
  @id
end

#legacyObject (readonly)

Returns the value of attribute legacy.


60
61
62
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 60

def legacy
  @legacy
end

#localized_country_nameObject (readonly)

Returns the value of attribute localized_country_name.


62
63
64
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 62

def localized_country_name
  @localized_country_name
end

#localized_province_nameObject (readonly)

Returns the value of attribute localized_province_name.


64
65
66
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 64

def localized_province_name
  @localized_province_name
end

#nameObject (readonly)

Returns the value of attribute name.


66
67
68
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 66

def name
  @name
end

#phoneObject (readonly)

Returns the value of attribute phone.


68
69
70
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 68

def phone
  @phone
end

#provinceObject (readonly)

Returns the value of attribute province.


70
71
72
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 70

def province
  @province
end

#province_codeObject (readonly)

Returns the value of attribute province_code.


72
73
74
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 72

def province_code
  @province_code
end

#updated_atObject (readonly)

Returns the value of attribute updated_at.


74
75
76
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 74

def updated_at
  @updated_at
end

#zipObject (readonly)

Returns the value of attribute zip.


76
77
78
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 76

def zip
  @zip
end

Class Method Details

.all(session: ShopifyAPI::Context.active_session, **kwargs) ⇒ Object


103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 103

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


122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 122

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


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

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


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/shopify_api/rest/resources/2021_07/location.rb', line 144

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