first_data_gateway 1.2.0 → 1.3.0

data/lib/openapi_client/api/order_api.rb

@@ -3,7 +3,7 @@
 
 #The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
 
-OpenAPI spec version: 6.6.0.20190329.001
+The version of the OpenAPI document: 6.6.0.20190507.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -21,11 +21,11 @@ module OpenapiClient
     end
     # Retrieve the state of an order.
     # Use this query to get the current state of an existing order.
-    # @param content_type Content type.
-    # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param order_id Gateway order identifier as returned in the parameter orderId.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param order_id [String] Gateway order identifier as returned in the parameter orderId.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
     # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
@@ -38,16 +38,16 @@ module OpenapiClient
 
     # Retrieve the state of an order.
     # Use this query to get the current state of an existing order.
-    # @param content_type Content type.
-    # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param order_id Gateway order identifier as returned in the parameter orderId.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param order_id [String] Gateway order identifier as returned in the parameter orderId.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
     # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
     # @option opts [String] :store_id An optional outlet ID for clients that support multiple stores in the same developer app.
-    # @return [Array<(OrderResponse, Fixnum, Hash)>] OrderResponse data, response status code and response headers
+    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
     def order_inquiry_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OrderApi.order_inquiry ...'
@@ -57,8 +57,9 @@ module OpenapiClient
         fail ArgumentError, "Missing the required parameter 'content_type' when calling OrderApi.order_inquiry"
       end
       # verify enum value
-      if @api_client.config.client_side_validation && !['application/json'].include?(content_type)
-        fail ArgumentError, "invalid value for 'content_type', must be one of application/json"
+      allowable_values = ["application/json"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
+        fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
       end
       # verify the required parameter 'client_request_id' is set
       if @api_client.config.client_side_validation && client_request_id.nil?
@@ -80,11 +81,11 @@ module OpenapiClient
       local_var_path = '/orders/{order-id}'.sub('{' + 'order-id' + '}', order_id.to_s)
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
       query_params[:'storeId'] = opts[:'store_id'] if !opts[:'store_id'].nil?
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # header_params[:'Content-Type'] = content_type
@@ -95,12 +96,18 @@ module OpenapiClient
       header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'OrderResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -108,6 +115,8 @@ module OpenapiClient
         :auth_names => auth_names,
         :return_type => 'OrderResponse',
         :default_error_type => 'ErrorResponse')
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OrderApi#order_inquiry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -116,12 +125,12 @@ module OpenapiClient
 
     # Perform return or postAuth secondary transactions.
     # Use this to perform a postAuth or return secondary transaction using order ID. Partial postAuths and returns are allowed.
-    # @param content_type Content type.
-    # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param order_id Gateway order identifier as returned in the parameter orderId.
-    # @param secondary_transaction Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param order_id [String] Gateway order identifier as returned in the parameter orderId.
+    # @param secondary_transaction [SecondaryTransaction] Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
     # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
@@ -133,16 +142,16 @@ module OpenapiClient
 
     # Perform return or postAuth secondary transactions.
     # Use this to perform a postAuth or return secondary transaction using order ID. Partial postAuths and returns are allowed.
-    # @param content_type Content type.
-    # @param client_request_id A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param order_id Gateway order identifier as returned in the parameter orderId.
-    # @param secondary_transaction Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction.
+    # @param content_type [String] Content type.
+    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
+    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
+    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @param order_id [String] Gateway order identifier as returned in the parameter orderId.
+    # @param secondary_transaction [SecondaryTransaction] Accepted request types: PostAuthTransaction, VoidTransaction, and ReturnTransaction.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
     # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-    # @return [Array<(TransactionResponse, Fixnum, Hash)>] TransactionResponse data, response status code and response headers
+    # @return [Array<(TransactionResponse, Integer, Hash)>] TransactionResponse data, response status code and response headers
     def submit_secondary_transaction_from_order_with_http_info(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: OrderApi.submit_secondary_transaction_from_order ...'
@@ -152,8 +161,9 @@ module OpenapiClient
         fail ArgumentError, "Missing the required parameter 'content_type' when calling OrderApi.submit_secondary_transaction_from_order"
       end
       # verify enum value
-      if @api_client.config.client_side_validation && !['application/json'].include?(content_type)
-        fail ArgumentError, "invalid value for 'content_type', must be one of application/json"
+      allowable_values = ["application/json"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
+        fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
       end
       # verify the required parameter 'client_request_id' is set
       if @api_client.config.client_side_validation && client_request_id.nil?
@@ -179,10 +189,10 @@ module OpenapiClient
       local_var_path = '/orders/{order-id}'.sub('{' + 'order-id' + '}', order_id.to_s)
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
@@ -195,12 +205,18 @@ module OpenapiClient
       header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(secondary_transaction)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:body] || @api_client.object_to_http_body(secondary_transaction) 
+
+      # return_type
+      return_type = opts[:return_type] || 'TransactionResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -209,11 +225,12 @@ module OpenapiClient
         :return_type => 'TransactionResponse',
         :default_error_type => 'ErrorResponse',
         :error_type => 'TransactionErrorResponse')
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: OrderApi#submit_secondary_transaction_from_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
-
   end
 end