diff --git a/access_token/.gitattributes b/access_token/.gitattributes new file mode 100755 index 000000000..4d75d5900 --- /dev/null +++ b/access_token/.gitattributes @@ -0,0 +1,2 @@ +# This allows generated code to be indexed correctly +*.py linguist-generated=false \ No newline at end of file diff --git a/access_token/.gitignore b/access_token/.gitignore new file mode 100755 index 000000000..3cdf33802 --- /dev/null +++ b/access_token/.gitignore @@ -0,0 +1,6 @@ +venv/ +src/*.egg-info/ +__pycache__/ +.pytest_cache/ +.python-version +.DS_Store diff --git a/access_token/README.md b/access_token/README.md index caaf79ad0..767f8af17 100755 --- a/access_token/README.md +++ b/access_token/README.md @@ -12,44 +12,172 @@ pip install git+https://github.com/epilot-dev/sdk-python.git#subdirectory=access ```python import epilot -from epilot.models import operations, shared +from epilot.models import shared s = epilot.Epilot( security=shared.Security( - epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE", + epilot_auth="", ), ) - -req = shared.JourneyTokenParameters( - journey_id="deserunt", - name="Postman Access Token", - token_type="journey", +req = shared.AccessTokenParameters( + assignments=[ + '123:owner', + ], + name='Postman Access Token', ) - + res = s.access_tokens.create_access_token(req) if res.create_access_token_201_application_json_object is not None: # handle response + pass ``` -## SDK Available Operations +## Available Resources and Operations -### access_tokens +### [access_tokens](docs/sdks/accesstokens/README.md) -* `create_access_token` - createAccessToken -* `list_access_tokens` - listAccessTokens -* `revoke_access_token` - revokeAccessToken +* [create_access_token](docs/sdks/accesstokens/README.md#create_access_token) - createAccessToken +* [list_access_tokens](docs/sdks/accesstokens/README.md#list_access_tokens) - listAccessTokens +* [revoke_access_token](docs/sdks/accesstokens/README.md#revoke_access_token) - revokeAccessToken -### public +### [public](docs/sdks/public/README.md) -* `get_access_token_jwks` - getAccessTokenJwks -* `get_access_token_oidc` - getAccessTokenOIDC -* `get_public_token_jwks` - getPublicTokenJwks -* `get_public_token_oidc` - getPublicTokenOIDC +* [get_access_token_jwks](docs/sdks/public/README.md#get_access_token_jwks) - getAccessTokenJwks +* [get_access_token_oidc](docs/sdks/public/README.md#get_access_token_oidc) - getAccessTokenOIDC +* [get_public_token_jwks](docs/sdks/public/README.md#get_public_token_jwks) - getPublicTokenJwks +* [get_public_token_oidc](docs/sdks/public/README.md#get_public_token_oidc) - getPublicTokenOIDC + + + + + + + + + +# Pagination + +Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the +returned response object will have a `Next` method that can be called to pull down the next group of results. If the +return value of `Next` is `None`, then there are no more pages to be fetched. + +Here's an example of one such pagination call: + + + + + +# Error Handling + +Handling errors in your SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type. + + + + + + + +# Server Selection + +## Select Server by Index + +You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers: + +| # | Server | Variables | +| - | ------ | --------- | +| 0 | `https://access-token.sls.epilot.io` | None | + +For example: + + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), + server_idx=0 +) + +req = shared.AccessTokenParameters( + assignments=[ + '123:owner', + ], + name='Postman Access Token', +) + +res = s.access_tokens.create_access_token(req) + +if res.create_access_token_201_application_json_object is not None: + # handle response + pass +``` + + +## Override Server URL Per-Client + +The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example: + + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), + server_url="https://access-token.sls.epilot.io" +) + +req = shared.AccessTokenParameters( + assignments=[ + '123:owner', + ], + name='Postman Access Token', +) + +res = s.access_tokens.create_access_token(req) + +if res.create_access_token_201_application_json_object is not None: + # handle response + pass +``` + + + + + +# Custom HTTP Client + +The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object. + + +For example, you could specify a header for every request that your sdk makes as follows: + +```python +import epilot +import requests + +http_client = requests.Session() +http_client.headers.update({'x-custom-header': 'someValue'}) +s = epilot.Epilot(client: http_client) +``` + + + + + + + + ### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks) diff --git a/access_token/RELEASES.md b/access_token/RELEASES.md index ef8133475..d612e9738 100644 --- a/access_token/RELEASES.md +++ b/access_token/RELEASES.md @@ -40,4 +40,196 @@ Based on: ### Changes Based on: - OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml -- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy \ No newline at end of file +- Speakeasy CLI 1.19.2 (2.16.5) https://github.com/speakeasy-api/speakeasy + +## 2023-08-09 00:44:50 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.70.2 (2.83.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.3.0] access_token + +## 2023-08-15 00:36:09 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.72.0 (2.84.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.4.0] access_token + +## 2023-08-19 00:34:32 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.74.3 (2.86.6) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.4.1] access_token + +## 2023-08-25 00:36:38 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.74.11 (2.87.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.4.2] access_token + +## 2023-08-26 00:35:09 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.74.16 (2.88.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.5.0] access_token + +## 2023-08-29 00:36:57 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.74.17 (2.88.5) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.5.1] access_token + +## 2023-08-31 00:37:17 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.76.0 (2.89.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.6.0] access_token + +## 2023-09-01 00:39:47 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.77.0 (2.91.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.7.0] access_token + +## 2023-09-02 00:35:28 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.77.2 (2.93.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.7.1] access_token + +## 2023-09-05 00:36:27 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.78.3 (2.96.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.7.2] access_token + +## 2023-09-12 00:35:53 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.82.5 (2.108.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.7.3] access_token + +## 2023-09-16 00:36:15 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.86.0 (2.115.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.7.4] access_token + +## 2023-09-20 00:37:26 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.88.0 (2.118.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.7.5] access_token + +## 2023-09-26 00:37:59 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.91.0 (2.129.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.8.0] access_token + +## 2023-09-27 00:37:58 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.91.2 (2.131.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.8.1] access_token + +## 2023-09-29 00:38:04 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.91.3 (2.139.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.9.0] access_token + +## 2023-10-01 00:43:15 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.92.2 (2.142.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.10.0] access_token + +## 2023-10-02 00:38:27 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.92.3 (2.143.2) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.10.1] access_token + +## 2023-10-05 00:38:01 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.94.0 (2.147.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.10.2] access_token + +## 2023-10-07 00:37:09 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.96.1 (2.150.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.11.0] access_token + +## 2023-10-13 00:38:59 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.99.1 (2.154.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v1.11.1] access_token + +## 2023-10-18 00:38:05 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.101.0 (2.161.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.0.0] access_token + +## 2023-10-21 00:36:38 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.104.0 (2.169.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.0] access_token + +## 2023-10-28 00:36:21 +### Changes +Based on: +- OpenAPI Doc 0.2.0 https://docs.api.epilot.io/access-token.yaml +- Speakeasy CLI 1.109.0 (2.173.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v2.1.1] access_token \ No newline at end of file diff --git a/access_token/USAGE.md b/access_token/USAGE.md index a78cc3125..a15ffaeab 100755 --- a/access_token/USAGE.md +++ b/access_token/USAGE.md @@ -1,24 +1,27 @@ + + ```python import epilot -from epilot.models import operations, shared +from epilot.models import shared s = epilot.Epilot( security=shared.Security( - epilot_auth="Bearer YOUR_BEARER_TOKEN_HERE", + epilot_auth="", ), ) - -req = shared.JourneyTokenParameters( - journey_id="deserunt", - name="Postman Access Token", - token_type="journey", +req = shared.AccessTokenParameters( + assignments=[ + '123:owner', + ], + name='Postman Access Token', ) - + res = s.access_tokens.create_access_token(req) if res.create_access_token_201_application_json_object is not None: # handle response + pass ``` \ No newline at end of file diff --git a/access_token/docs/models/operations/createaccesstoken201applicationjson.md b/access_token/docs/models/operations/createaccesstoken201applicationjson.md new file mode 100755 index 000000000..cf51a9329 --- /dev/null +++ b/access_token/docs/models/operations/createaccesstoken201applicationjson.md @@ -0,0 +1,16 @@ +# CreateAccessToken201ApplicationJSON + +The new generated Access Token + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `assignments` | List[*str*] | :heavy_minus_sign: | List of role ids attached to an user | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | api_5ZugdRXasLfWBypHi93Fk | +| `journey_id` | *Optional[str]* | :heavy_minus_sign: | Journey ID for access token type "journey" | | +| `name` | *str* | :heavy_check_mark: | Human readable name for access token | Postman Access Token | +| `token` | *Optional[str]* | :heavy_minus_sign: | A JWT Access Token | eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp... | +| `token_type` | [Optional[shared.AccessTokenType]](../../models/shared/accesstokentype.md) | :heavy_minus_sign: | Access token type | api | \ No newline at end of file diff --git a/access_token/docs/models/operations/createaccesstokenresponse.md b/access_token/docs/models/operations/createaccesstokenresponse.md new file mode 100755 index 000000000..f40de9c32 --- /dev/null +++ b/access_token/docs/models/operations/createaccesstokenresponse.md @@ -0,0 +1,11 @@ +# CreateAccessTokenResponse + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `create_access_token_201_application_json_object` | [Optional[CreateAccessToken201ApplicationJSON]](../../models/operations/createaccesstoken201applicationjson.md) | :heavy_minus_sign: | The new generated Access Token | \ No newline at end of file diff --git a/access_token/docs/models/operations/getaccesstokenjwks200applicationjson.md b/access_token/docs/models/operations/getaccesstokenjwks200applicationjson.md new file mode 100755 index 000000000..08914072c --- /dev/null +++ b/access_token/docs/models/operations/getaccesstokenjwks200applicationjson.md @@ -0,0 +1,10 @@ +# GetAccessTokenJwks200ApplicationJSON + +Set of jwks + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `keys` | List[[GetAccessTokenJwks200ApplicationJSONKeys](../../models/operations/getaccesstokenjwks200applicationjsonkeys.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/access_token/docs/models/operations/getaccesstokenjwks200applicationjsonkeys.md b/access_token/docs/models/operations/getaccesstokenjwks200applicationjsonkeys.md new file mode 100755 index 000000000..d8f4af65f --- /dev/null +++ b/access_token/docs/models/operations/getaccesstokenjwks200applicationjsonkeys.md @@ -0,0 +1,13 @@ +# GetAccessTokenJwks200ApplicationJSONKeys + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `alg` | *Optional[str]* | :heavy_minus_sign: | N/A | RS256 | +| `e` | *Optional[str]* | :heavy_minus_sign: | N/A | AQAB | +| `kid` | *Optional[str]* | :heavy_minus_sign: | N/A | tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw= | +| `kty` | *Optional[str]* | :heavy_minus_sign: | N/A | RSA | +| `n` | *Optional[str]* | :heavy_minus_sign: | N/A | h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ | +| `use` | *Optional[str]* | :heavy_minus_sign: | N/A | sig | \ No newline at end of file diff --git a/access_token/docs/models/operations/getaccesstokenjwksresponse.md b/access_token/docs/models/operations/getaccesstokenjwksresponse.md new file mode 100755 index 000000000..2561e0af6 --- /dev/null +++ b/access_token/docs/models/operations/getaccesstokenjwksresponse.md @@ -0,0 +1,11 @@ +# GetAccessTokenJwksResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_access_token_jwks_200_application_json_object` | [Optional[GetAccessTokenJwks200ApplicationJSON]](../../models/operations/getaccesstokenjwks200applicationjson.md) | :heavy_minus_sign: | Set of jwks | \ No newline at end of file diff --git a/access_token/docs/models/operations/getaccesstokenoidc200applicationjson.md b/access_token/docs/models/operations/getaccesstokenoidc200applicationjson.md new file mode 100755 index 000000000..969c68d42 --- /dev/null +++ b/access_token/docs/models/operations/getaccesstokenoidc200applicationjson.md @@ -0,0 +1,11 @@ +# GetAccessTokenOIDC200ApplicationJSON + +OpenID Configuration + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `issuer` | *Optional[str]* | :heavy_minus_sign: | N/A | https://access-token.sls.epilot.io/v1/access-tokens | +| `jwks_uri` | *Optional[str]* | :heavy_minus_sign: | N/A | https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json | \ No newline at end of file diff --git a/access_token/docs/models/operations/getaccesstokenoidcresponse.md b/access_token/docs/models/operations/getaccesstokenoidcresponse.md new file mode 100755 index 000000000..c72db5fa0 --- /dev/null +++ b/access_token/docs/models/operations/getaccesstokenoidcresponse.md @@ -0,0 +1,11 @@ +# GetAccessTokenOIDCResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_access_token_oidc_200_application_json_object` | [Optional[GetAccessTokenOIDC200ApplicationJSON]](../../models/operations/getaccesstokenoidc200applicationjson.md) | :heavy_minus_sign: | OpenID Configuration | \ No newline at end of file diff --git a/access_token/docs/models/operations/getpublictokenjwks200applicationjson.md b/access_token/docs/models/operations/getpublictokenjwks200applicationjson.md new file mode 100755 index 000000000..1bd502832 --- /dev/null +++ b/access_token/docs/models/operations/getpublictokenjwks200applicationjson.md @@ -0,0 +1,10 @@ +# GetPublicTokenJwks200ApplicationJSON + +Set of jwks + + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| `keys` | List[[GetPublicTokenJwks200ApplicationJSONKeys](../../models/operations/getpublictokenjwks200applicationjsonkeys.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/access_token/docs/models/operations/getpublictokenjwks200applicationjsonkeys.md b/access_token/docs/models/operations/getpublictokenjwks200applicationjsonkeys.md new file mode 100755 index 000000000..7db0222bd --- /dev/null +++ b/access_token/docs/models/operations/getpublictokenjwks200applicationjsonkeys.md @@ -0,0 +1,13 @@ +# GetPublicTokenJwks200ApplicationJSONKeys + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `alg` | *Optional[str]* | :heavy_minus_sign: | N/A | RS256 | +| `e` | *Optional[str]* | :heavy_minus_sign: | N/A | AQAB | +| `kid` | *Optional[str]* | :heavy_minus_sign: | N/A | tXWU5mPMbRPczpbQwi6vbhLF4GgF3wlMDSyqo7pfeiw= | +| `kty` | *Optional[str]* | :heavy_minus_sign: | N/A | RSA | +| `n` | *Optional[str]* | :heavy_minus_sign: | N/A | h_QDoCjZ8W_trtYXaP7_S22wf5r5Wd9XBLED78oT44bJjQXn8ddcFV8Hik65_4IYXVX_hTTU4zpxe3H8vx2j7-Zz3O59mYMp5S0MzODNEdf5Y_2o19eis0brmAJniixsNlQ9LlYkdrVamrgaxHu3ZpP_99zkfFybYeuYoQNzb3PyrT8xVnz_USs_nlFMHpGUxvvz7gfKPqxcLvgLJr4cwI9yzaSY9CD4qW181QVcnL_WzpQ8xx6AuhhHZQ1l_3GG4InTk8ahE7U2ZHVu8RrX6d01pMgc3piEcet9RgFLnhbTg3YIiKGoAbN42wJn_x3lgIAC42T9mbmTsHyUdS6nUQ | +| `use` | *Optional[str]* | :heavy_minus_sign: | N/A | sig | \ No newline at end of file diff --git a/access_token/docs/models/operations/getpublictokenjwksresponse.md b/access_token/docs/models/operations/getpublictokenjwksresponse.md new file mode 100755 index 000000000..a94888dad --- /dev/null +++ b/access_token/docs/models/operations/getpublictokenjwksresponse.md @@ -0,0 +1,11 @@ +# GetPublicTokenJwksResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_public_token_jwks_200_application_json_object` | [Optional[GetPublicTokenJwks200ApplicationJSON]](../../models/operations/getpublictokenjwks200applicationjson.md) | :heavy_minus_sign: | Set of jwks | \ No newline at end of file diff --git a/access_token/docs/models/operations/getpublictokenoidc200applicationjson.md b/access_token/docs/models/operations/getpublictokenoidc200applicationjson.md new file mode 100755 index 000000000..8708bb523 --- /dev/null +++ b/access_token/docs/models/operations/getpublictokenoidc200applicationjson.md @@ -0,0 +1,11 @@ +# GetPublicTokenOIDC200ApplicationJSON + +OpenID Configuration + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `issuer` | *Optional[str]* | :heavy_minus_sign: | N/A | https://access-token.sls.epilot.io/v1/access-tokens | +| `jwks_uri` | *Optional[str]* | :heavy_minus_sign: | N/A | https://access-token.sls.epilot.io/v1/access-tokens/.well-known/jwks.json | \ No newline at end of file diff --git a/access_token/docs/models/operations/getpublictokenoidcresponse.md b/access_token/docs/models/operations/getpublictokenoidcresponse.md new file mode 100755 index 000000000..0c0558f09 --- /dev/null +++ b/access_token/docs/models/operations/getpublictokenoidcresponse.md @@ -0,0 +1,11 @@ +# GetPublicTokenOIDCResponse + + +## Fields + +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | +| `get_public_token_oidc_200_application_json_object` | [Optional[GetPublicTokenOIDC200ApplicationJSON]](../../models/operations/getpublictokenoidc200applicationjson.md) | :heavy_minus_sign: | OpenID Configuration | \ No newline at end of file diff --git a/access_token/docs/models/operations/listaccesstokensrequest.md b/access_token/docs/models/operations/listaccesstokensrequest.md new file mode 100755 index 000000000..36d503a3e --- /dev/null +++ b/access_token/docs/models/operations/listaccesstokensrequest.md @@ -0,0 +1,8 @@ +# ListAccessTokensRequest + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `token_type` | List[[shared.AccessTokenType](../../models/shared/accesstokentype.md)] | :heavy_minus_sign: | Filter by token types | \ No newline at end of file diff --git a/access_token/docs/models/operations/listaccesstokensresponse.md b/access_token/docs/models/operations/listaccesstokensresponse.md new file mode 100755 index 000000000..2022e037f --- /dev/null +++ b/access_token/docs/models/operations/listaccesstokensresponse.md @@ -0,0 +1,11 @@ +# ListAccessTokensResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `access_token_items` | List[[shared.AccessTokenItem](../../models/shared/accesstokenitem.md)] | :heavy_minus_sign: | List of Access Tokens | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/access_token/docs/models/operations/revokeaccesstokenrequest.md b/access_token/docs/models/operations/revokeaccesstokenrequest.md new file mode 100755 index 000000000..d1f480889 --- /dev/null +++ b/access_token/docs/models/operations/revokeaccesstokenrequest.md @@ -0,0 +1,8 @@ +# RevokeAccessTokenRequest + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------- | ------------------------- | ------------------------- | ------------------------- | ------------------------- | +| `id` | *str* | :heavy_check_mark: | N/A | api_5ZugdRXasLfWBypHi93Fk | \ No newline at end of file diff --git a/access_token/docs/models/operations/revokeaccesstokenresponse.md b/access_token/docs/models/operations/revokeaccesstokenresponse.md new file mode 100755 index 000000000..214bd686e --- /dev/null +++ b/access_token/docs/models/operations/revokeaccesstokenresponse.md @@ -0,0 +1,11 @@ +# RevokeAccessTokenResponse + + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `access_token_item` | [Optional[shared.AccessTokenItem]](../../models/shared/accesstokenitem.md) | :heavy_minus_sign: | The revoked generated Access Token | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/access_token/docs/models/shared/accesstokenitem.md b/access_token/docs/models/shared/accesstokenitem.md new file mode 100755 index 000000000..2ed9d8b8a --- /dev/null +++ b/access_token/docs/models/shared/accesstokenitem.md @@ -0,0 +1,13 @@ +# AccessTokenItem + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `assignments` | List[*str*] | :heavy_minus_sign: | List of role ids attached to an user | | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `id` | *str* | :heavy_check_mark: | N/A | api_5ZugdRXasLfWBypHi93Fk | +| `journey_id` | *Optional[str]* | :heavy_minus_sign: | Journey ID for access token type "journey" | | +| `name` | *str* | :heavy_check_mark: | Human readable name for access token | Postman Access Token | +| `token_type` | [Optional[AccessTokenType]](../../models/shared/accesstokentype.md) | :heavy_minus_sign: | Access token type | api | \ No newline at end of file diff --git a/access_token/docs/models/shared/accesstokenparameters.md b/access_token/docs/models/shared/accesstokenparameters.md new file mode 100755 index 000000000..5338cb284 --- /dev/null +++ b/access_token/docs/models/shared/accesstokenparameters.md @@ -0,0 +1,10 @@ +# AccessTokenParameters + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `assignments` | List[*str*] | :heavy_minus_sign: | List of role ids attached to an user | | +| `name` | *str* | :heavy_check_mark: | Human readable name for access token | Postman Access Token | +| `token_type` | [Optional[AccessTokenParametersTokenType]](../../models/shared/accesstokenparameterstokentype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/access_token/docs/models/shared/accesstokenparameterstokentype.md b/access_token/docs/models/shared/accesstokenparameterstokentype.md new file mode 100755 index 000000000..f7773b229 --- /dev/null +++ b/access_token/docs/models/shared/accesstokenparameterstokentype.md @@ -0,0 +1,8 @@ +# AccessTokenParametersTokenType + + +## Values + +| Name | Value | +| ----- | ----- | +| `API` | api | \ No newline at end of file diff --git a/access_token/docs/models/shared/accesstokentype.md b/access_token/docs/models/shared/accesstokentype.md new file mode 100755 index 000000000..1405fdffd --- /dev/null +++ b/access_token/docs/models/shared/accesstokentype.md @@ -0,0 +1,11 @@ +# AccessTokenType + +Access token type + + +## Values + +| Name | Value | +| --------- | --------- | +| `API` | api | +| `JOURNEY` | journey | \ No newline at end of file diff --git a/access_token/docs/models/shared/journeytokenparameters.md b/access_token/docs/models/shared/journeytokenparameters.md new file mode 100755 index 000000000..269121329 --- /dev/null +++ b/access_token/docs/models/shared/journeytokenparameters.md @@ -0,0 +1,10 @@ +# JourneyTokenParameters + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `journey_id` | *str* | :heavy_check_mark: | Journey ID for access token type "journey" | | +| `name` | *str* | :heavy_check_mark: | Human readable name for access token | Postman Access Token | +| `token_type` | [Optional[JourneyTokenParametersTokenType]](../../models/shared/journeytokenparameterstokentype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/access_token/docs/models/shared/journeytokenparameterstokentype.md b/access_token/docs/models/shared/journeytokenparameterstokentype.md new file mode 100755 index 000000000..cc5403ee4 --- /dev/null +++ b/access_token/docs/models/shared/journeytokenparameterstokentype.md @@ -0,0 +1,8 @@ +# JourneyTokenParametersTokenType + + +## Values + +| Name | Value | +| --------- | --------- | +| `JOURNEY` | journey | \ No newline at end of file diff --git a/access_token/docs/models/shared/security.md b/access_token/docs/models/shared/security.md new file mode 100755 index 000000000..7e7da0ee3 --- /dev/null +++ b/access_token/docs/models/shared/security.md @@ -0,0 +1,9 @@ +# Security + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | +| `epilot_auth` | *Optional[str]* | :heavy_minus_sign: | N/A | | +| `epilot_org` | *Optional[str]* | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/access_token/docs/models/shared/tokenparameters.md b/access_token/docs/models/shared/tokenparameters.md new file mode 100755 index 000000000..77f76fab4 --- /dev/null +++ b/access_token/docs/models/shared/tokenparameters.md @@ -0,0 +1,17 @@ +# TokenParameters + + +## Supported Types + +### AccessTokenParameters + +```python +tokenParameters: shared.AccessTokenParameters = /* values here */ +``` + +### JourneyTokenParameters + +```python +tokenParameters: shared.JourneyTokenParameters = /* values here */ +``` + diff --git a/access_token/docs/sdks/accesstokens/README.md b/access_token/docs/sdks/accesstokens/README.md new file mode 100755 index 000000000..1d55468ea --- /dev/null +++ b/access_token/docs/sdks/accesstokens/README.md @@ -0,0 +1,146 @@ +# AccessTokens +(*access_tokens*) + +## Overview + +Create Access Tokens for epilot APIs + +### Available Operations + +* [create_access_token](#create_access_token) - createAccessToken +* [list_access_tokens](#list_access_tokens) - listAccessTokens +* [revoke_access_token](#revoke_access_token) - revokeAccessToken + +## create_access_token + +**Access Token type: `API`** (default if not specified): + +Generates a new Access Token to use for calling epilot APIs. + +Takes optionally a list of Roles assigned to the Access Token. Defaults to current user's assignments + +See [Permissions API docs](https://docs.epilot.io/api/permissions) + +**Access Token type: `JOURNEY`**: + +Generates a Public Access Token related to a journey. +The journey id should be specfied. + + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = shared.AccessTokenParameters( + assignments=[ + '123:owner', + ], + name='Postman Access Token', +) + +res = s.access_tokens.create_access_token(req) + +if res.create_access_token_201_application_json_object is not None: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| `request` | [Union[shared.AccessTokenParameters, shared.JourneyTokenParameters]](../../models/shared/tokenparameters.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.CreateAccessTokenResponse](../../models/operations/createaccesstokenresponse.md)** + + +## list_access_tokens + +Lists all Access Tokens for current user (by default excludes system generated tokens) + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.ListAccessTokensRequest( + token_type=[ + shared.AccessTokenType.API, + ], +) + +res = s.access_tokens.list_access_tokens(req) + +if res.access_token_items is not None: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `request` | [operations.ListAccessTokensRequest](../../models/operations/listaccesstokensrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.ListAccessTokensResponse](../../models/operations/listaccesstokensresponse.md)** + + +## revoke_access_token + +Revokes an Access Token so it can't be used anymore. + +### Example Usage + +```python +import epilot +from epilot.models import operations, shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + +req = operations.RevokeAccessTokenRequest( + id='api_5ZugdRXasLfWBypHi93Fk', +) + +res = s.access_tokens.revoke_access_token(req) + +if res.access_token_item is not None: + # handle response + pass +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| `request` | [operations.RevokeAccessTokenRequest](../../models/operations/revokeaccesstokenrequest.md) | :heavy_check_mark: | The request object to use for the request. | + + +### Response + +**[operations.RevokeAccessTokenResponse](../../models/operations/revokeaccesstokenresponse.md)** + diff --git a/access_token/docs/sdks/epilot/README.md b/access_token/docs/sdks/epilot/README.md new file mode 100755 index 000000000..ee5c43338 --- /dev/null +++ b/access_token/docs/sdks/epilot/README.md @@ -0,0 +1,10 @@ +# Epilot SDK + + +## Overview + +Access Token API: Generate Access Tokens for 3rd party applications that need access to epilot APIs. + + +### Available Operations + diff --git a/access_token/docs/sdks/public/README.md b/access_token/docs/sdks/public/README.md new file mode 100755 index 000000000..02388601d --- /dev/null +++ b/access_token/docs/sdks/public/README.md @@ -0,0 +1,141 @@ +# Public +(*public*) + +## Overview + +Well known endpoints to verify tokens generated by this API + +### Available Operations + +* [get_access_token_jwks](#get_access_token_jwks) - getAccessTokenJwks +* [get_access_token_oidc](#get_access_token_oidc) - getAccessTokenOIDC +* [get_public_token_jwks](#get_public_token_jwks) - getPublicTokenJwks +* [get_public_token_oidc](#get_public_token_oidc) - getPublicTokenOIDC + +## get_access_token_jwks + +Get jwks public key set to verify access tokens generated by this API + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.public.get_access_token_jwks() + +if res.get_access_token_jwks_200_application_json_object is not None: + # handle response + pass +``` + + +### Response + +**[operations.GetAccessTokenJwksResponse](../../models/operations/getaccesstokenjwksresponse.md)** + + +## get_access_token_oidc + +OpenID Connect configuration for Access Token API as identity provider + +Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to +automate the process of verifying JWT tokens. + + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.public.get_access_token_oidc() + +if res.get_access_token_oidc_200_application_json_object is not None: + # handle response + pass +``` + + +### Response + +**[operations.GetAccessTokenOIDCResponse](../../models/operations/getaccesstokenoidcresponse.md)** + + +## get_public_token_jwks + +Get jwks public key set to verify public tokens generated by this API + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.public.get_public_token_jwks() + +if res.get_public_token_jwks_200_application_json_object is not None: + # handle response + pass +``` + + +### Response + +**[operations.GetPublicTokenJwksResponse](../../models/operations/getpublictokenjwksresponse.md)** + + +## get_public_token_oidc + +OpenID Connect configuration for Access Token API a a public identity provider + +Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to +automate the process of verifying JWT tokens. + + +### Example Usage + +```python +import epilot +from epilot.models import shared + +s = epilot.Epilot( + security=shared.Security( + epilot_auth="", + ), +) + + +res = s.public.get_public_token_oidc() + +if res.get_public_token_oidc_200_application_json_object is not None: + # handle response + pass +``` + + +### Response + +**[operations.GetPublicTokenOIDCResponse](../../models/operations/getpublictokenoidcresponse.md)** + diff --git a/access_token/files.gen b/access_token/files.gen index e399adfb6..e369ec570 100755 --- a/access_token/files.gen +++ b/access_token/files.gen @@ -1,3 +1,4 @@ +src/epilot/sdkconfiguration.py src/epilot/access_tokens.py src/epilot/public.py src/epilot/sdk.py @@ -5,6 +6,7 @@ pylintrc setup.py src/epilot/__init__.py src/epilot/models/__init__.py +src/epilot/models/errors/sdkerror.py src/epilot/utils/__init__.py src/epilot/utils/retries.py src/epilot/utils/utils.py @@ -16,10 +18,39 @@ src/epilot/models/operations/getaccesstokenoidc.py src/epilot/models/operations/getpublictokenjwks.py src/epilot/models/operations/getpublictokenoidc.py src/epilot/models/operations/__init__.py -src/epilot/models/shared/accesstokentype_enum.py +src/epilot/models/shared/accesstokentype.py src/epilot/models/shared/accesstokenparameters.py src/epilot/models/shared/journeytokenparameters.py src/epilot/models/shared/accesstokenitem.py src/epilot/models/shared/security.py src/epilot/models/shared/__init__.py -USAGE.md \ No newline at end of file +src/epilot/models/errors/__init__.py +USAGE.md +docs/models/operations/createaccesstoken201applicationjson.md +docs/models/operations/createaccesstokenresponse.md +docs/models/operations/listaccesstokensrequest.md +docs/models/operations/listaccesstokensresponse.md +docs/models/operations/revokeaccesstokenrequest.md +docs/models/operations/revokeaccesstokenresponse.md +docs/models/operations/getaccesstokenjwks200applicationjsonkeys.md +docs/models/operations/getaccesstokenjwks200applicationjson.md +docs/models/operations/getaccesstokenjwksresponse.md +docs/models/operations/getaccesstokenoidc200applicationjson.md +docs/models/operations/getaccesstokenoidcresponse.md +docs/models/operations/getpublictokenjwks200applicationjsonkeys.md +docs/models/operations/getpublictokenjwks200applicationjson.md +docs/models/operations/getpublictokenjwksresponse.md +docs/models/operations/getpublictokenoidc200applicationjson.md +docs/models/operations/getpublictokenoidcresponse.md +docs/models/shared/accesstokentype.md +docs/models/shared/tokenparameters.md +docs/models/shared/accesstokenparameterstokentype.md +docs/models/shared/accesstokenparameters.md +docs/models/shared/journeytokenparameterstokentype.md +docs/models/shared/journeytokenparameters.md +docs/models/shared/accesstokenitem.md +docs/models/shared/security.md +docs/sdks/epilot/README.md +docs/sdks/accesstokens/README.md +docs/sdks/public/README.md +.gitattributes \ No newline at end of file diff --git a/access_token/gen.yaml b/access_token/gen.yaml index 41c73ca78..db7b4302b 100755 --- a/access_token/gen.yaml +++ b/access_token/gen.yaml @@ -2,15 +2,25 @@ configVersion: 1.0.0 management: docChecksum: 02397f0d4663d4ade6c146f4c087489b docVersion: 0.2.0 - speakeasyVersion: 1.19.2 - generationVersion: 2.16.5 + speakeasyVersion: 1.109.0 + generationVersion: 2.173.0 generation: - telemetryEnabled: false + repoURL: https://github.com/epilot-dev/sdk-python.git sdkClassName: epilot sdkFlattening: true singleTagPerOp: false + telemetryEnabled: false +features: + python: + core: 3.3.1 + globalSecurity: 2.82.0 + globalServerURLs: 2.82.0 python: - version: 1.2.2 + version: 2.1.1 author: epilot description: Python Client SDK for Epilot + flattenGlobalSecurity: false + installationURL: https://github.com/epilot-dev/sdk-python.git#subdirectory=access_token + maxMethodParams: 0 packageName: epilot-access-token + repoSubDirectory: access_token diff --git a/access_token/pylintrc b/access_token/pylintrc index fd2961312..c8dca9c8f 100755 --- a/access_token/pylintrc +++ b/access_token/pylintrc @@ -88,7 +88,7 @@ persistent=yes # Minimum Python version to use for version dependent checks. Will default to # the version used to run pylint. -py-version=3.9 +py-version=3.8 # Discover python modules and packages in the file system subtree. recursive=no @@ -116,20 +116,15 @@ argument-naming-style=snake_case #argument-rgx= # Naming style matching correct attribute names. -attr-naming-style=snake_case +#attr-naming-style=snake_case # Regular expression matching correct attribute names. Overrides attr-naming- # style. If left empty, attribute names will be checked with the set naming # style. -#attr-rgx= +attr-rgx=[^\W\d][^\W]*|__.*__$ # Bad variable names which should always be refused, separated by a comma. -bad-names=foo, - bar, - baz, - toto, - tutu, - tata +bad-names= # Bad variable names regexes, separated by a comma. If names match any regex, # they will always be refused @@ -441,7 +436,13 @@ disable=raw-checker-failed, trailing-newlines, too-many-public-methods, too-many-locals, - too-many-lines + too-many-lines, + using-constant-test, + too-many-statements, + cyclic-import, + too-many-nested-blocks, + too-many-boolean-expressions, + no-else-raise # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -622,7 +623,7 @@ additional-builtins= allow-global-unused-variables=yes # List of names allowed to shadow builtins -allowed-redefined-builtins= +allowed-redefined-builtins=id,object # List of strings which can identify a callback function by name. A callback # name must start or end with one of those strings. diff --git a/access_token/setup.py b/access_token/setup.py index be4bd1085..e98aecc56 100755 --- a/access_token/setup.py +++ b/access_token/setup.py @@ -10,30 +10,31 @@ setuptools.setup( name="epilot-access-token", - version="1.2.2", + version="2.1.1", author="epilot", description="Python Client SDK for Epilot", long_description=long_description, long_description_content_type="text/markdown", packages=setuptools.find_packages(where="src"), install_requires=[ - "certifi==2022.12.07", - "charset-normalizer==2.1.1", - "dataclasses-json-speakeasy==0.5.8", - "idna==3.3", - "marshmallow==3.17.1", - "marshmallow-enum==1.5.1", - "mypy-extensions==0.4.3", - "packaging==21.3", - "pyparsing==3.0.9", - "python-dateutil==2.8.2", - "requests==2.28.1", - "six==1.16.0", - "typing-inspect==0.8.0", - "typing_extensions==4.3.0", - "urllib3==1.26.12", - "pylint==2.16.2", + "certifi>=2023.7.22", + "charset-normalizer>=3.2.0", + "dataclasses-json>=0.6.1", + "idna>=3.4", + "jsonpath-python>=1.0.6 ", + "marshmallow>=3.19.0", + "mypy-extensions>=1.0.0", + "packaging>=23.1", + "python-dateutil>=2.8.2", + "requests>=2.31.0", + "six>=1.16.0", + "typing-inspect>=0.9.0", + "typing_extensions>=4.7.1", + "urllib3>=2.0.4", ], + extras_require={ + "dev":["pylint==2.16.2"] + }, package_dir={'': 'src'}, - python_requires='>=3.9' + python_requires='>=3.8' ) diff --git a/access_token/src/epilot/__init__.py b/access_token/src/epilot/__init__.py index b9e232018..e6c0deeb6 100755 --- a/access_token/src/epilot/__init__.py +++ b/access_token/src/epilot/__init__.py @@ -1,3 +1,4 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" from .sdk import * +from .sdkconfiguration import * diff --git a/access_token/src/epilot/access_tokens.py b/access_token/src/epilot/access_tokens.py index b8eeca096..331942f93 100755 --- a/access_token/src/epilot/access_tokens.py +++ b/access_token/src/epilot/access_tokens.py @@ -1,53 +1,44 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils -from epilot.models import operations, shared -from typing import Any, Optional +from .sdkconfiguration import SDKConfiguration +from epilot import utils +from epilot.models import errors, operations, shared +from typing import List, Optional, Union class AccessTokens: r"""Create Access Tokens for epilot APIs""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str - - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config - def create_access_token(self, request: Any) -> operations.CreateAccessTokenResponse: + + def create_access_token(self, request: Union[shared.AccessTokenParameters, shared.JourneyTokenParameters]) -> operations.CreateAccessTokenResponse: r"""createAccessToken **Access Token type: `API`** (default if not specified): - + Generates a new Access Token to use for calling epilot APIs. - + Takes optionally a list of Roles assigned to the Access Token. Defaults to current user's assignments - + See [Permissions API docs](https://docs.epilot.io/api/permissions) - + **Access Token type: `JOURNEY`**: - + Generates a Public Access Token related to a journey. The journey id should be specfied. - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/access-tokens' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/access-tokens' headers = {} - req_content_type, data, form = utils.serialize_request_body(request, "request", 'json') + req_content_type, data, form = utils.serialize_request_body(request, "request", False, True, 'json') if req_content_type not in ('multipart/form-data', 'multipart/mixed'): headers['content-type'] = req_content_type + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent - client = self._security_client + client = self.sdk_configuration.security_client http_res = client.request('POST', url, data=data, files=form, headers=headers) content_type = http_res.headers.get('Content-Type') @@ -58,45 +49,55 @@ def create_access_token(self, request: Any) -> operations.CreateAccessTokenRespo if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.CreateAccessToken201ApplicationJSON]) res.create_access_token_201_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res + def list_access_tokens(self, request: operations.ListAccessTokensRequest) -> operations.ListAccessTokensResponse: r"""listAccessTokens Lists all Access Tokens for current user (by default excludes system generated tokens) """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/access-tokens' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/access-tokens' + headers = {} query_params = utils.get_query_params(operations.ListAccessTokensRequest, request) + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url, params=query_params) + http_res = client.request('GET', url, params=query_params, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.ListAccessTokensResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) if http_res.status_code == 200: if utils.match_content_type(content_type, 'application/json'): - out = utils.unmarshal_json(http_res.text, Optional[list[shared.AccessTokenItem]]) + out = utils.unmarshal_json(http_res.text, Optional[List[shared.AccessTokenItem]]) res.access_token_items = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res + def revoke_access_token(self, request: operations.RevokeAccessTokenRequest) -> operations.RevokeAccessTokenResponse: r"""revokeAccessToken Revokes an Access Token so it can't be used anymore. """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) url = utils.generate_url(operations.RevokeAccessTokenRequest, base_url, '/v1/access-tokens/{id}', request) + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('DELETE', url) + http_res = client.request('DELETE', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.RevokeAccessTokenResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -105,6 +106,8 @@ def revoke_access_token(self, request: operations.RevokeAccessTokenRequest) -> o if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[shared.AccessTokenItem]) res.access_token_item = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/access_token/src/epilot/models/__init__.py b/access_token/src/epilot/models/__init__.py index 889f8adcf..36628d6cc 100755 --- a/access_token/src/epilot/models/__init__.py +++ b/access_token/src/epilot/models/__init__.py @@ -1,2 +1,3 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" +# __init__.py diff --git a/access_token/src/epilot/models/errors/__init__.py b/access_token/src/epilot/models/errors/__init__.py new file mode 100755 index 000000000..cfd848441 --- /dev/null +++ b/access_token/src/epilot/models/errors/__init__.py @@ -0,0 +1,4 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +from .sdkerror import SDKError +__all__ = ["SDKError"] diff --git a/access_token/src/epilot/models/errors/sdkerror.py b/access_token/src/epilot/models/errors/sdkerror.py new file mode 100755 index 000000000..6bb02bbd6 --- /dev/null +++ b/access_token/src/epilot/models/errors/sdkerror.py @@ -0,0 +1,24 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests as requests_http + + +class SDKError(Exception): + """Represents an error returned by the API.""" + message: str + status_code: int + body: str + raw_response: requests_http.Response + + def __init__(self, message: str, status_code: int, body: str, raw_response: requests_http.Response): + self.message = message + self.status_code = status_code + self.body = body + self.raw_response = raw_response + + def __str__(self): + body = '' + if len(self.body) > 0: + body = f'\n{self.body}' + + return f'{self.message}: Status {self.status_code}{body}' diff --git a/access_token/src/epilot/models/operations/createaccesstoken.py b/access_token/src/epilot/models/operations/createaccesstoken.py index c176b3bcc..aaf982022 100755 --- a/access_token/src/epilot/models/operations/createaccesstoken.py +++ b/access_token/src/epilot/models/operations/createaccesstoken.py @@ -4,39 +4,42 @@ import dataclasses import dateutil.parser import requests as requests_http -from ..shared import accesstokentype_enum as shared_accesstokentype_enum +from ..shared import accesstokentype as shared_accesstokentype from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from marshmallow import fields -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class CreateAccessToken201ApplicationJSON: r"""The new generated Access Token""" - - created_at: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso') }}) - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + created_at: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""Human readable name for access token""" - assignments: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assignments'), 'exclude': lambda f: f is None }}) - r"""List of role ids attached to an user""" + r"""Human readable name for access token""" + assignments: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assignments'), 'exclude': lambda f: f is None }}) + r"""List of role ids attached to an user""" journey_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journey_id'), 'exclude': lambda f: f is None }}) - r"""Journey ID for access token type \"journey\"""" + r"""Journey ID for access token type \\"journey\\" """ token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token'), 'exclude': lambda f: f is None }}) - r"""A JWT Access Token""" - token_type: Optional[shared_accesstokentype_enum.AccessTokenTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) - r"""Access token type""" + r"""A JWT Access Token""" + token_type: Optional[shared_accesstokentype.AccessTokenType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) + r"""Access token type""" + + @dataclasses.dataclass class CreateAccessTokenResponse: - - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" create_access_token_201_application_json_object: Optional[CreateAccessToken201ApplicationJSON] = dataclasses.field(default=None) - r"""The new generated Access Token""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + r"""The new generated Access Token""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/access_token/src/epilot/models/operations/getaccesstokenjwks.py b/access_token/src/epilot/models/operations/getaccesstokenjwks.py index e22064e49..41aef0332 100755 --- a/access_token/src/epilot/models/operations/getaccesstokenjwks.py +++ b/access_token/src/epilot/models/operations/getaccesstokenjwks.py @@ -5,35 +5,40 @@ import requests as requests_http from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class GetAccessTokenJwks200ApplicationJSONKeys: + alg: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('alg'), 'exclude': lambda f: f is None }}) + e: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('e'), 'exclude': lambda f: f is None }}) + kid: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kid'), 'exclude': lambda f: f is None }}) + kty: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kty'), 'exclude': lambda f: f is None }}) + n: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('n'), 'exclude': lambda f: f is None }}) + use: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('use'), 'exclude': lambda f: f is None }}) - alg: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('alg'), 'exclude': lambda f: f is None }}) - e: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('e'), 'exclude': lambda f: f is None }}) - kid: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kid'), 'exclude': lambda f: f is None }}) - kty: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kty'), 'exclude': lambda f: f is None }}) - n: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('n'), 'exclude': lambda f: f is None }}) - use: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('use'), 'exclude': lambda f: f is None }}) - + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class GetAccessTokenJwks200ApplicationJSON: r"""Set of jwks""" + keys: Optional[List[GetAccessTokenJwks200ApplicationJSONKeys]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keys'), 'exclude': lambda f: f is None }}) - keys: Optional[list[GetAccessTokenJwks200ApplicationJSONKeys]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keys'), 'exclude': lambda f: f is None }}) - + + @dataclasses.dataclass class GetAccessTokenJwksResponse: - - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_access_token_jwks_200_application_json_object: Optional[GetAccessTokenJwks200ApplicationJSON] = dataclasses.field(default=None) - r"""Set of jwks""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + r"""Set of jwks""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/access_token/src/epilot/models/operations/getaccesstokenoidc.py b/access_token/src/epilot/models/operations/getaccesstokenoidc.py index ad358704c..989f562b4 100755 --- a/access_token/src/epilot/models/operations/getaccesstokenoidc.py +++ b/access_token/src/epilot/models/operations/getaccesstokenoidc.py @@ -12,17 +12,21 @@ @dataclasses.dataclass class GetAccessTokenOIDC200ApplicationJSON: r"""OpenID Configuration""" + issuer: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issuer'), 'exclude': lambda f: f is None }}) + jwks_uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jwks_uri'), 'exclude': lambda f: f is None }}) - issuer: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issuer'), 'exclude': lambda f: f is None }}) - jwks_uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jwks_uri'), 'exclude': lambda f: f is None }}) - + + @dataclasses.dataclass class GetAccessTokenOIDCResponse: - - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_access_token_oidc_200_application_json_object: Optional[GetAccessTokenOIDC200ApplicationJSON] = dataclasses.field(default=None) - r"""OpenID Configuration""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + r"""OpenID Configuration""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/access_token/src/epilot/models/operations/getpublictokenjwks.py b/access_token/src/epilot/models/operations/getpublictokenjwks.py index a9b3d13b0..1e06366f3 100755 --- a/access_token/src/epilot/models/operations/getpublictokenjwks.py +++ b/access_token/src/epilot/models/operations/getpublictokenjwks.py @@ -5,35 +5,40 @@ import requests as requests_http from dataclasses_json import Undefined, dataclass_json from epilot import utils -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class GetPublicTokenJwks200ApplicationJSONKeys: + alg: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('alg'), 'exclude': lambda f: f is None }}) + e: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('e'), 'exclude': lambda f: f is None }}) + kid: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kid'), 'exclude': lambda f: f is None }}) + kty: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kty'), 'exclude': lambda f: f is None }}) + n: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('n'), 'exclude': lambda f: f is None }}) + use: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('use'), 'exclude': lambda f: f is None }}) - alg: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('alg'), 'exclude': lambda f: f is None }}) - e: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('e'), 'exclude': lambda f: f is None }}) - kid: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kid'), 'exclude': lambda f: f is None }}) - kty: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('kty'), 'exclude': lambda f: f is None }}) - n: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('n'), 'exclude': lambda f: f is None }}) - use: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('use'), 'exclude': lambda f: f is None }}) - + + @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class GetPublicTokenJwks200ApplicationJSON: r"""Set of jwks""" + keys: Optional[List[GetPublicTokenJwks200ApplicationJSONKeys]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keys'), 'exclude': lambda f: f is None }}) - keys: Optional[list[GetPublicTokenJwks200ApplicationJSONKeys]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keys'), 'exclude': lambda f: f is None }}) - + + @dataclasses.dataclass class GetPublicTokenJwksResponse: - - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_public_token_jwks_200_application_json_object: Optional[GetPublicTokenJwks200ApplicationJSON] = dataclasses.field(default=None) - r"""Set of jwks""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + r"""Set of jwks""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/access_token/src/epilot/models/operations/getpublictokenoidc.py b/access_token/src/epilot/models/operations/getpublictokenoidc.py index aa27687f4..9c3bb959e 100755 --- a/access_token/src/epilot/models/operations/getpublictokenoidc.py +++ b/access_token/src/epilot/models/operations/getpublictokenoidc.py @@ -12,17 +12,21 @@ @dataclasses.dataclass class GetPublicTokenOIDC200ApplicationJSON: r"""OpenID Configuration""" + issuer: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issuer'), 'exclude': lambda f: f is None }}) + jwks_uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jwks_uri'), 'exclude': lambda f: f is None }}) - issuer: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('issuer'), 'exclude': lambda f: f is None }}) - jwks_uri: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jwks_uri'), 'exclude': lambda f: f is None }}) - + + @dataclasses.dataclass class GetPublicTokenOIDCResponse: - - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" get_public_token_oidc_200_application_json_object: Optional[GetPublicTokenOIDC200ApplicationJSON] = dataclasses.field(default=None) - r"""OpenID Configuration""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + r"""OpenID Configuration""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/access_token/src/epilot/models/operations/listaccesstokens.py b/access_token/src/epilot/models/operations/listaccesstokens.py index c38e4b155..fd8a61f4f 100755 --- a/access_token/src/epilot/models/operations/listaccesstokens.py +++ b/access_token/src/epilot/models/operations/listaccesstokens.py @@ -4,23 +4,27 @@ import dataclasses import requests as requests_http from ..shared import accesstokenitem as shared_accesstokenitem -from ..shared import accesstokentype_enum as shared_accesstokentype_enum -from typing import Optional +from ..shared import accesstokentype as shared_accesstokentype +from typing import List, Optional @dataclasses.dataclass class ListAccessTokensRequest: + token_type: Optional[List[shared_accesstokentype.AccessTokenType]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'token_type', 'style': 'form', 'explode': True }}) + r"""Filter by token types""" - token_type: Optional[list[shared_accesstokentype_enum.AccessTokenTypeEnum]] = dataclasses.field(default=None, metadata={'query_param': { 'field_name': 'token_type', 'style': 'form', 'explode': True }}) - r"""Filter by token types""" - + + @dataclasses.dataclass class ListAccessTokensResponse: + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" + access_token_items: Optional[List[shared_accesstokenitem.AccessTokenItem]] = dataclasses.field(default=None) + r"""List of Access Tokens""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() - access_token_items: Optional[list[shared_accesstokenitem.AccessTokenItem]] = dataclasses.field(default=None) - r"""List of Access Tokens""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + diff --git a/access_token/src/epilot/models/operations/revokeaccesstoken.py b/access_token/src/epilot/models/operations/revokeaccesstoken.py index 47ebd9959..fdff8b515 100755 --- a/access_token/src/epilot/models/operations/revokeaccesstoken.py +++ b/access_token/src/epilot/models/operations/revokeaccesstoken.py @@ -9,16 +9,20 @@ @dataclasses.dataclass class RevokeAccessTokenRequest: + id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': False }}) - + + @dataclasses.dataclass class RevokeAccessTokenResponse: - - content_type: str = dataclasses.field() - status_code: int = dataclasses.field() + content_type: str = dataclasses.field() + r"""HTTP response content type for this operation""" + status_code: int = dataclasses.field() + r"""HTTP response status code for this operation""" access_token_item: Optional[shared_accesstokenitem.AccessTokenItem] = dataclasses.field(default=None) - r"""The revoked generated Access Token""" - raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) - \ No newline at end of file + r"""The revoked generated Access Token""" + raw_response: Optional[requests_http.Response] = dataclasses.field(default=None) + r"""Raw HTTP response; suitable for custom response parsing""" + + diff --git a/access_token/src/epilot/models/shared/__init__.py b/access_token/src/epilot/models/shared/__init__.py index 1e46f7ea9..1906e23f3 100755 --- a/access_token/src/epilot/models/shared/__init__.py +++ b/access_token/src/epilot/models/shared/__init__.py @@ -2,8 +2,8 @@ from .accesstokenitem import * from .accesstokenparameters import * -from .accesstokentype_enum import * +from .accesstokentype import * from .journeytokenparameters import * from .security import * -__all__ = ["AccessTokenItem","AccessTokenParameters","AccessTokenParametersTokenTypeEnum","AccessTokenTypeEnum","JourneyTokenParameters","JourneyTokenParametersTokenTypeEnum","Security"] +__all__ = ["AccessTokenItem","AccessTokenParameters","AccessTokenParametersTokenType","AccessTokenType","JourneyTokenParameters","JourneyTokenParametersTokenType","Security"] diff --git a/access_token/src/epilot/models/shared/accesstokenitem.py b/access_token/src/epilot/models/shared/accesstokenitem.py index fe41a4e7d..ad21ad76f 100755 --- a/access_token/src/epilot/models/shared/accesstokenitem.py +++ b/access_token/src/epilot/models/shared/accesstokenitem.py @@ -3,27 +3,25 @@ from __future__ import annotations import dataclasses import dateutil.parser -from ..shared import accesstokentype_enum as shared_accesstokentype_enum +from ..shared import accesstokentype as shared_accesstokentype from dataclasses_json import Undefined, dataclass_json from datetime import datetime from epilot import utils -from marshmallow import fields -from typing import Optional +from typing import List, Optional @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AccessTokenItem: - r"""The revoked generated Access Token""" - - created_at: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse, 'mm_field': fields.DateTime(format='iso') }}) - id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) + created_at: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('created_at'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) + id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id') }}) name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""Human readable name for access token""" - assignments: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assignments'), 'exclude': lambda f: f is None }}) - r"""List of role ids attached to an user""" + r"""Human readable name for access token""" + assignments: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assignments'), 'exclude': lambda f: f is None }}) + r"""List of role ids attached to an user""" journey_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journey_id'), 'exclude': lambda f: f is None }}) - r"""Journey ID for access token type \"journey\"""" - token_type: Optional[shared_accesstokentype_enum.AccessTokenTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) - r"""Access token type""" - \ No newline at end of file + r"""Journey ID for access token type \\"journey\\" """ + token_type: Optional[shared_accesstokentype.AccessTokenType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) + r"""Access token type""" + + diff --git a/access_token/src/epilot/models/shared/accesstokenparameters.py b/access_token/src/epilot/models/shared/accesstokenparameters.py index db82a5aa2..713869d64 100755 --- a/access_token/src/epilot/models/shared/accesstokenparameters.py +++ b/access_token/src/epilot/models/shared/accesstokenparameters.py @@ -5,19 +5,19 @@ from dataclasses_json import Undefined, dataclass_json from enum import Enum from epilot import utils -from typing import Optional +from typing import List, Optional -class AccessTokenParametersTokenTypeEnum(str, Enum): - API = "api" +class AccessTokenParametersTokenType(str, Enum): + API = 'api' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AccessTokenParameters: - name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""Human readable name for access token""" - assignments: Optional[list[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assignments'), 'exclude': lambda f: f is None }}) - r"""List of role ids attached to an user""" - token_type: Optional[AccessTokenParametersTokenTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + r"""Human readable name for access token""" + assignments: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('assignments'), 'exclude': lambda f: f is None }}) + r"""List of role ids attached to an user""" + token_type: Optional[AccessTokenParametersTokenType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) + + diff --git a/access_token/src/epilot/models/shared/accesstokentype_enum.py b/access_token/src/epilot/models/shared/accesstokentype.py similarity index 67% rename from access_token/src/epilot/models/shared/accesstokentype_enum.py rename to access_token/src/epilot/models/shared/accesstokentype.py index 888ec8dae..4c4f6adb1 100755 --- a/access_token/src/epilot/models/shared/accesstokentype_enum.py +++ b/access_token/src/epilot/models/shared/accesstokentype.py @@ -3,7 +3,7 @@ from __future__ import annotations from enum import Enum -class AccessTokenTypeEnum(str, Enum): +class AccessTokenType(str, Enum): r"""Access token type""" - API = "api" - JOURNEY = "journey" + API = 'api' + JOURNEY = 'journey' diff --git a/access_token/src/epilot/models/shared/journeytokenparameters.py b/access_token/src/epilot/models/shared/journeytokenparameters.py index fe256d0f3..fc01cadf6 100755 --- a/access_token/src/epilot/models/shared/journeytokenparameters.py +++ b/access_token/src/epilot/models/shared/journeytokenparameters.py @@ -7,17 +7,17 @@ from epilot import utils from typing import Optional -class JourneyTokenParametersTokenTypeEnum(str, Enum): - JOURNEY = "journey" +class JourneyTokenParametersTokenType(str, Enum): + JOURNEY = 'journey' @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class JourneyTokenParameters: - journey_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('journey_id') }}) - r"""Journey ID for access token type \"journey\"""" + r"""Journey ID for access token type \\"journey\\" """ name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('name') }}) - r"""Human readable name for access token""" - token_type: Optional[JourneyTokenParametersTokenTypeEnum] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) - \ No newline at end of file + r"""Human readable name for access token""" + token_type: Optional[JourneyTokenParametersTokenType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_type'), 'exclude': lambda f: f is None }}) + + diff --git a/access_token/src/epilot/models/shared/security.py b/access_token/src/epilot/models/shared/security.py index 0dedc5e9a..95a8719c2 100755 --- a/access_token/src/epilot/models/shared/security.py +++ b/access_token/src/epilot/models/shared/security.py @@ -7,7 +7,7 @@ @dataclasses.dataclass class Security: + epilot_auth: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'http', 'sub_type': 'bearer', 'field_name': 'Authorization' }}) + epilot_org: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'x-epilot-org-id' }}) - epilot_auth: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'http', 'sub_type': 'bearer', 'field_name': 'Authorization' }}) - epilot_org: Optional[str] = dataclasses.field(default=None, metadata={'security': { 'scheme': True, 'type': 'apiKey', 'sub_type': 'header', 'field_name': 'x-epilot-org-id' }}) - \ No newline at end of file + diff --git a/access_token/src/epilot/public.py b/access_token/src/epilot/public.py index 8862ef592..33fe41fd1 100755 --- a/access_token/src/epilot/public.py +++ b/access_token/src/epilot/public.py @@ -1,39 +1,32 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests as requests_http -from . import utils -from epilot.models import operations +from .sdkconfiguration import SDKConfiguration +from epilot import utils +from epilot.models import errors, operations from typing import Optional class Public: r"""Well known endpoints to verify tokens generated by this API""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str - _language: str - _sdk_version: str - _gen_version: str - - def __init__(self, client: requests_http.Session, security_client: requests_http.Session, server_url: str, language: str, sdk_version: str, gen_version: str) -> None: - self._client = client - self._security_client = security_client - self._server_url = server_url - self._language = language - self._sdk_version = sdk_version - self._gen_version = gen_version + sdk_configuration: SDKConfiguration + + def __init__(self, sdk_config: SDKConfiguration) -> None: + self.sdk_configuration = sdk_config + def get_access_token_jwks(self) -> operations.GetAccessTokenJwksResponse: r"""getAccessTokenJwks Get jwks public key set to verify access tokens generated by this API """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/access-tokens/.well-known/jwks.json' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/access-tokens/.well-known/jwks.json' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetAccessTokenJwksResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -42,25 +35,29 @@ def get_access_token_jwks(self) -> operations.GetAccessTokenJwksResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetAccessTokenJwks200ApplicationJSON]) res.get_access_token_jwks_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res + def get_access_token_oidc(self) -> operations.GetAccessTokenOIDCResponse: r"""getAccessTokenOIDC OpenID Connect configuration for Access Token API as identity provider - + Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to automate the process of verifying JWT tokens. - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/access-tokens/.well-known/openid-configuration' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/access-tokens/.well-known/openid-configuration' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetAccessTokenOIDCResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -69,21 +66,26 @@ def get_access_token_oidc(self) -> operations.GetAccessTokenOIDCResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetAccessTokenOIDC200ApplicationJSON]) res.get_access_token_oidc_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res + def get_public_token_jwks(self) -> operations.GetPublicTokenJwksResponse: r"""getPublicTokenJwks Get jwks public key set to verify public tokens generated by this API """ - base_url = self._server_url + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) - url = base_url.removesuffix('/') + '/v1/access-tokens/public/.well-known/jwks.json' + url = base_url + '/v1/access-tokens/public/.well-known/jwks.json' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent + client = self.sdk_configuration.security_client - client = self._security_client - - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetPublicTokenJwksResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -92,25 +94,29 @@ def get_public_token_jwks(self) -> operations.GetPublicTokenJwksResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetPublicTokenJwks200ApplicationJSON]) res.get_public_token_jwks_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res + def get_public_token_oidc(self) -> operations.GetPublicTokenOIDCResponse: r"""getPublicTokenOIDC OpenID Connect configuration for Access Token API a a public identity provider - + Note: This API is not a fully compliant OAuth2.0 / OIDC identity provider, but this endpoint is useful to automate the process of verifying JWT tokens. - """ - base_url = self._server_url - - url = base_url.removesuffix('/') + '/v1/access-tokens/public/.well-known/openid-configuration' + base_url = utils.template_url(*self.sdk_configuration.get_server_details()) + url = base_url + '/v1/access-tokens/public/.well-known/openid-configuration' + headers = {} + headers['Accept'] = 'application/json' + headers['user-agent'] = self.sdk_configuration.user_agent - client = self._security_client + client = self.sdk_configuration.security_client - http_res = client.request('GET', url) + http_res = client.request('GET', url, headers=headers) content_type = http_res.headers.get('Content-Type') res = operations.GetPublicTokenOIDCResponse(status_code=http_res.status_code, content_type=content_type, raw_response=http_res) @@ -119,6 +125,8 @@ def get_public_token_oidc(self) -> operations.GetPublicTokenOIDCResponse: if utils.match_content_type(content_type, 'application/json'): out = utils.unmarshal_json(http_res.text, Optional[operations.GetPublicTokenOIDC200ApplicationJSON]) res.get_public_token_oidc_200_application_json_object = out + else: + raise errors.SDKError(f'unknown content-type received: {content_type}', http_res.status_code, http_res.text, http_res) return res diff --git a/access_token/src/epilot/sdk.py b/access_token/src/epilot/sdk.py index 434ca3120..4e088825b 100755 --- a/access_token/src/epilot/sdk.py +++ b/access_token/src/epilot/sdk.py @@ -1,83 +1,61 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" import requests as requests_http -from . import utils from .access_tokens import AccessTokens from .public import Public +from .sdkconfiguration import SDKConfiguration +from epilot import utils from epilot.models import shared - -SERVERS = [ - "https://access-token.sls.epilot.io", -] -"""Contains the list of servers available to the SDK""" +from typing import Dict class Epilot: - r"""Generate Access Tokens for 3rd party applications that need access to epilot APIs. - - """ + r"""Access Token API: Generate Access Tokens for 3rd party applications that need access to epilot APIs.""" access_tokens: AccessTokens r"""Create Access Tokens for epilot APIs""" public: Public r"""Well known endpoints to verify tokens generated by this API""" - _client: requests_http.Session - _security_client: requests_http.Session - _server_url: str = SERVERS[0] - _language: str = "python" - _sdk_version: str = "1.2.2" - _gen_version: str = "2.16.5" + sdk_configuration: SDKConfiguration def __init__(self, security: shared.Security = None, + server_idx: int = None, server_url: str = None, - url_params: dict[str, str] = None, - client: requests_http.Session = None + url_params: Dict[str, str] = None, + client: requests_http.Session = None, + retry_config: utils.RetryConfig = None ) -> None: """Instantiates the SDK configuring it with the provided parameters. :param security: The security details required for authentication :type security: shared.Security + :param server_idx: The index of the server to use for all operations + :type server_idx: int :param server_url: The server URL to use for all operations :type server_url: str :param url_params: Parameters to optionally template the server URL with - :type url_params: dict[str, str] + :type url_params: Dict[str, str] :param client: The requests.Session HTTP client to use for all operations - :type client: requests_http.Session + :type client: requests_http.Session + :param retry_config: The utils.RetryConfig to use globally + :type retry_config: utils.RetryConfig """ - self._client = requests_http.Session() + if client is None: + client = requests_http.Session() - if server_url is not None: - if url_params is not None: - self._server_url = utils.template_url(server_url, url_params) - else: - self._server_url = server_url - - if client is not None: - self._client = client + security_client = utils.configure_security_client(client, security) - self._security_client = utils.configure_security_client(self._client, security) + if server_url is not None: + if url_params is not None: + server_url = utils.template_url(server_url, url_params) + self.sdk_configuration = SDKConfiguration(client, security_client, server_url, server_idx, retry_config=retry_config) + self._init_sdks() def _init_sdks(self): - self.access_tokens = AccessTokens( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - - self.public = Public( - self._client, - self._security_client, - self._server_url, - self._language, - self._sdk_version, - self._gen_version - ) - + self.access_tokens = AccessTokens(self.sdk_configuration) + self.public = Public(self.sdk_configuration) \ No newline at end of file diff --git a/access_token/src/epilot/sdkconfiguration.py b/access_token/src/epilot/sdkconfiguration.py new file mode 100755 index 000000000..4b161c1ef --- /dev/null +++ b/access_token/src/epilot/sdkconfiguration.py @@ -0,0 +1,34 @@ +"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" + +import requests +from dataclasses import dataclass +from typing import Dict, Tuple +from .utils.retries import RetryConfig +from .utils import utils + + +SERVERS = [ + 'https://access-token.sls.epilot.io', +] +"""Contains the list of servers available to the SDK""" + +@dataclass +class SDKConfiguration: + client: requests.Session + security_client: requests.Session + server_url: str = '' + server_idx: int = 0 + language: str = 'python' + openapi_doc_version: str = '0.2.0' + sdk_version: str = '2.1.1' + gen_version: str = '2.173.0' + user_agent: str = 'speakeasy-sdk/python 2.1.1 2.173.0 0.2.0 epilot-access-token' + retry_config: RetryConfig = None + + def get_server_details(self) -> Tuple[str, Dict[str, str]]: + if self.server_url: + return utils.remove_suffix(self.server_url, '/'), {} + if self.server_idx is None: + self.server_idx = 0 + + return SERVERS[self.server_idx], {} diff --git a/access_token/src/epilot/utils/retries.py b/access_token/src/epilot/utils/retries.py index c6251d948..25f49a1f2 100755 --- a/access_token/src/epilot/utils/retries.py +++ b/access_token/src/epilot/utils/retries.py @@ -2,6 +2,7 @@ import random import time +from typing import List import requests @@ -24,16 +25,17 @@ class RetryConfig: backoff: BackoffStrategy retry_connection_errors: bool - def __init__(self, strategy: str, retry_connection_errors: bool): + def __init__(self, strategy: str, backoff: BackoffStrategy, retry_connection_errors: bool): self.strategy = strategy + self.backoff = backoff self.retry_connection_errors = retry_connection_errors class Retries: config: RetryConfig - status_codes: list[str] + status_codes: List[str] - def __init__(self, config: RetryConfig, status_codes: list[str]): + def __init__(self, config: RetryConfig, status_codes: List[str]): self.config = config self.status_codes = status_codes diff --git a/access_token/src/epilot/utils/utils.py b/access_token/src/epilot/utils/utils.py index 9d4fba324..3ab126104 100755 --- a/access_token/src/epilot/utils/utils.py +++ b/access_token/src/epilot/utils/utils.py @@ -3,11 +3,14 @@ import base64 import json import re +import sys from dataclasses import Field, dataclass, fields, is_dataclass, make_dataclass from datetime import date, datetime +from decimal import Decimal from email.message import Message from enum import Enum -from typing import Any, Callable, Optional, Tuple, Union, get_args, get_origin +from typing import (Any, Callable, Dict, List, Optional, Tuple, Union, + get_args, get_origin) from xmlrpc.client import boolean import dateutil.parser @@ -17,14 +20,14 @@ class SecurityClient: client: requests.Session - query_params: dict[str, str] = {} + query_params: Dict[str, str] = {} def __init__(self, client: requests.Session): self.client = client def request(self, method, url, **kwargs): params = kwargs.get('params', {}) - kwargs["params"] = self.query_params | params + kwargs["params"] = {**self.query_params, **params} return self.client.request(method, url, **kwargs) @@ -67,7 +70,7 @@ def _parse_security_option(client: SecurityClient, option: dataclass): client, metadata, getattr(option, opt_field.name)) -def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme: any): +def _parse_security_scheme(client: SecurityClient, scheme_metadata: Dict, scheme: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -91,7 +94,7 @@ def _parse_security_scheme(client: SecurityClient, scheme_metadata: dict, scheme client, scheme_metadata, scheme_metadata, scheme) -def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, security_metadata: dict, value: any): +def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: Dict, security_metadata: Dict, value: any): scheme_type = scheme_metadata.get('type') sub_type = scheme_metadata.get('sub_type') @@ -112,7 +115,8 @@ def _parse_security_scheme_value(client: SecurityClient, scheme_metadata: dict, client.client.headers[header_name] = value elif scheme_type == 'http': if sub_type == 'bearer': - client.client.headers[header_name] = value + client.client.headers[header_name] = value.lower().startswith( + 'bearer ') and value or f'Bearer {value}' else: raise Exception('not supported') else: @@ -141,7 +145,8 @@ def _parse_basic_auth_scheme(client: SecurityClient, scheme: dataclass): client.client.headers['Authorization'] = f'Basic {base64.b64encode(data).decode()}' -def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> str: +def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass, + gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> str: path_param_fields: Tuple[Field, ...] = fields(clazz) for field in path_param_fields: request_metadata = field.metadata.get('request') @@ -152,71 +157,80 @@ def generate_url(clazz: type, server_url: str, path: str, path_params: dataclass if param_metadata is None: continue - if param_metadata.get('style', 'simple') == 'simple': - param = getattr( - path_params, field.name) if path_params is not None else None - param = _populate_from_globals( - field.name, param, 'pathParam', gbls) - - if param is None: - continue - - if isinstance(param, list): - pp_vals: list[str] = [] - for pp_val in param: - if pp_val is None: - continue - pp_vals.append(_val_to_string(pp_val)) - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif isinstance(param, dict): - pp_vals: list[str] = [] - for pp_key in param: - if param[pp_key] is None: - continue - if param_metadata.get('explode'): - pp_vals.append( - f"{pp_key}={_val_to_string(param[pp_key])}") - else: - pp_vals.append( - f"{pp_key},{_val_to_string(param[pp_key])}") - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - elif not isinstance(param, (str, int, float, complex, bool)): - pp_vals: list[str] = [] - param_fields: Tuple[Field, ...] = fields(param) - for param_field in param_fields: - param_value_metadata = param_field.metadata.get( - 'path_param') - if not param_value_metadata: - continue + param = getattr( + path_params, field.name) if path_params is not None else None + param = _populate_from_globals( + field.name, param, 'pathParam', gbls) - parm_name = param_value_metadata.get( - 'field_name', field.name) + if param is None: + continue - param_field_val = getattr(param, param_field.name) - if param_field_val is None: - continue - if param_metadata.get('explode'): - pp_vals.append( - f"{parm_name}={_val_to_string(param_field_val)}") - else: - pp_vals.append( - f"{parm_name},{_val_to_string(param_field_val)}") - path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) - else: + f_name = param_metadata.get("field_name", field.name) + serialization = param_metadata.get('serialization', '') + if serialization != '': + serialized_params = _get_serialized_params( + param_metadata, f_name, param) + for key, value in serialized_params.items(): path = path.replace( - '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) + '{' + key + '}', value, 1) + else: + if param_metadata.get('style', 'simple') == 'simple': + if isinstance(param, List): + pp_vals: List[str] = [] + for pp_val in param: + if pp_val is None: + continue + pp_vals.append(_val_to_string(pp_val)) + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) + elif isinstance(param, Dict): + pp_vals: List[str] = [] + for pp_key in param: + if param[pp_key] is None: + continue + if param_metadata.get('explode'): + pp_vals.append( + f"{pp_key}={_val_to_string(param[pp_key])}") + else: + pp_vals.append( + f"{pp_key},{_val_to_string(param[pp_key])}") + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) + elif not isinstance(param, (str, int, float, complex, bool, Decimal)): + pp_vals: List[str] = [] + param_fields: Tuple[Field, ...] = fields(param) + for param_field in param_fields: + param_value_metadata = param_field.metadata.get( + 'path_param') + if not param_value_metadata: + continue + + parm_name = param_value_metadata.get( + 'field_name', field.name) + + param_field_val = getattr(param, param_field.name) + if param_field_val is None: + continue + if param_metadata.get('explode'): + pp_vals.append( + f"{parm_name}={_val_to_string(param_field_val)}") + else: + pp_vals.append( + f"{parm_name},{_val_to_string(param_field_val)}") + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', ",".join(pp_vals), 1) + else: + path = path.replace( + '{' + param_metadata.get('field_name', field.name) + '}', _val_to_string(param), 1) - return server_url.removesuffix("/") + path + return remove_suffix(server_url, '/') + path def is_optional(field): return get_origin(field) is Union and type(None) in get_args(field) -def template_url(url_with_params: str, params: dict[str, str]) -> str: +def template_url(url_with_params: str, params: Dict[str, str]) -> str: for key, value in params.items(): url_with_params = url_with_params.replace( '{' + key + '}', value) @@ -224,8 +238,9 @@ def template_url(url_with_params: str, params: dict[str, str]) -> str: return url_with_params -def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[str, dict[str, Any]]] = None) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def get_query_params(clazz: type, query_params: dataclass, gbls: Dict[str, Dict[str, Dict[str, Any]]] = None) -> Dict[ + str, List[str]]: + params: Dict[str, List[str]] = {} param_fields: Tuple[Field, ...] = fields(clazz) for field in param_fields: @@ -246,26 +261,33 @@ def get_query_params(clazz: type, query_params: dataclass, gbls: dict[str, dict[ f_name = metadata.get("field_name") serialization = metadata.get('serialization', '') if serialization != '': - params = params | _get_serialized_query_params( - metadata, f_name, value) + serialized_parms = _get_serialized_params(metadata, f_name, value) + for key, value in serialized_parms.items(): + if key in params: + params[key].extend(value) + else: + params[key] = [value] else: style = metadata.get('style', 'form') if style == 'deepObject': - params = params | _get_deep_object_query_params( - metadata, f_name, value) + params = {**params, **_get_deep_object_query_params( + metadata, f_name, value)} elif style == 'form': - params = params | _get_form_query_params( - metadata, f_name, value) + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, ",")} + elif style == 'pipeDelimited': + params = {**params, **_get_delimited_query_params( + metadata, f_name, value, "|")} else: raise Exception('not yet implemented') return params -def get_headers(headers_params: dataclass) -> dict[str, str]: +def get_headers(headers_params: dataclass) -> Dict[str, str]: if headers_params is None: return {} - headers: dict[str, str] = {} + headers: Dict[str, str] = {} param_fields: Tuple[Field, ...] = fields(headers_params) for field in param_fields: @@ -282,8 +304,8 @@ def get_headers(headers_params: dataclass) -> dict[str, str]: return headers -def _get_serialized_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _get_serialized_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, str]: + params: Dict[str, str] = {} serialization = metadata.get('serialization', '') if serialization == 'json': @@ -292,8 +314,8 @@ def _get_serialized_query_params(metadata: dict, field_name: str, obj: any) -> d return params -def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _get_deep_object_query_params(metadata: Dict, field_name: str, obj: any) -> Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -309,27 +331,30 @@ def _get_deep_object_query_params(metadata: dict, field_name: str, obj: any) -> if obj_val is None: continue - if isinstance(obj_val, list): + if isinstance(obj_val, List): for val in obj_val: if val is None: continue - if params.get(f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]') is None: - params[f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ + if params.get( + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]') is None: + params[ + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ ] params[ - f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'].append(_val_to_string(val)) + f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'].append( + _val_to_string(val)) else: params[ f'{metadata.get("field_name", field_name)}[{obj_param_metadata.get("field_name", obj_field.name)}]'] = [ _val_to_string(obj_val)] - elif isinstance(obj, dict): + elif isinstance(obj, Dict): for key, value in obj.items(): if value is None: continue - if isinstance(value, list): + if isinstance(value, List): for val in value: if val is None: continue @@ -355,28 +380,36 @@ def _get_query_param_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _get_form_query_params(metadata: dict, field_name: str, obj: any) -> dict[str, list[str]]: - return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name) +def _get_delimited_query_params(metadata: Dict, field_name: str, obj: any, delimiter: str) -> Dict[ + str, List[str]]: + return _populate_form(field_name, metadata.get("explode", True), obj, _get_query_param_field_name, delimiter) SERIALIZATION_METHOD_TO_CONTENT_TYPE = { - 'json': 'application/json', - 'form': 'application/x-www-form-urlencoded', + 'json': 'application/json', + 'form': 'application/x-www-form-urlencoded', 'multipart': 'multipart/form-data', - 'raw': 'application/octet-stream', - 'string': 'text/plain', + 'raw': 'application/octet-stream', + 'string': 'text/plain', } -def serialize_request_body(request: dataclass, request_field_name: str, serialization_method: str) -> Tuple[str, any, any]: +def serialize_request_body(request: dataclass, request_field_name: str, nullable: bool, optional: bool, serialization_method: str, encoder=None) -> Tuple[ + str, any, any]: if request is None: - return None, None, None, None + if not nullable and optional: + return None, None, None if not is_dataclass(request) or not hasattr(request, request_field_name): - return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], request) + return serialize_content_type(request_field_name, SERIALIZATION_METHOD_TO_CONTENT_TYPE[serialization_method], + request, encoder) request_val = getattr(request, request_field_name) + if request_val is None: + if not nullable and optional: + return None, None, None + request_fields: Tuple[Field, ...] = fields(request) request_metadata = None @@ -388,12 +421,13 @@ def serialize_request_body(request: dataclass, request_field_name: str, serializ if request_metadata is None: raise Exception('invalid request type') - return serialize_content_type(request_field_name, request_metadata.get('media_type', 'application/octet-stream'), request_val) + return serialize_content_type(request_field_name, request_metadata.get('media_type', 'application/octet-stream'), + request_val) -def serialize_content_type(field_name: str, media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: +def serialize_content_type(field_name: str, media_type: str, request: dataclass, encoder=None) -> Tuple[str, any, List[List[any]]]: if re.match(r'(application|text)\/.*?\+*json.*', media_type) is not None: - return media_type, marshal_json(request), None + return media_type, marshal_json(request, encoder), None if re.match(r'multipart\/.*', media_type) is not None: return serialize_multipart_form(media_type, request) if re.match(r'application\/x-www-form-urlencoded.*', media_type) is not None: @@ -407,8 +441,8 @@ def serialize_content_type(field_name: str, media_type: str, request: dataclass) f"invalid request body type {type(request)} for mediaType {media_type}") -def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, list[list[any]]]: - form: list[list[any]] = [] +def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, any, List[List[any]]]: + form: List[List[any]] = [] request_fields = fields(request) for field in request_fields: @@ -449,7 +483,7 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, else: field_name = field_metadata.get( "field_name", field.name) - if isinstance(val, list): + if isinstance(val, List): for value in val: if value is None: continue @@ -460,8 +494,8 @@ def serialize_multipart_form(media_type: str, request: dataclass) -> Tuple[str, return media_type, None, form -def serialize_dict(original: dict, explode: bool, field_name, existing: Optional[dict[str, list[str]]]) -> dict[ - str, list[str]]: +def serialize_dict(original: Dict, explode: bool, field_name, existing: Optional[Dict[str, List[str]]]) -> Dict[ + str, List[str]]: if existing is None: existing = [] @@ -481,8 +515,8 @@ def serialize_dict(original: dict, explode: bool, field_name, existing: Optional return existing -def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: - form: dict[str, list[str]] = {} +def serialize_form_data(field_name: str, data: dataclass) -> Dict[str, any]: + form: Dict[str, List[str]] = {} if is_dataclass(data): for field in fields(data): @@ -500,12 +534,12 @@ def serialize_form_data(field_name: str, data: dataclass) -> dict[str, any]: form[field_name] = [marshal_json(val)] else: if metadata.get('style', 'form') == 'form': - form = form | _populate_form( - field_name, metadata.get('explode', True), val, _get_form_field_name) + form = {**form, **_populate_form( + field_name, metadata.get('explode', True), val, _get_form_field_name, ",")} else: raise Exception( f'Invalid form style for field {field.name}') - elif isinstance(data, dict): + elif isinstance(data, Dict): for key, value in data.items(): form[key] = [_val_to_string(value)] else: @@ -523,8 +557,9 @@ def _get_form_field_name(obj_field: Field) -> str: return obj_param_metadata.get("field_name", obj_field.name) -def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable) -> dict[str, list[str]]: - params: dict[str, list[str]] = {} +def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_func: Callable, delimiter: str) -> \ + Dict[str, List[str]]: + params: Dict[str, List[str]] = {} if obj is None: return params @@ -546,11 +581,11 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f params[obj_field_name] = [_val_to_string(val)] else: items.append( - f'{obj_field_name},{_val_to_string(val)}') + f'{obj_field_name}{delimiter}{_val_to_string(val)}') if len(items) > 0: - params[field_name] = [','.join(items)] - elif isinstance(obj, dict): + params[field_name] = [delimiter.join(items)] + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): if value is None: @@ -559,11 +594,11 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f if explode: params[key] = _val_to_string(value) else: - items.append(f'{key},{_val_to_string(value)}') + items.append(f'{key}{delimiter}{_val_to_string(value)}') if len(items) > 0: - params[field_name] = [','.join(items)] - elif isinstance(obj, list): + params[field_name] = [delimiter.join(items)] + elif isinstance(obj, List): items = [] for value in obj: @@ -578,7 +613,8 @@ def _populate_form(field_name: str, explode: boolean, obj: any, get_field_name_f items.append(_val_to_string(value)) if len(items) > 0: - params[field_name] = [','.join([str(item) for item in items])] + params[field_name] = [delimiter.join( + [str(item) for item in items])] else: params[field_name] = [_val_to_string(obj)] @@ -616,7 +652,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join(items) - elif isinstance(obj, dict): + elif isinstance(obj, Dict): items = [] for key, value in obj.items(): @@ -631,7 +667,7 @@ def _serialize_header(explode: bool, obj: any) -> str: if len(items) > 0: return ','.join([str(item) for item in items]) - elif isinstance(obj, list): + elif isinstance(obj, List): items = [] for value in obj: @@ -648,20 +684,28 @@ def _serialize_header(explode: bool, obj: any) -> str: return '' -def unmarshal_json(data, typ): - unmarhsal = make_dataclass('Unmarhsal', [('res', typ)], +def unmarshal_json(data, typ, decoder=None): + unmarshal = make_dataclass('Unmarshal', [('res', typ)], bases=(DataClassJsonMixin,)) json_dict = json.loads(data) - out = unmarhsal.from_dict({"res": json_dict}) - return out.res + try: + out = unmarshal.from_dict({"res": json_dict}) + except AttributeError as attr_err: + raise AttributeError( + f'unable to unmarshal {data} as {typ}') from attr_err + + return out.res if decoder is None else decoder(out.res) -def marshal_json(val): +def marshal_json(val, encoder=None): marshal = make_dataclass('Marshal', [('res', type(val))], bases=(DataClassJsonMixin,)) marshaller = marshal(res=val) json_dict = marshaller.to_dict() - return json.dumps(json_dict["res"]) + + val = json_dict["res"] if encoder is None else encoder(json_dict["res"]) + + return json.dumps(val) def match_content_type(content_type: str, pattern: str) -> boolean: @@ -705,6 +749,106 @@ def datefromisoformat(date_str: str): return dateutil.parser.parse(date_str).date() +def bigintencoder(optional: bool): + def bigintencode(val: int): + if optional and val is None: + return None + return str(val) + + return bigintencode + + +def bigintdecoder(val): + if isinstance(val, float): + raise ValueError(f"{val} is a float") + return int(val) + + +def decimalencoder(optional: bool, as_str: bool): + def decimalencode(val: Decimal): + if optional and val is None: + return None + + if as_str: + return str(val) + + return float(val) + + return decimalencode + + +def decimaldecoder(val): + return Decimal(str(val)) + + +def map_encoder(optional: bool, value_encoder: Callable): + def map_encode(val: Dict): + if optional and val is None: + return None + + encoded = {} + for key, value in val.items(): + encoded[key] = value_encoder(value) + + return encoded + + return map_encode + + +def map_decoder(value_decoder: Callable): + def map_decode(val: Dict): + decoded = {} + for key, value in val.items(): + decoded[key] = value_decoder(value) + + return decoded + + return map_decode + + +def list_encoder(optional: bool, value_encoder: Callable): + def list_encode(val: List): + if optional and val is None: + return None + + encoded = [] + for value in val: + encoded.append(value_encoder(value)) + + return encoded + + return list_encode + + +def list_decoder(value_decoder: Callable): + def list_decode(val: List): + decoded = [] + for value in val: + decoded.append(value_decoder(value)) + + return decoded + + return list_decode + +def union_encoder(all_encoders: Dict[str, Callable]): + def selective_encoder(val: any): + if type(val) in all_encoders: + return all_encoders[type(val)](val) + return val + return selective_encoder + +def union_decoder(all_decoders: List[Callable]): + def selective_decoder(val: any): + decoded = val + for decoder in all_decoders: + try: + decoded = decoder(val) + break + except (TypeError, ValueError): + continue + return decoded + return selective_decoder + def get_field_name(name): def override(_, _field_name=name): return _field_name @@ -718,12 +862,12 @@ def _val_to_string(val): if isinstance(val, datetime): return val.isoformat().replace('+00:00', 'Z') if isinstance(val, Enum): - return val.value + return str(val.value) return str(val) -def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: dict[str, dict[str, dict[str, Any]]]): +def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: Dict[str, Dict[str, Dict[str, Any]]]): if value is None and gbls is not None: if 'parameters' in gbls: if param_type in gbls['parameters']: @@ -733,3 +877,16 @@ def _populate_from_globals(param_name: str, value: any, param_type: str, gbls: d value = global_value return value + + +def decoder_with_discriminator(field_name): + def decode_fx(obj): + kls = getattr(sys.modules['sdk.models.shared'], obj[field_name]) + return unmarshal_json(json.dumps(obj), kls) + return decode_fx + + +def remove_suffix(input_string, suffix): + if suffix and input_string.endswith(suffix): + return input_string[:-len(suffix)] + return input_string