From 36d8f3b7765a39928dd0d75d92b7604fe8d899c2 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 27 Dec 2024 00:05:58 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.460.3 --- .speakeasy/gen.lock | 20 +++---- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 14 ++--- RELEASES.md | 12 ++++- docs/Models/Components/AgedCreditors.md | 14 ++--- docs/Models/Components/AgedDebtors.md | 14 ++--- docs/Models/Components/AgedReportFilter.md | 1 + docs/Models/Components/BalanceByPeriod.md | 12 ++--- .../Models/Components/BalanceByTransaction.md | 3 +- .../OutstandingBalanceByCurrency.md | 1 + ...nce.md => OutstandingBalanceByCustomer.md} | 6 +-- .../OutstandingBalanceBySupplier.md | 10 ++++ docs/Models/Components/TransactionType.md | 2 +- .../AccountingAgedCreditorsOneRequest.md | 2 +- .../AccountingAgedDebtorsOneRequest.md | 2 +- docs/sdks/agedcreditors/README.md | 1 + docs/sdks/ageddebtors/README.md | 1 + src/Models/Components/AgedCreditors.php | 6 +-- src/Models/Components/AgedDebtors.php | 6 +-- src/Models/Components/AgedReportFilter.php | 12 ++++- src/Models/Components/BalanceByPeriod.php | 44 +++++++-------- .../Components/BalanceByTransaction.php | 13 ++++- .../OutstandingBalanceByCurrency.php | 13 ++++- ...e.php => OutstandingBalanceByCustomer.php} | 6 +-- .../OutstandingBalanceBySupplier.php | 53 +++++++++++++++++++ src/Models/Components/TransactionType.php | 2 +- src/SDKConfiguration.php | 4 +- 27 files changed, 194 insertions(+), 82 deletions(-) rename docs/Models/Components/{OutstandingBalance.md => OutstandingBalanceByCustomer.md} (94%) create mode 100644 docs/Models/Components/OutstandingBalanceBySupplier.md rename src/Models/Components/{OutstandingBalance.php => OutstandingBalanceByCustomer.php} (92%) create mode 100644 src/Models/Components/OutstandingBalanceBySupplier.php diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index dde5057..94811ab 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 0e1578f5-5df8-4086-96d6-369ac62fc49d management: - docChecksum: 00527826e00802057f1f1f32cd5fa2ff + docChecksum: 7dcfb4378c6b67f6f82c84503a30eb9f docVersion: 10.9.0 - speakeasyVersion: 1.460.2 + speakeasyVersion: 1.460.3 generationVersion: 2.484.0 - releaseVersion: 0.2.0 - configChecksum: 236753ff2eaa619d8b8c448b59dee7ea + releaseVersion: 0.2.1 + configChecksum: 6f5320d1ee1c87c751c46c07b06b2f27 repoURL: https://github.com/apideck-libraries/sdk-php.git installationURL: https://github.com/apideck-libraries/sdk-php published: true @@ -585,8 +585,9 @@ generatedFiles: - docs/Models/Components/Options.md - docs/Models/Components/OrdersSort.md - docs/Models/Components/OrdersSortBy.md - - docs/Models/Components/OutstandingBalance.md - docs/Models/Components/OutstandingBalanceByCurrency.md + - docs/Models/Components/OutstandingBalanceByCustomer.md + - docs/Models/Components/OutstandingBalanceBySupplier.md - docs/Models/Components/Owner.md - docs/Models/Components/PaginationCoverage.md - docs/Models/Components/PaginationCoverageMode.md @@ -2023,8 +2024,9 @@ generatedFiles: - src/Models/Components/Options.php - src/Models/Components/OrdersSort.php - src/Models/Components/OrdersSortBy.php - - src/Models/Components/OutstandingBalance.php - src/Models/Components/OutstandingBalanceByCurrency.php + - src/Models/Components/OutstandingBalanceByCustomer.php + - src/Models/Components/OutstandingBalanceBySupplier.php - src/Models/Components/Owner.php - src/Models/Components/PaginationCoverage.php - src/Models/Components/PaginationCoverageMode.php @@ -9475,7 +9477,7 @@ examples: "": parameters: query: - filter: {"customer_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30} + filter: {"customer_id": "123abc", "supplier_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30} pass_through: {"search": "San Francisco"} fields: "id,updated_at" header: @@ -9484,7 +9486,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "AgedCreditors", "operation": "one", "data": {"report_generated_at": "2024-11-14T12:00:00.000Z", "report_as_of_date": "2024-11-13", "period_count": 4, "period_length": 30, "outstanding_balances": [{"customer_id": "123", "customer_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}, {"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}]}, {"customer_id": "123", "customer_name": "Super Store", "outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": []}]}]}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "AgedCreditors", "operation": "one", "data": {"report_generated_at": "2024-11-14T12:00:00.000Z", "report_as_of_date": "2024-11-13", "period_count": 4, "period_length": 30, "outstanding_balances": [{"outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}, {"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}, {"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}, {"currency": "USD", "balances_by_period": [{"start_date": "2024-01-01", "end_date": "2024-01-30", "total_amount": 1500, "balances_by_transaction": [{"transaction_id": "INV-1001", "transaction_date": "2024-01-15", "transaction_type": "invoice", "due_date": "2024-02-15", "original_amount": 1000, "outstanding_balance": 800}]}]}]}, {"outstanding_balances_by_currency": [{"currency": "USD", "balances_by_period": []}]}]}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": {"missing": [{"foobar": "required"}]}, "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -9501,7 +9503,7 @@ examples: "": parameters: query: - filter: {"customer_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30} + filter: {"customer_id": "123abc", "supplier_id": "123abc", "report_as_of_date": "2024-01-01", "period_count": 3, "period_length": 30} pass_through: {"search": "San Francisco"} fields: "id,updated_at" header: diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 685a5f0..189e445 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -13,7 +13,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: true php: - version: 0.2.0 + version: 0.2.1 additionalDependencies: autoload: {} autoload-dev: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 334eff1..57cf9cd 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.460.2 +speakeasyVersion: 1.460.3 sources: Apideck: sourceNamespace: apideck - sourceRevisionDigest: sha256:8ffa6bb63ffbea34b1922c2cbca4b5b8f328d850e3c5d86e29a6f598d23afc20 - sourceBlobDigest: sha256:2387ea8d9d23982c568313b9885a37ac801333e6aba340789bb8b193cb5eb772 + sourceRevisionDigest: sha256:8d88085b547fe4eadbe16eec774574625b6d45335843bb765f5c096747a86a82 + sourceBlobDigest: sha256:6f14d7b19054d88262d5b57d85b909579b0fa66e54405da78a9dee274ab1c557 tags: - latest - - speakeasy-sdk-regen-1734368306 + - speakeasy-sdk-regen-1735225949 - 10.9.0 targets: apideck: source: Apideck sourceNamespace: apideck - sourceRevisionDigest: sha256:8ffa6bb63ffbea34b1922c2cbca4b5b8f328d850e3c5d86e29a6f598d23afc20 - sourceBlobDigest: sha256:2387ea8d9d23982c568313b9885a37ac801333e6aba340789bb8b193cb5eb772 + sourceRevisionDigest: sha256:8d88085b547fe4eadbe16eec774574625b6d45335843bb765f5c096747a86a82 + sourceBlobDigest: sha256:6f14d7b19054d88262d5b57d85b909579b0fa66e54405da78a9dee274ab1c557 codeSamplesNamespace: apideck-php-code-samples - codeSamplesRevisionDigest: sha256:59d93392ab01736eac0cfd36b928c415784b25046823c9ec91ac1602007a7803 + codeSamplesRevisionDigest: sha256:27961cfb9aa691898c4eeea6ebd60dd427f8539ff74f0d93ff9f003c8a06ffc9 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 0eb0cf7..8bf79c9 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -38,4 +38,14 @@ Based on: ### Generated - [php v0.2.0] . ### Releases -- [Composer v0.2.0] https://packagist.org/packages/apideck-libraries/sdk-php#v0.2.0 - . \ No newline at end of file +- [Composer v0.2.0] https://packagist.org/packages/apideck-libraries/sdk-php#v0.2.0 - . + +## 2024-12-27 00:02:07 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.460.3 (2.484.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [php v0.2.1] . +### Releases +- [Composer v0.2.1] https://packagist.org/packages/apideck-libraries/sdk-php#v0.2.1 - . \ No newline at end of file diff --git a/docs/Models/Components/AgedCreditors.md b/docs/Models/Components/AgedCreditors.md index 9ceeb7f..b59574b 100644 --- a/docs/Models/Components/AgedCreditors.md +++ b/docs/Models/Components/AgedCreditors.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `reportGeneratedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z | -| `reportAsOfDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 | -| `periodCount` | *?int* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 | -| `periodLength` | *?int* | :heavy_minus_sign: | Length of each aging period in days. | 30 | -| `outstandingBalances` | array<[Components\OutstandingBalance](../../Models/Components/OutstandingBalance.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `reportGeneratedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z | +| `reportAsOfDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 | +| `periodCount` | *?int* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 | +| `periodLength` | *?int* | :heavy_minus_sign: | Length of each aging period in days. | 30 | +| `outstandingBalances` | array<[Components\OutstandingBalanceBySupplier](../../Models/Components/OutstandingBalanceBySupplier.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/Models/Components/AgedDebtors.md b/docs/Models/Components/AgedDebtors.md index 8ed535a..8109049 100644 --- a/docs/Models/Components/AgedDebtors.md +++ b/docs/Models/Components/AgedDebtors.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `reportGeneratedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z | -| `reportAsOfDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 | -| `periodCount` | *?int* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 | -| `periodLength` | *?int* | :heavy_minus_sign: | Length of each aging period in days. | 30 | -| `outstandingBalances` | array<[Components\OutstandingBalance](../../Models/Components/OutstandingBalance.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `reportGeneratedAt` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The exact date and time the report was generated. | 2024-11-14T12:00:00.000Z | +| `reportAsOfDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The cutoff date for transactions included in the report. | 2024-11-13 | +| `periodCount` | *?int* | :heavy_minus_sign: | Number of aging periods shown in the report. | 4 | +| `periodLength` | *?int* | :heavy_minus_sign: | Length of each aging period in days. | 30 | +| `outstandingBalances` | array<[Components\OutstandingBalanceByCustomer](../../Models/Components/OutstandingBalanceByCustomer.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/Models/Components/AgedReportFilter.md b/docs/Models/Components/AgedReportFilter.md index bbe83af..efb150a 100644 --- a/docs/Models/Components/AgedReportFilter.md +++ b/docs/Models/Components/AgedReportFilter.md @@ -6,6 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | | `customerId` | *?string* | :heavy_minus_sign: | Filter by customer id | 123abc | +| `supplierId` | *?string* | :heavy_minus_sign: | Filter by supplier id | 123abc | | `reportAsOfDate` | *?string* | :heavy_minus_sign: | The cutoff date for considering transactions | 2024-01-01 | | `periodCount` | *?int* | :heavy_minus_sign: | Number of periods to split the aged creditors report into | 3 | | `periodLength` | *?int* | :heavy_minus_sign: | Length of each period in days | 30 | \ No newline at end of file diff --git a/docs/Models/Components/BalanceByPeriod.md b/docs/Models/Components/BalanceByPeriod.md index d3f82cf..a2353dd 100644 --- a/docs/Models/Components/BalanceByPeriod.md +++ b/docs/Models/Components/BalanceByPeriod.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `startDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | Start date of the period. | 2024-01-01 | -| `endDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | End date of the period. | 2024-01-30 | -| `totalAmount` | *?float* | :heavy_minus_sign: | Total amount of the period. | 1500 | -| `balancesByTransaction` | array<[Components\BalanceByTransaction](../../Models/Components/BalanceByTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `totalAmount` | *?float* | :heavy_minus_sign: | Total amount of the period. | 1500 | +| `balancesByTransaction` | array<[Components\BalanceByTransaction](../../Models/Components/BalanceByTransaction.md)> | :heavy_minus_sign: | N/A | | +| `startDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The starting date of the period. If not provided, it represents the oldest period, where all transactions due before the specified `end_date` are included. | 2024-01-01 | +| `endDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | The ending date of the period. If not provided, it represents an open-ended period starting from the `start_date`, typically capturing future-dated transactions that are not yet aged. | 2024-01-30 | \ No newline at end of file diff --git a/docs/Models/Components/BalanceByTransaction.md b/docs/Models/Components/BalanceByTransaction.md index 976e13a..f9d472b 100644 --- a/docs/Models/Components/BalanceByTransaction.md +++ b/docs/Models/Components/BalanceByTransaction.md @@ -10,4 +10,5 @@ | `transactionType` | [?Components\TransactionType](../../Models/Components/TransactionType.md) | :heavy_minus_sign: | Type of the transaction. | invoice | | `dueDate` | [\DateTime](https://www.php.net/manual/en/class.datetime.php) | :heavy_minus_sign: | Due date of the transaction. | 2024-02-15 | | `originalAmount` | *?float* | :heavy_minus_sign: | Original amount of the transaction. | 1000 | -| `outstandingBalance` | *?float* | :heavy_minus_sign: | Outstanding balance of the transaction. | 800 | \ No newline at end of file +| `outstandingBalance` | *?float* | :heavy_minus_sign: | Outstanding balance of the transaction. | 800 | +| `transactionNumber` | *?string* | :heavy_minus_sign: | Transaction number of the transaction. | INV-1001 | \ No newline at end of file diff --git a/docs/Models/Components/OutstandingBalanceByCurrency.md b/docs/Models/Components/OutstandingBalanceByCurrency.md index 8157a85..b5e4b9f 100644 --- a/docs/Models/Components/OutstandingBalanceByCurrency.md +++ b/docs/Models/Components/OutstandingBalanceByCurrency.md @@ -5,5 +5,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `totalAmount` | *?float* | :heavy_minus_sign: | Total amount of the outstanding balance. | | | `balancesByPeriod` | array<[Components\BalanceByPeriod](../../Models/Components/BalanceByPeriod.md)> | :heavy_minus_sign: | N/A | | | `currency` | [?Components\Currency](../../Models/Components/Currency.md) | :heavy_minus_sign: | Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). | USD | \ No newline at end of file diff --git a/docs/Models/Components/OutstandingBalance.md b/docs/Models/Components/OutstandingBalanceByCustomer.md similarity index 94% rename from docs/Models/Components/OutstandingBalance.md rename to docs/Models/Components/OutstandingBalanceByCustomer.md index 33634ce..e2721d1 100644 --- a/docs/Models/Components/OutstandingBalance.md +++ b/docs/Models/Components/OutstandingBalanceByCustomer.md @@ -1,10 +1,10 @@ -# OutstandingBalance +# OutstandingBalanceByCustomer ## Fields | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `customerId` | *?string* | :heavy_minus_sign: | Unique identifier for the customer or supplier. | 123 | -| `customerName` | *?string* | :heavy_minus_sign: | Full name of the customer or supplier. | Super Store | +| `customerId` | *?string* | :heavy_minus_sign: | Unique identifier for the customer. | 123 | +| `customerName` | *?string* | :heavy_minus_sign: | Full name of the customer. | Super Store | | `outstandingBalancesByCurrency` | array<[Components\OutstandingBalanceByCurrency](../../Models/Components/OutstandingBalanceByCurrency.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/Models/Components/OutstandingBalanceBySupplier.md b/docs/Models/Components/OutstandingBalanceBySupplier.md new file mode 100644 index 0000000..5f0068a --- /dev/null +++ b/docs/Models/Components/OutstandingBalanceBySupplier.md @@ -0,0 +1,10 @@ +# OutstandingBalanceBySupplier + + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `supplierId` | *?string* | :heavy_minus_sign: | Unique identifier for the supplier. | 123 | +| `supplierName` | *?string* | :heavy_minus_sign: | Full name of the supplier. | Super Store | +| `outstandingBalancesByCurrency` | array<[Components\OutstandingBalanceByCurrency](../../Models/Components/OutstandingBalanceByCurrency.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/Models/Components/TransactionType.md b/docs/Models/Components/TransactionType.md index a082d1f..8250503 100644 --- a/docs/Models/Components/TransactionType.md +++ b/docs/Models/Components/TransactionType.md @@ -11,4 +11,4 @@ Type of the transaction. | `CreditNote` | credit_note | | `Bill` | bill | | `Payment` | payment | -| `BillPayment` | bill-payment | \ No newline at end of file +| `BillPayment` | bill_payment | \ No newline at end of file diff --git a/docs/Models/Operations/AccountingAgedCreditorsOneRequest.md b/docs/Models/Operations/AccountingAgedCreditorsOneRequest.md index 49def0e..78047ae 100644 --- a/docs/Models/Operations/AccountingAgedCreditorsOneRequest.md +++ b/docs/Models/Operations/AccountingAgedCreditorsOneRequest.md @@ -9,6 +9,6 @@ | `consumerId` | *?string* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `appId` | *?string* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `serviceId` | *?string* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `filter` | [?Components\AgedReportFilter](../../Models/Components/AgedReportFilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} | +| `filter` | [?Components\AgedReportFilter](../../Models/Components/AgedReportFilter.md) | :heavy_minus_sign: | Apply filters | {
"supplier_id": "123abc",
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} | | `passThrough` | array | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *?string* | :heavy_minus_sign: | 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.

