vgs_api_client 0.0.1.alpha202205271226 → 0.0.1.alpha202205272111

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7550d328892698eb930bea04bbea7c281721593415ce0b2e3baaa1966bf3ba05
-  data.tar.gz: d95737723e4073aff12413520bd525b8befb47467f18d899b5991e4190a3ed49
+  metadata.gz: 2c002bdf5a526c4634dc23d5ad9074b6194c09f086e576311738aec7a3a61aa6
+  data.tar.gz: 5d2f9924ad206fbe7bf5147e118eeb1ade67dc6a4e0c6bd3d3e39c766f2623f0
 SHA512:
-  metadata.gz: 3cbf7f157eff2176bcdc9237e2480bf55eaa0aad140487969311ac1d2e6e1cab3fcd5809ab6afbea98ac49965c80ef4496737eaaaf88a9832ec9e050de4ff1f6
-  data.tar.gz: 8efdf504e1c71463364beefb08e11d4802fffe48e60a0ae7f0e66fbc7e37edfb2aa1a3c7c9c22647a44ce822db6061b403c614e489ad3c0c93891d9a1916616f
+  metadata.gz: c94ea93bdbd4a681b2b96430f5d72e0c0c7705ca380dce13898a0b2c5de2c030ef3f7366e4fbacf52fdcd65609952a6b7d250af5bfbbee1eda439e66bcd2d073
+  data.tar.gz: cf69308fca8ff06a5a679e26eb15081dca9bc5688f94ddcc956bb6496199ea051d60a16cb6d993d5d9ad2e96706d68734b70553782bf5e5bf3bef23f2ca84b5e

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha202205271226
+0.0.1.alpha202205272111

data/api.yaml

@@ -3,7 +3,7 @@ info:
   title: Vault HTTP API
   description: |
     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
@@ -17,13 +17,13 @@ info:
     **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.
