feat(api): api update (#230)

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 70
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/conductor%2Fconductor-44925fb24737d00a777f66dcbc0825ecda1f913c4029fa6b4002985965a9940c.yml
+configured_endpoints: 71
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/conductor%2Fconductor-a6a18ba80810ceb90173e44a17324eb2a9fbd683627c02811c5d70eaedc142af.yml

api.md

@@ -273,3 +273,15 @@ Methods:
 - <code title="get /quickbooks-desktop/vendors/{id}">client.qbd.vendors.<a href="./src/conductor/resources/qbd/vendors.py">retrieve</a>(id) -> <a href="./src/conductor/types/qbd/vendor.py">Vendor</a></code>
 - <code title="post /quickbooks-desktop/vendors/{id}">client.qbd.vendors.<a href="./src/conductor/resources/qbd/vendors.py">update</a>(id, \*\*<a href="src/conductor/types/qbd/vendor_update_params.py">params</a>) -> <a href="./src/conductor/types/qbd/vendor.py">Vendor</a></code>
 - <code title="get /quickbooks-desktop/vendors">client.qbd.vendors.<a href="./src/conductor/resources/qbd/vendors.py">list</a>(\*\*<a href="src/conductor/types/qbd/vendor_list_params.py">params</a>) -> <a href="./src/conductor/types/qbd/vendor.py">SyncCursorPage[Vendor]</a></code>
+
+## Checks
+
+Types:
+
+```python
+from conductor.types.qbd import CheckListResponse
+```
+
+Methods:
+
+- <code title="get /quickbooks-desktop/checks">client.qbd.checks.<a href="./src/conductor/resources/qbd/checks.py">list</a>(\*\*<a href="src/conductor/types/qbd/check_list_params.py">params</a>) -> <a href="./src/conductor/types/qbd/check_list_response.py">SyncCursorPage[CheckListResponse]</a></code>

src/conductor/resources/qbd/__init__.py

@@ -16,6 +16,14 @@
     BillsResourceWithStreamingResponse,
     AsyncBillsResourceWithStreamingResponse,
 )
+from .checks import (
+    ChecksResource,
+    AsyncChecksResource,
+    ChecksResourceWithRawResponse,
+    AsyncChecksResourceWithRawResponse,
+    ChecksResourceWithStreamingResponse,
+    AsyncChecksResourceWithStreamingResponse,
+)
 from .classes import (
     ClassesResource,
     AsyncClassesResource,
@@ -234,6 +242,12 @@
     "AsyncVendorsResourceWithRawResponse",
     "VendorsResourceWithStreamingResponse",
     "AsyncVendorsResourceWithStreamingResponse",
+    "ChecksResource",
+    "AsyncChecksResource",
+    "ChecksResourceWithRawResponse",
+    "AsyncChecksResourceWithRawResponse",
+    "ChecksResourceWithStreamingResponse",
+    "AsyncChecksResourceWithStreamingResponse",
     "QbdResource",
     "AsyncQbdResource",
     "QbdResourceWithRawResponse",

src/conductor/resources/qbd/qbd.py

@@ -10,6 +10,14 @@
     BillsResourceWithStreamingResponse,
     AsyncBillsResourceWithStreamingResponse,
 )