Example: `fields=name,email,addresses.city`

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. | id,updated_at | \ No newline at end of file diff --git a/docs/Models/Operations/AccountingAgedDebtorsOneRequest.md b/docs/Models/Operations/AccountingAgedDebtorsOneRequest.md index c29e649..38c0725 100644 --- a/docs/Models/Operations/AccountingAgedDebtorsOneRequest.md +++ b/docs/Models/Operations/AccountingAgedDebtorsOneRequest.md @@ -9,6 +9,6 @@ | `consumerId` | *?string* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `appId` | *?string* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `serviceId` | *?string* | :heavy_minus_sign: | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | salesforce | -| `filter` | [?Components\AgedReportFilter](../../Models/Components/AgedReportFilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} | +| `filter` | [?Components\AgedReportFilter](../../Models/Components/AgedReportFilter.md) | :heavy_minus_sign: | Apply filters | {
"supplier_id": "123abc",
"customer_id": "123abc",
"report_as_of_date": "2024-01-01",
"period_count": 3,
"period_length": 30
} | | `passThrough` | array | :heavy_minus_sign: | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | {
"search": "San Francisco"
} | | `fields` | *?string* | :heavy_minus_sign: | 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.

Example: `fields=name,email,addresses.city`

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. | id,updated_at | \ No newline at end of file diff --git a/docs/sdks/agedcreditors/README.md b/docs/sdks/agedcreditors/README.md index 0ac523e..cdda10d 100644 --- a/docs/sdks/agedcreditors/README.md +++ b/docs/sdks/agedcreditors/README.md @@ -33,6 +33,7 @@ $request = new Operations\AccountingAgedCreditorsOneRequest( serviceId: 'salesforce', filter: new Components\AgedReportFilter( customerId: '123abc', + supplierId: '123abc', reportAsOfDate: '2024-01-01', periodCount: 3, periodLength: 30, diff --git a/docs/sdks/ageddebtors/README.md b/docs/sdks/ageddebtors/README.md index 393941c..0c2da99 100644 --- a/docs/sdks/ageddebtors/README.md +++ b/docs/sdks/ageddebtors/README.md @@ -33,6 +33,7 @@ $request = new Operations\AccountingAgedDebtorsOneRequest( serviceId: 'salesforce', filter: new Components\AgedReportFilter( customerId: '123abc', + supplierId: '123abc', reportAsOfDate: '2024-01-01', periodCount: 3, periodLength: 30, diff --git a/src/Models/Components/AgedCreditors.php b/src/Models/Components/AgedCreditors.php index cea5b4d..42ab1a8 100644 --- a/src/Models/Components/AgedCreditors.php +++ b/src/Models/Components/AgedCreditors.php @@ -32,10 +32,10 @@ class AgedCreditors /** * $outstandingBalances * - * @var ?array $outstandingBalances + * @var ?array $outstandingBalances */ #[\Speakeasy\Serializer\Annotation\SerializedName('outstanding_balances')] - #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\OutstandingBalance>|null')] + #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\OutstandingBalanceBySupplier>|null')] #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $outstandingBalances = null; @@ -62,7 +62,7 @@ class AgedCreditors * @param ?LocalDate $reportAsOfDate * @param ?int $periodCount * @param ?int $periodLength - * @param ?array $outstandingBalances + * @param ?array $outstandingBalances */ public function __construct(?\DateTime $reportGeneratedAt = null, ?LocalDate $reportAsOfDate = null, ?array $outstandingBalances = null, ?int $periodCount = 4, ?int $periodLength = 30) { diff --git a/src/Models/Components/AgedDebtors.php b/src/Models/Components/AgedDebtors.php index 9618876..80fde20 100644 --- a/src/Models/Components/AgedDebtors.php +++ b/src/Models/Components/AgedDebtors.php @@ -32,10 +32,10 @@ class AgedDebtors /** * $outstandingBalances * - * @var ?array $outstandingBalances + * @var ?array $outstandingBalances */ #[\Speakeasy\Serializer\Annotation\SerializedName('outstanding_balances')] - #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\OutstandingBalance>|null')] + #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\OutstandingBalanceByCustomer>|null')] #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?array $outstandingBalances = null; @@ -62,7 +62,7 @@ class AgedDebtors * @param ?LocalDate $reportAsOfDate * @param ?int $periodCount * @param ?int $periodLength - * @param ?array $outstandingBalances + * @param ?array $outstandingBalances */ public function __construct(?\DateTime $reportGeneratedAt = null, ?LocalDate $reportAsOfDate = null, ?array $outstandingBalances = null, ?int $periodCount = 4, ?int $periodLength = 30) { diff --git a/src/Models/Components/AgedReportFilter.php b/src/Models/Components/AgedReportFilter.php index bd28201..e2d0851 100644 --- a/src/Models/Components/AgedReportFilter.php +++ b/src/Models/Components/AgedReportFilter.php @@ -19,6 +19,14 @@ class AgedReportFilter #[SpeakeasyMetadata('queryParam:name=customer_id')] public ?string $customerId = null; + /** + * Filter by supplier id + * + * @var ?string $supplierId + */ + #[SpeakeasyMetadata('queryParam:name=supplier_id')] + public ?string $supplierId = null; + /** * The cutoff date for considering transactions * @@ -45,13 +53,15 @@ class AgedReportFilter /** * @param ?string $customerId + * @param ?string $supplierId * @param ?string $reportAsOfDate * @param ?int $periodCount * @param ?int $periodLength */ - public function __construct(?string $customerId = null, ?string $reportAsOfDate = null, ?int $periodCount = null, ?int $periodLength = null) + public function __construct(?string $customerId = null, ?string $supplierId = null, ?string $reportAsOfDate = null, ?int $periodCount = null, ?int $periodLength = null) { $this->customerId = $customerId; + $this->supplierId = $supplierId; $this->reportAsOfDate = $reportAsOfDate; $this->periodCount = $periodCount; $this->periodLength = $periodLength; diff --git a/src/Models/Components/BalanceByPeriod.php b/src/Models/Components/BalanceByPeriod.php index 204d2f3..6de1072 100644 --- a/src/Models/Components/BalanceByPeriod.php +++ b/src/Models/Components/BalanceByPeriod.php @@ -12,53 +12,53 @@ class BalanceByPeriod { /** - * Start date of the period. + * Total amount of the period. * - * @var ?LocalDate $startDate + * @var ?float $totalAmount */ - #[\Speakeasy\Serializer\Annotation\SerializedName('start_date')] + #[\Speakeasy\Serializer\Annotation\SerializedName('total_amount')] #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?LocalDate $startDate = null; + public ?float $totalAmount = null; /** - * End date of the period. + * $balancesByTransaction * - * @var ?LocalDate $endDate + * @var ?array $balancesByTransaction */ - #[\Speakeasy\Serializer\Annotation\SerializedName('end_date')] + #[\Speakeasy\Serializer\Annotation\SerializedName('balances_by_transaction')] + #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\BalanceByTransaction>|null')] #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?LocalDate $endDate = null; + public ?array $balancesByTransaction = null; /** - * Total amount of the period. + * The starting date of the period. If not provided, it represents the oldest period, where all transactions due before the specified `end_date` are included. * - * @var ?float $totalAmount + * @var ?LocalDate $startDate */ - #[\Speakeasy\Serializer\Annotation\SerializedName('total_amount')] + #[\Speakeasy\Serializer\Annotation\SerializedName('start_date')] #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?float $totalAmount = null; + public ?LocalDate $startDate = null; /** - * $balancesByTransaction + * The ending date of the period. If not provided, it represents an open-ended period starting from the `start_date`, typically capturing future-dated transactions that are not yet aged. * - * @var ?array $balancesByTransaction + * @var ?LocalDate $endDate */ - #[\Speakeasy\Serializer\Annotation\SerializedName('balances_by_transaction')] - #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\BalanceByTransaction>|null')] + #[\Speakeasy\Serializer\Annotation\SerializedName('end_date')] #[\Speakeasy\Serializer\Annotation\SkipWhenNull] - public ?array $balancesByTransaction = null; + public ?LocalDate $endDate = null; /** - * @param ?LocalDate $startDate - * @param ?LocalDate $endDate * @param ?float $totalAmount * @param ?array $balancesByTransaction + * @param ?LocalDate $startDate + * @param ?LocalDate $endDate */ - public function __construct(?LocalDate $startDate = null, ?LocalDate $endDate = null, ?float $totalAmount = null, ?array $balancesByTransaction = null) + public function __construct(?float $totalAmount = null, ?array $balancesByTransaction = null, ?LocalDate $startDate = null, ?LocalDate $endDate = null) { - $this->startDate = $startDate; - $this->endDate = $endDate; $this->totalAmount = $totalAmount; $this->balancesByTransaction = $balancesByTransaction; + $this->startDate = $startDate; + $this->endDate = $endDate; } } \ No newline at end of file diff --git a/src/Models/Components/BalanceByTransaction.php b/src/Models/Components/BalanceByTransaction.php index 5ca93a9..dcdb6b4 100644 --- a/src/Models/Components/BalanceByTransaction.php +++ b/src/Models/Components/BalanceByTransaction.php @@ -66,6 +66,15 @@ class BalanceByTransaction #[\Speakeasy\Serializer\Annotation\SkipWhenNull] public ?float $outstandingBalance = null; + /** + * Transaction number of the transaction. + * + * @var ?string $transactionNumber + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('transaction_number')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?string $transactionNumber = null; + /** * @param ?string $transactionId * @param ?LocalDate $transactionDate @@ -73,8 +82,9 @@ class BalanceByTransaction * @param ?LocalDate $dueDate * @param ?float $originalAmount * @param ?float $outstandingBalance + * @param ?string $transactionNumber */ - public function __construct(?string $transactionId = null, ?LocalDate $transactionDate = null, ?TransactionType $transactionType = null, ?LocalDate $dueDate = null, ?float $originalAmount = null, ?float $outstandingBalance = null) + public function __construct(?string $transactionId = null, ?LocalDate $transactionDate = null, ?TransactionType $transactionType = null, ?LocalDate $dueDate = null, ?float $originalAmount = null, ?float $outstandingBalance = null, ?string $transactionNumber = null) { $this->transactionId = $transactionId; $this->transactionDate = $transactionDate; @@ -82,5 +92,6 @@ public function __construct(?string $transactionId = null, ?LocalDate $transacti $this->dueDate = $dueDate; $this->originalAmount = $originalAmount; $this->outstandingBalance = $outstandingBalance; + $this->transactionNumber = $transactionNumber; } } \ No newline at end of file diff --git a/src/Models/Components/OutstandingBalanceByCurrency.php b/src/Models/Components/OutstandingBalanceByCurrency.php index 7eadb48..d97ef52 100644 --- a/src/Models/Components/OutstandingBalanceByCurrency.php +++ b/src/Models/Components/OutstandingBalanceByCurrency.php @@ -11,6 +11,15 @@ class OutstandingBalanceByCurrency { + /** + * Total amount of the outstanding balance. + * + * @var ?float $totalAmount + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('total_amount')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?float $totalAmount = null; + /** * $balancesByPeriod * @@ -32,11 +41,13 @@ class OutstandingBalanceByCurrency public ?Currency $currency = null; /** + * @param ?float $totalAmount * @param ?array $balancesByPeriod * @param ?Currency $currency */ - public function __construct(?array $balancesByPeriod = null, ?Currency $currency = null) + public function __construct(?float $totalAmount = null, ?array $balancesByPeriod = null, ?Currency $currency = null) { + $this->totalAmount = $totalAmount; $this->balancesByPeriod = $balancesByPeriod; $this->currency = $currency; } diff --git a/src/Models/Components/OutstandingBalance.php b/src/Models/Components/OutstandingBalanceByCustomer.php similarity index 92% rename from src/Models/Components/OutstandingBalance.php rename to src/Models/Components/OutstandingBalanceByCustomer.php index 07ce8d2..64a35ae 100644 --- a/src/Models/Components/OutstandingBalance.php +++ b/src/Models/Components/OutstandingBalanceByCustomer.php @@ -9,10 +9,10 @@ namespace Apideck\Unify\Models\Components; -class OutstandingBalance +class OutstandingBalanceByCustomer { /** - * Unique identifier for the customer or supplier. + * Unique identifier for the customer. * * @var ?string $customerId */ @@ -21,7 +21,7 @@ class OutstandingBalance public ?string $customerId = null; /** - * Full name of the customer or supplier. + * Full name of the customer. * * @var ?string $customerName */ diff --git a/src/Models/Components/OutstandingBalanceBySupplier.php b/src/Models/Components/OutstandingBalanceBySupplier.php new file mode 100644 index 0000000..03e394c --- /dev/null +++ b/src/Models/Components/OutstandingBalanceBySupplier.php @@ -0,0 +1,53 @@ + $outstandingBalancesByCurrency + */ + #[\Speakeasy\Serializer\Annotation\SerializedName('outstanding_balances_by_currency')] + #[\Speakeasy\Serializer\Annotation\Type('array<\Apideck\Unify\Models\Components\OutstandingBalanceByCurrency>|null')] + #[\Speakeasy\Serializer\Annotation\SkipWhenNull] + public ?array $outstandingBalancesByCurrency = null; + + /** + * @param ?string $supplierId + * @param ?string $supplierName + * @param ?array $outstandingBalancesByCurrency + */ + public function __construct(?string $supplierId = null, ?string $supplierName = null, ?array $outstandingBalancesByCurrency = null) + { + $this->supplierId = $supplierId; + $this->supplierName = $supplierName; + $this->outstandingBalancesByCurrency = $outstandingBalancesByCurrency; + } +} \ No newline at end of file diff --git a/src/Models/Components/TransactionType.php b/src/Models/Components/TransactionType.php index d5324d9..f47b02b 100644 --- a/src/Models/Components/TransactionType.php +++ b/src/Models/Components/TransactionType.php @@ -16,5 +16,5 @@ enum TransactionType: string case CreditNote = 'credit_note'; case Bill = 'bill'; case Payment = 'payment'; - case BillPayment = 'bill-payment'; + case BillPayment = 'bill_payment'; } diff --git a/src/SDKConfiguration.php b/src/SDKConfiguration.php index 70de7a0..3bd5e34 100644 --- a/src/SDKConfiguration.php +++ b/src/SDKConfiguration.php @@ -26,11 +26,11 @@ class SDKConfiguration public string $openapiDocVersion = '10.9.0'; - public string $sdkVersion = '0.2.0'; + public string $sdkVersion = '0.2.1'; public string $genVersion = '2.484.0'; - public string $userAgent = 'speakeasy-sdk/php 0.2.0 2.484.0 10.9.0 apideck-libraries/sdk-php'; + public string $userAgent = 'speakeasy-sdk/php 0.2.1 2.484.0 10.9.0 apideck-libraries/sdk-php'; /** @var array>> */ public ?array $globals = [ 'parameters' => [],