Class: ShopifyAPI::CarrierService

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

api_call_limit, base_find, class_name, create_instance, create_instances_from_response, #delete, get_path, get_path_ids, has_many?, has_one?, inherited, json_body_name, json_response_body_names, #method_missing, next_page?, next_page_info, prev_page?, prev_page_info, primary_key, read_only_attributes, request, #respond_to_missing?, retry_request_after, #save, #save!, #to_hash

Constructor Details

#initialize(session: ShopifyAPI::Context.active_session, from_hash: nil) ⇒ CarrierService

Returns a new instance of CarrierService.



19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 19

def initialize(session: ShopifyAPI::Context.active_session, from_hash: nil)

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

  super(session: session, from_hash: from_hash)
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.



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

def active
  @active
end

#admin_graphql_api_id ⇒ Object (readonly)

Returns the value of attribute admin_graphql_api_id.



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

def admin_graphql_api_id
  @admin_graphql_api_id
end

#callback_url ⇒ Object (readonly)

Returns the value of attribute callback_url.



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

def callback_url
  @callback_url
end

#carrier_service_type ⇒ Object (readonly)

Returns the value of attribute carrier_service_type.



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

def carrier_service_type
  @carrier_service_type
end

#format ⇒ Object (readonly)

Returns the value of attribute format.



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

def format
  @format
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



54
55
56
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 54

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



56
57
58
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 56

def name
  @name
end

#service_discovery ⇒ Object (readonly)

Returns the value of attribute service_discovery.



58
59
60
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 58

def service_discovery
  @service_discovery
end

Class Method Details

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



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 104

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 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 85

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 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shopify_api/rest/resources/2022_04/carrier_service.rb', line 67

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