@@ -35,9 +35,9 @@ info:
     [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
@@ -80,13 +80,14 @@ info:
   contact:
     email: support@verygoodsecurity.com
   x-logo:
-    url: images/vgs-logo.png
+    url: https://www.verygoodsecurity.com/img/press-and-assets/vgs-logo-color.png
     href: https://www.verygoodsecurity.com
     altText: VGS Logo
+  termsOfService: https://www.verygoodsecurity.com/terms-and-conditions
 
 externalDocs:
-  description: Find out more about VGS
-  url: https://www.verygoodsecurity.com/
+  description: Visit the VGS documentation homepage
+  url: https://www.verygoodsecurity.com/docs/
 
 servers:
   - url: https://api.sandbox.verygoodvault.com
@@ -111,9 +112,307 @@ x-tagGroups:
       - aliases
 
 security:
-  - basicAuth: []
+  - BasicAuth: []
 
 paths:
+  /functions:
+    post:
+      operationId: createFunction
+      summary: Creates a new function
+      security:
+        - OAuth2: [functions:write]
+      tags:
+        - functions
+      description: |
+        Creates a new function.
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreateFunctionRequest'
+            examples:
+              CreateFunctionRequestOne:
+                summary: Create a new function
+                value:
+                  data:
+                    - src: |
+                        def process(input, ctx):
+                          return input
+                      lang: larky
+                      name: my-function
+      responses:
+        '201':
+          description: Created
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Function'
+                    description: A retrieved function.
+                    minItems: 1
+                    maxItems: 20
+              examples:
+                CreateFunctionResponseOne:
+                  summary: Create a new function
+                  value:
+                    data:
+                      - src: |
+                          def process(input, ctx):
+                            return input
+                        lang: larky
+                        name: my-function-46Juzcyx
+                        hash: bc1f0c3322091740cead407000af9acc692e7fefd0d96446e07900dcd0f8e308
+
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+    get:
+      operationId: listFunctions
+      summary: Lists all functions
+      security:
+        - OAuth2: [functions:read]
+      tags:
+        - functions
+      description: |
+        Lists all functions
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Function'
+                    description: A retrieved function.
+                    minItems: 1
+                    maxItems: 20
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+  /functions/{functionName}:
+    parameters:
+      - $ref: '#/components/parameters/functionName'
+    get:
+      operationId: getFunction
+      tags:
+        - functions
+      summary: Retrieve a single function
+      security:
+        - OAuth2: [functions:read]
+      description: |
+        Retrieves a function
+      parameters:
+        - $ref: '#/components/parameters/functionName'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Function'
+                    description: The retrieved function.
+                    minItems: 1
+                    maxItems: 1
+              examples:
+                UpdateFunctionResponseOne:
+                  summary: Update a new function
+                  value:
+                    data:
+                      - src: |
+                          def process(input, ctx):
+                            return input
+                        lang: larky
+                        name: my-function-46Juzcyx
+                        hash: bc1f0c3322091740cead407000af9acc692e7fefd0d96446e07900dcd0f8e308
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+    put:
+      operationId: updateFunction
+      tags:
+        - functions
+      summary: Update function
+      security:
+        - OAuth2: [functions:write]
+      description: |
+        Update an existing function definition
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateFunctionRequestPayload'
+      responses:
+        '200':
+          description: No Content
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+    delete:
+      operationId: deleteFunction
+      tags:
+        - functions
+      summary: Deletes a function
+      security:
+        - OAuth2: [functions:write]
+      description: |
+        Removes a single alias.
+      parameters:
+        - $ref: '#/components/parameters/functionName'
+      responses:
+        '204':
+          description: No Content
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
+  /functions/{functionName}/invocations:
+    parameters:
+      - $ref: '#/components/parameters/functionName'
+    post:
+      operationId: invokeFunction
+      tags:
+        - functions
+      summary: Invoke a function
+      description: |
+        Invokes a function
+      parameters:
+        - $ref: '#/components/parameters/functionName'
+      requestBody:
+        content:
+          "application/x-www-form-urlencoded":
+            schema:
+              type: string
+              example:
+                hello world
+              description: Stream of bytes up to XX KB in size
+          "text/plain":
+            schema:
+              type: string
+              format: byte
+              example:
+                aGVsbG8gd29ybGQK
+              description: Stream of bytes base64 encoded up to XX KB in size
+          application/http:
+            schema:
+              type: object
+              properties:
+                method:
+                  type: string
+                  enum:
+                  - POST
+                  - PATCH
+                  - DELETE
+                  - PUT
+                  - GET
+                  - HEAD
+                uri:
+                  type: string
+                  format: uri
+                  example: https://example.com/software/htp/cics/index.html
+                version:
+                  type: string
+                  enum:
+                  - "1.0"
+                  - "1.1"
+                headers:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      key:
+                        type: string
+                      value:
+                        type: string
+                body:
+                  type: string
+                  format: string
+
+              description: https://www.iana.org/assignments/media-types/media-types.xhtml
+            examples:
+              InvokeFunction1:
+                summary: Invoke a function with a HTTP request payload
+                value:
+                  method: GET
+                  uri: https://example.com/software/htp/cics/index.html
+                  version: 1.0
+
+          "*/*":
+            schema:
+              type: string
+              format: binary?
+              description: Stream of bytes up to XX KB in size
+      responses:
+        '200':
+          description: OK
+          content:
+            application/http:
+              schema:
+                type: object
+                properties:
+                  method:
+                    type: string
+                    enum:
+                    - POST
+                    - PATCH
+                    - DELETE
+                    - PUT
+                    - GET
+                    - HEAD
+                  uri:
+                    type: string
+                    format: uri
+                    example: https://example.com/software/htp/cics/index.html
+                  version:
+                    type: string
+                    enum:
+                    - "1.0"
+                    - "1.1"
+                  headers:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        key:
+                          type: string
+                        value:
+                          type: string
+                  body:
+                    type: string
+                    format: string
+
+                description: https://www.iana.org/assignments/media-types/media-types.xhtml
+              example:
+                method: POST
+                uri: https://example.com/software/htp/cics/index.html
+                version: 1.0
+                headers:
+                  - key: Content-Type
+                    value: text/plain
+            "text/plain":
+              schema:
+                type: string
+                description: Stream of bytes base64 up to XX KB in size
+              example:
+                aGVsbG8gd29ybGQK
+            "*":
+              schema:
+                type: string
+                format: binary
+                description: Stream of bytes up to XX KB in size
+        default:
+          $ref: '#/components/responses/ApiErrorsResponse'
+
   /aliases:
     post:
       operationId: createAliases
@@ -345,16 +644,41 @@ paths:
              -X DELETE \
              -u "$USERNAME:$PASSWORD"
 
-
 components:
 
   # See the following links for details:
   # - https://swagger.io/docs/specification/authentication/basic-authentication/
+  # https://swagger.io/docs/specification/authentication/
   securitySchemes:
-    basicAuth:
+    BasicAuth:
       type: http
       scheme: basic
-      description: The default authentication schema.
+      description: |
+        The default authentication scheme for [Data API](#data-apis) based requests
+        is [Basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).
+    OAuth2:
+      type: oauth2
+      flows:
+        authorizationCode:
+          authorizationUrl: https://auth.verygoodsecurity.com/auth/realms/vgs/protocol/openid-connect/auth
+          tokenUrl: https://auth.verygoodsecurity.io/auth/realms/vgs/protocol/openid-connect/token
+          scopes:
+            credentials:read: Read vault credentials without reading secrets
+            credentials:write: Add, delete and manage credentials of vault
+            routes:read: Read your vault routes
+            routes:write: Create, read, update, delete your vault routes
+            vaults:read: Read details of your vaults
+            vaults:write: Read, create, update and delete your vaults
+            upstreams:read: Read your upstreams for SFTP routes
+            upstreams:write: Create and update upstreams for SFTP routes
+            certificates:read: Read certificates setup for your routes
+            certificates:write: Upload and delete certificates for routes
+            hostnames:read: Read/List Custom Hostnames of your vault routes
+            hostnames:write: Create/Delete Custom Hostname of your vault routes
+            functions:read: Read/List Functions
+            functions:write: Create/Delete Functions
+      description: |
+        The default authentication schema for [Management API](#management-apis) based requests.
 
   parameters:
     alias:
@@ -366,6 +690,15 @@ components:
         type: string
         example: tok_sandbox_bhtsCwFUzoJMw9rWUfEV5e
 
+    functionName:
+      name: functionName
+      in: path
+      required: true
+      description: Name of function to operate on
+      schema:
+        type: string
+        example: my-function-46Juzcyx
+
   responses:
     ApiErrorsResponse:
       description: Something went wrong
@@ -497,7 +830,7 @@ components:
           default: PERSISTENT
           description: |
             Storage medium to use.
-            
+
             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.
       required:
         - value
@@ -532,3 +865,78 @@ components:
             - classifiers
       required:
         - data
+
+    CreateFunctionRequest:
+      type: object
+      properties:
+        data:
+          type: array
+          items:
+            oneOf:
+              - $ref: '#/components/schemas/CreateFunctionRequestPayload'
+          minItems: 1
+          maxItems: 20
+      required:
+        - data
+
+    CreateFunctionRequestPayload:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Prefix to name your function
+          pattern: "[a-zA-Z]+([A-Za-z0-9\\-_]){5,28}[a-zA-Z0-9]"
+          example: my-function
+        src:
+          type: string
+          description: Definition of function body
+          example: |
+            def process(input, ctx):
+              return input
+        lang:
+          type: string
+          enum:
+            - larky
+          default: larky
+          description: |
+            Language to write your function in.
+      required:
+        - name
+        - src
+
+    UpdateFunctionRequestPayload:
+      type: object
+      properties:
+        src:
+          type: string
+          description: Definition of function body
+          example: |
+            def process(input, ctx):
+              return input
+      required:
+        - src
+
+    Function:
+      type: object
+      properties:
+        name:
+          type: string
+          example: my-function-46Juzcyx
+        src:
+          type: string
+          description: Definition of function body
+          example: |
+            def process(input, ctx):
+              return input
+        lang:
+          type: string
+          enum:
+            - larky
+          default: larky
+          description: |
+            Language to write your function in.
+        hash:
+          type: string
+          description: SHA256 representation of the function definition
+          example: bc1f0c3322091740cead407000af9acc692e7fefd0d96446e07900dcd0f8e308
+

data/lib/openapi_client/api/aliases_api.rb

@@ -64,7 +64,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type] || 'InlineResponse201'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.create_aliases",
@@ -127,7 +127,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.delete_alias",
@@ -190,7 +190,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type] || 'InlineResponse2001'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.reveal_alias",
@@ -254,7 +254,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type] || 'InlineResponse200'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.reveal_multiple_aliases",
@@ -324,7 +324,7 @@ module VgsApiClient
       return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || ['basicAuth']
+      auth_names = opts[:debug_auth_names] || ['BasicAuth']
 
       new_options = opts.merge(
         :operation => :"AliasesApi.update_alias",