Class: PCPServerSDK::Endpoints::OrderManagementCheckoutActionsApiClient

Inherits:
BaseApiClient
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb

Instance Attribute Summary

Attributes inherited from BaseApiClient

#http_client

Instance Method Summary collapse

Constructor Details

#initialize(config, http_client = nil) ⇒ OrderManagementCheckoutActionsApiClient

Returns a new instance of OrderManagementCheckoutActionsApiClient.



14
15
16
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb', line 14

def initialize(config, http_client = nil)
  super(config, http_client)
end

Instance Method Details

#cancel_order(merchant_id, commerce_case_id, checkout_id, payload) ⇒ PCPServerSDK::Models::CancelResponse

Cancel an order

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

  • payload (PCPServerSDK::Models::CancelRequest) —

    The cancel request

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb', line 111

def cancel_order(merchant_id, commerce_case_id, checkout_id, payload)
  validate_ids(merchant_id, commerce_case_id, checkout_id)

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/cancel")

  request_init = {
    method: 'POST',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate(payload)
  }

  response = make_api_call(url.to_s, request_init)
  deserialize_json(response, PCPServerSDK::Models::CancelResponse)
end

#complete_order(merchant_id, commerce_case_id, checkout_id, payload) ⇒ PCPServerSDK::Models::CompletePaymentResponse

Complete an order

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

  • payload (PCPServerSDK::Models::CompleteOrderRequest) —

    The complete order request

Returns:

Raises:

  • (TypeError) 


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb', line 46

def complete_order(merchant_id, commerce_case_id, checkout_id, payload)
  validate_ids(merchant_id, commerce_case_id, checkout_id)
  raise TypeError, PAYLOAD_REQUIRED_ERROR if payload.nil?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/complete-order")

  request_init = {
    method: 'POST',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate(payload)
  }

  response = make_api_call(url.to_s, request_init)
  deserialize_json(response, PCPServerSDK::Models::CompletePaymentResponse)
end

#create_order(merchant_id, commerce_case_id, checkout_id, payload) ⇒ PCPServerSDK::Models::OrderResponse

Create an order

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

  • payload (PCPServerSDK::Models::OrderRequest) —

    The order request

Returns:

Raises:

  • (TypeError) 


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb', line 24

def create_order(merchant_id, commerce_case_id, checkout_id, payload)
  validate_ids(merchant_id, commerce_case_id, checkout_id)
  raise TypeError, PAYLOAD_REQUIRED_ERROR if payload.nil?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/order")

  request_init = {
    method: 'POST',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate(payload)
  }

  response = make_api_call(url.to_s, request_init)
  deserialize_json(response, PCPServerSDK::Models::OrderResponse)
end

#deliver_order(merchant_id, commerce_case_id, checkout_id, payload) ⇒ PCPServerSDK::Models::DeliverResponse

Deliver an order

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

  • payload (PCPServerSDK::Models::DeliverRequest) —

    The deliver request

Returns:

Raises:

  • (TypeError) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb', line 68

def deliver_order(merchant_id, commerce_case_id, checkout_id, payload)
  validate_ids(merchant_id, commerce_case_id, checkout_id)
  raise TypeError, PAYLOAD_REQUIRED_ERROR if payload.nil?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/deliver")

  request_init = {
    method: 'POST',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate(payload)
  }

  response = make_api_call(url.to_s, request_init)
  deserialize_json(response, PCPServerSDK::Models::DeliverResponse)
end

#return_order(merchant_id, commerce_case_id, checkout_id, payload) ⇒ PCPServerSDK::Models::ReturnResponse

Return an order

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

  • payload (PCPServerSDK::Models::ReturnRequest) —

    The return request

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/order_management_checkout_actions_api_client.rb', line 90

def return_order(merchant_id, commerce_case_id, checkout_id, payload)
  validate_ids(merchant_id, commerce_case_id, checkout_id)

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}/return")

  request_init = {
    method: 'POST',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate(payload)
  }

  response = make_api_call(url.to_s, request_init)
  deserialize_json(response, PCPServerSDK::Models::ReturnResponse)
end