postfinancecheckout-ruby-sdk 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dd2db591c94ada9dcf5600600327c263a8901f93cdb34acf1a9362e9a9d6aaa
-  data.tar.gz: ac079d86662e21d00ccc09b2175033448b7be18529fe6acf4e27299f4c914201
+  metadata.gz: e04513d6cbd8bcf2756ad90ca734abb146541407857028b5eafda996d5f2940f
+  data.tar.gz: 262aaa159a6211ce7dfe769c15f6e20cf05d3f681420a27e913b4760ef734bbf
 SHA512:
-  metadata.gz: 5e2614000bd72c31572e9e24fb8bd8f009f4a657d62755a558efb0018618d7bb4a1d0d873540e54b9ec8b0260d60dfc72493055af28e7986cd64f1645648fa83
-  data.tar.gz: d3ef3c0a61c4725017ec29b732896299d805d88f496ce298e45e680acf7ccd3048b0e2a7db5d65bcc294edb7c0b8f42cc685f18704badc5718e1b439ca363301
+  metadata.gz: 8387cf0aa7338c96116bc6fb597dfa38a3c5cddc03098efee78aab691d33df003a93894ef58c634f3b4b9b19f982f70c4c436199755d6b7e28259fbb10cc606f
+  data.tar.gz: 11e2aeb66e8ec48a0d031fd21847814bd17fc162792aafae31a3332963fa91ecff3d1c55ffa80bd9c63558cf37aa34ba4fe02bbed757855a9f7a238e24e3fe8a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    postfinancecheckout-ruby-sdk (6.0.0)
+    postfinancecheckout-ruby-sdk (6.1.0)
       concurrent-ruby (~> 1.3.5)
       faraday (~> 2.13.1, < 3.0)
       faraday-multipart (~> 1.1.0)
@@ -19,21 +19,21 @@ GEM
       logger
     faraday-multipart (1.1.1)
       multipart-post (~> 2.0)
-    faraday-net_http (3.4.1)
-      net-http (>= 0.5.0)
-    json (2.15.2)
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    json (2.16.0)
     jwt (2.10.2)
       base64
     logger (1.7.0)
     marcel (1.0.4)
     multipart-post (2.4.1)
-    net-http (0.6.0)
+    net-http (0.7.0)
       uri
-    power_assert (2.0.5)
+    power_assert (3.0.1)
     rake (13.3.1)
     test-unit (3.6.9)
       power_assert
