vgs_api_client 0.0.1.alpha202306021830 → 0.0.1.alpha202306061541

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202ee25ab57921678ee2647ef2bfc1cc0b0a747437a1ec2c2283fc2458002664
-  data.tar.gz: 9884a1c0f38bb0feee80b5aab3ca8742e25e03e516db2a34abe0aa83dd94979b
+  metadata.gz: b8b7b0499b7cd08601cbfb2cb62ed79053373d94e5d72635816792175e4dd6a2
+  data.tar.gz: a65045274b40cff8fae0093c396fc5aea1e4d248fed0dbea7aae20b695b1c797
 SHA512:
-  metadata.gz: 5ca0495b73b9ee454aed0d4c301c397c1b9825f500b17dafe729d6696509ea44123280386000c06180c91878adf93a991808aff0db8b6bacba32b2ddc8f25a0e
-  data.tar.gz: 6369b070acef3e63fc8ea29db1d49eda36a28845fe1bec3c99f98bad2ded956947f82eb9a1fbc72305d6f539ceb9c757c78d1a87dd20c9f60ae05d1028b1474e
+  metadata.gz: 97ad3a1b881a3ba22f7e91188c5d4c15b62ef1808da0feab96bf8868dfdf3f2df4aa7bf55df07741897b369a9b3b3848925f7540010211a02bc970873beb9b84
+  data.tar.gz: c1a9b924bb9a66507160c6e9a2cae09ffdd2ac020280c88f260414eefa1c0c721238f10aa01d629b6a48e3335324e9e78f930d76402fb6935c5d8af03deeff9e

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha202306021830
+0.0.1.alpha202306061541

data/api.yaml

@@ -201,7 +201,7 @@ paths:
         manager or drop us a line at
         [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
       parameters:
-        - name: q
+        - name: aliases
           in: query
           required: true
           description: Comma-separated list of aliases to reveal.
@@ -209,6 +209,14 @@ paths:
             - "tok_sandbox_5UpnbMvaihRuRwz5QXwBFw,tok_sandbox_9ToiJHedw1nE1Jfx1qYYgz"
           schema:
             type: string
+        - name: storage
+          in: query
+          required: false
+          description: PERSISTENT or VOLATILE storage
+          example:
+            - "PERSISTENT"
+          schema:
+            type: string
       responses:
         '200':
           description: OK
@@ -247,12 +255,37 @@ paths:
         - lang: Shell
           label: cURL
           source: |
-            curl https://api.sandbox.verygoodvault.com/aliases?q={{alias1}},{{alias2}} \
+            curl https://api.sandbox.verygoodvault.com/aliases?aliases={{alias1}},{{alias2}}?storage=PERSISTENT \
              -u "$USERNAME:$PASSWORD"
 
+  /aliases/delete:
+    post:
+      summary: "POST aliases/delete"
+      operationId: "deleteAliases"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/BatchAliasesRequest"
+        required: true
+      responses:
+        "204":
+          description: "No Content"
+        "404":
+          description: "Not Found"
+      x-codeSamples:
+        - lang: Shell
+          label: cURL
+          source: |
+            curl -v https://api.sandbox.verygoodvault.com/aliases/delete -d \
+              '{"storage":"VOLATILE","data":["tok_whjuj6F8r3f2KeCpY7RPCE"]}' \ 
+            -H 'Content-Type: application/json' \
+            -u "$USERNAME:$PASSWORD"
+
   /aliases/{alias}:
     parameters:
       - $ref: '#/components/parameters/alias'
+      - $ref: '#/components/parameters/storage'
     get:
       operationId: revealAlias
       tags:
@@ -267,6 +300,7 @@ paths:
         [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com).
       parameters:
         - $ref: '#/components/parameters/alias'
+        - $ref: '#/components/parameters/storage'
       responses:
         '200':
           description: OK
@@ -288,7 +322,7 @@ paths:
         - lang: Shell
           label: cURL
           source: |
-            curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
+            curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}?storage=PERSISTENT \
              -u "$USERNAME:$PASSWORD"
     put:
       operationId: updateAlias