+from .checks import (
+    ChecksResource,
+    AsyncChecksResource,
+    ChecksResourceWithRawResponse,
+    AsyncChecksResourceWithRawResponse,
+    ChecksResourceWithStreamingResponse,
+    AsyncChecksResourceWithStreamingResponse,
+)
 from .classes import (
     ClassesResource,
     AsyncClassesResource,
@@ -201,6 +209,10 @@ def transfers(self) -> TransfersResource:
     def vendors(self) -> VendorsResource:
         return VendorsResource(self._client)
 
+    @cached_property
+    def checks(self) -> ChecksResource:
+        return ChecksResource(self._client)
+
     @cached_property
     def with_raw_response(self) -> QbdResourceWithRawResponse:
         """
@@ -286,6 +298,10 @@ def transfers(self) -> AsyncTransfersResource:
     def vendors(self) -> AsyncVendorsResource:
         return AsyncVendorsResource(self._client)
 
+    @cached_property
+    def checks(self) -> AsyncChecksResource:
+        return AsyncChecksResource(self._client)
+
     @cached_property
     def with_raw_response(self) -> AsyncQbdResourceWithRawResponse:
         """
@@ -374,6 +390,10 @@ def transfers(self) -> TransfersResourceWithRawResponse:
     def vendors(self) -> VendorsResourceWithRawResponse:
         return VendorsResourceWithRawResponse(self._qbd.vendors)
 
+    @cached_property
+    def checks(self) -> ChecksResourceWithRawResponse:
+        return ChecksResourceWithRawResponse(self._qbd.checks)
+
 
 class AsyncQbdResourceWithRawResponse:
     def __init__(self, qbd: AsyncQbdResource) -> None:
@@ -443,6 +463,10 @@ def transfers(self) -> AsyncTransfersResourceWithRawResponse:
     def vendors(self) -> AsyncVendorsResourceWithRawResponse:
         return AsyncVendorsResourceWithRawResponse(self._qbd.vendors)
 
+    @cached_property
+    def checks(self) -> AsyncChecksResourceWithRawResponse:
+        return AsyncChecksResourceWithRawResponse(self._qbd.checks)
+
 
 class QbdResourceWithStreamingResponse:
     def __init__(self, qbd: QbdResource) -> None:
@@ -512,6 +536,10 @@ def transfers(self) -> TransfersResourceWithStreamingResponse:
     def vendors(self) -> VendorsResourceWithStreamingResponse:
         return VendorsResourceWithStreamingResponse(self._qbd.vendors)
 
+    @cached_property
+    def checks(self) -> ChecksResourceWithStreamingResponse:
+        return ChecksResourceWithStreamingResponse(self._qbd.checks)
+
 
 class AsyncQbdResourceWithStreamingResponse:
     def __init__(self, qbd: AsyncQbdResource) -> None:
@@ -580,3 +608,7 @@ def transfers(self) -> AsyncTransfersResourceWithStreamingResponse:
     @cached_property
     def vendors(self) -> AsyncVendorsResourceWithStreamingResponse:
         return AsyncVendorsResourceWithStreamingResponse(self._qbd.vendors)
+
+    @cached_property
+    def checks(self) -> AsyncChecksResourceWithStreamingResponse:
+        return AsyncChecksResourceWithStreamingResponse(self._qbd.checks)

src/conductor/types/qbd/__init__.py

@@ -16,6 +16,7 @@
 from .sales_tax_item import SalesTaxItem as SalesTaxItem
 from .bill_list_params import BillListParams as BillListParams
 from .date_driven_term import DateDrivenTerm as DateDrivenTerm
+from .check_list_params import CheckListParams as CheckListParams
 from .class_list_params import ClassListParams as ClassListParams
 from .bill_create_params import BillCreateParams as BillCreateParams
 from .bill_update_params import BillUpdateParams as BillUpdateParams
@@ -24,6 +25,7 @@
 from .non_inventory_item import NonInventoryItem as NonInventoryItem
 from .vendor_list_params import VendorListParams as VendorListParams
 from .account_list_params import AccountListParams as AccountListParams
+from .check_list_response import CheckListResponse as CheckListResponse
 from .class_create_params import ClassCreateParams as ClassCreateParams
 from .class_list_response import ClassListResponse as ClassListResponse
 from .class_update_params import ClassUpdateParams as ClassUpdateParams

src/conductor/types/qbd/check_list_params.py

@@ -0,0 +1,145 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from datetime import date
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["CheckListParams"]
+
+
+class CheckListParams(TypedDict, total=False):
+    conductor_end_user_id: Required[Annotated[str, PropertyInfo(alias="Conductor-End-User-Id")]]
+    """
+    The ID of the EndUser to receive this request (e.g.,
+    `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+    """
+
+    account_ids: Annotated[List[str], PropertyInfo(alias="accountIds")]
+    """Filter for checks from this account or accounts.
+
+    Specify a single account ID or multiple using a comma-separated list (e.g.,
+    `accountIds=1,2,3`).
+    """
+
+    currency_ids: Annotated[List[str], PropertyInfo(alias="currencyIds")]
+    """Filter for checks in this currency or currencies.
+
+    Specify a single currency ID or multiple using a comma-separated list (e.g.,
+    `currencyIds=1,2,3`).
+    """
+
+    cursor: str
+    """
+    The pagination token to fetch the next set of results when paginating with the
+    `limit` parameter. Retrieve this value from the `nextCursor` field in the
+    previous response. If omitted, the API returns the first page of results.
+    """
+
+    ids: List[str]
+    """Filter for specific checks by their QuickBooks-assigned unique identifier(s).
+
+    NOTE: If you include this parameter, QuickBooks will ignore all other query
+    parameters.
+    """
+
+    include_line_items: Annotated[bool, PropertyInfo(alias="includeLineItems")]
+    """Whether to include line items in the response."""
+
+    include_linked_transactions: Annotated[bool, PropertyInfo(alias="includeLinkedTransactions")]
+    """Whether to include linked transactions in the response.
+
+    For example, a payment linked to the corresponding check.
+    """
+
+    limit: int
+    """The maximum number of objects to return.
+
+    Ranging from 1 to 150, defaults to 150. Use this parameter in conjunction with
+    the `cursor` parameter to paginate through results. The response will include a
+    `nextCursor` field, which can be used as the `cursor` parameter value in
+    subsequent requests to fetch the next set of results.
+    """
+
+    payee_ids: Annotated[List[str], PropertyInfo(alias="payeeIds")]
+    """Filter for checks from this payee or payees.
+
+    Specify a single payee ID or multiple using a comma-separated list (e.g.,
+    `payeeIds=1,2,3`). The person or company to whom the check is written.
+    """
+
+    ref_number_contains: Annotated[str, PropertyInfo(alias="refNumberContains")]
+    """Filter for checks whose `refNumber` contains this substring.
+
+    NOTE: If you use this parameter, you cannot also use `refNumberStartsWith` or
+    `refNumberEndsWith`.
+    """
+
+    ref_number_ends_with: Annotated[str, PropertyInfo(alias="refNumberEndsWith")]
+    """Filter for checks whose `refNumber` ends with this substring.
+
+    NOTE: If you use this parameter, you cannot also use `refNumberContains` or
+    `refNumberStartsWith`.
+    """
+
+    ref_number_from: Annotated[str, PropertyInfo(alias="refNumberFrom")]
+    """Filter for checks whose `refNumber` is greater than or equal to this value.
+
+    If omitted, the range will begin with the first number of the list. Uses a
+    numerical comparison for values that contain only digits; otherwise, uses a
+    lexicographical comparison.
+    """
+
+    ref_numbers: Annotated[List[str], PropertyInfo(alias="refNumbers")]
+    """Filter for specific checks by their ref-number(s), case-sensitive.
+
+    In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily
+    changed by the QuickBooks user.
+
+    NOTE: If you include this parameter, QuickBooks will ignore all other query
+    parameters.
+    """
+
+    ref_number_starts_with: Annotated[str, PropertyInfo(alias="refNumberStartsWith")]
+    """Filter for checks whose `refNumber` starts with this substring.
+
+    NOTE: If you use this parameter, you cannot also use `refNumberContains` or
+    `refNumberEndsWith`.
+    """
+
+    ref_number_to: Annotated[str, PropertyInfo(alias="refNumberTo")]
+    """Filter for checks whose `refNumber` is less than or equal to this value.
+
+    If omitted, the range will end with the last number of the list. Uses a
+    numerical comparison for values that contain only digits; otherwise, uses a
+    lexicographical comparison.
+    """
+
+    transaction_date_from: Annotated[Union[str, date], PropertyInfo(alias="transactionDateFrom", format="iso8601")]
+    """
+    Filter for checks created on or after this date, in ISO 8601 format
+    (YYYY-MM-DD).
+    """
+
+    transaction_date_to: Annotated[Union[str, date], PropertyInfo(alias="transactionDateTo", format="iso8601")]
+    """
+    Filter for checks created on or before this date, in ISO 8601 format
+    (YYYY-MM-DD).
+    """
+
+    updated_after: Annotated[str, PropertyInfo(alias="updatedAfter")]
+    """
+    Filter for checks updated on or after this date and time, in ISO 8601 format
+    (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is
+    assumed to be 00:00:00 of that day.
+    """
+
+    updated_before: Annotated[str, PropertyInfo(alias="updatedBefore")]
+    """
+    Filter for checks updated on or before this date and time, in ISO 8601 format
+    (YYYY-MM-DDTHH:mm:ss). If you only provide a date (YYYY-MM-DD), the time is
+    assumed to be 23:59:59 of that day.
+    """