postfinancecheckout-ruby-sdk 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50b4017d8354bbbb5950cfd5904f01d5ae4a6fc2
-  data.tar.gz: 81a95ec22f1f361c5a2a001114dac00c77a0acf3
+  metadata.gz: fe47f059c81b6761cfd9fb7e0a42401b2009d8cf
+  data.tar.gz: c0203015d18d0ac365b42f4b98dd3566c73cb0c9
 SHA512:
-  metadata.gz: 73753905830f923a2322cccada648bf36b932f79d52f323ab0b1fe32ff296cbad307b0c0636b8fc05a160eb8b41b32c434f604132ad1523a3edcfade8e8fa0ce
-  data.tar.gz: 22735830e6de0ce1dcc5dc1486959f6c2f43751f442ac14640469edbd23f30714823b3f22f61f2e6373e6a11e4a08753f0896bbd858dff464562eb680099e1d3
+  metadata.gz: ef7c006c7e6ba469ed5aad3b05125cccc20b3227ea3d47f7a31696af6f37f548c75a5a39ce900c6f45018e527a7f7eef8285ecb2c6699eb0585820587422883b
+  data.tar.gz: 07fbccd5c3b759f19c52e151857b1847c06043252ab972452e77de4b1bdcd732eb8d32867d8043347c38bb1a23ca4c4ae083aee6ec4d79bf647b13499debd555

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    postfinancecheckout-ruby-sdk (3.1.4)
+    postfinancecheckout-ruby-sdk (3.2.0)
       addressable (~> 2.3, >= 2.3.0)
       json (~> 2.3, >= 2.3.0)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -9,8 +9,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ethon (0.15.0)
       ffi (>= 1.15.0)
     ffi (1.15.5)
@@ -32,4 +32,4 @@ DEPENDENCIES
   test-unit (~> 3.2.5)
 
 BUNDLED WITH
-   2.3.19
+   2.3.22

data/README.md

@@ -20,7 +20,7 @@ $ gem install postfinancecheckout-ruby-sdk
 
 ## Usage
 The library needs to be configured with your account's space id, user id, and secret key which are available in your [PostFinance Checkout