@@ -332,6 +366,7 @@ paths:
         Removes a single alias.
       parameters:
         - $ref: '#/components/parameters/alias'
+        - $ref: '#/components/parameters/storage'
       responses:
         '204':
           description: No Content
@@ -341,7 +376,7 @@ paths:
         - lang: Shell
           label: cURL
           source: |
-            curl https://api.sandbox.verygoodvault.com/aliases/{{alias}} \
+            curl https://api.sandbox.verygoodvault.com/aliases/{{alias}}?storage=PERSISTENT \
              -X DELETE \
              -u "$USERNAME:$PASSWORD"
 
@@ -365,6 +400,16 @@ components:
       schema:
         type: string
         example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
+    storage:
+      name: "storage"
+      in: "query"
+      required: false
+      schema:
+        type: "string"
+        enum:
+          - "PERSISTENT"
+          - "VOLATILE"
+        default: "PERSISTENT"
 
   responses:
     ApiErrorsResponse:
@@ -414,13 +459,14 @@ components:
         aliases:
           type: "array"
           items:
-            $ref: '#/components/schemas/Alias'
+            $ref: '#/components/schemas/AliasDto'
           description: List of aliases associated with the value.
         created_at:
           type: "string"
           format: "date-time"
           description: Creation time, in UTC.
           example: "2019-05-15T12:30:45Z"
+          nullable: true
         storage:
           type: string
           enum:
@@ -432,7 +478,7 @@ components:
 
             VOLATILE results in data being persisted into an in-memory data store for one hour which is required for PCI compliant storage of card security code data.
 
-    Alias:
+    AliasDto:
       type: "object"
       properties:
         alias:
@@ -441,27 +487,48 @@ components:
           description: Opaque string used to substitute the raw value.
         format:
           $ref: '#/components/schemas/AliasFormat'
+          nullable: true
 
     AliasFormat:
       type: string
       enum:
