Class: ShopifyAPI::FulfillmentService

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

Returns a new instance of FulfillmentService.



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

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

  @admin_graphql_api_id = T.let(nil, T.nilable(String))
  @callback_url = T.let(nil, T.nilable(String))
  @format = T.let(nil, T.nilable(String))
  @fulfillment_orders_opt_in = T.let(nil, T.nilable(T::Boolean))
  @handle = T.let(nil, T.nilable(String))
  @id = T.let(nil, T.nilable(Integer))
  @inventory_management = T.let(nil, T.nilable(T::Boolean))
  @location_id = T.let(nil, T.nilable(Integer))
  @name = T.let(nil, T.nilable(String))
  @provider_id = T.let(nil, T.nilable(String))
  @requires_shipping_method = T.let(nil, T.nilable(T::Boolean))
  @tracking_support = 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

#admin_graphql_api_id ⇒ Object (readonly)

Returns the value of attribute admin_graphql_api_id.



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

def admin_graphql_api_id
  @admin_graphql_api_id
end

#callback_url ⇒ Object (readonly)

Returns the value of attribute callback_url.



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

def callback_url
  @callback_url
end

#format ⇒ Object (readonly)

Returns the value of attribute format.



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

def format
  @format
end

#fulfillment_orders_opt_in ⇒ Object (readonly)

Returns the value of attribute fulfillment_orders_opt_in.



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

def fulfillment_orders_opt_in
  @fulfillment_orders_opt_in
end

#handle ⇒ Object (readonly)

Returns the value of attribute handle.



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

def handle
  @handle
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#inventory_management ⇒ Object (readonly)

Returns the value of attribute inventory_management.



60
61
62
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 60

def inventory_management
  @inventory_management
end

#location_id ⇒ Object (readonly)

Returns the value of attribute location_id.



62
63
64
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 62

def location_id
  @location_id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



64
65
66
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 64

def name
  @name
end

#permits_sku_sharing ⇒ Object (readonly)

Returns the value of attribute permits_sku_sharing.



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

def permits_sku_sharing
  @permits_sku_sharing
end

#provider_id ⇒ Object (readonly)

Returns the value of attribute provider_id.



66
67
68
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 66

def provider_id
  @provider_id
end

#requires_shipping_method ⇒ Object (readonly)

Returns the value of attribute requires_shipping_method.



68
69
70
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 68

def requires_shipping_method
  @requires_shipping_method
end

#tracking_support ⇒ Object (readonly)

Returns the value of attribute tracking_support.



70
71
72
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 70

def tracking_support
  @tracking_support
end

Class Method Details

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



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_service.rb', line 117

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

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

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



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

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 



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

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