Skip to content

Commit

Permalink
Automated update by SDK Generator version:1.3.0 commit:b8d7057
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 11, 2024
1 parent ff26f2f commit 96cd4e1
Show file tree
Hide file tree
Showing 1,355 changed files with 2,278 additions and 1,346 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -919,6 +919,8 @@ _VaultApi_ | [**logs_all**](docs/apis/VaultApi.md#logs_all) | **GET** /vault/log

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

_VaultApi_ | [**validate_connection_state**](docs/apis/VaultApi.md#validate_connection_state) | **POST** /vault/connections/{unified_api}/{service_id}/validate | Validate Connection State |

_WebhookApi_ | [**event_logs_all**](docs/apis/WebhookApi.md#event_logs_all) | **GET** /webhook/logs | List event logs |

_WebhookApi_ | [**webhooks_add**](docs/apis/WebhookApi.md#webhooks_add) | **POST** /webhook/webhooks | Create webhook subscription |
Expand Down Expand Up @@ -1577,6 +1579,8 @@ _WebhookApi_ | [**webhooks_update**](docs/apis/WebhookApi.md#webhooks_update) |
- [UploadSession](docs/models/UploadSession.md)
- [Url](docs/models/Url.md)
- [User](docs/models/User.md)
- [ValidateConnectionStateResponse](docs/models/ValidateConnectionStateResponse.md)
- [ValidateConnectionStateResponseData](docs/models/ValidateConnectionStateResponseData.md)
- [VaultEventType](docs/models/VaultEventType.md)
- [VirtualWebhooks](docs/models/VirtualWebhooks.md)
- [WalletDetails](docs/models/WalletDetails.md)
Expand Down
108 changes: 108 additions & 0 deletions docs/apis/VaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Method | HTTP request | Description
[**custom_fields_all**](VaultApi.md#custom_fields_all) | **GET** /vault/connections/{unified_api}/{service_id}/{resource}/custom-fields | Get resource custom fields
[**logs_all**](VaultApi.md#logs_all) | **GET** /vault/logs | Get all consumer request logs
[**sessions_create**](VaultApi.md#sessions_create) | **POST** /vault/sessions | Create Session
[**validate_connection_state**](VaultApi.md#validate_connection_state) | **POST** /vault/connections/{unified_api}/{service_id}/validate | Validate Connection State


# **connection_settings_all**
Expand Down Expand Up @@ -1890,3 +1891,110 @@ Name | Type | Description | Notes

[[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)

# **validate_connection_state**
> ValidateConnectionStateResponse validate_connection_state(service_id, unified_api)
Validate Connection State

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.

### Example

* Api Key Authentication (apiKey):

```python
import time
import apideck
from apideck.api import vault_api
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.validate_connection_state_response import ValidateConnectionStateResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.unprocessable_response import UnprocessableResponse
from apideck.model.not_found_response import NotFoundResponse
from pprint import pprint
# Defining the host is optional and defaults to https://unify.apideck.com
# See configuration.py for a list of all supported configuration parameters.
configuration = apideck.Configuration(
host = "https://unify.apideck.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with apideck.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = vault_api.VaultApi(api_client)
service_id = "pipedrive" # str | Service ID of the resource to return
unified_api = "crm" # str | Unified API
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
body = {} # dict | (optional)

# example passing only required values which don't have defaults set
try:
# Validate Connection State
api_response = api_instance.validate_connection_state(service_id, unified_api)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling VaultApi->validate_connection_state: %s\n" % e)

# example passing only required values which don't have defaults set
# and optional values
try:
# Validate Connection State
api_response = api_instance.validate_connection_state(service_id, unified_api, consumer_id=consumer_id, app_id=app_id, body=body)
pprint(api_response)
except apideck.ApiException as e:
print("Exception when calling VaultApi->validate_connection_state: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **str**| Service ID of the resource to return |
**unified_api** | **str**| Unified API |
**consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional]
**app_id** | **str**| The ID of your Unify application | [optional]
**body** | **dict**| | [optional]

### Return type

[**ValidateConnectionStateResponse**](ValidateConnectionStateResponse.md)

### Authorization

[apiKey](../../README.md#apiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Connection access token refreshed | - |
**400** | Bad Request | - |
**401** | Unauthorized | - |
**402** | Payment Required | - |
**404** | The specified resource was not found | - |
**422** | Unprocessable | - |
**0** | Unexpected error | - |

[[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)

14 changes: 14 additions & 0 deletions docs/models/ValidateConnectionStateResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# ValidateConnectionStateResponse


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status_code** | **int** | HTTP Response Status Code |
**status** | **str** | HTTP Response Status |
**data** | [**ValidateConnectionStateResponseData**](ValidateConnectionStateResponseData.md) | |
**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]

[[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 changes: 13 additions & 0 deletions docs/models/ValidateConnectionStateResponseData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ValidateConnectionStateResponseData


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique identifier of the connection. | [optional] [readonly]
**state** | [**ConnectionState**](ConnectionState.md) | | [optional]
**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]

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


6 changes: 6 additions & 0 deletions src/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,8 @@ apideck/model/update_webhook_response.py
apideck/model/upload_session.py
apideck/model/url.py
apideck/model/user.py
apideck/model/validate_connection_state_response.py
apideck/model/validate_connection_state_response_data.py
apideck/model/vault_event_type.py
apideck/model/virtual_webhooks.py
apideck/model/wallet_details.py
Expand Down Expand Up @@ -1343,6 +1345,8 @@ docs/UpdateWebhookResponse.md
docs/UploadSession.md
docs/Url.md
docs/User.md
docs/ValidateConnectionStateResponse.md
docs/ValidateConnectionStateResponseData.md
docs/VaultApi.md
docs/VaultEventType.md
docs/VirtualWebhooks.md
Expand Down Expand Up @@ -2018,6 +2022,8 @@ test/test_update_webhook_response.py
test/test_upload_session.py
test/test_url.py
test/test_user.py
test/test_validate_connection_state_response.py
test/test_validate_connection_state_response_data.py
test/test_vault_api.py
test/test_vault_event_type.py
test/test_virtual_webhooks.py
Expand Down
2 changes: 1 addition & 1 deletion src/apideck/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/accounting_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

The Apideck OpenAPI Spec: SDK Optimized # noqa: E501

The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/ats_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/connector_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/crm_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/ecommerce_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/file_storage_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/hris_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/issue_tracking_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/lead_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/pos_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
2 changes: 1 addition & 1 deletion src/apideck/api/sms_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.6.2
The version of the OpenAPI document: 10.6.3
Generated by: https://openapi-generator.tech
"""

Expand Down
Loading

0 comments on commit 96cd4e1

Please sign in to comment.