-        - FPE_ACC_NUM_T_FOUR
-        - FPE_ALPHANUMERIC_ACC_NUM_T_FOUR
-        - FPE_SIX_T_FOUR
-        - FPE_SSN_T_FOUR
-        - FPE_T_FOUR
-        - GENERIC_T_FOUR
-        - NON_LUHN_FPE_ALPHANUMERIC
-        - NUM_LENGTH_PRESERVING
-        - PFPT
-        - RAW_UUID
-        - UUID
-        - VGS_FIXED_LEN_GENERIC
+            - "ALPHANUMERIC_SIX_T_FOUR"
+            - "CUSTOM"
+            - "FPE_ACC_NUM_T_FOUR"
+            - "FPE_ALPHANUMERIC_ACC_NUM_T_FOUR"
+            - "FPE_SIX_T_FOUR"
+            - "FPE_SSN_T_FOUR"
+            - "FPE_T_FOUR"
+            - "GENERIC_T_FOUR"
+            - "JS"
+            - "NON_LUHN_FPE_ALPHANUMERIC"
+            - "NUM_LENGTH_PRESERVING"
+            - "PFPT"
+            - "RAW_UUID"
+            - "UUID"
+            - "VGS_FIXED_LEN_GENERIC"
       description: |
         Format of the generated alias string.
 
         See [Alias Formats](#section/Introduction/Alias-Formats) for details.
       example: UUID
+      nullable: true
+
+    BatchAliasesRequest:
+      type: "object"
+      properties:
+        data:
+          type: "array"
+          items:
+            type: "string"
+        storage:
+          type: "string"
+          enum:
+            - "PERSISTENT"
+            - "VOLATILE"
+      description: |
+        Format for batch requests (limit 20)
+      example: '{"data":["123-13123-1232"],"storage":"PERSISTENT"}'
 
     CreateAliasesRequest:
       type: object
@@ -469,9 +536,7 @@ components:
         data:
           type: array
           items:
-            oneOf:
-              - $ref: '#/components/schemas/CreateAliasesRequestNew'
-              - $ref: '#/components/schemas/CreateAliasesRequestReference'
+            $ref: "#/components/schemas/CreateAliasesRequestNew"
           minItems: 1
           maxItems: 20
       required:

data/lib/openapi_client/api/aliases_api.rb

@@ -87,6 +87,7 @@ module VgsApiClient
     # Removes a single alias. 
     # @param _alias [String] Alias to operate on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage  (default to 'PERSISTENT')
     # @return [nil]
     def delete_alias(_alias, opts = {})
       delete_alias_with_http_info(_alias, opts)
@@ -97,6 +98,7 @@ module VgsApiClient
     # Removes a single alias. 
     # @param _alias [String] Alias to operate on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage 
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_alias_with_http_info(_alias, opts = {})
       if @api_client.config.debugging
@@ -106,11 +108,16 @@ module VgsApiClient
       if @api_client.config.client_side_validation && _alias.nil?
         fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.delete_alias"
       end
+      allowable_values = ["PERSISTENT", "VOLATILE"]
+      if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
+        fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -150,6 +157,7 @@ module VgsApiClient
     # Retrieves a stored value along with its aliases.  **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com). 
     # @param _alias [String] Alias to operate on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage  (default to 'PERSISTENT')
     # @return [InlineResponse2001]
     def reveal_alias(_alias, opts = {})
       data, _status_code, _headers = reveal_alias_with_http_info(_alias, opts)
@@ -160,6 +168,7 @@ module VgsApiClient
     # Retrieves a stored value along with its aliases.  **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com). 
     # @param _alias [String] Alias to operate on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage 
     # @return [Array<(InlineResponse2001, Integer, Hash)>] InlineResponse2001 data, response status code and response headers
     def reveal_alias_with_http_info(_alias, opts = {})
       if @api_client.config.debugging
@@ -169,11 +178,16 @@ module VgsApiClient
       if @api_client.config.client_side_validation && _alias.nil?
         fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.reveal_alias"
       end
+      allowable_values = ["PERSISTENT", "VOLATILE"]
+      if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
+        fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -211,33 +225,36 @@ module VgsApiClient
 
     # Reveal multiple aliases
     # Given a list of aliases, retrieves all associated values stored in the vault.  **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com). 
-    # @param q [String] Comma-separated list of aliases to reveal.
+    # @param aliases [String] Comma-separated list of aliases to reveal.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage PERSISTENT or VOLATILE storage
     # @return [InlineResponse200]
-    def reveal_multiple_aliases(q, opts = {})
-      data, _status_code, _headers = reveal_multiple_aliases_with_http_info(q, opts)
+    def reveal_multiple_aliases(aliases, opts = {})
+      data, _status_code, _headers = reveal_multiple_aliases_with_http_info(aliases, opts)
       data
     end
 
     # Reveal multiple aliases
     # Given a list of aliases, retrieves all associated values stored in the vault.  **NOTE:** This endpoint may expose sensitive data. Therefore, it is disabled by default. To enable it, please contact your VGS account manager or drop us a line at [support@verygoodsecurity.com](mailto:support@verygoodsecurity.com). 
-    # @param q [String] Comma-separated list of aliases to reveal.
+    # @param aliases [String] Comma-separated list of aliases to reveal.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage PERSISTENT or VOLATILE storage
     # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers
-    def reveal_multiple_aliases_with_http_info(q, opts = {})
+    def reveal_multiple_aliases_with_http_info(aliases, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AliasesApi.reveal_multiple_aliases ...'
       end
-      # verify the required parameter 'q' is set
-      if @api_client.config.client_side_validation && q.nil?
-        fail ArgumentError, "Missing the required parameter 'q' when calling AliasesApi.reveal_multiple_aliases"
+      # verify the required parameter 'aliases' is set
+      if @api_client.config.client_side_validation && aliases.nil?
+        fail ArgumentError, "Missing the required parameter 'aliases' when calling AliasesApi.reveal_multiple_aliases"
       end
       # resource path
       local_var_path = '/aliases'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'q'] = q
+      query_params[:'aliases'] = aliases
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -277,6 +294,7 @@ module VgsApiClient
     # Apply new classifiers to the value that the specified alias is associated with. 
     # @param _alias [String] Alias to operate on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage  (default to 'PERSISTENT')
     # @option opts [UpdateAliasRequest] :update_alias_request 
     # @return [nil]
     def update_alias(_alias, opts = {})
@@ -288,6 +306,7 @@ module VgsApiClient
     # Apply new classifiers to the value that the specified alias is associated with. 
     # @param _alias [String] Alias to operate on.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :storage 
     # @option opts [UpdateAliasRequest] :update_alias_request 
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def update_alias_with_http_info(_alias, opts = {})
@@ -298,11 +317,16 @@ module VgsApiClient
       if @api_client.config.client_side_validation && _alias.nil?
         fail ArgumentError, "Missing the required parameter '_alias' when calling AliasesApi.update_alias"
       end
+      allowable_values = ["PERSISTENT", "VOLATILE"]
+      if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
+        fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/aliases/{alias}'.sub('{' + 'alias' + '}', CGI.escape(_alias.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/openapi_client/api/default_api.rb

@@ -0,0 +1,86 @@
+=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 and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam)  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 DefaultApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # POST aliases/delete
+    # @param batch_aliases_request [BatchAliasesRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_aliases(batch_aliases_request, opts = {})
+      delete_aliases_with_http_info(batch_aliases_request, opts)
+      nil
+    end
+
+    # POST aliases/delete
+    # @param batch_aliases_request [BatchAliasesRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_aliases_with_http_info(batch_aliases_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DefaultApi.delete_aliases ...'
+      end
+      # verify the required parameter 'batch_aliases_request' is set
+      if @api_client.config.client_side_validation && batch_aliases_request.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_aliases_request' when calling DefaultApi.delete_aliases"
+      end
+      # resource path
+      local_var_path = '/aliases/delete'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(batch_aliases_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"DefaultApi.delete_aliases",
+        :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: DefaultApi#delete_aliases\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.alpha202306021830/ruby"
+      @user_agent = "vgs-api-client/0.0.1.alpha202306061541/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/openapi_client/models/{model_alias.rb → alias_dto.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module VgsApiClient
-  class ModelAlias
+  class AliasDto
     # Opaque string used to substitute the raw value.
     attr_accessor :_alias
 
@@ -44,6 +44,7 @@ module VgsApiClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'format'
       ])
     end
 
