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 #68

Merged
merged 6 commits into from
Dec 17, 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 @@ -18,5 +18,5 @@ jobs:
uses: ncipollo/release-action@v1
with:
commit: main
tag: 3.6.0
tag: 3.7.0

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@apideck/php",
"version": "3.6.0",
"version": "3.7.0",
"description": "Apideck PHP SDK",
"keywords": [
"apideck",
Expand Down
36 changes: 33 additions & 3 deletions src/gen/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ docs/Model/ActivitiesSort.md
docs/Model/Activity.md
docs/Model/ActivityAttendee.md
docs/Model/Address.md
docs/Model/AgedCreditors.md
docs/Model/AgedDebtors.md
docs/Model/AgedReportFilter.md
docs/Model/Allocation.md
docs/Model/Api.md
docs/Model/ApiResource.md
Expand All @@ -55,6 +58,8 @@ docs/Model/AttachmentReference.md
docs/Model/AttachmentReferenceType.md
docs/Model/AuthType.md
docs/Model/BadRequestResponse.md
docs/Model/BalanceByPeriod.md
docs/Model/BalanceByTransaction.md
docs/Model/BalanceSheet.md
docs/Model/BalanceSheetAccount.md
docs/Model/BalanceSheetAccountRecord.md
Expand Down Expand Up @@ -123,7 +128,7 @@ docs/Model/CreateAttachmentRequest.md
docs/Model/CreateAttachmentResponse.md
docs/Model/CreateBillPaymentResponse.md
docs/Model/CreateBillResponse.md
docs/Model/CreateCallbackStateData.md
docs/Model/CreateCallbackState.md
docs/Model/CreateCallbackStateResponse.md
docs/Model/CreateCallbackStateResponseData.md
docs/Model/CreateCommentResponse.md
Expand Down Expand Up @@ -307,6 +312,8 @@ docs/Model/GetAccountingLocationResponse.md
docs/Model/GetAccountingLocationsResponse.md
docs/Model/GetActivitiesResponse.md
docs/Model/GetActivityResponse.md
docs/Model/GetAgedCreditorsResponse.md
docs/Model/GetAgedDebtorsResponse.md
docs/Model/GetApiResourceCoverageResponse.md
docs/Model/GetApiResourceResponse.md
docs/Model/GetApiResponse.md
Expand Down Expand Up @@ -457,6 +464,7 @@ docs/Model/HrisJobs.md
docs/Model/IntegrationState.md
docs/Model/Invoice.md
docs/Model/InvoiceItem.md
docs/Model/InvoiceItemFilter.md
docs/Model/InvoiceItemSalesDetails.md
docs/Model/InvoiceItemsFilter.md
docs/Model/InvoiceLineItem.md
Expand Down Expand Up @@ -528,6 +536,8 @@ docs/Model/OrderRefunds.md
docs/Model/OrderTenders.md
docs/Model/OrderType.md
docs/Model/OrdersSort.md
docs/Model/OutstandingBalance.md
docs/Model/OutstandingBalanceByCurrency.md
docs/Model/Owner.md
docs/Model/PaginationCoverage.md
docs/Model/PassThroughQuery.md
Expand Down Expand Up @@ -722,6 +732,9 @@ lib/Model/ActivitiesSort.php
lib/Model/Activity.php
lib/Model/ActivityAttendee.php
lib/Model/Address.php
lib/Model/AgedCreditors.php
lib/Model/AgedDebtors.php
lib/Model/AgedReportFilter.php
lib/Model/Allocation.php
lib/Model/Api.php
lib/Model/ApiResource.php
Expand All @@ -745,6 +758,8 @@ lib/Model/AttachmentReference.php
lib/Model/AttachmentReferenceType.php
lib/Model/AuthType.php
lib/Model/BadRequestResponse.php
lib/Model/BalanceByPeriod.php
lib/Model/BalanceByTransaction.php
lib/Model/BalanceSheet.php
lib/Model/BalanceSheetAccount.php
lib/Model/BalanceSheetAccountRecord.php
Expand Down Expand Up @@ -813,7 +828,7 @@ lib/Model/CreateAttachmentRequest.php
lib/Model/CreateAttachmentResponse.php
lib/Model/CreateBillPaymentResponse.php
lib/Model/CreateBillResponse.php
lib/Model/CreateCallbackStateData.php
lib/Model/CreateCallbackState.php
lib/Model/CreateCallbackStateResponse.php
lib/Model/CreateCallbackStateResponseData.php
lib/Model/CreateCommentResponse.php
Expand Down Expand Up @@ -997,6 +1012,8 @@ lib/Model/GetAccountingLocationResponse.php
lib/Model/GetAccountingLocationsResponse.php
lib/Model/GetActivitiesResponse.php
lib/Model/GetActivityResponse.php
lib/Model/GetAgedCreditorsResponse.php
lib/Model/GetAgedDebtorsResponse.php
lib/Model/GetApiResourceCoverageResponse.php
lib/Model/GetApiResourceResponse.php
lib/Model/GetApiResponse.php
Expand Down Expand Up @@ -1147,6 +1164,7 @@ lib/Model/HrisJobs.php
lib/Model/IntegrationState.php
lib/Model/Invoice.php
lib/Model/InvoiceItem.php
lib/Model/InvoiceItemFilter.php
lib/Model/InvoiceItemSalesDetails.php
lib/Model/InvoiceItemsFilter.php
lib/Model/InvoiceLineItem.php
Expand Down Expand Up @@ -1219,6 +1237,8 @@ lib/Model/OrderRefunds.php
lib/Model/OrderTenders.php
lib/Model/OrderType.php
lib/Model/OrdersSort.php
lib/Model/OutstandingBalance.php
lib/Model/OutstandingBalanceByCurrency.php
lib/Model/Owner.php
lib/Model/PaginationCoverage.php
lib/Model/PassThroughQuery.php
Expand Down Expand Up @@ -1409,6 +1429,9 @@ test/Model/ActivitiesSortTest.php
test/Model/ActivityAttendeeTest.php
test/Model/ActivityTest.php
test/Model/AddressTest.php
test/Model/AgedCreditorsTest.php
test/Model/AgedDebtorsTest.php
test/Model/AgedReportFilterTest.php
test/Model/AllocationTest.php
test/Model/ApiResourceCoverageCoverageTest.php
test/Model/ApiResourceCoverageTest.php
Expand All @@ -1432,6 +1455,8 @@ test/Model/AttachmentReferenceTypeTest.php
test/Model/AttachmentTest.php
test/Model/AuthTypeTest.php
test/Model/BadRequestResponseTest.php
test/Model/BalanceByPeriodTest.php
test/Model/BalanceByTransactionTest.php
test/Model/BalanceSheetAccountRecordTest.php
test/Model/BalanceSheetAccountTest.php
test/Model/BalanceSheetAssetsAccountTest.php
Expand Down Expand Up @@ -1500,9 +1525,9 @@ test/Model/CreateAttachmentRequestTest.php
test/Model/CreateAttachmentResponseTest.php
test/Model/CreateBillPaymentResponseTest.php
test/Model/CreateBillResponseTest.php
test/Model/CreateCallbackStateDataTest.php
test/Model/CreateCallbackStateResponseDataTest.php
test/Model/CreateCallbackStateResponseTest.php
test/Model/CreateCallbackStateTest.php
test/Model/CreateCommentResponseTest.php
test/Model/CreateCompanyResponseTest.php
test/Model/CreateConnectionResponseTest.php
Expand Down Expand Up @@ -1684,6 +1709,8 @@ test/Model/GetAccountingLocationResponseTest.php
test/Model/GetAccountingLocationsResponseTest.php
test/Model/GetActivitiesResponseTest.php
test/Model/GetActivityResponseTest.php
test/Model/GetAgedCreditorsResponseTest.php
test/Model/GetAgedDebtorsResponseTest.php
test/Model/GetApiResourceCoverageResponseTest.php
test/Model/GetApiResourceResponseTest.php
test/Model/GetApiResponseTest.php
Expand Down Expand Up @@ -1832,6 +1859,7 @@ test/Model/HrisJobLocationTest.php
test/Model/HrisJobTest.php
test/Model/HrisJobsTest.php
test/Model/IntegrationStateTest.php
test/Model/InvoiceItemFilterTest.php
test/Model/InvoiceItemSalesDetailsTest.php
test/Model/InvoiceItemTest.php
test/Model/InvoiceItemsFilterTest.php
Expand Down Expand Up @@ -1905,6 +1933,8 @@ test/Model/OrderTendersTest.php
test/Model/OrderTest.php
test/Model/OrderTypeTest.php
test/Model/OrdersSortTest.php
test/Model/OutstandingBalanceByCurrencyTest.php
test/Model/OutstandingBalanceTest.php
test/Model/OwnerTest.php
test/Model/PaginationCoverageTest.php
test/Model/PassThroughQueryTest.php
Expand Down
139 changes: 139 additions & 0 deletions src/gen/docs/apis/AccountingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

## Methods

* [Get Aged Creditors](#agedCreditorsOne)
* [Get Aged Debtors](#agedDebtorsOne)
* [List Attachments](#attachmentsAll)
* [Delete Attachment](#attachmentsDelete)
* [Download Attachment](#attachmentsDownload)
Expand Down Expand Up @@ -98,6 +100,142 @@
* [Get Tracking Category](#trackingCategoriesOne)
* [Update Tracking Category](#trackingCategoriesUpdate)

<a name="agedCreditorsOne"></a>
# Get Aged Creditors


Method: **agedCreditorsOne**

```php
Apideck->getAccountingApi()->agedCreditorsOne($data)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_apideck_consumer_id** | **string**| ID of the consumer which you want to get or push data from |
**x_apideck_app_id** | **string**| The ID of your Unify application |
**x_apideck_service_id** | **string**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
**filter** | [\Apideck\Client\Model\AgedReportFilter](../models/\Apideck\Client\Model\AgedReportFilter.md)| Apply filters |
**pass_through** | [\Apideck\Client\Model\PassThroughQuery](../models/\Apideck\Client\Model\PassThroughQuery.md)| Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads |
**fields** | **string**| 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: &#x60;fields=name,email,addresses.city&#x60;<br /><br />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. |
**raw** | [**bool**] | Include raw response. Mostly used for debugging purposes | (optional) defaults to false



### Response Type

[`\Apideck\Client\Model\GetAgedCreditorsResponse`](../models/\Apideck\Client\Model\GetAgedCreditorsResponse.md)



### HTTP response details
| Status code | Description |
|-------------|-------------|
**200** | Aged Creditors |
**400** | Bad Request |
**401** | Unauthorized |
**402** | Payment Required |
**404** | The specified resource was not found |
**422** | Unprocessable |
4/5xx | Unexpected error |


## Example Usage

```php
<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
$response = $apideck->getAccountingApi()->agedCreditorsOne();
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}

```


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

<a name="agedDebtorsOne"></a>
# Get Aged Debtors


Method: **agedDebtorsOne**

```php
Apideck->getAccountingApi()->agedDebtorsOne($data)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_apideck_consumer_id** | **string**| ID of the consumer which you want to get or push data from |
**x_apideck_app_id** | **string**| The ID of your Unify application |
**x_apideck_service_id** | **string**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
**filter** | [\Apideck\Client\Model\AgedReportFilter](../models/\Apideck\Client\Model\AgedReportFilter.md)| Apply filters |
**pass_through** | [\Apideck\Client\Model\PassThroughQuery](../models/\Apideck\Client\Model\PassThroughQuery.md)| Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads |
**fields** | **string**| 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: &#x60;fields=name,email,addresses.city&#x60;<br /><br />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. |
**raw** | [**bool**] | Include raw response. Mostly used for debugging purposes | (optional) defaults to false



### Response Type

[`\Apideck\Client\Model\GetAgedDebtorsResponse`](../models/\Apideck\Client\Model\GetAgedDebtorsResponse.md)



### HTTP response details
| Status code | Description |
|-------------|-------------|
**200** | Aged Debtors |
**400** | Bad Request |
**401** | Unauthorized |
**402** | Payment Required |
**404** | The specified resource was not found |
**422** | Unprocessable |
4/5xx | Unexpected error |


## Example Usage

```php
<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
$response = $apideck->getAccountingApi()->agedDebtorsOne();
var_dump('API called successfully', $response);
} catch(ApiException $error) {
var_dump('API called failed', $error);
}

```


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

<a name="attachmentsAll"></a>
# List Attachments

Expand Down Expand Up @@ -2742,6 +2880,7 @@ Name | Type | Description | Notes
**x_apideck_app_id** | **string**| The ID of your Unify application |
**x_apideck_service_id** | **string**| Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. |
**fields** | **string**| 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: &#x60;fields=name,email,addresses.city&#x60;<br /><br />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. |
**filter** | [\Apideck\Client\Model\InvoiceItemFilter](../models/\Apideck\Client\Model\InvoiceItemFilter.md)| Apply filters |
**raw** | [**bool**] | Include raw response. Mostly used for debugging purposes | (optional) defaults to false


Expand Down
2 changes: 1 addition & 1 deletion src/gen/docs/apis/VaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1018,7 +1018,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**service_id** | **string**| Service ID of the resource to return |
**unified_api** | **string**| Unified API |
**create_callback_state_data** | [\Apideck\Client\Model\CreateCallbackStateData](../models/\Apideck\Client\Model\CreateCallbackStateData.md)| Callback state data |
**create_callback_state** | [\Apideck\Client\Model\CreateCallbackState](../models/\Apideck\Client\Model\CreateCallbackState.md)| Callback state data |
**x_apideck_consumer_id** | **string**| ID of the consumer which you want to get or push data from |
**x_apideck_app_id** | **string**| The ID of your Unify application |

Expand Down
29 changes: 29 additions & 0 deletions src/gen/docs/models/AgedCreditors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Apideck.AgedCreditors

### Description

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
`report_generated_at` | **\DateTime** | The exact date and time the report was generated. | [optional]
`report_as_of_date` | **\DateTime** | The cutoff date for transactions included in the report. | [optional]
`period_count` | **int** | Number of aging periods shown in the report. | [optional]
`period_length` | **int** | Length of each aging period in days. | [optional]
`outstanding_balances` | [**\Apideck\Client\Model\OutstandingBalance[]**](OutstandingBalance.md) | | [optional]





## Referenced Types:




* [`OutstandingBalance`](OutstandingBalance.md)

---

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


Loading