-account dashboard](https://checkout.postfinance.ch/account/select). Set `space_id`, `user_id`, and `api_secret` to their values:
+account dashboard](https://checkout.postfinance.ch/account/select). Set `space_id`, `user_id`, and `api_secret` to their values. You can also optionally set `default_headers` to set some headers that will be sent to all requests:
 
 ### Configuring a Service
 
@@ -31,9 +31,11 @@ space_id = 405
 app_user_id = 512
 app_user_key = "FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ="
 
+# default_headers is an optional param, that represents headers sent to all requests
 PostFinanceCheckout.configure do |config|
   config.user_id = app_user_id
   config.authentication_key = app_user_key
+  config.default_headers = {"x-meta-custom-header": 'value-1', "x-meta-custom-header-2": 'value-2'}
 end
 
 # TransactionService

data/lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb

@@ -0,0 +1,381 @@
+=begin
+The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module PostFinanceCheckout
+  class AnalyticsQueryService
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Cancel Execution
+    # Cancels the specified query execution.
+    # @param id The ID of the query execution to cancel.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def cancel_execution(id, opts = {})
+      cancel_execution_with_http_info(id, opts)
+      return nil
+    end
+
+    # Cancel Execution
+    # Cancels the specified query execution.
+    # @param id The ID of the query execution to cancel.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def cancel_execution_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsQueryService.cancel_execution ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.cancel_execution" if id.nil?
+      # resource path
+      local_var_path = "/analytics-query/cancel-execution".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueryService#cancel_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch Result
+    # Fetches one batch of the result of a query execution.
+    # @param id The ID of the query execution for which to fetch the result.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :timeout The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.
+    # @option opts [Integer] :max_rows The maximum number of rows to return per batch. (Between 1 and 999. The default is 999.)
+    # @option opts [String] :next_token The next-token of the preceding batch to get the next result batch or null to get the first result batch.
+    # @return [AnalyticsQueryResultBatch]
+    def fetch_result(id, opts = {})
+      data, _status_code, _headers = fetch_result_with_http_info(id, opts)
+      return data
+    end
+
+    # Fetch Result
+    # Fetches one batch of the result of a query execution.
+    # @param id The ID of the query execution for which to fetch the result.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :timeout The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.
+    # @option opts [Integer] :max_rows The maximum number of rows to return per batch. (Between 1 and 999. The default is 999.)
+    # @option opts [String] :next_token The next-token of the preceding batch to get the next result batch or null to get the first result batch.
+    # @return [Array<(AnalyticsQueryResultBatch, Fixnum, Hash)>] AnalyticsQueryResultBatch data, response status code and response headers
+    def fetch_result_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsQueryService.fetch_result ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.fetch_result" if id.nil?
+      # resource path
+      local_var_path = "/analytics-query/fetch-result".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
+      query_params[:'maxRows'] = opts[:'max_rows'] if !opts[:'max_rows'].nil?
+      query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AnalyticsQueryResultBatch')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueryService#fetch_result\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Generate Download URL
+    # Generate a URL from which the results of a query execution can be downloaded in CSV format.
+    # @param id The ID of the query execution for which to generate the download URL.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :timeout The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.
+    # @return [String]
+    def generate_download_url(id, opts = {})
+      data, _status_code, _headers = generate_download_url_with_http_info(id, opts)
+      return data
+    end
+
+    # Generate Download URL
+    # Generate a URL from which the results of a query execution can be downloaded in CSV format.
+    # @param id The ID of the query execution for which to generate the download URL.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :timeout The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def generate_download_url_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsQueryService.generate_download_url ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.generate_download_url" if id.nil?
+      # resource path
+      local_var_path = "/analytics-query/generate-download-url".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['text/plain']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueryService#generate_download_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Schemas
+    # Get the schemas describing the available tables and their columns.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<AnalyticsSchemaTable>]
+    def schema(opts = {})
+      data, _status_code, _headers = schema_with_http_info(opts)
+      return data
+    end
+
+    # Get Schemas
+    # Get the schemas describing the available tables and their columns.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<AnalyticsSchemaTable>, Fixnum, Hash)>] Array<AnalyticsSchemaTable> data, response status code and response headers
+    def schema_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsQueryService.schema ..."
+      end
+      # resource path
+      local_var_path = "/analytics-query/schema".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<AnalyticsSchemaTable>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueryService#schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Execution Status
+    # Returns the current status of a query execution.
+    # @param id The ID of the query execution for which to get the status.
+    # @param [Hash] opts the optional parameters
+    # @return [AnalyticsQueryExecution]
+    def status(id, opts = {})
+      data, _status_code, _headers = status_with_http_info(id, opts)
+      return data
+    end
+
+    # Execution Status
+    # Returns the current status of a query execution.
+    # @param id The ID of the query execution for which to get the status.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnalyticsQueryExecution, Fixnum, Hash)>] AnalyticsQueryExecution data, response status code and response headers
+    def status_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsQueryService.status ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.status" if id.nil?
+      # resource path
+      local_var_path = "/analytics-query/status".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['*/*']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AnalyticsQueryExecution')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueryService#status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Submit Query
+    # Submits a query for execution.
+    # @param query The query to submit.
+    # @param [Hash] opts the optional parameters
+    # @return [AnalyticsQueryExecution]
+    def submit_query(query, opts = {})
+      data, _status_code, _headers = submit_query_with_http_info(query, opts)
+      return data
+    end
+
+    # Submit Query
+    # Submits a query for execution.
+    # @param query The query to submit.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnalyticsQueryExecution, Fixnum, Hash)>] AnalyticsQueryExecution data, response status code and response headers
+    def submit_query_with_http_info(query, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AnalyticsQueryService.submit_query ..."
+      end
+      # verify the required parameter 'query' is set
+      fail ArgumentError, "Missing the required parameter 'query' when calling AnalyticsQueryService.submit_query" if query.nil?
+      # resource path
+      local_var_path = "/analytics-query/submit-query".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json;charset=utf-8']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json;charset=utf-8']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(query)
+      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 => 'AnalyticsQueryExecution')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalyticsQueryService#submit_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -44,6 +44,9 @@ module PostFinanceCheckout
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
       }
+      config.default_headers.each do |key, value|
+        @default_headers[key] = value
+      end
     end
 
     def self.default
@@ -98,7 +101,16 @@ module PostFinanceCheckout
       url = build_request_url(path)
       http_method = http_method.to_sym.downcase
 
+      default_headers = {
+        'x-meta-sdk-version': "3.2.0",
+        'x-meta-sdk-language': "ruby",
+        'x-meta-sdk-provider': "PostFinance Checkout",
+        'x-meta-sdk-language-version': RUBY_VERSION
+      }
+
       header_params = @default_headers.merge(opts[:header_params] || {})
+      header_params = header_params.merge(default_headers)
+
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

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

@@ -90,7 +90,9 @@ module PostFinanceCheckout
 
     attr_accessor :force_ending_format
 
-    def initialize
+    attr_accessor :default_headers
+
+    def initialize(default_headers = {})
       @scheme = 'https'
       @host = 'checkout.postfinance.ch:443'
       @base_path = '/api'
@@ -102,6 +104,7 @@ module PostFinanceCheckout
       @inject_format = false
       @force_ending_format = false
       @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+      @default_headers = default_headers
 
       yield(self) if block_given?
     end