@@ -51,13 +52,13 @@ module VgsApiClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `VgsApiClient::ModelAlias` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VgsApiClient::AliasDto` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `VgsApiClient::ModelAlias`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VgsApiClient::AliasDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/openapi_client/models/alias_format.rb

@@ -15,12 +15,15 @@ require 'time'
 
 module VgsApiClient
   class AliasFormat
+    ALPHANUMERIC_SIX_T_FOUR = "ALPHANUMERIC_SIX_T_FOUR".freeze
+    CUSTOM = "CUSTOM".freeze
     FPE_ACC_NUM_T_FOUR = "FPE_ACC_NUM_T_FOUR".freeze
     FPE_ALPHANUMERIC_ACC_NUM_T_FOUR = "FPE_ALPHANUMERIC_ACC_NUM_T_FOUR".freeze
     FPE_SIX_T_FOUR = "FPE_SIX_T_FOUR".freeze
     FPE_SSN_T_FOUR = "FPE_SSN_T_FOUR".freeze
     FPE_T_FOUR = "FPE_T_FOUR".freeze
     GENERIC_T_FOUR = "GENERIC_T_FOUR".freeze
+    JS = "JS".freeze
     NON_LUHN_FPE_ALPHANUMERIC = "NON_LUHN_FPE_ALPHANUMERIC".freeze
     NUM_LENGTH_PRESERVING = "NUM_LENGTH_PRESERVING".freeze
     PFPT = "PFPT".freeze

data/lib/openapi_client/models/batch_aliases_request.rb

@@ -0,0 +1,264 @@
+=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 and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam)  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 'date'
+require 'time'
+
+module VgsApiClient
+  # Format for batch requests (limit 20) 
+  class BatchAliasesRequest
+    attr_accessor :data
+
+    attr_accessor :storage
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'storage' => :'storage'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'Array<String>',
+        :'storage' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VgsApiClient::BatchAliasesRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `VgsApiClient::BatchAliasesRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'storage')
+        self.storage = attributes[:'storage']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      storage_validator = EnumAttributeValidator.new('String', ["PERSISTENT", "VOLATILE"])
+      return false unless storage_validator.valid?(@storage)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] storage Object to be assigned
+    def storage=(storage)
+      validator = EnumAttributeValidator.new('String', ["PERSISTENT", "VOLATILE"])
+      unless validator.valid?(storage)
+        fail ArgumentError, "invalid value for \"storage\", must be one of #{validator.allowable_values}."
+      end
+      @storage = storage
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          data == o.data &&
+          storage == o.storage
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [data, storage].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = VgsApiClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/openapi_client/models/create_aliases_request.rb

