diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 2dadd359..0e6e1efe 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: fca0ac3a-5f4e-452c-bbc7-2311afa8da40 management: - docChecksum: 61df122cba17c214e57e21a31256463e - docVersion: 10.21.18 + docChecksum: 931d63edaff2267943df0de38e5fa2ad + docVersion: 10.21.19 speakeasyVersion: 1.656.1 generationVersion: 2.753.1 - releaseVersion: 0.27.86 - configChecksum: 7919bdb35bb8fe074c0b4973c2144f4d + releaseVersion: 0.27.88 + configChecksum: e5678354c0361164e8aab420971d241a repoURL: https://github.com/apideck-libraries/sdk-python.git installationURL: https://github.com/apideck-libraries/sdk-python.git published: true @@ -305,6 +305,7 @@ generatedFiles: - docs/models/accountinglocationsupdateglobals.md - docs/models/accountinglocationsupdaterequest.md - docs/models/accountinglocationsupdateresponse.md + - docs/models/accountingmethod.md - docs/models/accountingpaymentsaddglobals.md - docs/models/accountingpaymentsaddrequest.md - docs/models/accountingpaymentsaddresponse.md @@ -525,6 +526,7 @@ generatedFiles: - docs/models/bankaccount2.md - docs/models/bankaccount2accounttype.md - docs/models/bankaccountsfilter.md + - docs/models/bankaccountsfilteraccounttype.md - docs/models/bankaccountsfilterstatus.md - docs/models/bankaccountssort.md - docs/models/bankaccounttype.md @@ -1558,6 +1560,7 @@ generatedFiles: - docs/models/productstatus.md - docs/models/profitandloss.md - docs/models/profitandlossfilter.md + - docs/models/profitandlossfilteraccountingmethod.md - docs/models/profitandlossindicator.md - docs/models/profitandlosstype.md - docs/models/project.md @@ -5465,7 +5468,7 @@ examples: parameters: query: pass_through: {"search": "San Francisco"} - filter: {"start_date": "2021-01-01", "end_date": "2021-12-31", "period_count": 3, "period_type": "month", "location_id": "123"} + filter: {"start_date": "2021-01-01", "end_date": "2021-12-31", "period_count": 3, "period_type": "month", "location_id": "123", "accounting_method": "accrual"} raw: false header: x-apideck-consumer-id: "test-consumer" @@ -5517,7 +5520,7 @@ examples: parameters: query: raw: false - filter: {"customer_id": "123abc", "start_date": "2021-01-01", "end_date": "2021-12-31", "location_id": "123"} + filter: {"customer_id": "123abc", "start_date": "2021-01-01", "end_date": "2021-12-31", "location_id": "123", "accounting_method": "accrual"} pass_through: {"search": "San Francisco"} fields: "id,updated_at" header: @@ -18208,7 +18211,7 @@ examples: query: raw: false limit: 20 - filter: {"name": "Main Operating", "status": "active"} + filter: {"name": "Main Operating", "account_type": "checking", "status": "active"} sort: {"by": "updated_at", "direction": "asc"} pass_through: {"search": "San Francisco"} fields: "id,updated_at" @@ -18271,7 +18274,7 @@ examples: x-apideck-service-id: "salesforce" responses: "200": - application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "bank-accounts", "operation": "one", "data": {"id": "12345", "display_id": "BA-001", "name": "Main Operating Account", "account_number": "123465", "account_type": "checking", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453", "parent_id": "123456", "display_id": "123456"}, "bank_name": "Chase Bank", "currency": "USD", "balance": 25000, "available_balance": 24500, "overdraft_limit": 5000, "routing_number": "021000021", "iban": "GB33BUKB20201555555555", "bic": "CHASUS33", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "country": "US", "status": "active", "description": "Primary operating account for daily transactions", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "created_by": "12345", "updated_by": "12345"}} + application/json: {"status_code": 200, "status": "OK", "service": "quickbooks", "resource": "bank-accounts", "operation": "one", "data": {"id": "12345", "downstream_id": "12345", "display_id": "BA-001", "name": "Main Operating Account", "account_number": "123465", "account_type": "checking", "ledger_account": {"id": "123456", "name": "Bank account", "nominal_code": "N091", "code": "453", "parent_id": "123456", "display_id": "123456"}, "bank_name": "Chase Bank", "currency": "USD", "balance": 25000, "available_balance": 24500, "overdraft_limit": 5000, "routing_number": "021000021", "iban": "GB33BUKB20201555555555", "bic": "CHASUS33", "bsb_number": "062-001", "branch_identifier": "001", "bank_code": "BNH", "country": "US", "status": "active", "description": "Primary operating account for daily transactions", "custom_fields": [{"id": "2389328923893298", "name": "employee_level", "description": "Employee Level", "value": "Uses Salesforce and Marketo"}], "created_at": "2020-09-30T07:43:32.000Z", "updated_at": "2020-09-30T07:43:32.000Z", "created_by": "12345", "updated_by": "12345"}} "400": application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestValidationError", "message": "Invalid Params", "detail": "Missing property foobar", "ref": "https://developers.apideck.com/errors#requestvalidationerror"} "401": @@ -18475,3 +18478,4 @@ examples: application/json: {"status_code": 400, "error": "Bad Request", "type_name": "RequestHeadersValidationError", "message": "Invalid Params", "detail": "Missing Header: x-apideck-consumer-id", "ref": "https://developers.apideck.com/errors#unauthorizederror"} examplesVersion: 1.0.2 generatedTests: {} +releaseNotes: "## Python SDK Changes Detected:\n* `apideck.accounting.balance_sheet.get()`: `request.filter` **Changed**\n* `apideck.accounting.profit_and_loss.get()`: `request.filter` **Changed**\n* `apideck.accounting.bank_accounts.list()`: \n * `request.filter` **Changed**\n * `response.data.[].downstream_id` **Added**\n* `apideck.accounting.bank_accounts.get()`: `response.data.downstream_id` **Added**\n" diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 39ad9838..cf5af17e 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -28,7 +28,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false python: - version: 0.27.86 + version: 0.27.88 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index f93b443a..399022a4 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,20 +2,20 @@ speakeasyVersion: 1.656.1 sources: Apideck: sourceNamespace: apideck - sourceRevisionDigest: sha256:7943744a97996166cce2f28e896ee04e866d7dc6118f243a930c11f6e8fc0406 - sourceBlobDigest: sha256:b426327f78b6ab700ad4e4b02246636b8be9536ae50bcb0e6420def02749458d + sourceRevisionDigest: sha256:ef15e5348a2c102565786ad54b8bfe4344a93ac0bdee20a9046f39122359b929 + sourceBlobDigest: sha256:7f6cb30ce3d491aa0ae69c3ec4da9234b860ccfb60bcea974134b575bcdc7e2c tags: - latest - - speakeasy-sdk-regen-1764162795 - - 10.21.18 + - speakeasy-sdk-regen-1764201934 + - 10.21.19 targets: apideck: source: Apideck sourceNamespace: apideck - sourceRevisionDigest: sha256:7943744a97996166cce2f28e896ee04e866d7dc6118f243a930c11f6e8fc0406 - sourceBlobDigest: sha256:b426327f78b6ab700ad4e4b02246636b8be9536ae50bcb0e6420def02749458d + sourceRevisionDigest: sha256:ef15e5348a2c102565786ad54b8bfe4344a93ac0bdee20a9046f39122359b929 + sourceBlobDigest: sha256:7f6cb30ce3d491aa0ae69c3ec4da9234b860ccfb60bcea974134b575bcdc7e2c codeSamplesNamespace: apideck-python-code-samples - codeSamplesRevisionDigest: sha256:f6a28933503ccd0ca980974ebff8e9c1bd913dabba9fa9cfcdf3fa842a9d0bf9 + codeSamplesRevisionDigest: sha256:f6f10388ceb21081dcd9c65fdfa2db33f500d6724bc25941fa7008d930ce4686 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index c8e8a644..890a6cbf 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -988,4 +988,14 @@ Based on: ### Generated - [python v0.27.86] . ### Releases -- [PyPI v0.27.86] https://pypi.org/project/apideck-unify/0.27.86 - . \ No newline at end of file +- [PyPI v0.27.86] https://pypi.org/project/apideck-unify/0.27.86 - . + +## 2025-11-27 09:04:00 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.656.1 (2.753.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.27.88] . +### Releases +- [PyPI v0.27.88] https://pypi.org/project/apideck-unify/0.27.88 - . \ No newline at end of file diff --git a/docs/models/accountingbalancesheetonerequest.md b/docs/models/accountingbalancesheetonerequest.md index 268b957a..fa338495 100644 --- a/docs/models/accountingbalancesheetonerequest.md +++ b/docs/models/accountingbalancesheetonerequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :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 | -| `pass_through` | Dict[str, *Any*] | :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"
} | -| `filter_` | [Optional[models.BalanceSheetFilter]](../models/balancesheetfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month",
"location_id": "123"
} | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `service_id` | *Optional[str]* | :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 | +| `pass_through` | Dict[str, *Any*] | :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"
} | +| `filter_` | [Optional[models.BalanceSheetFilter]](../models/balancesheetfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month",
"location_id": "123",
"accounting_method": "accrual"
} | +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | \ No newline at end of file diff --git a/docs/models/accountingbankaccount.md b/docs/models/accountingbankaccount.md index 6f9c38f8..9434fad9 100644 --- a/docs/models/accountingbankaccount.md +++ b/docs/models/accountingbankaccount.md @@ -6,6 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `id` | *str* | :heavy_check_mark: | A unique identifier for an object. | 12345 | +| `downstream_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The third-party API ID of original entity | 12345 | | `display_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Display ID for the bank account | BA-001 | | `name` | *OptionalNullable[str]* | :heavy_minus_sign: | The name of the bank account | Main Operating Account | | `account_number` | *OptionalNullable[str]* | :heavy_minus_sign: | The bank account number | 123465 | diff --git a/docs/models/accountingmethod.md b/docs/models/accountingmethod.md new file mode 100644 index 00000000..d72d69ef --- /dev/null +++ b/docs/models/accountingmethod.md @@ -0,0 +1,11 @@ +# AccountingMethod + +The accounting method used for the report: cash or accrual. + + +## Values + +| Name | Value | +| --------- | --------- | +| `CASH` | cash | +| `ACCRUAL` | accrual | \ No newline at end of file diff --git a/docs/models/accountingprofitandlossonerequest.md b/docs/models/accountingprofitandlossonerequest.md index ef5f6a55..c971b5bc 100644 --- a/docs/models/accountingprofitandlossonerequest.md +++ b/docs/models/accountingprofitandlossonerequest.md @@ -9,6 +9,6 @@ | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :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_` | [Optional[models.ProfitAndLossFilter]](../models/profitandlossfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"location_id": "123"
} | +| `filter_` | [Optional[models.ProfitAndLossFilter]](../models/profitandlossfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"location_id": "123",
"accounting_method": "accrual"
} | | `pass_through` | Dict[str, *Any*] | :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` | *OptionalNullable[str]* | :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/balancesheetfilter.md b/docs/models/balancesheetfilter.md index 025ce7a5..f297fab8 100644 --- a/docs/models/balancesheetfilter.md +++ b/docs/models/balancesheetfilter.md @@ -9,4 +9,5 @@ | `end_date` | *Optional[str]* | :heavy_minus_sign: | The end date of the period to include in the resource. | 2021-12-31 | | `period_count` | *Optional[int]* | :heavy_minus_sign: | The number of periods to include in the resource. | 3 | | `period_type` | [Optional[models.PeriodType]](../models/periodtype.md) | :heavy_minus_sign: | The type of period to include in the resource: month, quarter, year. | month | -| `location_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the location to include in the resource. | 123 | \ No newline at end of file +| `location_id` | *Optional[str]* | :heavy_minus_sign: | The ID of the location to include in the resource. | 123 | +| `accounting_method` | [Optional[models.AccountingMethod]](../models/accountingmethod.md) | :heavy_minus_sign: | The accounting method used for the report: cash or accrual. | accrual | \ No newline at end of file diff --git a/docs/models/bankaccountsfilter.md b/docs/models/bankaccountsfilter.md index 8bffb21c..cb24546d 100644 --- a/docs/models/bankaccountsfilter.md +++ b/docs/models/bankaccountsfilter.md @@ -3,7 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `name` | *Optional[str]* | :heavy_minus_sign: | Filter by bank account name | Main Operating | -| `status` | [Optional[models.BankAccountsFilterStatus]](../models/bankaccountsfilterstatus.md) | :heavy_minus_sign: | Filter by account status | active | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `name` | *Optional[str]* | :heavy_minus_sign: | Filter by bank account name | Main Operating | +| `account_type` | [Optional[models.BankAccountsFilterAccountType]](../models/bankaccountsfilteraccounttype.md) | :heavy_minus_sign: | Filter by account type | checking | +| `status` | [Optional[models.BankAccountsFilterStatus]](../models/bankaccountsfilterstatus.md) | :heavy_minus_sign: | Filter by account status | active | \ No newline at end of file diff --git a/docs/models/bankaccountsfilteraccounttype.md b/docs/models/bankaccountsfilteraccounttype.md new file mode 100644 index 00000000..f52450e1 --- /dev/null +++ b/docs/models/bankaccountsfilteraccounttype.md @@ -0,0 +1,16 @@ +# BankAccountsFilterAccountType + +Filter by account type + + +## Values + +| Name | Value | +| ---------------- | ---------------- | +| `CHECKING` | checking | +| `SAVINGS` | savings | +| `CREDIT_CARD` | credit_card | +| `MONEY_MARKET` | money_market | +| `LINE_OF_CREDIT` | line_of_credit | +| `OTHER` | other | +| `CASH` | cash | \ No newline at end of file diff --git a/docs/models/creditnotestatus.md b/docs/models/creditnotestatus.md index db9e4e95..708459fc 100644 --- a/docs/models/creditnotestatus.md +++ b/docs/models/creditnotestatus.md @@ -5,10 +5,11 @@ Status of credit notes ## Values -| Name | Value | -| ------------ | ------------ | -| `DRAFT` | draft | -| `AUTHORISED` | authorised | -| `PAID` | paid | -| `VOIDED` | voided | -| `DELETED` | deleted | \ No newline at end of file +| Name | Value | +| ---------------- | ---------------- | +| `DRAFT` | draft | +| `AUTHORISED` | authorised | +| `PARTIALLY_PAID` | partially_paid | +| `PAID` | paid | +| `VOIDED` | voided | +| `DELETED` | deleted | \ No newline at end of file diff --git a/docs/models/profitandlossfilter.md b/docs/models/profitandlossfilter.md index f8a9d6ec..af17bcfc 100644 --- a/docs/models/profitandlossfilter.md +++ b/docs/models/profitandlossfilter.md @@ -3,9 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `customer_id` | *Optional[str]* | :heavy_minus_sign: | Filter by customer id | 123abc | -| `start_date` | *Optional[str]* | :heavy_minus_sign: | Filter by start date. If start date is given, end date is required. | 2021-01-01 | -| `end_date` | *Optional[str]* | :heavy_minus_sign: | Filter by end date. If end date is given, start date is required. | 2021-12-31 | -| `location_id` | *Optional[str]* | :heavy_minus_sign: | Filter by location id | 123 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `customer_id` | *Optional[str]* | :heavy_minus_sign: | Filter by customer id | 123abc | +| `start_date` | *Optional[str]* | :heavy_minus_sign: | Filter by start date. If start date is given, end date is required. | 2021-01-01 | +| `end_date` | *Optional[str]* | :heavy_minus_sign: | Filter by end date. If end date is given, start date is required. | 2021-12-31 | +| `location_id` | *Optional[str]* | :heavy_minus_sign: | Filter by location id | 123 | +| `accounting_method` | [Optional[models.ProfitAndLossFilterAccountingMethod]](../models/profitandlossfilteraccountingmethod.md) | :heavy_minus_sign: | The accounting method used for the report: cash or accrual. | accrual | \ No newline at end of file diff --git a/docs/models/profitandlossfilteraccountingmethod.md b/docs/models/profitandlossfilteraccountingmethod.md new file mode 100644 index 00000000..32389246 --- /dev/null +++ b/docs/models/profitandlossfilteraccountingmethod.md @@ -0,0 +1,11 @@ +# ProfitAndLossFilterAccountingMethod + +The accounting method used for the report: cash or accrual. + + +## Values + +| Name | Value | +| --------- | --------- | +| `CASH` | cash | +| `ACCRUAL` | accrual | \ No newline at end of file diff --git a/docs/sdks/balancesheetsdk/README.md b/docs/sdks/balancesheetsdk/README.md index 2e275a20..2fdffac0 100644 --- a/docs/sdks/balancesheetsdk/README.md +++ b/docs/sdks/balancesheetsdk/README.md @@ -44,15 +44,15 @@ with Apideck( ### Parameters -| Parameter | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | -| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | -| `service_id` | *Optional[str]* | :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 | -| `pass_through` | Dict[str, *Any*] | :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"
} | -| `filter_` | [Optional[models.BalanceSheetFilter]](../../models/balancesheetfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month",
"location_id": "123"
} | -| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | -| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | +| Parameter | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | +| `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | +| `service_id` | *Optional[str]* | :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 | +| `pass_through` | Dict[str, *Any*] | :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"
} | +| `filter_` | [Optional[models.BalanceSheetFilter]](../../models/balancesheetfilter.md) | :heavy_minus_sign: | Apply filters | {
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"period_count": 3,
"period_type": "month",
"location_id": "123",
"accounting_method": "accrual"
} | +| `raw` | *Optional[bool]* | :heavy_minus_sign: | Include raw response. Mostly used for debugging purposes | | +| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | ### Response diff --git a/docs/sdks/bankaccounts/README.md b/docs/sdks/bankaccounts/README.md index 3a8e587f..2df8e40b 100644 --- a/docs/sdks/bankaccounts/README.md +++ b/docs/sdks/bankaccounts/README.md @@ -32,6 +32,7 @@ with Apideck( res = apideck.accounting.bank_accounts.list(raw=False, service_id="salesforce", limit=20, filter_={ "name": "Main Operating", + "account_type": apideck_unify.BankAccountsFilterAccountType.CHECKING, "status": apideck_unify.BankAccountsFilterStatus.ACTIVE, }, sort={}, pass_through={ "search": "San Francisco", diff --git a/docs/sdks/profitandlosssdk/README.md b/docs/sdks/profitandlosssdk/README.md index 9a532b6c..94c7894b 100644 --- a/docs/sdks/profitandlosssdk/README.md +++ b/docs/sdks/profitandlosssdk/README.md @@ -48,7 +48,7 @@ with Apideck( | `consumer_id` | *Optional[str]* | :heavy_minus_sign: | ID of the consumer which you want to get or push data from | test-consumer | | `app_id` | *Optional[str]* | :heavy_minus_sign: | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX | | `service_id` | *Optional[str]* | :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_` | [Optional[models.ProfitAndLossFilter]](../../models/profitandlossfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"location_id": "123"
} | +| `filter_` | [Optional[models.ProfitAndLossFilter]](../../models/profitandlossfilter.md) | :heavy_minus_sign: | Apply filters | {
"customer_id": "123abc",
"start_date": "2021-01-01",
"end_date": "2021-12-31",
"location_id": "123",
"accounting_method": "accrual"
} | | `pass_through` | Dict[str, *Any*] | :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` | *OptionalNullable[str]* | :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 | | `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. | | diff --git a/pyproject.toml b/pyproject.toml index 8eb5c6cd..b9425522 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "apideck-unify" -version = "0.27.86" +version = "0.27.88" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Speakeasy" },] readme = "README-PYPI.md" diff --git a/src/apideck_unify/_version.py b/src/apideck_unify/_version.py index af224aa5..f1d9fd76 100644 --- a/src/apideck_unify/_version.py +++ b/src/apideck_unify/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "apideck-unify" -__version__: str = "0.27.86" -__openapi_doc_version__: str = "10.21.18" +__version__: str = "0.27.88" +__openapi_doc_version__: str = "10.21.19" __gen_version__: str = "2.753.1" -__user_agent__: str = "speakeasy-sdk/python 0.27.86 2.753.1 10.21.18 apideck-unify" +__user_agent__: str = "speakeasy-sdk/python 0.27.88 2.753.1 10.21.19 apideck-unify" try: if __package__ is not None: diff --git a/src/apideck_unify/models/__init__.py b/src/apideck_unify/models/__init__.py index f4214984..18ec7f3b 100644 --- a/src/apideck_unify/models/__init__.py +++ b/src/apideck_unify/models/__init__.py @@ -1214,6 +1214,7 @@ ReportsTypedDict, ) from .balancesheetfilter import ( + AccountingMethod, BalanceSheetFilter, BalanceSheetFilterTypedDict, PeriodType, @@ -1231,6 +1232,7 @@ ) from .bankaccountsfilter import ( BankAccountsFilter, + BankAccountsFilterAccountType, BankAccountsFilterStatus, BankAccountsFilterTypedDict, ) @@ -3777,7 +3779,11 @@ UncategorizedAccounts, UncategorizedAccountsTypedDict, ) - from .profitandlossfilter import ProfitAndLossFilter, ProfitAndLossFilterTypedDict + from .profitandlossfilter import ( + ProfitAndLossFilter, + ProfitAndLossFilterAccountingMethod, + ProfitAndLossFilterTypedDict, + ) from .profitandlossindicator import ( ProfitAndLossIndicator, ProfitAndLossIndicatorTypedDict, @@ -5019,6 +5025,7 @@ "AccountingLocationsUpdateRequestTypedDict", "AccountingLocationsUpdateResponse", "AccountingLocationsUpdateResponseTypedDict", + "AccountingMethod", "AccountingPaymentsAddGlobals", "AccountingPaymentsAddGlobalsTypedDict", "AccountingPaymentsAddRequest", @@ -5430,6 +5437,7 @@ "BankAccountType", "BankAccountTypedDict", "BankAccountsFilter", + "BankAccountsFilterAccountType", "BankAccountsFilterStatus", "BankAccountsFilterTypedDict", "BankAccountsSort", @@ -7385,6 +7393,7 @@ "ProductStatus", "ProfitAndLoss", "ProfitAndLossFilter", + "ProfitAndLossFilterAccountingMethod", "ProfitAndLossFilterTypedDict", "ProfitAndLossIndicator", "ProfitAndLossIndicatorTypedDict", @@ -8874,6 +8883,7 @@ "BalanceSheetUncategorizedItemsAccountTypedDict": ".balancesheet", "Reports": ".balancesheet", "ReportsTypedDict": ".balancesheet", + "AccountingMethod": ".balancesheetfilter", "BalanceSheetFilter": ".balancesheetfilter", "BalanceSheetFilterTypedDict": ".balancesheetfilter", "PeriodType": ".balancesheetfilter", @@ -8887,6 +8897,7 @@ "BankAccount2AccountType": ".bankaccount2", "BankAccount2TypedDict": ".bankaccount2", "BankAccountsFilter": ".bankaccountsfilter", + "BankAccountsFilterAccountType": ".bankaccountsfilter", "BankAccountsFilterStatus": ".bankaccountsfilter", "BankAccountsFilterTypedDict": ".bankaccountsfilter", "BankAccountsSort": ".bankaccountssort", @@ -10850,6 +10861,7 @@ "UncategorizedAccounts": ".profitandloss", "UncategorizedAccountsTypedDict": ".profitandloss", "ProfitAndLossFilter": ".profitandlossfilter", + "ProfitAndLossFilterAccountingMethod": ".profitandlossfilter", "ProfitAndLossFilterTypedDict": ".profitandlossfilter", "ProfitAndLossIndicator": ".profitandlossindicator", "ProfitAndLossIndicatorTypedDict": ".profitandlossindicator", diff --git a/src/apideck_unify/models/accountingbankaccount.py b/src/apideck_unify/models/accountingbankaccount.py index fbc12ee1..7e36e0b8 100644 --- a/src/apideck_unify/models/accountingbankaccount.py +++ b/src/apideck_unify/models/accountingbankaccount.py @@ -41,6 +41,8 @@ class AccountingBankAccountStatus(str, Enum): class AccountingBankAccountTypedDict(TypedDict): id: str r"""A unique identifier for an object.""" + downstream_id: NotRequired[Nullable[str]] + r"""The third-party API ID of original entity""" display_id: NotRequired[Nullable[str]] r"""Display ID for the bank account""" name: NotRequired[Nullable[str]] @@ -95,6 +97,9 @@ class AccountingBankAccount(BaseModel): id: str r"""A unique identifier for an object.""" + downstream_id: OptionalNullable[str] = UNSET + r"""The third-party API ID of original entity""" + display_id: OptionalNullable[str] = UNSET r"""Display ID for the bank account""" @@ -171,6 +176,7 @@ class AccountingBankAccount(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ + "downstream_id", "display_id", "name", "account_number", @@ -198,6 +204,7 @@ def serialize_model(self, handler): "updated_by", ] nullable_fields = [ + "downstream_id", "display_id", "name", "account_number", diff --git a/src/apideck_unify/models/balancesheetfilter.py b/src/apideck_unify/models/balancesheetfilter.py index c1b11527..83bc7c7c 100644 --- a/src/apideck_unify/models/balancesheetfilter.py +++ b/src/apideck_unify/models/balancesheetfilter.py @@ -17,6 +17,13 @@ class PeriodType(str, Enum): YEAR = "year" +class AccountingMethod(str, Enum): + r"""The accounting method used for the report: cash or accrual.""" + + CASH = "cash" + ACCRUAL = "accrual" + + class BalanceSheetFilterTypedDict(TypedDict): start_date: NotRequired[str] r"""The start date of the period to include in the resource.""" @@ -28,6 +35,8 @@ class BalanceSheetFilterTypedDict(TypedDict): r"""The type of period to include in the resource: month, quarter, year.""" location_id: NotRequired[str] r"""The ID of the location to include in the resource.""" + accounting_method: NotRequired[AccountingMethod] + r"""The accounting method used for the report: cash or accrual.""" class BalanceSheetFilter(BaseModel): @@ -51,3 +60,8 @@ class BalanceSheetFilter(BaseModel): location_id: Annotated[Optional[str], FieldMetadata(query=True)] = None r"""The ID of the location to include in the resource.""" + + accounting_method: Annotated[ + Optional[AccountingMethod], FieldMetadata(query=True) + ] = None + r"""The accounting method used for the report: cash or accrual.""" diff --git a/src/apideck_unify/models/bankaccountsfilter.py b/src/apideck_unify/models/bankaccountsfilter.py index cc2b55a8..71bbe6e5 100644 --- a/src/apideck_unify/models/bankaccountsfilter.py +++ b/src/apideck_unify/models/bankaccountsfilter.py @@ -8,6 +8,18 @@ from typing_extensions import Annotated, NotRequired, TypedDict +class BankAccountsFilterAccountType(str, Enum): + r"""Filter by account type""" + + CHECKING = "checking" + SAVINGS = "savings" + CREDIT_CARD = "credit_card" + MONEY_MARKET = "money_market" + LINE_OF_CREDIT = "line_of_credit" + OTHER = "other" + CASH = "cash" + + class BankAccountsFilterStatus(str, Enum): r"""Filter by account status""" @@ -19,6 +31,8 @@ class BankAccountsFilterStatus(str, Enum): class BankAccountsFilterTypedDict(TypedDict): name: NotRequired[str] r"""Filter by bank account name""" + account_type: NotRequired[BankAccountsFilterAccountType] + r"""Filter by account type""" status: NotRequired[BankAccountsFilterStatus] r"""Filter by account status""" @@ -27,6 +41,11 @@ class BankAccountsFilter(BaseModel): name: Annotated[Optional[str], FieldMetadata(query=True)] = None r"""Filter by bank account name""" + account_type: Annotated[ + Optional[BankAccountsFilterAccountType], FieldMetadata(query=True) + ] = None + r"""Filter by account type""" + status: Annotated[Optional[BankAccountsFilterStatus], FieldMetadata(query=True)] = ( None ) diff --git a/src/apideck_unify/models/creditnote.py b/src/apideck_unify/models/creditnote.py index 85b0517b..80f1ed4c 100644 --- a/src/apideck_unify/models/creditnote.py +++ b/src/apideck_unify/models/creditnote.py @@ -43,6 +43,7 @@ class CreditNoteStatus(str, Enum): DRAFT = "draft" AUTHORISED = "authorised" + PARTIALLY_PAID = "partially_paid" PAID = "paid" VOIDED = "voided" DELETED = "deleted" diff --git a/src/apideck_unify/models/profitandlossfilter.py b/src/apideck_unify/models/profitandlossfilter.py index 1002297f..87aa831e 100644 --- a/src/apideck_unify/models/profitandlossfilter.py +++ b/src/apideck_unify/models/profitandlossfilter.py @@ -3,10 +3,18 @@ from __future__ import annotations from apideck_unify.types import BaseModel from apideck_unify.utils import FieldMetadata +from enum import Enum from typing import Optional from typing_extensions import Annotated, NotRequired, TypedDict +class ProfitAndLossFilterAccountingMethod(str, Enum): + r"""The accounting method used for the report: cash or accrual.""" + + CASH = "cash" + ACCRUAL = "accrual" + + class ProfitAndLossFilterTypedDict(TypedDict): customer_id: NotRequired[str] r"""Filter by customer id""" @@ -16,6 +24,8 @@ class ProfitAndLossFilterTypedDict(TypedDict): r"""Filter by end date. If end date is given, start date is required.""" location_id: NotRequired[str] r"""Filter by location id""" + accounting_method: NotRequired[ProfitAndLossFilterAccountingMethod] + r"""The accounting method used for the report: cash or accrual.""" class ProfitAndLossFilter(BaseModel): @@ -30,3 +40,8 @@ class ProfitAndLossFilter(BaseModel): location_id: Annotated[Optional[str], FieldMetadata(query=True)] = None r"""Filter by location id""" + + accounting_method: Annotated[ + Optional[ProfitAndLossFilterAccountingMethod], FieldMetadata(query=True) + ] = None + r"""The accounting method used for the report: cash or accrual."""