Class: ShopifyAPI::FulfillmentRequest

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

Returns a new instance of FulfillmentRequest.



19
20
21
22
23
24
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb', line 19

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

  @fulfillment_order_id = T.let(nil, T.nilable(Integer))

  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

#fulfillment_order_id ⇒ Object (readonly)

Returns the value of attribute fulfillment_order_id.



35
36
37
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb', line 35

def fulfillment_order_id
  @fulfillment_order_id
end

Class Method Details

.json_response_body_names ⇒ Object 



41
42
43
44
45
46
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb', line 41

def json_response_body_names()
  [
    "submitted_fulfillment_order",
    "fulfillment_order"
  ]
end

Instance Method Details

#accept(message: nil, body: nil, **kwargs) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb', line 57

def accept(
  message: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :accept,
    session: @session,
    ids: {fulfillment_order_id: @fulfillment_order_id},
    params: {message: message}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end

#reject(message: nil, reason: nil, line_items: nil, body: nil, **kwargs) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/shopify_api/rest/resources/2022_04/fulfillment_request.rb', line 82

def reject(
  message: nil,
  reason: nil,
  line_items: nil,
  body: nil,
  **kwargs
)
  self.class.request(
    http_method: :post,
    operation: :reject,
    session: @session,
    ids: {fulfillment_order_id: @fulfillment_order_id},
    params: {message: message, reason: reason, line_items: line_items}.merge(kwargs).compact,
    body: body,
    entity: self,
  )
end