@@ -32,7 +32,7 @@ module VgsApiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'data' => :'Array<OneOfCreateAliasesRequestNewCreateAliasesRequestReference>'
+        :'data' => :'Array<CreateAliasesRequestNew>'
       }
     end
 

data/lib/openapi_client/models/create_aliases_request_new.rb

@@ -76,6 +76,7 @@ module VgsApiClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'format',
       ])
     end
 
@@ -119,10 +120,6 @@ module VgsApiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @format.nil?
-        invalid_properties.push('invalid value for "format", format cannot be nil.')
-      end
-
       if @value.nil?
         invalid_properties.push('invalid value for "value", value cannot be nil.')
       end
@@ -133,7 +130,6 @@ module VgsApiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @format.nil?
       storage_validator = EnumAttributeValidator.new('String', ["PERSISTENT", "VOLATILE"])
       return false unless storage_validator.valid?(@storage)
       return false if @value.nil?

data/lib/openapi_client/models/create_aliases_request_reference.rb

@@ -44,6 +44,7 @@ module VgsApiClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'format'
       ])
     end
 
@@ -79,10 +80,6 @@ module VgsApiClient
         invalid_properties.push('invalid value for "_alias", _alias cannot be nil.')
       end
 
-      if @format.nil?
-        invalid_properties.push('invalid value for "format", format cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -90,7 +87,6 @@ module VgsApiClient
     # @return true if the model is valid
     def valid?
       return false if @_alias.nil?
-      return false if @format.nil?
       true
     end
 

data/lib/openapi_client/models/revealed_data.rb

@@ -71,7 +71,7 @@ module VgsApiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'aliases' => :'Array<ModelAlias>',
+        :'aliases' => :'Array<AliasDto>',
         :'classifiers' => :'Array<String>',
         :'created_at' => :'Time',
         :'storage' => :'String',
@@ -82,6 +82,7 @@ module VgsApiClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'created_at',
       ])
     end
 

data/lib/openapi_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module VgsApiClient
-  VERSION = '0.0.1.alpha202306021830'
+  VERSION = '0.0.1.alpha202306061541'
 end

data/lib/openapi_client.rb

@@ -17,8 +17,10 @@ require 'openapi_client/version'
 require 'openapi_client/configuration'
 
 # Models
+require 'openapi_client/models/alias_dto'
 require 'openapi_client/models/alias_format'
 require 'openapi_client/models/api_error'
