vgs-api-client 0.0.1.dev202305161416__py3-none-any.whl → 0.0.1.dev202404232319__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- vgs/__init__.py +3 -3
- vgs/aliases_api.py +21 -12
- vgs/base_api.py +1 -3
- vgs/configuration.py +7 -5
- vgs/control_plane/__init__.py +1 -0
- vgs/control_plane/apis/__init__.py +1 -0
- vgs/control_plane/apis/vault_management.py +0 -0
- vgs/control_plane/clients/__init__.py +1 -0
- vgs/control_plane/clients/organizations.py +2 -0
- vgs/control_plane/clients/vaults.py +6 -0
- vgs/functions_api.py +7 -19
- vgs/sdk/account_mgmt.py +1 -1
- vgs/sdk/accounts_api.py +1 -1
- vgs/sdk/auth_api.py +2 -2
- vgs/sdk/errors.py +3 -11
- vgs/sdk/routes.py +9 -0
- vgs/sdk/vault_mgmt.py +1 -1
- vgs/sdk/vaults_api.py +1 -1
- vgs_api_client/__init__.py +2 -2
- vgs_api_client/api/aliases_api.py +182 -11
- vgs_api_client/api_client.py +2 -2
- vgs_api_client/configuration.py +2 -2
- vgs_api_client/exceptions.py +1 -1
- vgs_api_client/model/{alias.py → alias_dto.py} +4 -4
- vgs_api_client/model/alias_format.py +10 -6
- vgs_api_client/model/api_error.py +1 -1
- vgs_api_client/model/batch_aliases_request.py +264 -0
- vgs_api_client/model/create_aliases_request.py +4 -6
- vgs_api_client/model/create_aliases_request_new.py +1 -1
- vgs_api_client/model/create_aliases_request_reference.py +1 -1
- vgs_api_client/model/inline_response200.py +1 -1
- vgs_api_client/model/inline_response2001.py +1 -1
- vgs_api_client/model/inline_response201.py +1 -1
- vgs_api_client/model/inline_response_default.py +1 -1
- vgs_api_client/model/revealed_data.py +9 -9
- vgs_api_client/model/update_alias_request.py +1 -1
- vgs_api_client/model/update_alias_request_data.py +1 -1
- vgs_api_client/model_utils.py +1 -1
- vgs_api_client/models/__init__.py +2 -1
- vgs_api_client/rest.py +1 -1
- vgs_api_client-0.0.1.dev202404232319.dist-info/METADATA +95 -0
- vgs_api_client-0.0.1.dev202404232319.dist-info/RECORD +57 -0
- {vgs_api_client-0.0.1.dev202305161416.dist-info → vgs_api_client-0.0.1.dev202404232319.dist-info}/top_level.txt +0 -1
- vgs_api_client-0.0.1.dev202305161416.dist-info/METADATA +0 -75
- vgs_api_client-0.0.1.dev202305161416.dist-info/RECORD +0 -50
- /sdk/__init__.py → /vgs/control_plane/apis/account_management.py +0 -0
- {vgs_api_client-0.0.1.dev202305161416.dist-info → vgs_api_client-0.0.1.dev202404232319.dist-info}/LICENSE +0 -0
- {vgs_api_client-0.0.1.dev202305161416.dist-info → vgs_api_client-0.0.1.dev202404232319.dist-info}/WHEEL +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Vault HTTP API
|
|
3
3
|
|
|
4
|
-
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\" } ] } ``` # noqa: E501
|
|
4
|
+
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) ## Introduction ### Alias-Formats | Format | Description | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx | | NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx | | FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> | | FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> | | PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx | | NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx | | FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> | | FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> | | RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx | ## 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\" } ] } ``` # noqa: E501
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Vault HTTP API
|
|
3
3
|
|
|
4
|
-
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\" } ] } ``` # noqa: E501
|
|
4
|
+
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) ## Introduction ### Alias-Formats | Format | Description | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx | | NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx | | FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> | | FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> | | PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx | | NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx | | FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> | | FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> | | RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx | ## 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\" } ] } ``` # noqa: E501
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -31,8 +31,8 @@ from vgs_api_client.exceptions import ApiAttributeError
|
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
def lazy_import():
|
|
34
|
-
from vgs_api_client.model.
|
|
35
|
-
globals()['
|
|
34
|
+
from vgs_api_client.model.alias_dto import AliasDto
|
|
35
|
+
globals()['AliasDto'] = AliasDto
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
class RevealedData(ModelNormal):
|
|
@@ -92,9 +92,9 @@ class RevealedData(ModelNormal):
|
|
|
92
92
|
"""
|
|
93
93
|
lazy_import()
|
|
94
94
|
return {
|
|
95
|
-
'aliases': ([
|
|
95
|
+
'aliases': ([AliasDto],), # noqa: E501
|
|
96
96
|
'classifiers': ([str],), # noqa: E501
|
|
97
|
-
'created_at': (datetime,), # noqa: E501
|
|
97
|
+
'created_at': (datetime, none_type,), # noqa: E501
|
|
98
98
|
'storage': (str,), # noqa: E501
|
|
99
99
|
'value': (str,), # noqa: E501
|
|
100
100
|
}
|
|
@@ -153,9 +153,9 @@ class RevealedData(ModelNormal):
|
|
|
153
153
|
Animal class but this time we won't travel
|
|
154
154
|
through its discriminator because we passed in
|
|
155
155
|
_visited_composed_classes = (Animal,)
|
|
156
|
-
aliases ([
|
|
156
|
+
aliases ([AliasDto]): List of aliases associated with the value.. [optional] # noqa: E501
|
|
157
157
|
classifiers ([str]): List of tags the value is classified with.. [optional] # noqa: E501
|
|
158
|
-
created_at (datetime): Creation time, in UTC.. [optional] # noqa: E501
|
|
158
|
+
created_at (datetime, none_type): Creation time, in UTC.. [optional] # noqa: E501
|
|
159
159
|
storage (str): 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. . [optional] if omitted the server will use the default value of "PERSISTENT" # noqa: E501
|
|
160
160
|
value (str): Decrypted value stored in the vault.. [optional] # noqa: E501
|
|
161
161
|
"""
|
|
@@ -239,9 +239,9 @@ class RevealedData(ModelNormal):
|
|
|
239
239
|
Animal class but this time we won't travel
|
|
240
240
|
through its discriminator because we passed in
|
|
241
241
|
_visited_composed_classes = (Animal,)
|
|
242
|
-
aliases ([
|
|
242
|
+
aliases ([AliasDto]): List of aliases associated with the value.. [optional] # noqa: E501
|
|
243
243
|
classifiers ([str]): List of tags the value is classified with.. [optional] # noqa: E501
|
|
244
|
-
created_at (datetime): Creation time, in UTC.. [optional] # noqa: E501
|
|
244
|
+
created_at (datetime, none_type): Creation time, in UTC.. [optional] # noqa: E501
|
|
245
245
|
storage (str): 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. . [optional] if omitted the server will use the default value of "PERSISTENT" # noqa: E501
|
|
246
246
|
value (str): Decrypted value stored in the vault.. [optional] # noqa: E501
|
|
247
247
|
"""
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Vault HTTP API
|
|
3
3
|
|
|
4
|
-
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\" } ] } ``` # noqa: E501
|
|
4
|
+
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) ## Introduction ### Alias-Formats | Format | Description | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx | | NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx | | FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> | | FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> | | PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx | | NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx | | FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> | | FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> | | RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx | ## 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\" } ] } ``` # noqa: E501
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Vault HTTP API
|
|
3
3
|
|
|
4
|
-
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\" } ] } ``` # noqa: E501
|
|
4
|
+
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) ## Introduction ### Alias-Formats | Format | Description | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx | | NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx | | FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> | | FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> | | PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx | | NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx | | FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> | | FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> | | RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx | ## 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\" } ] } ``` # noqa: E501
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
vgs_api_client/model_utils.py
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Vault HTTP API
|
|
3
3
|
|
|
4
|
-
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\" } ] } ``` # noqa: E501
|
|
4
|
+
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) ## Introduction ### Alias-Formats | Format | Description | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx | | NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx | | FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> | | FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> | | PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx | | NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx | | FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> | | FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> | | RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx | ## 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\" } ] } ``` # noqa: E501
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -9,9 +9,10 @@
|
|
|
9
9
|
# import sys
|
|
10
10
|
# sys.setrecursionlimit(n)
|
|
11
11
|
|
|
12
|
-
from vgs_api_client.model.
|
|
12
|
+
from vgs_api_client.model.alias_dto import AliasDto
|
|
13
13
|
from vgs_api_client.model.alias_format import AliasFormat
|
|
14
14
|
from vgs_api_client.model.api_error import ApiError
|
|
15
|
+
from vgs_api_client.model.batch_aliases_request import BatchAliasesRequest
|
|
15
16
|
from vgs_api_client.model.create_aliases_request import CreateAliasesRequest
|
|
16
17
|
from vgs_api_client.model.create_aliases_request_new import CreateAliasesRequestNew
|
|
17
18
|
from vgs_api_client.model.create_aliases_request_reference import CreateAliasesRequestReference
|
vgs_api_client/rest.py
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"""
|
|
2
2
|
Vault HTTP API
|
|
3
3
|
|
|
4
|
-
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\" } ] } ``` # noqa: E501
|
|
4
|
+
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) ## Introduction ### Alias-Formats | Format | Description | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx | | NUM_LENGTH_PRESERVING | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx | | FPE_SIX_T_FOUR | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four> | | FPE_T_FOUR | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four> | | PFPT | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx | | NON_LUHN_FPE_ALPHANUMERIC | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx | | FPE_SSN_T_FOUR | SSN - Format Preserving (A4) - xxx-xx-<last_four> | | FPE_ACC_NUM_T_FOUR | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four> | | GENERIC_T_FOUR | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four> | | RAW_UUID | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx | | ALPHANUMERIC_SIX_T_FOUR | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx | ## 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\" } ] } ``` # noqa: E501
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.0.0
|
|
7
7
|
Contact: support@verygoodsecurity.com
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: vgs-api-client
|
|
3
|
+
Version: 0.0.1.dev202404232319
|
|
4
|
+
Summary: VGS API Client.
|
|
5
|
+
Home-page: https://github.com/verygoodsecurity/vgs-api-client-python
|
|
6
|
+
Author: OpenAPI Generator community
|
|
7
|
+
Author-email: Marshall Jones <marshall@vgs.io>
|
|
8
|
+
Maintainer-email: VGS DevEx Engineering Team <hey-team-devex@verygoodsecurity.com>
|
|
9
|
+
License: BSD-3-Clause
|
|
10
|
+
Project-URL: Source Code, https://github.com/verygoodsecurity/vgs-api-client-python/
|
|
11
|
+
Project-URL: Issue Tracker, https://github.com/verygoodsecurity/vgs-api-client-python/issues/
|
|
12
|
+
Keywords: OpenAPI,OpenAPI-Generator,Vault HTTP API
|
|
13
|
+
Platform: any
|
|
14
|
+
Classifier: Development Status :: 1 - Planning
|
|
15
|
+
Classifier: Environment :: No Input/Output (Daemon)
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: License :: OSI Approved :: BSD License
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python
|
|
20
|
+
Requires-Python: >=3.6
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: aiohttp (<4,>=3.8.4)
|
|
24
|
+
Requires-Dist: python-dateutil (<3,>=2.8.2)
|
|
25
|
+
Requires-Dist: PyJWT (>=2.4)
|
|
26
|
+
Requires-Dist: PyYAML (>=5.1)
|
|
27
|
+
Requires-Dist: requests (>=2.27.1)
|
|
28
|
+
Requires-Dist: setuptools
|
|
29
|
+
Requires-Dist: simple-rest-client (==0.5.2)
|
|
30
|
+
Requires-Dist: textwrap3 (<1,>=0.9.2)
|
|
31
|
+
Provides-Extra: control-plane
|
|
32
|
+
Requires-Dist: lxml ; extra == 'control-plane'
|
|
33
|
+
Requires-Dist: PyYAML ; extra == 'control-plane'
|
|
34
|
+
Requires-Dist: pydantic (==1.7.4) ; extra == 'control-plane'
|
|
35
|
+
Requires-Dist: python-dotenv (>=0.15.0) ; extra == 'control-plane'
|
|
36
|
+
Requires-Dist: python-jose (>=3.2.0) ; extra == 'control-plane'
|
|
37
|
+
Requires-Dist: python-keycloak-client (>=0.2.3) ; extra == 'control-plane'
|
|
38
|
+
Requires-Dist: python-slugify (>=4.0.1) ; extra == 'control-plane'
|
|
39
|
+
Requires-Dist: python-status (>=1.0.1) ; extra == 'control-plane'
|
|
40
|
+
Requires-Dist: shortuuid (>=1.0.1) ; extra == 'control-plane'
|
|
41
|
+
Requires-Dist: simple-rest-client (>=1.0.8) ; extra == 'control-plane'
|
|
42
|
+
Provides-Extra: tests
|
|
43
|
+
Requires-Dist: pytest ; extra == 'tests'
|
|
44
|
+
Requires-Dist: pytest-mock ; extra == 'tests'
|
|
45
|
+
Requires-Dist: pytest-cov ; extra == 'tests'
|
|
46
|
+
Requires-Dist: pytest-black ; extra == 'tests'
|
|
47
|
+
Requires-Dist: pdbpp ; extra == 'tests'
|
|
48
|
+
Requires-Dist: black ; extra == 'tests'
|
|
49
|
+
Requires-Dist: isort ; extra == 'tests'
|
|
50
|
+
Requires-Dist: flake8 ; extra == 'tests'
|
|
51
|
+
Requires-Dist: mock ; extra == 'tests'
|
|
52
|
+
|
|
53
|
+
# vgs-api-client-python
|
|
54
|
+
|
|
55
|
+
[](https://dl.circleci.com/status-badge/redirect/gh/verygoodsecurity/vgs-api-client-python/tree/master)
|
|
56
|
+
|
|
57
|
+
This repository contains a Python API client library for the Very Good Security API.
|
|
58
|
+
|
|
59
|
+
### Requirements
|
|
60
|
+
|
|
61
|
+
Building and using the API client library requires Python 3.6+.
|
|
62
|
+
|
|
63
|
+
### Installation
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
pip install vgs-api-client
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Development
|
|
70
|
+
|
|
71
|
+
Follow [DEVELOPMENT](https://github.com/verygoodsecurity/vgs-api-client-python/blob/master/DEVELOPMENT.md) instruction.
|
|
72
|
+
|
|
73
|
+
### Release
|
|
74
|
+
|
|
75
|
+
Follow [RELEASE](https://github.com/verygoodsecurity/vgs-api-client-python/blob/master/RELEASE.md) instruction.
|
|
76
|
+
|
|
77
|
+
### Documentation
|
|
78
|
+
|
|
79
|
+
https://www.verygoodsecurity.com/docs/vault/api/
|
|
80
|
+
|
|
81
|
+
### Tutorial
|
|
82
|
+
|
|
83
|
+
https://www.verygoodsecurity.com/docs/tokenization/python-tutorial
|
|
84
|
+
|
|
85
|
+
### Artifact
|
|
86
|
+
|
|
87
|
+
https://pypi.org/project/vgs-api-client/
|
|
88
|
+
|
|
89
|
+
### Artifact
|
|
90
|
+
|
|
91
|
+
https://pypi.org/project/vgs-api-client/
|
|
92
|
+
|
|
93
|
+
### Support
|
|
94
|
+
|
|
95
|
+
support@verygoodsecurity.com
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
vgs/__init__.py,sha256=ULZPAmePcbYn9G9tl8oijOZrzhW6OHgJunUmhjAIs-s,216
|
|
2
|
+
vgs/aliases_api.py,sha256=LU8bwGYd1uP5SqTIPihU_Z6WTbuxW7HcK76w7zc1lS4,3580
|
|
3
|
+
vgs/base_api.py,sha256=l3ELY35PbvE6z5eMKl5vsqW66QDTrTCzMlb1XXOhWms,1730
|
|
4
|
+
vgs/configuration.py,sha256=_LGfACVJxZmJVbIPTRp8riVYpr02L29JvVdw2goXWH0,743
|
|
5
|
+
vgs/exceptions.py,sha256=JmnO9xKEf3J6aBobxFNyPNqo71DfNvVke2zjqXv07Os,478
|
|
6
|
+
vgs/functions_api.py,sha256=jFrUBUQRBr4c7Tbq5aJthDUGoSvzzCrb7nsbPP3gc0w,10494
|
|
7
|
+
vgs/certs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
|
+
vgs/certs/vgs-proxy-dev.pem,sha256=QDJjqhxofR37v4yZSkGI9U4C0K3q-buab4QUzO0pR_Q,1379
|
|
9
|
+
vgs/certs/vgs-proxy-live.pem,sha256=fbB0CS-ziPDTKi9gaZcx3oPTqkE9dNp11KKKEUSFlVk,1387
|
|
10
|
+
vgs/certs/vgs-proxy-sandbox.pem,sha256=_N1Zt7Ywj0XN0gb1rSCxP8VIQnGfx6bjGCq0NNjS_UM,1395
|
|
11
|
+
vgs/control_plane/__init__.py,sha256=tFoV_tu7G2Z9urOTb3LJcMW8O5X7f3Vgb0JwjVM5AYk,28
|
|
12
|
+
vgs/control_plane/apis/__init__.py,sha256=EwJQMcbcZxuVputS5SuZmm-1gyZAFm_eflE7hf_fdTU,51
|
|
13
|
+
vgs/control_plane/apis/account_management.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
14
|
+
vgs/control_plane/apis/vault_management.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
15
|
+
vgs/control_plane/clients/__init__.py,sha256=9jleXl5JSsRCor2x52yaF_VTkJdipl9E05dw80Oz-w4,36
|
|
16
|
+
vgs/control_plane/clients/organizations.py,sha256=W7YPjSHE-lQ4qoOk6Plr3J8Gid7-hNNLI2Frk2WPHoA,37
|
|
17
|
+
vgs/control_plane/clients/vaults.py,sha256=FP_jjfHFON7_n-xS59Rzbfbpsdqu0SvwunnClZDrPZA,67
|
|
18
|
+
vgs/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
19
|
+
vgs/sdk/account_mgmt.py,sha256=lNdUv_CGjiiFCOOC9q3dg7dtPaHaAtIIInVipKvD_J4,2087
|
|
20
|
+
vgs/sdk/accounts_api.py,sha256=AjGRHX4JPcRd1U38uOFYrobdsj_e2FAh6y0AtxiZCcI,1748
|
|
21
|
+
vgs/sdk/auth_api.py,sha256=b-P_9hFyTgxWPawOd05eElmel-dT-bUxmybpQRYlxmI,2256
|
|
22
|
+
vgs/sdk/errors.py,sha256=_ulKAG6-bJShN8RvvETm6Pg2j9Lgu4I4jJtHIcMR5FA,5119
|
|
23
|
+
vgs/sdk/routes.py,sha256=WEQThPlsfKKZuWl8LaYDGylbhR4cdm0cYPbBaSBiRuM,1874
|
|
24
|
+
vgs/sdk/serializers.py,sha256=nE4P83LRA4MwJkvvMNRVTxQ34-Ue_-NAtvbNfJ-B-IA,2259
|
|
25
|
+
vgs/sdk/utils.py,sha256=A_ZKhCefl8v0ELB3xfSIHM-wooxV1GftVMLLvd0RPaM,2668
|
|
26
|
+
vgs/sdk/vault_mgmt.py,sha256=R7dUKunJBzk4R37-h0qFf13MkvXXR4yRG8nwW58f4eo,1854
|
|
27
|
+
vgs/sdk/vaults_api.py,sha256=Lcro7uMDfOM1qTAFfv4ENxfPgbGBk8eH1DB72Y99HTU,1454
|
|
28
|
+
vgs_api_client/__init__.py,sha256=-oMg4tYBtgJ9r9iWA4wS6PM9f0OxbVqwfvg66Sc5dVQ,6631
|
|
29
|
+
vgs_api_client/api_client.py,sha256=xxKfQ3gi9BHdeNKbcSjvSIELTIuccXRimGnBlx_gKGE,43519
|
|
30
|
+
vgs_api_client/configuration.py,sha256=-z7XbFla9RlH8mVL3D-Kwv-5adilC5vz5Q0jvtbRaCo,23059
|
|
31
|
+
vgs_api_client/exceptions.py,sha256=0I5k2yYDfsDk_E8q_5a22yS0HkeEAKxABgmhTw6OX_M,10937
|
|
32
|
+
vgs_api_client/model_utils.py,sha256=Ouh-4QLJ-9LkKIhiEi1XthmxQU4dPJ7cq-glDjldmw4,87951
|
|
33
|
+
vgs_api_client/rest.py,sha256=GkE8MJ48Z1i8j9knJdQxeoBxuDKtN1zhV4el4Ubn93s,20061
|
|
34
|
+
vgs_api_client/api/__init__.py,sha256=ZH2vM54I3vD1_ApDnXo1cb3sPmiLCBAPjtEBqnkRFAk,218
|
|
35
|
+
vgs_api_client/api/aliases_api.py,sha256=tYb_hXrD-msqPVbMHH4dNdxCEQrGZx9oLHFbDOz11iQ,37963
|
|
36
|
+
vgs_api_client/apis/__init__.py,sha256=2-Va0okhCKEPLInN9e0rkcEdO3svrKqn0JfEwL9gbWU,467
|
|
37
|
+
vgs_api_client/model/__init__.py,sha256=N49d9K35V_Hd5lOHWcMeVRl0Iy_-L-03rZgfKXwlESM,348
|
|
38
|
+
vgs_api_client/model/alias_dto.py,sha256=2FkSFujCv9cM_lETka5tn3bOZFPz5-LAicFwbmaxXWA,17354
|
|
39
|
+
vgs_api_client/model/alias_format.py,sha256=1vY97OruVZbTXmtz8Vmb8iQDRtIVbPAVXhGArCqZc5M,19552
|
|
40
|
+
vgs_api_client/model/api_error.py,sha256=LbRIFkJKkUNwk7wZNIaw6-_wdUYpAHBvUpQL5dvuIco,17669
|
|
41
|
+
vgs_api_client/model/batch_aliases_request.py,sha256=EpvXKr324ScfUgmMStROJWmmpQvEVhyYzECmAAJcOVY,17213
|
|
42
|
+
vgs_api_client/model/create_aliases_request.py,sha256=uIxeejLzk0j1agwd9IH7Kf3aET4kxtAB2ATluI8Ug7U,17322
|
|
43
|
+
vgs_api_client/model/create_aliases_request_new.py,sha256=MJWeRM23YWqPD5KKMt3gpot2pN0S5j6EJ6w7iO7XE_M,18558
|
|
44
|
+
vgs_api_client/model/create_aliases_request_reference.py,sha256=tTYQm9J7CuM_h6F-0qh5iZgje7gie77h7RGpDPyxOiE,17467
|
|
45
|
+
vgs_api_client/model/inline_response200.py,sha256=Vyz-WYxZ0pFDV739zlip-MbDfRYsgfkOsodlogLkpxg,17127
|
|
46
|
+
vgs_api_client/model/inline_response2001.py,sha256=1C3sZUS4dDcwp8HpDtIrUbSQnfOibn-pfbXbpcbnExA,17238
|
|
47
|
+
vgs_api_client/model/inline_response201.py,sha256=JyFEcum7jb-xzyIF-MleBBm8GU0iISIe1yyOolfmjHw,17201
|
|
48
|
+
vgs_api_client/model/inline_response_default.py,sha256=zVNbbmkiRjaAs1m9UpLFMS4kJXJ9hXbwX5-ojm2dZQo,17279
|
|
49
|
+
vgs_api_client/model/revealed_data.py,sha256=iwbBeXm8dFd3a_Jy-aYSss1lcd-WtsHMu5XHWz4nKis,18829
|
|
50
|
+
vgs_api_client/model/update_alias_request.py,sha256=1-eVausLuXiWT8vjL9CaVz97JGqnK46de8iutPJ2KDY,17214
|
|
51
|
+
vgs_api_client/model/update_alias_request_data.py,sha256=ZQ28nNKrtauPmGHrYihjkEm-NCsk30gf7pb1QnIimV4,17119
|
|
52
|
+
vgs_api_client/models/__init__.py,sha256=EiYza7gtB_YK7gcFkHMfN4BJzXAB1HCSC2tsugz1R84,1376
|
|
53
|
+
vgs_api_client-0.0.1.dev202404232319.dist-info/LICENSE,sha256=gagH-1SrLS5Ak0nwk7XRKDn_9LHLVj_m0YrWmXKXpjE,1469
|
|
54
|
+
vgs_api_client-0.0.1.dev202404232319.dist-info/METADATA,sha256=i3elCznnRrKhs7wG_YPc5slCzj-wL8zYmlSAePJGwRk,3439
|
|
55
|
+
vgs_api_client-0.0.1.dev202404232319.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
|
|
56
|
+
vgs_api_client-0.0.1.dev202404232319.dist-info/top_level.txt,sha256=mENC1FHtjk4WsD_SkaFv5S4v1_nRpy7PjClldcU3_DU,19
|
|
57
|
+
vgs_api_client-0.0.1.dev202404232319.dist-info/RECORD,,
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: vgs-api-client
|
|
3
|
-
Version: 0.0.1.dev202305161416
|
|
4
|
-
Summary: VGS API Client
|
|
5
|
-
Home-page: https://github.com/verygoodsecurity/vgs-api-client-python
|
|
6
|
-
Author: Very Good Security
|
|
7
|
-
Author-email: support@verygoodsecurity.com
|
|
8
|
-
License: BSD
|
|
9
|
-
Project-URL: Bug Tracker, https://github.com/verygoodsecurity/vgs-api-client-python/issues
|
|
10
|
-
Project-URL: Documentation, https://www.verygoodsecurity.com/docs/
|
|
11
|
-
Project-URL: Source Code, https://github.com/verygoodsecurity/vgs-api-client-python
|
|
12
|
-
Keywords: openapi,api,client,vgs,VeryGoodSecurity
|
|
13
|
-
Platform: any
|
|
14
|
-
Classifier: Intended Audience :: Developers
|
|
15
|
-
Classifier: License :: OSI Approved :: BSD License
|
|
16
|
-
Classifier: Operating System :: OS Independent
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.7
|
|
18
|
-
Classifier: Programming Language :: Python :: 3.8
|
|
19
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
20
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
21
|
-
Requires-Python: >=3.7
|
|
22
|
-
Description-Content-Type: text/markdown
|
|
23
|
-
License-File: LICENSE
|
|
24
|
-
Requires-Dist: aiohttp (==3.8.4)
|
|
25
|
-
Requires-Dist: python-dateutil (==2.8.2)
|
|
26
|
-
Requires-Dist: PyJWT (>=2.4)
|
|
27
|
-
Requires-Dist: PyYAML (>=5.1)
|
|
28
|
-
Requires-Dist: requests (>=2.27.1)
|
|
29
|
-
Requires-Dist: setuptools (==62.3.3)
|
|
30
|
-
Requires-Dist: simple-rest-client (==0.5.2)
|
|
31
|
-
Requires-Dist: textwrap3 (==0.9.2)
|
|
32
|
-
|
|
33
|
-
# vgs-api-client-python
|
|
34
|
-
|
|
35
|
-
[](https://github.com/verygoodsecurity/vgs-api-client-python)
|
|
36
|
-
|
|
37
|
-
This repository contains a Python API client library for the Very Good Security API.
|
|
38
|
-
|
|
39
|
-
### Requirements
|
|
40
|
-
|
|
41
|
-
Building and using the API client library requires Python 3.6+.
|
|
42
|
-
|
|
43
|
-
### Installation
|
|
44
|
-
|
|
45
|
-
```
|
|
46
|
-
pip install vgs-api-client
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
### Development
|
|
50
|
-
|
|
51
|
-
Follow [DEVELOPMENT](https://github.com/verygoodsecurity/vgs-api-client-python/blob/master/DEVELOPMENT.md) instruction.
|
|
52
|
-
|
|
53
|
-
### Release
|
|
54
|
-
|
|
55
|
-
Follow [RELEASE](https://github.com/verygoodsecurity/vgs-api-client-python/blob/master/RELEASE.md) instruction.
|
|
56
|
-
|
|
57
|
-
### Documentation
|
|
58
|
-
|
|
59
|
-
https://www.verygoodsecurity.com/docs/vault/api/
|
|
60
|
-
|
|
61
|
-
### Tutorial
|
|
62
|
-
|
|
63
|
-
https://www.verygoodsecurity.com/docs/tokenization/python-tutorial
|
|
64
|
-
|
|
65
|
-
### Artifact
|
|
66
|
-
|
|
67
|
-
https://pypi.org/project/vgs-api-client/
|
|
68
|
-
|
|
69
|
-
### Artifact
|
|
70
|
-
|
|
71
|
-
https://pypi.org/project/vgs-api-client/
|
|
72
|
-
|
|
73
|
-
### Support
|
|
74
|
-
|
|
75
|
-
support@verygoodsecurity.com
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
-
vgs/__init__.py,sha256=7i5U1jFYOL-U6rw6o5qrqk3C2vHfpIsB4R2L_F0UG0A,213
|
|
3
|
-
vgs/aliases_api.py,sha256=mSla6oPwGbaXVYrptTu_ABjwCHyu-ovzyL1qvvWtvxE,3377
|
|
4
|
-
vgs/base_api.py,sha256=VL8VpPXBKsYMc-1hsq9yQjQsdrq6uX7RzdSA30sFyEQ,1776
|
|
5
|
-
vgs/configuration.py,sha256=CEQLAg4CrSx2lWL4zE7nEDmj8kq5Vl_fkrv8Yx8gd6o,646
|
|
6
|
-
vgs/exceptions.py,sha256=JmnO9xKEf3J6aBobxFNyPNqo71DfNvVke2zjqXv07Os,478
|
|
7
|
-
vgs/functions_api.py,sha256=r1NZozxqSr0Tqqbstcr_NuHjOTp8nI8fb6abOtJ8-t8,10666
|
|
8
|
-
vgs/certs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
9
|
-
vgs/certs/vgs-proxy-dev.pem,sha256=QDJjqhxofR37v4yZSkGI9U4C0K3q-buab4QUzO0pR_Q,1379
|
|
10
|
-
vgs/certs/vgs-proxy-live.pem,sha256=fbB0CS-ziPDTKi9gaZcx3oPTqkE9dNp11KKKEUSFlVk,1387
|
|
11
|
-
vgs/certs/vgs-proxy-sandbox.pem,sha256=_N1Zt7Ywj0XN0gb1rSCxP8VIQnGfx6bjGCq0NNjS_UM,1395
|
|
12
|
-
vgs/sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
13
|
-
vgs/sdk/account_mgmt.py,sha256=BehrIfGqkar3Y4MyRE9NYH3kgmMuwpGXVRcpS2P_sGk,2087
|
|
14
|
-
vgs/sdk/accounts_api.py,sha256=NnWrEhIFacIT0BaCaXV2OfzmX1Tla2PhHkrpMNqkgRI,1748
|
|
15
|
-
vgs/sdk/auth_api.py,sha256=kalmf0w82fHoWZvyabhxuBqbQYSYhT5mILrysqOjZ-4,2256
|
|
16
|
-
vgs/sdk/errors.py,sha256=5X7CXXd14gD3kIIRsZyPPjA0rsu46iQrxhptHGltSWY,5223
|
|
17
|
-
vgs/sdk/routes.py,sha256=xEPDG37ECys1AWWaf_rFx5tt6Y3BkamzvxskeD4xOx8,1349
|
|
18
|
-
vgs/sdk/serializers.py,sha256=nE4P83LRA4MwJkvvMNRVTxQ34-Ue_-NAtvbNfJ-B-IA,2259
|
|
19
|
-
vgs/sdk/utils.py,sha256=A_ZKhCefl8v0ELB3xfSIHM-wooxV1GftVMLLvd0RPaM,2668
|
|
20
|
-
vgs/sdk/vault_mgmt.py,sha256=ez6cnhXW3NTULLNs9FC5XEhPBHdX08MLwA6kfF3BYIE,1854
|
|
21
|
-
vgs/sdk/vaults_api.py,sha256=-_-mgmyeb0ly1qbSEJjH5kvWR7_6AhDv0bItEf_QWjo,1454
|
|
22
|
-
vgs_api_client/__init__.py,sha256=F7u_NpQII5g98uU4iHYle9PngYSClz1-rvAAcI34D9M,4675
|
|
23
|
-
vgs_api_client/api_client.py,sha256=UdG20WyBOYoOp0yZGd25pWYufe2DKsgifRfTTtkF4go,41563
|
|
24
|
-
vgs_api_client/configuration.py,sha256=RnbvpsMEJhZeOxRIThaEhrWRjZGNSbHSf7XYPUQwsyk,21103
|
|
25
|
-
vgs_api_client/exceptions.py,sha256=uq6hLBifxzcf26HNEYHenvyYr2WQaGMT9Bm_R4MwGd0,8981
|
|
26
|
-
vgs_api_client/model_utils.py,sha256=2TUCJD4BlYUYgaTre_Vi0ycJN4lMmFgXkss1JJr59pk,85995
|
|
27
|
-
vgs_api_client/rest.py,sha256=LA53pnePXISleLyRjQSyomGzJR5ejbja2p-vE1C_W3w,18105
|
|
28
|
-
vgs_api_client/api/__init__.py,sha256=ZH2vM54I3vD1_ApDnXo1cb3sPmiLCBAPjtEBqnkRFAk,218
|
|
29
|
-
vgs_api_client/api/aliases_api.py,sha256=JpiU1G7DZgyiLOM622TEYQ5NZqrhMppgrQaIiaZ2QvU,29489
|
|
30
|
-
vgs_api_client/apis/__init__.py,sha256=2-Va0okhCKEPLInN9e0rkcEdO3svrKqn0JfEwL9gbWU,467
|
|
31
|
-
vgs_api_client/model/__init__.py,sha256=N49d9K35V_Hd5lOHWcMeVRl0Iy_-L-03rZgfKXwlESM,348
|
|
32
|
-
vgs_api_client/model/alias.py,sha256=hUITAxJ6ant1rp0V9vCgTJre4wTebCq7ePbYn2sT8vI,15389
|
|
33
|
-
vgs_api_client/model/alias_format.py,sha256=-aDeONQvD9PSfOuXsPpMFv5-IgK4aIegBXdvDGIP6KY,17277
|
|
34
|
-
vgs_api_client/model/api_error.py,sha256=aDikvoON1eB8giSzOtBNITHYKN5wi3MOpSpsV3KIhXE,15713
|
|
35
|
-
vgs_api_client/model/create_aliases_request.py,sha256=j91ed-CNN8cZuBTrKjRz7Vi0xUGh6USYDX8w7ci7Ozk,15656
|
|
36
|
-
vgs_api_client/model/create_aliases_request_new.py,sha256=TYtHiEUFGExDDz8k0Igz_gdoilQKUf2mFxBFjx5969s,16602
|
|
37
|
-
vgs_api_client/model/create_aliases_request_reference.py,sha256=_5Lz2Uxmm6znL_hHzSQrfKGh65Huyy_htQFsygeWZTo,15511
|
|
38
|
-
vgs_api_client/model/inline_response200.py,sha256=9A6MfSnlR6uoG6OtHR6b7wocm6GLu9GJZ5sSJO8AZg0,15171
|
|
39
|
-
vgs_api_client/model/inline_response2001.py,sha256=Y-bJyP1DIQIUNg4NWMr6f1EyLMJY6i54lnJ3jndOJ4A,15282
|
|
40
|
-
vgs_api_client/model/inline_response201.py,sha256=dysXMRk4NniTeQmqegwLSLhZy9u21vgI81vAlJ5aZHU,15245
|
|
41
|
-
vgs_api_client/model/inline_response_default.py,sha256=3AexMWYmdf0ToybLi1Uxgb_CWLQTxZajG43CMAXfCgI,15323
|
|
42
|
-
vgs_api_client/model/revealed_data.py,sha256=yQNMLJDC85xtozzgIirmdKRpysG7Lxwu7Ty3L2daepg,16818
|
|
43
|
-
vgs_api_client/model/update_alias_request.py,sha256=1_U4nTwMEZJydmCaK6xJjwNK7t4cD57DVOVv4fRH8AI,15258
|
|
44
|
-
vgs_api_client/model/update_alias_request_data.py,sha256=GVSPxYQ6aySolzU6aFV4QQYkhKCh-fhkl0bOwLlS2Ig,15163
|
|
45
|
-
vgs_api_client/models/__init__.py,sha256=Dpplz2lyCGEyABG8UXRGxryCicX5nWdCyQgAlrJU-iw,1294
|
|
46
|
-
vgs_api_client-0.0.1.dev202305161416.dist-info/LICENSE,sha256=gagH-1SrLS5Ak0nwk7XRKDn_9LHLVj_m0YrWmXKXpjE,1469
|
|
47
|
-
vgs_api_client-0.0.1.dev202305161416.dist-info/METADATA,sha256=CX8dV5yKMmsq7eawHJ0AvJs9cgpIJkZ3FS2PpCCYuYY,2238
|
|
48
|
-
vgs_api_client-0.0.1.dev202305161416.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
|
|
49
|
-
vgs_api_client-0.0.1.dev202305161416.dist-info/top_level.txt,sha256=vM9hfijq_VK5Y_UIF-BfISXYfNc4AXOHYV-mORSaauQ,23
|
|
50
|
-
vgs_api_client-0.0.1.dev202305161416.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|