Class: PCPServerSDK::Endpoints::CheckoutApiClient

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

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ CheckoutApiClient

Returns a new instance of CheckoutApiClient.



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

def initialize(config)
  super(config)
end

Instance Method Details

#create_checkout_request(merchant_id, commerce_case_id, payload) ⇒ PCPServerSDK::Models::CreateCheckoutResponse

Create a checkout

Parameters:

Returns:

Raises:

  • (TypeError) 


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

def create_checkout_request(merchant_id, commerce_case_id, payload)
  raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
  raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
  raise TypeError, PAYLOAD_REQUIRED_ERROR if payload.nil?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts")
  
  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::CreateCheckoutResponse)
end

#get_checkout_request(merchant_id, commerce_case_id, checkout_id) ⇒ PCPServerSDK::Models::CheckoutResponse

Get a checkout

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

Returns:

Raises:

  • (TypeError) 


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

def get_checkout_request(merchant_id, commerce_case_id, checkout_id)
  raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
  raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
  raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}")
  
  request_init = {
    method: 'GET',
    headers: {}
  }

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

#get_checkouts_request(merchant_id, query_params = nil) ⇒ PCPServerSDK::Models::CheckoutsResponse

Get checkouts

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • query_params (PCPServerSDK::Models::GetCheckoutsQuery) (defaults to: nil) —

    The query parameters

Returns:

Raises:

  • (TypeError) 


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

def get_checkouts_request(merchant_id, query_params = nil)
  raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/checkouts")
  
  if query_params
    url.query = URI.encode_www_form(query_params.to_query_map)
  end

  request_init = {
    method: 'GET',
    headers: {}
  }

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

#remove_checkout_request(merchant_id, commerce_case_id, checkout_id) ⇒ nil

Remove a checkout

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

Returns:

  • (nil)

Raises:

  • (TypeError) 


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

def remove_checkout_request(merchant_id, commerce_case_id, checkout_id)
  raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
  raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
  raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}/checkouts/#{checkout_id}")
  
  request_init = {
    method: 'DELETE',
    headers: {}
  }

  make_api_call(url.to_s, request_init)
  nil
end

#update_checkout_request(merchant_id, commerce_case_id, checkout_id, payload) ⇒ nil

Update a checkout

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • checkout_id (String) —

    The checkout identifier

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

    The checkout request

Returns:

  • (nil)

Raises:

  • (TypeError) 


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

def update_checkout_request(merchant_id, commerce_case_id, checkout_id, payload)
  raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?
  raise TypeError, COMMERCE_CASE_ID_REQUIRED_ERROR if commerce_case_id.nil? || commerce_case_id.empty?
  raise TypeError, CHECKOUT_ID_REQUIRED_ERROR if checkout_id.nil? || checkout_id.empty?
  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}")
  
  request_init = {
    method: 'PATCH',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate(payload)
  }

  make_api_call(url.to_s, request_init)
  nil
end