Class: ShopifyAPI::CarrierService

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

Returns a new instance of CarrierService.


12
13
14
15
16
17
18
19
20
21
22
23
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 12

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

  @active = T.let(nil, T.nilable(T::Boolean))
  @admin_graphql_api_id = T.let(nil, T.nilable(String))
  @callback_url = T.let(nil, T.nilable(String))
  @carrier_service_type = T.let(nil, T.nilable(String))
  @format = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @service_discovery = T.let(nil, T.nilable(T::Boolean))
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.


36
37
38
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 36

def active
  @active
end

#admin_graphql_api_idObject (readonly)

Returns the value of attribute admin_graphql_api_id.


38
39
40
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 38

def admin_graphql_api_id
  @admin_graphql_api_id
end

#callback_urlObject (readonly)

Returns the value of attribute callback_url.


40
41
42
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 40

def callback_url
  @callback_url
end

#carrier_service_typeObject (readonly)

Returns the value of attribute carrier_service_type.


42
43
44
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 42

def carrier_service_type
  @carrier_service_type
end

#formatObject (readonly)

Returns the value of attribute format.


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

def format
  @format
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#nameObject (readonly)

Returns the value of attribute name.


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

def name
  @name
end

#service_discoveryObject (readonly)

Returns the value of attribute service_discovery.


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

def service_discovery
  @service_discovery
end

Class Method Details

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


96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 96

def all(
  session: ShopifyAPI::Context.active_session,
  **kwargs
)
  response = base_find(
    session: session,
    ids: {},
    params: {}.merge(kwargs).compact,
  )

  T.cast(response, T::Array[CarrierService])
end

.delete(id:, session: ShopifyAPI::Context.active_session) ⇒ Object


77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 77

def delete(
  id:,
  session: ShopifyAPI::Context.active_session
)
  request(
    http_method: :delete,
    operation: :delete,
    session: session,
    ids: {id: id},
    params: {},
  )
end

.find(id:, session: ShopifyAPI::Context.active_session) ⇒ Object


59
60
61
62
63
64
65
66
67
68
69
# File 'lib/shopify_api/rest/resources/2021_07/carrier_service.rb', line 59

def find(
  id:,
  session: ShopifyAPI::Context.active_session
)
  result = base_find(
    session: session,
    ids: {id: id},
    params: {},
  )
  T.cast(result[0], T.nilable(CarrierService))
end