Class: PCPServerSDK::Endpoints::CommerceCaseApiClient

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

Instance Attribute Summary

Attributes inherited from BaseApiClient

#http_client

Instance Method Summary collapse

Constructor Details

#initialize(config, http_client = nil) ⇒ CommerceCaseApiClient

Returns a new instance of CommerceCaseApiClient.



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

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

Instance Method Details

#create_commerce_case_request(merchant_id, payload) ⇒ PCPServerSDK::Models::CreateCommerceCaseResponse

Create a commerce case

Parameters:

Returns:

Raises:

  • (TypeError) 


21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/commerce_case_api_client.rb', line 21

def create_commerce_case_request(merchant_id, payload)
  raise TypeError, MERCHANT_ID_REQUIRED_ERROR if merchant_id.nil? || merchant_id.empty?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases")
  
  request_init = {
    method: 'POST',
    headers: { 'Content-Type' => 'application/json; charset=utf-8' },
    body: JSON.generate(payload)
  }

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

#get_commerce_case_request(merchant_id, commerce_case_id) ⇒ PCPServerSDK::Models::CommerceCaseResponse

Get a commerce case

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

Returns:

Raises:

  • (TypeError) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/commerce_case_api_client.rb', line 40

def get_commerce_case_request(merchant_id, commerce_case_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?

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

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

#get_commerce_cases_request(merchant_id, query_params = nil) ⇒ Array<PCPServerSDK::Models::CommerceCaseResponse>

Get commerce cases

Parameters:

  • merchant_id (String) —

    The merchant identifier

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

    The query parameters

Returns:

Raises:

  • (TypeError) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/commerce_case_api_client.rb', line 59

def get_commerce_cases_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}/commerce-cases")
  
  if query_params
    url.query = URI.encode_www_form(query_params.to_query_map)
  end

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

  request = make_api_call(url.to_s, request_init)
  request.map { |r| deserialize_json(r, PCPServerSDK::Models::CommerceCaseResponse) }
end

#update_commerce_case_request(merchant_id, commerce_case_id, customer) ⇒ nil

Update a commerce case

Parameters:

  • merchant_id (String) —

    The merchant identifier

  • commerce_case_id (String) —

    The commerce case identifier

  • customer (PCPServerSDK::Models::Customer) —

    The customer

Returns:

  • (nil)

Raises:

  • (TypeError) 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/PCP-server-Ruby-SDK/endpoints/commerce_case_api_client.rb', line 82

def update_commerce_case_request(merchant_id, commerce_case_id, customer)
  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?

  url = URI.join(get_config.host, "/v1/#{merchant_id}/commerce-cases/#{commerce_case_id}")
  
  request_init = {
    method: 'PATCH',
    headers: { 'Content-Type' => 'application/json' },
    body: JSON.generate({ customer: customer })
  }

  make_api_call(url.to_s, request_init)
  nil
end