vgs_api_client 0.0.1.alpha202205271209 → 0.0.1.alpha202205272111

data/lib/openapi_client/api/functions_api.rb

@@ -0,0 +1,409 @@
+=begin
+#Vault HTTP API
+
+#The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication.  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ``` 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@verygoodsecurity.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'cgi'
+
+module VgsApiClient
+  class FunctionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a new function
+    # Creates a new function. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateFunctionRequest] :create_function_request 
+    # @return [InlineResponse2002]
+    def create_function(opts = {})
+      data, _status_code, _headers = create_function_with_http_info(opts)
+      data
+    end
+
+    # Creates a new function
+    # Creates a new function. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [CreateFunctionRequest] :create_function_request 
+    # @return [Array<(InlineResponse2002, Integer, Hash)>] InlineResponse2002 data, response status code and response headers
+    def create_function_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.create_function ...'
+      end
+      # resource path
+      local_var_path = '/functions'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_function_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse2002'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.create_function",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: FunctionsApi#create_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deletes a function
+    # Removes a single alias. 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_function(function_name, opts = {})
+      delete_function_with_http_info(function_name, opts)
+      nil
+    end
+
+    # Deletes a function
+    # Removes a single alias. 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_function_with_http_info(function_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.delete_function ...'
+      end
+      # verify the required parameter 'function_name' is set
+      if @api_client.config.client_side_validation && function_name.nil?
+        fail ArgumentError, "Missing the required parameter 'function_name' when calling FunctionsApi.delete_function"
+      end
+      # resource path
+      local_var_path = '/functions/{functionName}'.sub('{' + 'functionName' + '}', CGI.escape(function_name.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.delete_function",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FunctionsApi#delete_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve a single function
+    # Retrieves a function 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse2003]
+    def get_function(function_name, opts = {})
+      data, _status_code, _headers = get_function_with_http_info(function_name, opts)
+      data
+    end
+
+    # Retrieve a single function
+    # Retrieves a function 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse2003, Integer, Hash)>] InlineResponse2003 data, response status code and response headers
+    def get_function_with_http_info(function_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.get_function ...'
+      end
+      # verify the required parameter 'function_name' is set
+      if @api_client.config.client_side_validation && function_name.nil?
+        fail ArgumentError, "Missing the required parameter 'function_name' when calling FunctionsApi.get_function"
+      end
+      # resource path
+      local_var_path = '/functions/{functionName}'.sub('{' + 'functionName' + '}', CGI.escape(function_name.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse2003'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.get_function",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: FunctionsApi#get_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Invoke a function
+    # Invokes a function 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :body 
+    # @return [File]
+    def invoke_function(function_name, opts = {})
+      data, _status_code, _headers = invoke_function_with_http_info(function_name, opts)
+      data
+    end
+
+    # Invoke a function
+    # Invokes a function 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :body 
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def invoke_function_with_http_info(function_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.invoke_function ...'
+      end
+      # verify the required parameter 'function_name' is set
+      if @api_client.config.client_side_validation && function_name.nil?
+        fail ArgumentError, "Missing the required parameter 'function_name' when calling FunctionsApi.invoke_function"
+      end
+      # resource path
+      local_var_path = '/functions/{functionName}/invocations'.sub('{' + 'functionName' + '}', CGI.escape(function_name.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/http', 'text/plain', 'application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/http', 'application/x-www-form-urlencoded', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.invoke_function",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: FunctionsApi#invoke_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists all functions
+    # Lists all functions 
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse2002]
+    def list_functions(opts = {})
+      data, _status_code, _headers = list_functions_with_http_info(opts)
+      data
+    end
+
+    # Lists all functions
+    # Lists all functions 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse2002, Integer, Hash)>] InlineResponse2002 data, response status code and response headers
+    def list_functions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.list_functions ...'
+      end
+      # resource path
+      local_var_path = '/functions'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InlineResponse2002'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.list_functions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: FunctionsApi#list_functions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update function
+    # Update an existing function definition 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateFunctionRequestPayload] :update_function_request_payload 
+    # @return [nil]
+    def update_function(function_name, opts = {})
+      update_function_with_http_info(function_name, opts)
+      nil
+    end
+
+    # Update function
+    # Update an existing function definition 
+    # @param function_name [String] Name of function to operate on
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateFunctionRequestPayload] :update_function_request_payload 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def update_function_with_http_info(function_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FunctionsApi.update_function ...'
+      end
+      # verify the required parameter 'function_name' is set
+      if @api_client.config.client_side_validation && function_name.nil?
+        fail ArgumentError, "Missing the required parameter 'function_name' when calling FunctionsApi.update_function"
+      end
+      # resource path
+      local_var_path = '/functions/{functionName}'.sub('{' + 'functionName' + '}', CGI.escape(function_name.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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_function_request_payload'])
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"FunctionsApi.update_function",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FunctionsApi#update_function\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/openapi_client/api_client.rb

@@ -31,7 +31,7 @@ module VgsApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "vgs-api-client/0.0.1.alpha202205271209/ruby"
+      @user_agent = "vgs-api-client/0.0.1.alpha202205272111/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/openapi_client/configuration.rb

@@ -215,13 +215,20 @@ module VgsApiClient
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'basicAuth' =>
+        'BasicAuth' =>
           {
             type: 'basic',
             in: 'header',
             key: 'Authorization',
             value: basic_auth_token
           },
+        'OAuth2' =>
+          {
+            type: 'oauth2',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token}"
+          },
       }
     end