Skip to content

Commit 26185bf

Browse files
nicklloydnicklloyd
authored
Automated update by SDK Generator (#59)
1 parent 8ffe578 commit 26185bf

File tree

1,410 files changed

+21362
-4401
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,410 files changed

+21362
-4401
lines changed

‎.github/workflows/publish.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@ name: Publish to PyPI.org
22
on:
33
release:
44
types: [released]
5-
6-
permissions:
7-
id-token: write
8-
contents: write
9-
105
jobs:
116
release:
127
runs-on: ubuntu-latest

‎.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ jobs:
2020
uses: ncipollo/release-action@v1
2121
with:
2222
commit: main
23-
tag: 1.1.2
23+
tag: 1.2.0
2424

‎README.md

Lines changed: 109 additions & 11 deletions
Large diffs are not rendered by default.

‎docs/apis/AccountingApi.md

Lines changed: 4572 additions & 1953 deletions
Large diffs are not rendered by default.

‎docs/apis/HrisApi.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1704,6 +1704,7 @@ with apideck.ApiClient(configuration) as api_client:
17041704
payment_unit=PaymentUnit("year"),
17051705
hired_at=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
17061706
is_primary=True,
1707+
is_manager=True,
17071708
location=Address(
17081709
id="123",
17091710
type="primary",
@@ -2139,6 +2140,7 @@ Get Employee
21392140
import time
21402141
import apideck
21412142
from apideck.api import hris_api
2143+
from apideck.model.employees_one_filter import EmployeesOneFilter
21422144
from apideck.model.get_employee_response import GetEmployeeResponse
21432145
from apideck.model.bad_request_response import BadRequestResponse
21442146
from apideck.model.payment_required_response import PaymentRequiredResponse
@@ -2174,6 +2176,9 @@ with apideck.ApiClient(configuration) as api_client:
21742176
service_id = "x-apideck-service-id_example" # str | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. (optional)
21752177
raw = False # bool | Include raw response. Mostly used for debugging purposes (optional) if omitted the server will use the default value of False
21762178
fields = "id,updated_at" # str, none_type | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded. (optional)
2179+
filter = EmployeesOneFilter(
2180+
company_id="1234",
2181+
) # EmployeesOneFilter | Apply filters (optional)
21772182

21782183
# example passing only required values which don't have defaults set
21792184
try:
@@ -2187,7 +2192,7 @@ with apideck.ApiClient(configuration) as api_client:
21872192
# and optional values
21882193
try:
21892194
# Get Employee
2190-
api_response = api_instance.employees_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, fields=fields)
2195+
api_response = api_instance.employees_one(id, consumer_id=consumer_id, app_id=app_id, service_id=service_id, raw=raw, fields=fields, filter=filter)
21912196
pprint(api_response)
21922197
except apideck.ApiException as e:
21932198
print("Exception when calling HrisApi->employees_one: %s\n" % e)
@@ -2204,6 +2209,7 @@ Name | Type | Description | Notes
22042209
**service_id** | **str**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | [optional]
22052210
**raw** | **bool**| Include raw response. Mostly used for debugging purposes | [optional] if omitted the server will use the default value of False
22062211
**fields** | **str, none_type**| The &#39;fields&#39; parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. &lt;br /&gt;&lt;br /&gt;Example: &#x60;fields&#x3D;name,email,addresses.city&#x60;&lt;br /&gt;&lt;br /&gt;In the example above, the response will only include the fields \&quot;name\&quot;, \&quot;email\&quot; and \&quot;addresses.city\&quot;. If any other fields are available, they will be excluded. | [optional]
2212+
**filter** | **EmployeesOneFilter**| Apply filters | [optional]
22072213

22082214
### Return type
22092215

@@ -2358,6 +2364,7 @@ with apideck.ApiClient(configuration) as api_client:
23582364
payment_unit=PaymentUnit("year"),
23592365
hired_at=dateutil_parser('Wed Aug 12 00:00:00 UTC 2020').date(),
23602366
is_primary=True,
2367+
is_manager=True,
23612368
location=Address(
23622369
id="123",
23632370
type="primary",

‎docs/apis/VaultApi.md

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Method | HTTP request | Description
1010
[**connections_delete**](VaultApi.md#connections_delete) | **DELETE** /vault/connections/{unified_api}/{service_id} | Deletes a connection
1111
[**connections_import**](VaultApi.md#connections_import) | **POST** /vault/connections/{unified_api}/{service_id}/import | Import connection
1212
[**connections_one**](VaultApi.md#connections_one) | **GET** /vault/connections/{unified_api}/{service_id} | Get connection
13+
[**connections_token**](VaultApi.md#connections_token) | **POST** /vault/connections/{unified_api}/{service_id}/token | Authorize Access Token
1314
[**connections_update**](VaultApi.md#connections_update) | **PATCH** /vault/connections/{unified_api}/{service_id} | Update connection
1415
[**consumer_request_counts_all**](VaultApi.md#consumer_request_counts_all) | **GET** /vault/consumers/{consumer_id}/stats | Consumer request counts
1516
[**consumers_add**](VaultApi.md#consumers_add) | **POST** /vault/consumers | Create consumer
@@ -669,6 +670,113 @@ Name | Type | Description | Notes
669670
- **Accept**: application/json
670671

671672

673+
### HTTP response details
674+
675+
| Status code | Description | Response headers |
676+
|-------------|-------------|------------------|
677+
**200** | Connection | - |
678+
**400** | Bad Request | - |
679+
**401** | Unauthorized | - |
680+
**402** | Payment Required | - |
681+
**404** | The specified resource was not found | - |
682+
**422** | Unprocessable | - |
683+
**0** | Unexpected error | - |
684+
685+
[[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)
686+
687+
# **connections_token**
688+
> GetConnectionResponse connections_token(service_id, unified_api)
689+
690+
Authorize Access Token
691+
692+
Triggers exchanging persisted connection credentials for an access token and store it in Vault. Currently supported for connections with the `client_credentials` or `password` OAuth grant type. Note: - Do not include any credentials in the request body. This operation does not persist changes, but only triggers the exchange of persisted connection credentials for an access token. - The access token will not be returned in the response. A 200 response code indicates the authorization was successful and that a valid access token was stored on the connection. - The access token will be used for subsequent API requests.
693+
694+
### Example
695+
696+
* Api Key Authentication (apiKey):
697+
698+
```python
699+
import time
700+
import apideck
701+
from apideck.api import vault_api
702+
from apideck.model.get_connection_response import GetConnectionResponse
703+
from apideck.model.bad_request_response import BadRequestResponse
704+
from apideck.model.payment_required_response import PaymentRequiredResponse
705+
from apideck.model.unexpected_error_response import UnexpectedErrorResponse
706+
from apideck.model.unauthorized_response import UnauthorizedResponse
707+
from apideck.model.unprocessable_response import UnprocessableResponse
708+
from apideck.model.not_found_response import NotFoundResponse
709+
from pprint import pprint
710+
# Defining the host is optional and defaults to https://unify.apideck.com
711+
# See configuration.py for a list of all supported configuration parameters.
712+
configuration = apideck.Configuration(
713+
host = "https://unify.apideck.com"
714+
)
715+
716+
# The client must configure the authentication and authorization parameters
717+
# in accordance with the API server security policy.
718+
# Examples for each auth method are provided below, use the example that
719+
# satisfies your auth use case.
720+
721+
# Configure API key authorization: apiKey
722+
configuration.api_key['apiKey'] = 'YOUR_API_KEY'
723+
724+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
725+
# configuration.api_key_prefix['apiKey'] = 'Bearer'
726+
727+
# Enter a context with an instance of the API client
728+
with apideck.ApiClient(configuration) as api_client:
729+
# Create an instance of the API class
730+
api_instance = vault_api.VaultApi(api_client)
731+
service_id = "pipedrive" # str | Service ID of the resource to return
732+
unified_api = "crm" # str | Unified API
733+
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
734+
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
735+
body = {} # dict | (optional)
736+
737+
# example passing only required values which don't have defaults set
738+
try:
739+
# Authorize Access Token
740+
api_response = api_instance.connections_token(service_id, unified_api)
741+
pprint(api_response)
742+
except apideck.ApiException as e:
743+
print("Exception when calling VaultApi->connections_token: %s\n" % e)
744+
745+
# example passing only required values which don't have defaults set
746+
# and optional values
747+
try:
748+
# Authorize Access Token
749+
api_response = api_instance.connections_token(service_id, unified_api, consumer_id=consumer_id, app_id=app_id, body=body)
750+
pprint(api_response)
751+
except apideck.ApiException as e:
752+
print("Exception when calling VaultApi->connections_token: %s\n" % e)
753+
```
754+
755+
756+
### Parameters
757+
758+
Name | Type | Description | Notes
759+
------------- | ------------- | ------------- | -------------
760+
**service_id** | **str**| Service ID of the resource to return |
761+
**unified_api** | **str**| Unified API |
762+
**consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional]
763+
**app_id** | **str**| The ID of your Unify application | [optional]
764+
**body** | **dict**| | [optional]
765+
766+
### Return type
767+
768+
[**GetConnectionResponse**](GetConnectionResponse.md)
769+
770+
### Authorization
771+
772+
[apiKey](../../README.md#apiKey)
773+
774+
### HTTP request headers
775+
776+
- **Content-Type**: application/json
777+
- **Accept**: application/json
778+
779+
672780
### HTTP response details
673781

674782
| Status code | Description | Response headers |
@@ -1486,6 +1594,7 @@ with apideck.ApiClient(configuration) as api_client:
14861594
resource = "leads" # str | Name of the resource (plural)
14871595
consumer_id = "x-apideck-consumer-id_example" # str | ID of the consumer which you want to get or push data from (optional)
14881596
app_id = "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX" # str | The ID of your Unify application (optional)
1597+
resource_id = "1234" # str | This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. (optional)
14891598

14901599
# example passing only required values which don't have defaults set
14911600
try:
@@ -1499,7 +1608,7 @@ with apideck.ApiClient(configuration) as api_client:
14991608
# and optional values
15001609
try:
15011610
# Get resource custom fields
1502-
api_response = api_instance.custom_fields_all(unified_api, service_id, resource, consumer_id=consumer_id, app_id=app_id)
1611+
api_response = api_instance.custom_fields_all(unified_api, service_id, resource, consumer_id=consumer_id, app_id=app_id, resource_id=resource_id)
15031612
pprint(api_response)
15041613
except apideck.ApiException as e:
15051614
print("Exception when calling VaultApi->custom_fields_all: %s\n" % e)
@@ -1515,6 +1624,7 @@ Name | Type | Description | Notes
15151624
**resource** | **str**| Name of the resource (plural) |
15161625
**consumer_id** | **str**| ID of the consumer which you want to get or push data from | [optional]
15171626
**app_id** | **str**| The ID of your Unify application | [optional]
1627+
**resource_id** | **str**| This is the id of the resource you want to fetch when listing custom fields. For example, if you want to fetch custom fields for a specific contact, you would use the contact id. | [optional]
15181628

15191629
### Return type
15201630

‎docs/models/AccountingDepartment.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# AccountingDepartment
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
8+
**parent_id** | **str, none_type** | A unique identifier for an object. | [optional]
9+
**name** | **str, none_type** | The name of the department. | [optional]
10+
**status** | **str** | Based on the status some functionality is enabled or disabled. | [optional]
11+
**subsidiaries** | [**[SubsidiaryReference]**](SubsidiaryReference.md) | | [optional]
12+
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
13+
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
14+
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
15+
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
16+
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
17+
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
18+
19+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
20+
21+

‎docs/models/AccountingDepartmentsFilter.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AccountingDepartmentsFilter
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**subsidiary** | **str** | Id of the subsidiary to search for | [optional]
8+
9+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
10+
11+

‎docs/models/AccountingLocation.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# AccountingLocation
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
8+
**parent_id** | **str, none_type** | A unique identifier for an object. | [optional]
9+
**company_name** | **str, none_type** | The name of the company. | [optional]
10+
**display_name** | **str, none_type** | The display name of the location. | [optional]
11+
**status** | **str** | Based on the status some functionality is enabled or disabled. | [optional]
12+
**addresses** | [**[Address]**](Address.md) | | [optional]
13+
**subsidiaries** | [**[SubsidiaryReference]**](SubsidiaryReference.md) | | [optional]
14+
**custom_mappings** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type** | When custom mappings are configured on the resource, the result is included here. | [optional] [readonly]
15+
**row_version** | **str, none_type** | A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. | [optional]
16+
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
17+
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
18+
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
19+
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
20+
21+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
22+
23+

‎docs/models/AccountingLocationsFilter.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AccountingLocationsFilter
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**subsidiary** | **str** | Id of the subsidiary to search for | [optional]
8+
9+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
10+
11+

‎docs/models/Attachment.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Attachment
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
8+
**name** | **str, none_type** | The name of the file | [optional]
9+
**mime_type** | **str, none_type** | The MIME type of the file. | [optional]
10+
**size** | **int, none_type** | The size of the file in bytes | [optional]
11+
**reference** | [**AttachmentReference**](AttachmentReference.md) | | [optional]
12+
**description** | **str, none_type** | Optional description of the file | [optional]
13+
**updated_by** | **str, none_type** | The user who last updated the object. | [optional] [readonly]
14+
**created_by** | **str, none_type** | The user who created the object. | [optional] [readonly]
15+
**updated_at** | **datetime, none_type** | The date and time when the object was last updated. | [optional] [readonly]
16+
**created_at** | **datetime, none_type** | The date and time when the object was created. | [optional] [readonly]
17+
18+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
19+
20+

‎docs/models/AttachmentReference.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AttachmentReference
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**type** | [**AttachmentReferenceType**](AttachmentReferenceType.md) | | [optional]
8+
**id** | **str** | A unique identifier for an object. | [optional] [readonly]
9+
10+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
11+
12+

‎docs/models/AttachmentReferenceType.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AttachmentReferenceType
2+
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**value** | **str** | | must be one of ["invoice", "bill", ]
8+
9+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
10+
11+

‎docs/models/Bill.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**downstream_id** | **str, none_type** | The third-party API ID of original entity | [optional] [readonly]
99
**bill_number** | **str, none_type** | Reference to supplier bill number | [optional]
1010
**supplier** | [**LinkedSupplier**](LinkedSupplier.md) | | [optional]
11+
**company_id** | **str, none_type** | The company or subsidiary id the transaction belongs to | [optional]
1112
**currency** | [**Currency**](Currency.md) | | [optional]
1213
**currency_rate** | **float, none_type** | Currency Exchange Rate at the time entity was recorded/generated. | [optional]
1314
**tax_inclusive** | **bool, none_type** | Amounts are including tax | [optional]

‎docs/models/ConnectionImportDataCredentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**refresh_token** | **str** | The refresh token can be used to obtain a new access token. |
7+
**refresh_token** | **str, none_type** | The refresh token can be used to obtain a new access token. | [optional]
88
**access_token** | **str** | Access token | [optional]
99
**issued_at** | **datetime, none_type** | The datetime at which the token was issued. If omitted the token will be queued for refresh. | [optional]
1010
**expires_in** | **int, none_type** | The number of seconds until the token expires. If omitted the token will be queued for refresh. | [optional]

0 commit comments

Comments
 (0)