conductor-node 12.22.0 → 12.23.0

package/src/resources/qbd/deleted-transactions.ts

@@ -0,0 +1,178 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from "../../resource.js";
+import * as Core from "../../core.js";
+
+export class DeletedTransactions extends APIResource {
+  /**
+   * Lists deleted transactions of the specified type(s) (e.g., invoice, bill,
+   * estimate) in the last 90 days. Results are grouped by transaction type and
+   * ordered by actual delete time (ascending). NOTE: For deleted non-transaction
+   * list-objects (e.g., customer, vendor, employee), see the deleted-list-objects
+   * endpoint.
+   *
+   * @example
+   * ```ts
+   * const deletedTransactions =
+   *   await conductor.qbd.deletedTransactions.list({
+   *     transactionTypes: ['invoice'],
+   *     conductorEndUserId: 'end_usr_1234567abcdefg',
+   *   });
+   * ```
+   */
+  list(
+    params: DeletedTransactionListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<DeletedTransactionListResponse> {
+    const { conductorEndUserId, ...query } = params;
+    return this._client.get('/quickbooks-desktop/deleted-transactions', {
+      query,
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+}
+
+export interface DeletedTransaction {
+  /**
+   * The unique identifier assigned by QuickBooks to this deleted transaction. This
+   * ID is unique across all transaction types.
+   */
+  id: string;
+
+  /**
+   * The date and time when this deleted transaction was created, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
+   * in QuickBooks.
+   */
+  createdAt: string;
+
+  /**
+   * The date and time when this deleted transaction was deleted, in ISO 8601 format
+   * (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone
+   * in QuickBooks.
+   */
+  deletedAt: string;
+
+  /**
+   * The type of object. This value is always `"qbd_deleted_transaction"`.
+   */
+  objectType: 'qbd_deleted_transaction';
+
+  /**
+   * The case-sensitive user-defined reference number for this deleted transaction,
+   * which can be used to identify the transaction in QuickBooks. This value is not
+   * required to be unique and can be arbitrarily changed by the QuickBooks user.
+   */
+  refNumber: string | null;
+
+  /**
+   * The type of deleted transaction.
+   */
+  transactionType:
+    | 'ar_refund_credit_card'
+    | 'bill'
+    | 'bill_payment_check'
+    | 'bill_payment_credit_card'
+    | 'build_assembly'
+    | 'charge'
+    | 'check'
+    | 'credit_card_charge'
+    | 'credit_card_credit'
+    | 'credit_memo'
+    | 'deposit'
+    | 'estimate'
+    | 'inventory_adjustment'
+    | 'invoice'
+    | 'item_receipt'
+    | 'journal_entry'
+    | 'purchase_order'
+    | 'receive_payment'
+    | 'sales_order'
+    | 'sales_receipt'
+    | 'sales_tax_payment_check'
+    | 'time_tracking'
+    | 'transfer_inventory'
+    | 'vehicle_mileage'
+    | 'vendor_credit';
+}
+
+export interface DeletedTransactionListResponse {
+  /**
+   * The array of deleted transactions.
+   */
+  data: Array<DeletedTransaction>;
+
+  /**
+   * The type of object. This value is always `"list"`.
+   */
+  objectType: 'list';
+
+  /**
+   * The endpoint URL where this list can be accessed.
+   */
+  url: string;
+}
+
+export interface DeletedTransactionListParams {
+  /**
+   * Query param: Filter for deleted transactions by their transaction type(s).
+   */
+  transactionTypes: Array<
+    | 'ar_refund_credit_card'
+    | 'bill'
+    | 'bill_payment_check'
+    | 'bill_payment_credit_card'
+    | 'build_assembly'
+    | 'charge'
+    | 'check'
+    | 'credit_card_charge'
+    | 'credit_card_credit'
+    | 'credit_memo'
+    | 'deposit'
+    | 'estimate'
+    | 'inventory_adjustment'
+    | 'invoice'
+    | 'item_receipt'
+    | 'journal_entry'
+    | 'purchase_order'
+    | 'receive_payment'
+    | 'sales_order'
+    | 'sales_receipt'
+    | 'sales_tax_payment_check'
+    | 'time_tracking'
+    | 'transfer_inventory'
+    | 'vehicle_mileage'
+    | 'vendor_credit'
+  >;
+
+  /**
+   * Header param: The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
+
+  /**
+   * Query param: Filter for deleted transactions deleted on or after this date and
+   * time, within the last 90 days (QuickBooks limit), 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.
+   */
+  deletedAfter?: string;
+
+  /**
+   * Query param: Filter for deleted transactions deleted on or before this date and
+   * time, within the last 90 days (QuickBooks limit), 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.
+   */
+  deletedBefore?: string;
+}
+
+export declare namespace DeletedTransactions {
+  export {
+    type DeletedTransaction as DeletedTransaction,
+    type DeletedTransactionListResponse as DeletedTransactionListResponse,
+    type DeletedTransactionListParams as DeletedTransactionListParams,
+  };
+}

package/src/resources/qbd/index.ts

@@ -129,6 +129,18 @@ export {
   type DateDrivenTermRetrieveParams,
   type DateDrivenTermListParams,
 } from "./date-driven-terms.js";
+export {
+  DeletedListObjects,
+  type DeletedListObject,
+  type DeletedListObjectListResponse,
+  type DeletedListObjectListParams,
+} from "./deleted-list-objects.js";
+export {
+  DeletedTransactions,
+  type DeletedTransaction,
+  type DeletedTransactionListResponse,
+  type DeletedTransactionListParams,
+} from "./deleted-transactions.js";
 export {
   DiscountItemsCursorPage,
   DiscountItems,

package/src/resources/qbd/qbd.ts

@@ -145,6 +145,20 @@ import {
   DateDrivenTermRetrieveParams,
   DateDrivenTerms,
 } from "./date-driven-terms.js";
+import * as DeletedListObjectsAPI from "./deleted-list-objects.js";
+import {
+  DeletedListObject,
+  DeletedListObjectListParams,
+  DeletedListObjectListResponse,
+  DeletedListObjects,
+} from "./deleted-list-objects.js";
+import * as DeletedTransactionsAPI from "./deleted-transactions.js";
+import {
+  DeletedTransaction,
+  DeletedTransactionListParams,
+  DeletedTransactionListResponse,
+  DeletedTransactions,
+} from "./deleted-transactions.js";
 import * as DiscountItemsAPI from "./discount-items.js";
 import {
   DiscountItem,
@@ -517,6 +531,11 @@ export class Qbd extends APIResource {
   creditMemos: CreditMemosAPI.CreditMemos = new CreditMemosAPI.CreditMemos(this._client);
   customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
   dateDrivenTerms: DateDrivenTermsAPI.DateDrivenTerms = new DateDrivenTermsAPI.DateDrivenTerms(this._client);
+  deletedListObjects: DeletedListObjectsAPI.DeletedListObjects = new DeletedListObjectsAPI.DeletedListObjects(
+    this._client,
+  );
+  deletedTransactions: DeletedTransactionsAPI.DeletedTransactions =
+    new DeletedTransactionsAPI.DeletedTransactions(this._client);
   discountItems: DiscountItemsAPI.DiscountItems = new DiscountItemsAPI.DiscountItems(this._client);
   employees: EmployeesAPI.Employees = new EmployeesAPI.Employees(this._client);
   estimates: EstimatesAPI.Estimates = new EstimatesAPI.Estimates(this._client);
@@ -633,6 +652,8 @@ Qbd.CreditMemosCursorPage = CreditMemosCursorPage;
 Qbd.Customers = Customers;
 Qbd.CustomersCursorPage = CustomersCursorPage;
 Qbd.DateDrivenTerms = DateDrivenTerms;
+Qbd.DeletedListObjects = DeletedListObjects;
+Qbd.DeletedTransactions = DeletedTransactions;
 Qbd.DiscountItems = DiscountItems;
 Qbd.DiscountItemsCursorPage = DiscountItemsCursorPage;
 Qbd.Employees = Employees;
@@ -845,6 +866,20 @@ export declare namespace Qbd {
     type DateDrivenTermListParams as DateDrivenTermListParams,
   };
 
+  export {
+    DeletedListObjects as DeletedListObjects,
+    type DeletedListObject as DeletedListObject,
+    type DeletedListObjectListResponse as DeletedListObjectListResponse,
+    type DeletedListObjectListParams as DeletedListObjectListParams,
+  };
+
+  export {
+    DeletedTransactions as DeletedTransactions,
+    type DeletedTransaction as DeletedTransaction,
+    type DeletedTransactionListResponse as DeletedTransactionListResponse,
+    type DeletedTransactionListParams as DeletedTransactionListParams,
+  };
+
   export {
     DiscountItems as DiscountItems,
     type DiscountItem as DiscountItem,

package/src/resources/qbd/transactions.ts

@@ -398,13 +398,12 @@ export interface TransactionListParams extends CursorPageParams {
   transactionDateTo?: string;
 
   /**
-   * Query param: Filter for transactions by their type. You can specify one or more
-   * transaction types.
+   * Query param: Filter for transactions by their transaction type(s).
    *
    * **NOTE**: Filtering for time tracking activities is not supported by QuickBooks
    * for this endpoint.
    */
-  transactionType?: Array<
+  transactionTypes?: Array<
     | 'all'
     | 'ar_refund_credit_card'
     | 'bill'

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '12.22.0'; // x-release-please-version
+export const VERSION = '12.23.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "12.22.0";
+export declare const VERSION = "12.23.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '12.22.0'; // x-release-please-version
+exports.VERSION = '12.23.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '12.22.0'; // x-release-please-version
+export const VERSION = '12.23.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map