-    uri (1.0.4)
+    uri (1.1.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -99,9 +99,14 @@ Web API client: [*link*](https://checkout.postfinance.ch//api/client)<br>
   &nbsp;&nbsp;&nbsp;&nbsp;Deactivate an account
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
-  &nbsp;&nbsp;* <code>delete_analytics_queries_query_token</code>
-  &nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/{queryToken}
-  &nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution
+  &nbsp;&nbsp;* <code>delete_analytics_queries_query_external_id_query_external_id</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/queryExternalId/{queryExternalId}
+  &nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution, identifying it by its external id.
+  <br><br>
+- <strong>AnalyticsQueriesService</strong><br>
+  &nbsp;&nbsp;* <code>delete_analytics_queries_query_token_query_token</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>DELETE</strong> /analytics/queries/queryToken/{queryToken}
+  &nbsp;&nbsp;&nbsp;&nbsp;Cancel a query execution, identifying it by its query token.
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
   &nbsp;&nbsp;* <code>get_analytics_queries</code>
@@ -109,14 +114,24 @@ Web API client: [*link*](https://checkout.postfinance.ch//api/client)<br>
   &nbsp;&nbsp;&nbsp;&nbsp;Get portion of query executions for account
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
-  &nbsp;&nbsp;* <code>get_analytics_queries_query_token</code>
-  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/{queryToken}
-  &nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_external_id_query_external_id</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}
+  &nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information by its external id
+  <br><br>
+- <strong>AnalyticsQueriesService</strong><br>
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_external_id_query_external_id_result</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryExternalId/{queryExternalId}/result
+  &nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result. It retrieves the query by its external id
+  <br><br>
+- <strong>AnalyticsQueriesService</strong><br>
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_token_query_token</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryToken/{queryToken}
+  &nbsp;&nbsp;&nbsp;&nbsp;Retrieve a query execution information by its query token
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
-  &nbsp;&nbsp;* <code>get_analytics_queries_query_token_result</code>
-  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/{queryToken}/result
-  &nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result
+  &nbsp;&nbsp;* <code>get_analytics_queries_query_token_query_token_result</code>
+  &nbsp;&nbsp;&nbsp;&nbsp;<strong>GET</strong> /analytics/queries/queryToken/{queryToken}/result
+  &nbsp;&nbsp;&nbsp;&nbsp;Generate a temporary URL to download the query result. It retrieves the query by its query token
   <br><br>
 - <strong>AnalyticsQueriesService</strong><br>
   &nbsp;&nbsp;* <code>post_analytics_queries_submit</code>

data/lib/postfinancecheckout-ruby-sdk/api_client.rb

@@ -116,7 +116,7 @@ module PostfinancecheckoutRubySdk
       http_method = http_method.to_sym.downcase
 
       default_headers = {
-        'x-meta-sdk-version': "6.0.0",
+        'x-meta-sdk-version': "6.1.0",
         'x-meta-sdk-language': "ruby",
         'x-meta-sdk-provider': "postfinancecheckout",
         'x-meta-sdk-language-version': RUBY_VERSION

data/lib/postfinancecheckout-ruby-sdk/models/analytics_query_execution_request.rb

@@ -23,13 +23,13 @@ require 'time'
 
 module PostfinancecheckoutRubySdk
   class AnalyticsQueryExecutionRequest
-    # Optional. Active SFTP Dispatch connection settings ID (dispatch settings ID) associated with the target account. Only required if the Analytics query result file is scheduled for delivery to a remote SFTP server.
+    # Optional. ID of the active SFTP configuration to use (associated with the target account). This is only required if the result file is scheduled for delivery to a remote SFTP server.
     attr_accessor :sftp_dispatch_settings_id
 
-    # Optional. Renaming pattern for Analytics query result file (may be used when Analytics query results file is scheduled for SFTP delivery). Pattern may look like Latin alphabet string with some timestamp placeholder: \"transaction_report_{YYYMMDD_hhmmss}\". Supported placeholder formats are just these: DDMMYY , MMDDYY , YYYYMMDD , DD_MM_YY , DD-MM-YY , YYYY-MM-DD , YYYY_MM_DD , YYYYMMDD_hhmmss , YYYY-MM-DD_hh-mm-ss
+    # Optional. Renaming pattern used for the result file during SFTP delivery. You can use a combination of fixed Latin text and timestamp variables (e.g., \"transaction_report_{YYYMMDD_hhmmss}\"). Supported variable formats: DDMMYY, MMDDYY, YYYYMMDD, DD_MM_YY, DD-MM-YY, YYYY-MM-DD, YYYY_MM_DD, YYYYMMDD_hhmmss, YYYY-MM-DD_hh-mm-ss.
     attr_accessor :sftp_dispatch_result_file_rename_pattern
 
-    # The SQL query (in PrestoDB dialect) to be executed against the analytics database. This query defines the data retrieval operation.
+    # The SQL query (in PrestoDB dialect) to execute on the analytics database. This query defines exactly which data should be retrieved.
     attr_accessor :sql
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/submitted_analytics_query_execution.rb

@@ -23,6 +23,9 @@ require 'time'
 
 module PostfinancecheckoutRubySdk
   class SubmittedAnalyticsQueryExecution
+    # The external id associated with this query, if any.
+    attr_accessor :query_external_id
+
     # The ID of the target account for which the analytics query will be executed, determining the data scope for the request.
     attr_accessor :account_id
 
@@ -74,6 +77,7 @@ module PostfinancecheckoutRubySdk
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'query_external_id' => :'queryExternalId',
         :'account_id' => :'accountId',
         :'total_billed_execution_time_ms' => :'totalBilledExecutionTimeMs',
         :'created_timestamp' => :'createdTimestamp',
@@ -94,6 +98,7 @@ module PostfinancecheckoutRubySdk
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'query_external_id' => :'String',
         :'account_id' => :'Integer',
         :'total_billed_execution_time_ms' => :'Integer',
         :'created_timestamp' => :'Time',
@@ -127,6 +132,10 @@ module PostfinancecheckoutRubySdk
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'query_external_id')
+        self.query_external_id = attributes[:'query_external_id']
+      end
+
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
@@ -184,6 +193,7 @@ module PostfinancecheckoutRubySdk
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          query_external_id == o.query_external_id &&
           account_id == o.account_id &&
           total_billed_execution_time_ms == o.total_billed_execution_time_ms &&
           created_timestamp == o.created_timestamp &&
@@ -204,7 +214,7 @@ module PostfinancecheckoutRubySdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, total_billed_execution_time_ms, created_timestamp, download_requests, original_query, scanned_bytes, portal_query_token, result_file_bytes, status].hash
+      [query_external_id, account_id, total_billed_execution_time_ms, created_timestamp, download_requests, original_query, scanned_bytes, portal_query_token, result_file_bytes, status].hash
     end    # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself

data/lib/postfinancecheckout-ruby-sdk/service/analytics_queries_service.rb

@@ -28,36 +28,105 @@ module PostfinancecheckoutRubySdk
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Cancel a query execution
+    # Cancel a query execution, identifying it by its external id.
+    # @param query_external_id [String] Identifies the query execution.
+    # @param account [Integer] Specifies the ID of the account the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_analytics_queries_query_external_id_query_external_id(query_external_id, account, opts = {})
+      delete_analytics_queries_query_external_id_query_external_id_with_http_info(query_external_id, account, opts)
+      nil
+    end
+
+    # Cancel a query execution, identifying it by its external id.
+
+    # @param query_external_id [String] Identifies the query execution.
+    # @param account [Integer] Specifies the ID of the account the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_analytics_queries_query_external_id_query_external_id_with_http_info(query_external_id, account, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.delete_analytics_queries_query_external_id_query_external_id ...'
+      end
+      # verify the required parameter 'query_external_id' is set
+      if @api_client.config.client_side_validation && query_external_id.nil?
+        fail ArgumentError, "Missing the required parameter 'query_external_id' when calling AnalyticsQueriesService.delete_analytics_queries_query_external_id_query_external_id"
+      end
+      # verify the required parameter 'account' is set
+      if @api_client.config.client_side_validation && account.nil?
+        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.delete_analytics_queries_query_external_id_query_external_id"
+      end
+      # resource path
+      local_var_path = '/analytics/queries/queryExternalId/{queryExternalId}'.sub('{' + 'queryExternalId' + '}', CGI.escape(query_external_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'Account'] = account
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      new_options = opts.merge(
+        :operation => :"AnalyticsQueriesService.delete_analytics_queries_query_external_id_query_external_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueriesService#delete_analytics_queries_query_external_id_query_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Cancel a query execution, identifying it by its query token.
     # @param query_token [String] Identifies the query execution.
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_analytics_queries_query_token(query_token, account, opts = {})
-      delete_analytics_queries_query_token_with_http_info(query_token, account, opts)
+    def delete_analytics_queries_query_token_query_token(query_token, account, opts = {})
+      delete_analytics_queries_query_token_query_token_with_http_info(query_token, account, opts)
       nil
     end
 
-    # Cancel a query execution
+    # Cancel a query execution, identifying it by its query token.
 
     # @param query_token [String] Identifies the query execution.
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_analytics_queries_query_token_with_http_info(query_token, account, opts = {})
+    def delete_analytics_queries_query_token_query_token_with_http_info(query_token, account, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.delete_analytics_queries_query_token ...'
+        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.delete_analytics_queries_query_token_query_token ...'
       end
       # verify the required parameter 'query_token' is set
       if @api_client.config.client_side_validation && query_token.nil?
-        fail ArgumentError, "Missing the required parameter 'query_token' when calling AnalyticsQueriesService.delete_analytics_queries_query_token"
+        fail ArgumentError, "Missing the required parameter 'query_token' when calling AnalyticsQueriesService.delete_analytics_queries_query_token_query_token"
       end
       # verify the required parameter 'account' is set
       if @api_client.config.client_side_validation && account.nil?
-        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.delete_analytics_queries_query_token"
+        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.delete_analytics_queries_query_token_query_token"
       end
       # resource path
-      local_var_path = '/analytics/queries/{queryToken}'.sub('{' + 'queryToken' + '}', CGI.escape(query_token.to_s))
+      local_var_path = '/analytics/queries/queryToken/{queryToken}'.sub('{' + 'queryToken' + '}', CGI.escape(query_token.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -81,7 +150,7 @@ module PostfinancecheckoutRubySdk
       return_type = opts[:debug_return_type]
 
       new_options = opts.merge(
-        :operation => :"AnalyticsQueriesService.delete_analytics_queries_query_token",
+        :operation => :"AnalyticsQueriesService.delete_analytics_queries_query_token_query_token",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -91,7 +160,7 @@ module PostfinancecheckoutRubySdk
 
       data, status_code, headers = @api_client.call_api(:DELETE.to_sym.downcase, local_var_path, new_options, connection_timeout)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsQueriesService#delete_analytics_queries_query_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+        @api_client.config.logger.debug "API called: AnalyticsQueriesService#delete_analytics_queries_query_token_query_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
       end
       return data, status_code, headers
     end
@@ -174,38 +243,180 @@ module PostfinancecheckoutRubySdk
     end
 
 
-    # Retrieve a query execution information
+    # Retrieve a query execution information by its external id
+    # Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
+    # @param query_external_id [String] Identifies the query execution.
+    # @param account [Integer] Specifies the ID of the account the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [SubmittedAnalyticsQueryExecution]
+    def get_analytics_queries_query_external_id_query_external_id(query_external_id, account, opts = {})
+      data, _status_code, _headers = get_analytics_queries_query_external_id_query_external_id_with_http_info(query_external_id, account, opts)
+      data
+    end
+
+    # Retrieve a query execution information by its external id
+    # Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
+    # Timeout for this request is: 97 seconds.
+    # @param query_external_id [String] Identifies the query execution.
+    # @param account [Integer] Specifies the ID of the account the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubmittedAnalyticsQueryExecution, Integer, Hash)>] SubmittedAnalyticsQueryExecution data, response status code and response headers
+    def get_analytics_queries_query_external_id_query_external_id_with_http_info(query_external_id, account, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id ...'
+      end
+      # verify the required parameter 'query_external_id' is set
+      if @api_client.config.client_side_validation && query_external_id.nil?
+        fail ArgumentError, "Missing the required parameter 'query_external_id' when calling AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id"
+      end
+      # verify the required parameter 'account' is set
+      if @api_client.config.client_side_validation && account.nil?
+        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id"
+      end
+      # resource path
+      local_var_path = '/analytics/queries/queryExternalId/{queryExternalId}'.sub('{' + 'queryExternalId' + '}', CGI.escape(query_external_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'Account'] = account
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = 97
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubmittedAnalyticsQueryExecution'
+
+      new_options = opts.merge(
+        :operation => :"AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueriesService#get_analytics_queries_query_external_id_query_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Generate a temporary URL to download the query result. It retrieves the query by its external id
+    # Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the 'Retrieve a query execution' endpoint for status checks.
+    # @param query_external_id [String] Identifies the query execution.
+    # @param account [Integer] Specifies the ID of the account the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def get_analytics_queries_query_external_id_query_external_id_result(query_external_id, account, opts = {})
+      data, _status_code, _headers = get_analytics_queries_query_external_id_query_external_id_result_with_http_info(query_external_id, account, opts)
+      data
+    end
+
+    # Generate a temporary URL to download the query result. It retrieves the query by its external id
+    # Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the &#39;Retrieve a query execution&#39; endpoint for status checks.
+
+    # @param query_external_id [String] Identifies the query execution.
+    # @param account [Integer] Specifies the ID of the account the operation should be executed in.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def get_analytics_queries_query_external_id_query_external_id_result_with_http_info(query_external_id, account, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id_result ...'
+      end
+      # verify the required parameter 'query_external_id' is set
+      if @api_client.config.client_side_validation && query_external_id.nil?
+        fail ArgumentError, "Missing the required parameter 'query_external_id' when calling AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id_result"
+      end
+      # verify the required parameter 'account' is set
+      if @api_client.config.client_side_validation && account.nil?
+        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id_result"
+      end
+      # resource path
+      local_var_path = '/analytics/queries/queryExternalId/{queryExternalId}/result'.sub('{' + 'queryExternalId' + '}', CGI.escape(query_external_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json']) unless header_params['Accept']
+      header_params[:'Account'] = account
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # connection timeout
+      connection_timeout = @api_client.config.timeout
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      new_options = opts.merge(
+        :operation => :"AnalyticsQueriesService.get_analytics_queries_query_external_id_query_external_id_result",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueriesService#get_analytics_queries_query_external_id_query_external_id_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Retrieve a query execution information by its query token
     # Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
     # @param query_token [String] Identifies the query execution.
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param [Hash] opts the optional parameters
     # @return [SubmittedAnalyticsQueryExecution]
-    def get_analytics_queries_query_token(query_token, account, opts = {})
-      data, _status_code, _headers = get_analytics_queries_query_token_with_http_info(query_token, account, opts)
+    def get_analytics_queries_query_token_query_token(query_token, account, opts = {})
+      data, _status_code, _headers = get_analytics_queries_query_token_query_token_with_http_info(query_token, account, opts)
       data
     end
 
-    # Retrieve a query execution information
+    # Retrieve a query execution information by its query token
     # Queries are processed asynchronously and may take several minutes to complete. Avoid frequent requests, as they will not speed up processing.
     # Timeout for this request is: 97 seconds.
     # @param query_token [String] Identifies the query execution.
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SubmittedAnalyticsQueryExecution, Integer, Hash)>] SubmittedAnalyticsQueryExecution data, response status code and response headers
-    def get_analytics_queries_query_token_with_http_info(query_token, account, opts = {})
+    def get_analytics_queries_query_token_query_token_with_http_info(query_token, account, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.get_analytics_queries_query_token ...'
+        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.get_analytics_queries_query_token_query_token ...'
       end
       # verify the required parameter 'query_token' is set
       if @api_client.config.client_side_validation && query_token.nil?
-        fail ArgumentError, "Missing the required parameter 'query_token' when calling AnalyticsQueriesService.get_analytics_queries_query_token"
+        fail ArgumentError, "Missing the required parameter 'query_token' when calling AnalyticsQueriesService.get_analytics_queries_query_token_query_token"
       end
       # verify the required parameter 'account' is set
       if @api_client.config.client_side_validation && account.nil?
-        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.get_analytics_queries_query_token"
+        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.get_analytics_queries_query_token_query_token"
       end
       # resource path
-      local_var_path = '/analytics/queries/{queryToken}'.sub('{' + 'queryToken' + '}', CGI.escape(query_token.to_s))
+      local_var_path = '/analytics/queries/queryToken/{queryToken}'.sub('{' + 'queryToken' + '}', CGI.escape(query_token.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -229,7 +440,7 @@ module PostfinancecheckoutRubySdk
       return_type = opts[:debug_return_type] || 'SubmittedAnalyticsQueryExecution'
 
       new_options = opts.merge(
-        :operation => :"AnalyticsQueriesService.get_analytics_queries_query_token",
+        :operation => :"AnalyticsQueriesService.get_analytics_queries_query_token_query_token",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -239,44 +450,44 @@ module PostfinancecheckoutRubySdk
 
       data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsQueriesService#get_analytics_queries_query_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+        @api_client.config.logger.debug "API called: AnalyticsQueriesService#get_analytics_queries_query_token_query_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
       end
       return data, status_code, headers
     end
 
 
-    # Generate a temporary URL to download the query result
+    # Generate a temporary URL to download the query result. It retrieves the query by its query token
     # Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the 'Retrieve a query execution' endpoint for status checks.
     # @param query_token [String] Identifies the query execution.
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param [Hash] opts the optional parameters
     # @return [String]
-    def get_analytics_queries_query_token_result(query_token, account, opts = {})
-      data, _status_code, _headers = get_analytics_queries_query_token_result_with_http_info(query_token, account, opts)
+    def get_analytics_queries_query_token_query_token_result(query_token, account, opts = {})
+      data, _status_code, _headers = get_analytics_queries_query_token_query_token_result_with_http_info(query_token, account, opts)
       data
     end
 
-    # Generate a temporary URL to download the query result
+    # Generate a temporary URL to download the query result. It retrieves the query by its query token
     # Generate a short-lived (5-minute) URL for downloading the Analytics query result file. Note that each URL generation is counted as a potential download and will be billed accordingly. Do not use this endpoint for periodic checks of file availability. Instead, use the &#39;Retrieve a query execution&#39; endpoint for status checks.
 
     # @param query_token [String] Identifies the query execution.
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
-    def get_analytics_queries_query_token_result_with_http_info(query_token, account, opts = {})
+    def get_analytics_queries_query_token_query_token_result_with_http_info(query_token, account, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.get_analytics_queries_query_token_result ...'
+        @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.get_analytics_queries_query_token_query_token_result ...'
       end
       # verify the required parameter 'query_token' is set
       if @api_client.config.client_side_validation && query_token.nil?
-        fail ArgumentError, "Missing the required parameter 'query_token' when calling AnalyticsQueriesService.get_analytics_queries_query_token_result"
+        fail ArgumentError, "Missing the required parameter 'query_token' when calling AnalyticsQueriesService.get_analytics_queries_query_token_query_token_result"
       end
       # verify the required parameter 'account' is set
       if @api_client.config.client_side_validation && account.nil?
-        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.get_analytics_queries_query_token_result"
+        fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.get_analytics_queries_query_token_query_token_result"
       end
       # resource path
-      local_var_path = '/analytics/queries/{queryToken}/result'.sub('{' + 'queryToken' + '}', CGI.escape(query_token.to_s))
+      local_var_path = '/analytics/queries/queryToken/{queryToken}/result'.sub('{' + 'queryToken' + '}', CGI.escape(query_token.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -300,7 +511,7 @@ module PostfinancecheckoutRubySdk
       return_type = opts[:debug_return_type] || 'String'
 
       new_options = opts.merge(
-        :operation => :"AnalyticsQueriesService.get_analytics_queries_query_token_result",
+        :operation => :"AnalyticsQueriesService.get_analytics_queries_query_token_query_token_result",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -310,32 +521,38 @@ module PostfinancecheckoutRubySdk
 
       data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsQueriesService#get_analytics_queries_query_token_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
+        @api_client.config.logger.debug "API called: AnalyticsQueriesService#get_analytics_queries_query_token_query_token_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
       end
       return data, status_code, headers
     end
 
 
     # Submit a query execution
+    # @param query_external_id [String] A unique id to be provided for each query. The same id for different queries will be only executed the first time
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param analytics_query_execution_request [AnalyticsQueryExecutionRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AnalyticsQueryExecutionResponse]
-    def post_analytics_queries_submit(account, analytics_query_execution_request, opts = {})
-      data, _status_code, _headers = post_analytics_queries_submit_with_http_info(account, analytics_query_execution_request, opts)
+    def post_analytics_queries_submit(query_external_id, account, analytics_query_execution_request, opts = {})
+      data, _status_code, _headers = post_analytics_queries_submit_with_http_info(query_external_id, account, analytics_query_execution_request, opts)
       data
     end
 
     # Submit a query execution
 
+    # @param query_external_id [String] A unique id to be provided for each query. The same id for different queries will be only executed the first time
     # @param account [Integer] Specifies the ID of the account the operation should be executed in.
     # @param analytics_query_execution_request [AnalyticsQueryExecutionRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AnalyticsQueryExecutionResponse, Integer, Hash)>] AnalyticsQueryExecutionResponse data, response status code and response headers
-    def post_analytics_queries_submit_with_http_info(account, analytics_query_execution_request, opts = {})
+    def post_analytics_queries_submit_with_http_info(query_external_id, account, analytics_query_execution_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AnalyticsQueriesService.post_analytics_queries_submit ...'
       end
+      # verify the required parameter 'query_external_id' is set
+      if @api_client.config.client_side_validation && query_external_id.nil?
+        fail ArgumentError, "Missing the required parameter 'query_external_id' when calling AnalyticsQueriesService.post_analytics_queries_submit"
+      end
       # verify the required parameter 'account' is set
       if @api_client.config.client_side_validation && account.nil?
         fail ArgumentError, "Missing the required parameter 'account' when calling AnalyticsQueriesService.post_analytics_queries_submit"
@@ -349,6 +566,7 @@ module PostfinancecheckoutRubySdk
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'queryExternalId'] = query_external_id
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/postfinancecheckout-ruby-sdk/version.rb

@@ -19,5 +19,5 @@
 # limitations under the License.
 
 module PostfinancecheckoutRubySdk
-  VERSION = '6.0.0'
+  VERSION = '6.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postfinancecheckout-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.1.0
 platform: ruby
 authors:
 - wallee AG