Class: CyberSource::OrdersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/orders_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ OrdersApi

Returns a new instance of OrdersApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/orders_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/orders_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#create_order(create_order_request, opts = {}) ⇒ PtsV2CreateOrderPost201Response

Create an Order A create order request enables you to send the itemized details along with the order. This API can be used by merchants initiating their transactions with the create order API.

Parameters:

  • create_order_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/cybersource_rest_client/api/orders_api.rb', line 29

def create_order(create_order_request, opts = {})
  data, status_code, headers = create_order_with_http_info(create_order_request, opts)
  return data, status_code, headers
end

#create_order_with_http_info(create_order_request, opts = {}) ⇒ Array<(PtsV2CreateOrderPost201Response, Fixnum, Hash)>

Create an Order A create order request enables you to send the itemized details along with the order. This API can be used by merchants initiating their transactions with the create order API.

Parameters:

  • create_order_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cybersource_rest_client/api/orders_api.rb', line 39

def create_order_with_http_info(create_order_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: OrdersApi.create_order ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'create_order_request' is set
  if @api_client.config.client_side_validation && create_order_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_order_request' when calling OrdersApi.create_order"
  end
  # resource path
  local_var_path = 'pts/v2/intents'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_order_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreateOrderRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PtsV2CreateOrderPost201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: OrdersApi#create_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#update_order(id, update_order_request, opts = {}) ⇒ PtsV2UpdateOrderPatch201Response

Update an Order This API can be used in two flavours - for updating the order as well as saving the order.

Parameters:

  • id —

    The ID returned from the original create order response.

  • update_order_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



99
100
101
102
 
# File 'lib/cybersource_rest_client/api/orders_api.rb', line 99

def update_order(id, update_order_request, opts = {})
  data, status_code, headers = update_order_with_http_info(id, update_order_request, opts)
  return data, status_code, headers
end

#update_order_with_http_info(id, update_order_request, opts = {}) ⇒ Array<(PtsV2UpdateOrderPatch201Response, Fixnum, Hash)>

Update an Order This API can be used in two flavours - for updating the order as well as saving the order.

Parameters:

  • id —

    The ID returned from the original create order response.

  • update_order_request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/cybersource_rest_client/api/orders_api.rb', line 110

def update_order_with_http_info(id, update_order_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: OrdersApi.update_order ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.update_order"
  end
  # verify the required parameter 'update_order_request' is set
  if @api_client.config.client_side_validation && update_order_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_order_request' when calling OrdersApi.update_order"
  end
  # resource path
  local_var_path = 'pts/v2/intents/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(update_order_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'UpdateOrderRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PtsV2UpdateOrderPatch201Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: OrdersApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end