+require 'openapi_client/models/batch_aliases_request'
 require 'openapi_client/models/create_aliases_request'
 require 'openapi_client/models/create_aliases_request_new'
 require 'openapi_client/models/create_aliases_request_reference'
@@ -26,13 +28,13 @@ require 'openapi_client/models/inline_response200'
 require 'openapi_client/models/inline_response2001'
 require 'openapi_client/models/inline_response201'
 require 'openapi_client/models/inline_response_default'
-require 'openapi_client/models/model_alias'
 require 'openapi_client/models/revealed_data'
 require 'openapi_client/models/update_alias_request'
 require 'openapi_client/models/update_alias_request_data'
 
 # APIs
 require 'openapi_client/api/aliases_api'
+require 'openapi_client/api/default_api'
 
 module VgsApiClient
   class << self

data/lib/version.rb

@@ -1,3 +1,3 @@
 module VGS
-  VERSION = '0.0.1.alpha202306021830'
+  VERSION = '0.0.1.alpha202306061541'
 end

data/lib/vgs_api_client.rb

@@ -65,7 +65,7 @@ module VGS
     def reveal(aliases)
       begin
         query = aliases.kind_of?(Array) ? aliases.join(",") : aliases
-        response = @aliases_api.reveal_multiple_aliases(q = query)
+        response = @aliases_api.reveal_multiple_aliases(aliases = query)
       rescue Exception => e
         raise map_exception("Failed to reveal aliases #{ aliases }", e)
       else

data/scripts/assemble/run.sh

@@ -3,7 +3,7 @@
 LIB_VERSION=${LIB_VERSION:-0.0.1.alpha$(date "+%Y%m%d%H%M")}
 
 # fix version
-grep -rl 0.0.1.alpha202306021830 . | xargs sed -i "s/0.0.1.alpha202306021830/${LIB_VERSION}/g"
+grep -rl 0.0.1.alpha202306061541 . | xargs sed -i "s/0.0.1.alpha202306061541/${LIB_VERSION}/g"
 
 # build
 gem build vgs_api_client.gemspec

data/scripts/test/run.sh

@@ -5,7 +5,7 @@ set -e
 echo "Installing lib from local sources"
 # fix version
 VERSION=0.0.1.alpha$(date "+%Y%m%d%H%M")
-grep -rl 0.0.1.alpha202306021830 . | xargs sed -i "s/0.0.1.alpha202306021830/$VERSION/g"
+grep -rl 0.0.1.alpha202306061541 . | xargs sed -i "s/0.0.1.alpha202306061541/$VERSION/g"
 
 bundle install
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vgs_api_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha202306021830
+  version: 0.0.1.alpha202306061541
 platform: ruby
 authors:
 - Very Good Security
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -68,11 +68,14 @@ files:
 - docker-compose.yaml
 - lib/openapi_client.rb
 - lib/openapi_client/api/aliases_api.rb
+- lib/openapi_client/api/default_api.rb
 - lib/openapi_client/api_client.rb
 - lib/openapi_client/api_error.rb
 - lib/openapi_client/configuration.rb
+- lib/openapi_client/models/alias_dto.rb
 - lib/openapi_client/models/alias_format.rb
 - lib/openapi_client/models/api_error.rb
+- lib/openapi_client/models/batch_aliases_request.rb
 - lib/openapi_client/models/create_aliases_request.rb
 - lib/openapi_client/models/create_aliases_request_new.rb
 - lib/openapi_client/models/create_aliases_request_reference.rb
@@ -80,7 +83,6 @@ files:
 - lib/openapi_client/models/inline_response2001.rb
 - lib/openapi_client/models/inline_response201.rb
 - lib/openapi_client/models/inline_response_default.rb
-- lib/openapi_client/models/model_alias.rb
 - lib/openapi_client/models/revealed_data.rb
 - lib/openapi_client/models/update_alias_request.rb
 - lib/openapi_client/models/update_alias_request_data.rb