Class: ShopifyAPI::FulfillmentService

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

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

Returns a new instance of FulfillmentService.


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

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

  @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))
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_idObject (readonly)

Returns the value of attribute admin_graphql_api_id.


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

def admin_graphql_api_id
  @admin_graphql_api_id
end

#callback_urlObject (readonly)

Returns the value of attribute callback_url.


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

def callback_url
  @callback_url
end

#formatObject (readonly)

Returns the value of attribute format.


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

def format
  @format
end

#fulfillment_orders_opt_inObject (readonly)

Returns the value of attribute fulfillment_orders_opt_in.


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

def fulfillment_orders_opt_in
  @fulfillment_orders_opt_in
end

#handleObject (readonly)

Returns the value of attribute handle.


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

def handle
  @handle
end

#idObject (readonly)

Returns the value of attribute id.


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

def id
  @id
end

#inventory_managementObject (readonly)

Returns the value of attribute inventory_management.


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

def inventory_management
  @inventory_management
end

#location_idObject (readonly)

Returns the value of attribute location_id.


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

def location_id
  @location_id
end

#nameObject (readonly)

Returns the value of attribute name.


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

def name
  @name
end

#provider_idObject (readonly)

Returns the value of attribute provider_id.


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

def provider_id
  @provider_id
end

#requires_shipping_methodObject (readonly)

Returns the value of attribute requires_shipping_method.


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

def requires_shipping_method
  @requires_shipping_method
end

#tracking_supportObject (readonly)

Returns the value of attribute tracking_support.


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

def tracking_support
  @tracking_support
end

Class Method Details

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


109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'lib/shopify_api/rest/resources/2021_07/fulfillment_service.rb', line 109

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


89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/shopify_api/rest/resources/2021_07/fulfillment_service.rb', line 89

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


71
72
73
74
75
76
77
78
79
80
81
# File 'lib/shopify_api/rest/resources/2021_07/fulfillment_service.rb', line 71

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