Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automated update by SDK Generator #87

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ jobs:
uses: ncipollo/release-action@v1
with:
commit: main
tag: 1.4.6
tag: 1.4.7

5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -963,6 +963,8 @@ _VaultApi_ | [**consumers_one**](docs/apis/VaultApi.md#consumers_one) | **GET**

_VaultApi_ | [**consumers_update**](docs/apis/VaultApi.md#consumers_update) | **PATCH** /vault/consumers/{consumer_id} | Update consumer |

_VaultApi_ | [**create_callback_state**](docs/apis/VaultApi.md#create_callback_state) | **POST** /vault/connections/{unified_api}/{service_id}/callback-state | Create Callback State |

_VaultApi_ | [**custom_fields_all**](docs/apis/VaultApi.md#custom_fields_all) | **GET** /vault/connections/{unified_api}/{service_id}/{resource}/custom-fields | Get resource custom fields |

_VaultApi_ | [**custom_mappings_all**](docs/apis/VaultApi.md#custom_mappings_all) | **GET** /vault/custom-mappings/{unified_api}/{service_id} | List custom mappings |
Expand Down Expand Up @@ -1093,6 +1095,9 @@ _WebhookApi_ | [**webhooks_update**](docs/apis/WebhookApi.md#webhooks_update) |
- [CreateAttachmentResponse](docs/models/CreateAttachmentResponse.md)
- [CreateBillPaymentResponse](docs/models/CreateBillPaymentResponse.md)
- [CreateBillResponse](docs/models/CreateBillResponse.md)
- [CreateCallbackStateData](docs/models/CreateCallbackStateData.md)
- [CreateCallbackStateResponse](docs/models/CreateCallbackStateResponse.md)
- [CreateCallbackStateResponseData](docs/models/CreateCallbackStateResponseData.md)
- [CreateCommentResponse](docs/models/CreateCommentResponse.md)
- [CreateCompanyResponse](docs/models/CreateCompanyResponse.md)
- [CreateConnectionResponse](docs/models/CreateConnectionResponse.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/apis/HrisApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1758,6 +1758,7 @@ with apideck.ApiClient(configuration) as api_client:
hired_at=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
is_primary=True,
is_manager=True,
status="active",
location=Address(
id="123",
type="primary",
Expand Down Expand Up @@ -2435,6 +2436,7 @@ with apideck.ApiClient(configuration) as api_client:
hired_at=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
is_primary=True,
is_manager=True,
status="active",
location=Address(
id="123",
type="primary",
Expand Down
111 changes: 111 additions & 0 deletions docs/apis/VaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Method | HTTP request | Description
[**consumers_delete**](VaultApi.md#consumers_delete) | **DELETE** /vault/consumers/{consumer_id} | Delete consumer
[**consumers_one**](VaultApi.md#consumers_one) | **GET** /vault/consumers/{consumer_id} | Get consumer
[**consumers_update**](VaultApi.md#consumers_update) | **PATCH** /vault/consumers/{consumer_id} | Update consumer
[**create_callback_state**](VaultApi.md#create_callback_state) | **POST** /vault/connections/{unified_api}/{service_id}/callback-state | Create Callback State
[**custom_fields_all**](VaultApi.md#custom_fields_all) | **GET** /vault/connections/{unified_api}/{service_id}/{resource}/custom-fields | Get resource custom fields
[**custom_mappings_all**](VaultApi.md#custom_mappings_all) | **GET** /vault/custom-mappings/{unified_api}/{service_id} | List custom mappings
[**logs_all**](VaultApi.md#logs_all) | **GET** /vault/logs | Get all consumer request logs
Expand Down Expand Up @@ -1657,6 +1658,116 @@ 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)

# **create_callback_state**
> CreateCallbackStateResponse create_callback_state(service_id, unified_api, create_callback_state_data)

Create Callback State

This endpoint creates a callback state that can be used to issue requests to the callback endpoint.

### Example

* Api Key Authentication (apiKey):

```python
import time
import apideck
from apideck.api import vault_api
from apideck.model.create_callback_state_response import CreateCallbackStateResponse
from apideck.model.bad_request_response import BadRequestResponse
from apideck.model.payment_required_response import PaymentRequiredResponse
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
from apideck.model.unauthorized_response import UnauthorizedResponse
from apideck.model.create_callback_state_data import CreateCallbackStateData
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
create_callback_state_data = CreateCallbackStateData(
redirect_uri="https://example.com/callback",
) # CreateCallbackStateData | Callback state data
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)

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

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


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **str**| Service ID of the resource to return |
**unified_api** | **str**| Unified API |
**create_callback_state_data** | [**CreateCallbackStateData**](CreateCallbackStateData.md)| Callback state data |
**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]

### Return type

[**CreateCallbackStateResponse**](CreateCallbackStateResponse.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** | Callback state created | - |
**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)

# **custom_fields_all**
> GetCustomFieldsResponse custom_fields_all(unified_api, service_id, resource)

Expand Down
12 changes: 12 additions & 0 deletions docs/models/CreateCallbackStateData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CreateCallbackStateData


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**redirect_uri** | **str** | The redirect URI to be used after the connection is created. | [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)


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


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


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


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **str** | Callback state | [optional] [readonly]
**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)


1 change: 1 addition & 0 deletions docs/models/EmployeeJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Description | Notes
**hired_at** | **date, none_type** | The date on which the employee was hired by the organization | [optional]
**is_primary** | **bool, none_type** | Indicates whether this the employee's primary job. | [optional]
**is_manager** | **bool, none_type** | Indicates whether this the employee has a manager role. | [optional]
**status** | **str, none_type** | Indicates the status of the job. | [optional]
**location** | [**Address**](Address.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]

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@apideck/python",
"version": "1.4.6",
"version": "1.4.7",
"description": "Apideck Python SDK",
"keywords": [
"apideck",
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "apideck"
version = "1.4.6"
version = "1.4.7"
authors = [
{ name="Apideck", email="[email protected]" },
]
Expand Down
9 changes: 9 additions & 0 deletions src/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,9 @@ apideck/model/create_attachment_request.py
apideck/model/create_attachment_response.py
apideck/model/create_bill_payment_response.py
apideck/model/create_bill_response.py
apideck/model/create_callback_state_data.py
apideck/model/create_callback_state_response.py
apideck/model/create_callback_state_response_data.py
apideck/model/create_comment_response.py
apideck/model/create_company_response.py
apideck/model/create_connection_response.py
Expand Down Expand Up @@ -830,6 +833,9 @@ docs/CreateAttachmentRequest.md
docs/CreateAttachmentResponse.md
docs/CreateBillPaymentResponse.md
docs/CreateBillResponse.md
docs/CreateCallbackStateData.md
docs/CreateCallbackStateResponse.md
docs/CreateCallbackStateResponseData.md
docs/CreateCommentResponse.md
docs/CreateCompanyResponse.md
docs/CreateConnectionResponse.md
Expand Down Expand Up @@ -1538,6 +1544,9 @@ test/test_create_attachment_request.py
test/test_create_attachment_response.py
test/test_create_bill_payment_response.py
test/test_create_bill_response.py
test/test_create_callback_state_data.py
test/test_create_callback_state_response.py
test/test_create_callback_state_response_data.py
test/test_create_comment_response.py
test/test_create_company_response.py
test/test_create_connection_response.py
Expand Down
4 changes: 2 additions & 2 deletions src/apideck/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
The Apideck OpenAPI Spec: SDK Optimized # noqa: E501
The version of the OpenAPI document: 10.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
Generated by: https://openapi-generator.tech
"""


__version__ = "1.4.6"
__version__ = "1.4.7"

# import ApiClient
from apideck.api_client import ApiClient
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
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.7.7
The version of the OpenAPI document: 10.8.1
Contact: [email protected]
Generated by: https://openapi-generator.tech
"""
Expand Down
Loading
Loading