Skip to content

Commit 96cd4e1

Browse files
Automated update by SDK Generator version:1.3.0 commit:b8d7057
1 parent ff26f2f commit 96cd4e1

File tree

1,355 files changed

+2278
-1346
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,355 files changed

+2278
-1346
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -919,6 +919,8 @@ _VaultApi_ | [**logs_all**](docs/apis/VaultApi.md#logs_all) | **GET** /vault/log
919919

920920
_VaultApi_ | [**sessions_create**](docs/apis/VaultApi.md#sessions_create) | **POST** /vault/sessions | Create Session |
921921

922+
_VaultApi_ | [**validate_connection_state**](docs/apis/VaultApi.md#validate_connection_state) | **POST** /vault/connections/{unified_api}/{service_id}/validate | Validate Connection State |
923+
922924
_WebhookApi_ | [**event_logs_all**](docs/apis/WebhookApi.md#event_logs_all) | **GET** /webhook/logs | List event logs |
923925

924926
_WebhookApi_ | [**webhooks_add**](docs/apis/WebhookApi.md#webhooks_add) | **POST** /webhook/webhooks | Create webhook subscription |
@@ -1577,6 +1579,8 @@ _WebhookApi_ | [**webhooks_update**](docs/apis/WebhookApi.md#webhooks_update) |
15771579
- [UploadSession](docs/models/UploadSession.md)
15781580
- [Url](docs/models/Url.md)
15791581
- [User](docs/models/User.md)
1582+
- [ValidateConnectionStateResponse](docs/models/ValidateConnectionStateResponse.md)
1583+
- [ValidateConnectionStateResponseData](docs/models/ValidateConnectionStateResponseData.md)
15801584
- [VaultEventType](docs/models/VaultEventType.md)
15811585
- [VirtualWebhooks](docs/models/VirtualWebhooks.md)
15821586
- [WalletDetails](docs/models/WalletDetails.md)

docs/apis/VaultApi.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Method | HTTP request | Description
2121
[**custom_fields_all**](VaultApi.md#custom_fields_all) | **GET** /vault/connections/{unified_api}/{service_id}/{resource}/custom-fields | Get resource custom fields
2222
[**logs_all**](VaultApi.md#logs_all) | **GET** /vault/logs | Get all consumer request logs
2323
[**sessions_create**](VaultApi.md#sessions_create) | **POST** /vault/sessions | Create Session
24+
[**validate_connection_state**](VaultApi.md#validate_connection_state) | **POST** /vault/connections/{unified_api}/{service_id}/validate | Validate Connection State
2425

2526

2627
# **connection_settings_all**
@@ -1890,3 +1891,110 @@ Name | Type | Description | Notes
18901891

18911892
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
18921893

1894+
# **validate_connection_state**
1895+
> ValidateConnectionStateResponse validate_connection_state(service_id, unified_api)
1896+
1897+
Validate Connection State
1898+
1899+
This endpoint validates the current state of a given connection. This will perform different checks based on the connection auth type. For basic and apiKey auth types, the presence of required fields is checked. For connectors that implement OAuth2, this operation forces the refresh flow for an access token regardless of its expiry. Note: - Do not include any credentials in the request body. This operation does not persist changes, but only triggers the validation of connection state. - If a refresh token flow was performed and successful, the new access token will then be used for subsequent API requests.
1900+
1901+
### Example
1902+
1903+
* Api Key Authentication (apiKey):
1904+
1905+
```python
1906+
import time
1907+
import apideck
1908+
from apideck.api import vault_api
1909+
from apideck.model.bad_request_response import BadRequestResponse
1910+
from apideck.model.payment_required_response import PaymentRequiredResponse
1911+
from apideck.model.validate_connection_state_response import ValidateConnectionStateResponse
1912+
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
1913+
from apideck.model.unauthorized_response import UnauthorizedResponse
1914+
from apideck.model.unprocessable_response import UnprocessableResponse
1915+
from apideck.model.not_found_response import NotFoundResponse
1916+
from pprint import pprint
1917+
# Defining the host is optional and defaults to https://unify.apideck.com
1918+
# See configuration.py for a list of all supported configuration parameters.
1919+
configuration = apideck.Configuration(
1920+
host = "https://unify.apideck.com"
1921+
)
1922+
1923+
# The client must configure the authentication and authorization parameters
1924+
# in accordance with the API server security policy.
1925+
# Examples for each auth method are provided below, use the example that
1926+
# satisfies your auth use case.
1927+
1928+
# Configure API key authorization: apiKey
1929+
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
1930+
1931+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
1932+
# configuration.api_key_prefix['apiKey'] = 'Bearer'
1933+
1934+
# Enter a context with an instance of the API client
1935+
with apideck.ApiClient(configuration) as api_client:
1936+
# Create an instance of the API class
1937+
api_instance = vault_api.VaultApi(api_client)
1938+
service_id = "pipedrive" # str | Service ID of the resource to return
1939+
unified_api = "crm" # str | Unified API
1940+
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
1941+
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
1942+
body = {} # dict | (optional)
1943+
1944+
# example passing only required values which don't have defaults set
1945+
try:
1946+
# Validate Connection State
1947+
api_response = api_instance.validate_connection_state(service_id, unified_api)
1948+
pprint(api_response)
1949+
except apideck.ApiException as e:
1950+
print("Exception when calling VaultApi->validate_connection_state: %s\n" % e)
1951+
1952+
# example passing only required values which don't have defaults set
1953+
# and optional values
1954+
try:
1955+
# Validate Connection State
1956+
api_response = api_instance.validate_connection_state(service_id, unified_api, consumer_id=consumer_id, app_id=app_id, body=body)
1957+
pprint(api_response)
1958+
except apideck.ApiException as e:
1959+
print("Exception when calling VaultApi->validate_connection_state: %s\n" % e)
1960+
```
1961+
1962+
1963+
### Parameters
1964+
1965+
Name | Type | Description | Notes
1966+
------------- | ------------- | ------------- | -------------
1967+
**service_id** | **str**| Service ID of the resource to return |
1968+
**unified_api** | **str**| Unified API |
1969+
**consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional]
1970+
**app_id** | **str**| The ID of your Unify application | [optional]
1971+
**body** | **dict**| | [optional]
1972+
1973+
### Return type
1974+
1975+
[**ValidateConnectionStateResponse**](ValidateConnectionStateResponse.md)
1976+
1977+
### Authorization
1978+
1979+
[apiKey](../../README.md#apiKey)
1980+
1981+
### HTTP request headers
1982+
1983+
- **Content-Type**: application/json
1984+
- **Accept**: application/json
1985+
1986+
1987+
### HTTP response details
1988+
1989+
| Status code | Description | Response headers |
1990+
|-------------|-------------|------------------|
1991+
**200** | Connection access token refreshed | - |
1992+
**400** | Bad Request | - |
1993+
**401** | Unauthorized | - |
1994+
**402** | Payment Required | - |
1995+
**404** | The specified resource was not found | - |
1996+
**422** | Unprocessable | - |
1997+
**0** | Unexpected error | - |
1998+
1999+
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
2000+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ValidateConnectionStateResponse
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**status_code** | **int** | HTTP Response Status Code |
8+
**status** | **str** | HTTP Response Status |
9+
**data** | [**ValidateConnectionStateResponseData**](ValidateConnectionStateResponseData.md) | |
10+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
11+
12+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
13+
14+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ValidateConnectionStateResponseData
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | The unique identifier of the connection. | [optional] [readonly]
8+
**state** | [**ConnectionState**](ConnectionState.md) | | [optional]
9+
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
10+
11+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
12+
13+

src/.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,8 @@ apideck/model/update_webhook_response.py
673673
apideck/model/upload_session.py
674674
apideck/model/url.py
675675
apideck/model/user.py
676+
apideck/model/validate_connection_state_response.py
677+
apideck/model/validate_connection_state_response_data.py
676678
apideck/model/vault_event_type.py
677679
apideck/model/virtual_webhooks.py
678680
apideck/model/wallet_details.py
@@ -1343,6 +1345,8 @@ docs/UpdateWebhookResponse.md
13431345
docs/UploadSession.md
13441346
docs/Url.md
13451347
docs/User.md
1348+
docs/ValidateConnectionStateResponse.md
1349+
docs/ValidateConnectionStateResponseData.md
13461350
docs/VaultApi.md
13471351
docs/VaultEventType.md
13481352
docs/VirtualWebhooks.md
@@ -2018,6 +2022,8 @@ test/test_update_webhook_response.py
20182022
test/test_upload_session.py
20192023
test/test_url.py
20202024
test/test_user.py
2025+
test/test_validate_connection_state_response.py
2026+
test/test_validate_connection_state_response_data.py
20212027
test/test_vault_api.py
20222028
test/test_vault_event_type.py
20232029
test/test_virtual_webhooks.py

src/apideck/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
77
8-
The version of the OpenAPI document: 10.6.2
8+
The version of the OpenAPI document: 10.6.3
99
Generated by: https://openapi-generator.tech
1010
"""
1111

src/apideck/api/accounting_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55

6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/ats_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/connector_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/crm_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/ecommerce_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/file_storage_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/hris_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/issue_tracking_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/lead_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/pos_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

src/apideck/api/sms_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
44
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
55
6-
The version of the OpenAPI document: 10.6.2
6+
The version of the OpenAPI document: 10.6.3
77
Generated by: https://openapi-generator.tech
88
"""
99

0 commit comments

Comments
 (0)