whitelabelmachinename-ruby-sdk 3.0.6 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f9d53c72324a06aa33fe1809ff1ec43dafe1f29fc6d7b5369fe7f65bb91969f4
-  data.tar.gz: be883c0ae1774faaa7702370fac0968a291a63172fcbcbe40b3f20ea4eab0b9b
+SHA1:
+  metadata.gz: 91db6d4247061994adbc6c001bdfb52cf19e982c
+  data.tar.gz: 030c19ce6b4d96d75ea32a11d028ee7832f03afe
 SHA512:
-  metadata.gz: 99083236e18cfd22320f766cb5a19f8f3be18145f86079cbfe4ce8f3431c53de2310dffcf7099c6416a447f482ec9e8f4af4f1f7fc462fc2fb87fe474b16a077
-  data.tar.gz: 3b50893ffe71022468c9a158107dd48189833548a30ead062c7876f8a367dad4bd3eef6d72781ee8c7814e93ed3ac4a5c06ba1bad588b7a01d7f3aa92f0ca5ce
+  metadata.gz: 549ca36f16f831caee7a7937a6da97cdfe0a6c436b4f071edf848ced078b29b60b505478aa99113f0fe50accbf1180b4745544f5a9996c1c7ef1504ee2e64c3e
+  data.tar.gz: 9f8f890b3665446574521b7d579a398f19e48d758acc791823b7c552d67359e8dd7982737c15a0a15840c529427e2b764fec398a373b51ab2319cf95610a9ae2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whitelabelmachinename-ruby-sdk (3.0.6)
+    whitelabelmachinename-ruby-sdk (3.1.4)
       addressable (~> 2.3, >= 2.3.0)
       json (~> 2.3, >= 2.3.0)
       typhoeus (~> 1.0, >= 1.0.1)
@@ -32,4 +32,4 @@ DEPENDENCIES
   whitelabelmachinename-ruby-sdk!
 
 BUNDLED WITH
-   2.3.13
+   2.3.19

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 wallee AG
+   Copyright 2022 wallee AG
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,5 +1,3 @@
-[![Build Status](https://travis-ci.org/WhiteLabelGithubOwnerName/ruby-sdk.svg?branch=master)](https://travis-ci.org/WhiteLabelGithubOwnerName/ruby-sdk)
-
 # WhiteLabelName Ruby Library
 
 The WhiteLabelName Ruby library wraps around the WhiteLabelName API. This library facilitates your interaction with various services such as transactions, accounts, and subscriptions.

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

@@ -0,0 +1,381 @@
+=begin
+The WhiteLabelName API allows an easy interaction with the WhiteLabelName 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 WhiteLabelMachineName
+  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/whitelabelmachinename-ruby-sdk/api/charge_flow_service_api.rb

@@ -88,6 +88,69 @@ module WhiteLabelMachineName
       return data, status_code, headers
     end
 
+    # Cancel Charge Flow
+    # This operation cancels the charge flow that is linked with the transaction indicated by the given ID.
+    # @param space_id 
+    # @param id The ID of the transaction for which the charge flow should be canceled.
+    # @param [Hash] opts the optional parameters
+    # @return [Transaction]
+    def cancel_charge_flow(space_id, id, opts = {})
+      data, _status_code, _headers = cancel_charge_flow_with_http_info(space_id, id, opts)
+      return data
+    end
+
+    # Cancel Charge Flow
+    # This operation cancels the charge flow that is linked with the transaction indicated by the given ID.
+    # @param space_id 
+    # @param id The ID of the transaction for which the charge flow should be canceled.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Transaction, Fixnum, Hash)>] Transaction data, response status code and response headers
+    def cancel_charge_flow_with_http_info(space_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ChargeFlowService.cancel_charge_flow ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.cancel_charge_flow" if space_id.nil?
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling ChargeFlowService.cancel_charge_flow" if id.nil?
+      # resource path
+      local_var_path = "/charge-flow/cancel-charge-flow".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      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,
+        :return_type => 'Transaction')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChargeFlowService#cancel_charge_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Count
     # Counts the number of items in the database as restricted by the given filter.
     # @param space_id 
@@ -148,6 +211,69 @@ module WhiteLabelMachineName
       return data, status_code, headers
     end
 
+    # Fetch Charge Flow Payment Page URL
+    # This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction. The operation might return an empty result when no payment page is needed or can be invoked.
+    # @param space_id 
+    # @param id The transaction id of the transaction for which the URL of the charge flow should be fetched.
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def fetch_charge_flow_payment_page_url(space_id, id, opts = {})
+      data, _status_code, _headers = fetch_charge_flow_payment_page_url_with_http_info(space_id, id, opts)
+      return data
+    end
+
+    # Fetch Charge Flow Payment Page URL
+    # This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction. The operation might return an empty result when no payment page is needed or can be invoked.
+    # @param space_id 
+    # @param id The transaction id of the transaction for which the URL of the charge flow should be fetched.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def fetch_charge_flow_payment_page_url_with_http_info(space_id, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ChargeFlowService.fetch_charge_flow_payment_page_url ..."
+      end
+      # verify the required parameter 'space_id' is set
+      fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.fetch_charge_flow_payment_page_url" if space_id.nil?
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling ChargeFlowService.fetch_charge_flow_payment_page_url" if id.nil?
+      # resource path
+      local_var_path = "/charge-flow/fetch-charge-flow-payment-page-url".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'spaceId'] = space_id
+      query_params[:'id'] = id
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json', 'text/plain;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 => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChargeFlowService#fetch_charge_flow_payment_page_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read
     # Reads the entity with the given 'id' and returns it.
     # @param space_id