Class: ShopifyAPI::CarrierService

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



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/shopify_api/rest/resources/2022_07/carrier_service.rb', line 16

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

#active ⇒ Object (readonly)

Returns the value of attribute active.



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

def active
  @active
end

#admin_graphql_api_id ⇒ Object (readonly)

Returns the value of attribute admin_graphql_api_id.



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

def admin_graphql_api_id
  @admin_graphql_api_id
end

#callback_url ⇒ Object (readonly)

Returns the value of attribute callback_url.



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

def callback_url
  @callback_url
end

#carrier_service_type ⇒ Object (readonly)

Returns the value of attribute carrier_service_type.



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

def carrier_service_type
  @carrier_service_type
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#service_discovery ⇒ Object (readonly)

Returns the value of attribute service_discovery.



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

def service_discovery
  @service_discovery
end

Class Method Details

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



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

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 



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

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 



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

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