conductor-node 12.0.0-beta.1 → 12.0.0-beta.11

package/src/resources/end-users.ts

@@ -5,28 +5,28 @@ import * as Core from '../core';
 
 export class EndUsers extends APIResource {
   /**
-   * Creates an EndUser.
+   * Creates an end-user.
    */
   create(body: EndUserCreateParams, options?: Core.RequestOptions): Core.APIPromise<EndUser> {
     return this._client.post('/end-users', { body, ...options });
   }
 
   /**
-   * Retrieves an EndUser object.
+   * Retrieves an end-user object.
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<EndUser> {
     return this._client.get(`/end-users/${id}`, options);
   }
 
   /**
-   * Returns a list of your EndUsers.
+   * Returns a list of your end-users.
    */
   list(options?: Core.RequestOptions): Core.APIPromise<EndUserListResponse> {
     return this._client.get('/end-users', options);
   }
 
   /**
-   * Permanently deletes an EndUser object and all of its connections.
+   * Permanently deletes an end-user object and all of its connections.
    */
   delete(id: string, options?: Core.RequestOptions): Core.APIPromise<EndUserDeleteResponse> {
     return this._client.delete(`/end-users/${id}`, options);
@@ -44,46 +44,33 @@ export class EndUsers extends APIResource {
   ): Core.APIPromise<EndUserPassthroughResponse> {
     return this._client.post(`/end-users/${id}/passthrough/${integrationSlug}`, { body, ...options });
   }
-
-  /**
-   * Checks whether the specified IntegrationConnection can connect and process
-   * requests end-to-end. This is useful for showing a "connection status" indicator
-   * in your app.
-   */
-  ping(
-    id: string,
-    integrationSlug: 'quickbooks_desktop',
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<EndUserPingResponse> {
-    return this._client.get(`/end-users/${id}/ping/${integrationSlug}`, options);
-  }
 }
 
 export interface EndUser {
   /**
-   * The unique identifier for this EndUser. You must save this value to your
+   * The unique identifier for this end-user. You must save this value to your
    * database because it is how you identify which of your users to receive your API
    * requests.
    */
   id: string;
 
   /**
-   * The EndUser's company name that will be shown elsewhere in Conductor.
+   * The end-user's company name that will be shown elsewhere in Conductor.
    */
   companyName: string;
 
   /**
-   * The date and time when this EndUser record was created.
+   * The date and time when this end-user record was created.
    */
   createdAt: string;
 
   /**
-   * The EndUser's email address for identification purposes.
+   * The end-user's email address for identification purposes.
    */
   email: string;
 
   /**
-   * The EndUser's IntegrationConnections.
+   * The end-user's integration connections.
    */
   integrationConnections: Array<EndUser.IntegrationConnection>;
 
@@ -93,7 +80,7 @@ export interface EndUser {
   objectType: 'end_user';
 
   /**
-   * The EndUser's unique identifier from your system. Maps users between your
+   * The end-user's unique identifier from your system. Maps users between your
    * database and Conductor.
    */
   sourceId: string;
@@ -102,12 +89,12 @@ export interface EndUser {
 export namespace EndUser {
   export interface IntegrationConnection {
     /**
-     * The unique identifier for this IntegrationConnection.
+     * The unique identifier for this integration connection.
      */
     id: string;
 
     /**
-     * The date and time when this IntegrationConnection record was created.
+     * The date and time when this integration connection record was created.
      */
     createdAt: string;
 
@@ -117,14 +104,14 @@ export namespace EndUser {
     integrationSlug: 'quickbooks_desktop';
 
     /**
-     * The date and time of your last API request to this IntegrationConnection.
+     * The date and time of your last API request to this integration connection.
      */
     lastRequestAt: string | null;
 
     /**
-     * The date and time of your last _successful_ API request to this
-     * IntegrationConnection. A successful request means the integration fully
-     * processed and returned a response without any errors end-to-end.
+     * The date and time of your last _successful_ API request to this integration
+     * connection. A successful request means the integration fully processed and
+     * returned a response without any errors end-to-end.
      */
     lastSuccessfulRequestAt: string | null;
 
@@ -137,7 +124,7 @@ export namespace EndUser {
 
 export interface EndUserListResponse {
   /**
-   * The array of EndUsers.
+   * The array of end-users.
    */
   data: Array<EndUser>;
 
@@ -154,12 +141,12 @@ export interface EndUserListResponse {
 
 export interface EndUserDeleteResponse {
   /**
-   * The ID of the deleted EndUser.
+   * The ID of the deleted end-user.
    */
   id: string;
 
   /**
-   * Indicates whether the EndUser was deleted.
+   * Indicates whether the end-user was deleted.
    */
   deleted: boolean;
 
@@ -174,13 +161,6 @@ export interface EndUserDeleteResponse {
  */
 export type EndUserPassthroughResponse = Record<string, unknown>;
 
-export interface EndUserPingResponse {
-  /**
-   * The time, in milliseconds, that it took to ping the connection.
-   */
-  duration: number;
-}
-
 export interface EndUserCreateParams {
   /**
    * The end-user's company name that will be shown elsewhere in Conductor.
@@ -209,7 +189,6 @@ export declare namespace EndUsers {
     type EndUserListResponse as EndUserListResponse,
     type EndUserDeleteResponse as EndUserDeleteResponse,
     type EndUserPassthroughResponse as EndUserPassthroughResponse,
-    type EndUserPingResponse as EndUserPingResponse,
     type EndUserCreateParams as EndUserCreateParams,
     type EndUserPassthroughParams as EndUserPassthroughParams,
   };

package/src/resources/index.ts

@@ -7,8 +7,7 @@ export {
   type EndUserListResponse,
   type EndUserDeleteResponse,
   type EndUserPassthroughResponse,
-  type EndUserPingResponse,
   type EndUserCreateParams,
   type EndUserPassthroughParams,
 } from './end-users';
-export { Qbd } from './qbd/qbd';
+export { Qbd, type QbdHealthCheckResponse, type QbdHealthCheckParams } from './qbd/qbd';

package/src/resources/qbd/bill-check-payments.ts

@@ -1030,14 +1030,14 @@ export interface BillCheckPaymentListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for bill check payments created on or after this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for bill check payments whose `date` field is on or after
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for bill check payments created on or before this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for bill check payments whose `date` field is on or before
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/bill-credit-card-payments.ts

@@ -796,14 +796,14 @@ export interface BillCreditCardPaymentListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for bill credit card payments created on or after this date,
-   * in ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for bill credit card payments whose `date` field is on or
+   * after this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for bill credit card payments created on or before this
-   * date, in ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for bill credit card payments whose `date` field is on or
+   * before this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/bills.ts

@@ -2984,14 +2984,14 @@ export interface BillListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for bills created on or after this date, in ISO 8601 format
-   * (YYYY-MM-DD).
+   * Query param: Filter for bills whose `date` field is on or after this date, in
+   * ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for bills created on or before this date, in ISO 8601 format
-   * (YYYY-MM-DD).
+   * Query param: Filter for bills whose `date` field is on or before this date, in
+   * ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/checks.ts

@@ -2953,14 +2953,14 @@ export interface CheckListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for checks created on or after this date, in ISO 8601 format
-   * (YYYY-MM-DD).
+   * Query param: Filter for checks whose `date` field is on or after this date, in
+   * ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for checks created on or before this date, in ISO 8601
-   * format (YYYY-MM-DD).
+   * Query param: Filter for checks whose `date` field is on or before this date, in
+   * ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/credit-card-charges.ts

@@ -2596,14 +2596,14 @@ export interface CreditCardChargeListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for credit card charges created on or after this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for credit card charges whose `date` field is on or after
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for credit card charges created on or before this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for credit card charges whose `date` field is on or before
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/credit-card-credits.ts

@@ -2593,14 +2593,14 @@ export interface CreditCardCreditListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for credit card credits created on or after this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for credit card credits whose `date` field is on or after
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for credit card credits created on or before this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for credit card credits whose `date` field is on or before
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/credit-memos.ts

@@ -3107,14 +3107,14 @@ export interface CreditMemoListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for credit memos created on or after this date, in ISO 8601
-   * format (YYYY-MM-DD).
+   * Query param: Filter for credit memos whose `date` field is on or after this
+   * date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for credit memos created on or before this date, in ISO 8601
-   * format (YYYY-MM-DD).
+   * Query param: Filter for credit memos whose `date` field is on or before this
+   * date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/employees.ts

@@ -108,7 +108,7 @@ export interface Employee {
 
   /**
    * The employee's billing rate, used to override service item rates in time
-   * tracking transactions.
+   * tracking activities.
    */
   billingRate: Employee.BillingRate | null;
 
@@ -513,7 +513,7 @@ export namespace Employee {
 
   /**
    * The employee's billing rate, used to override service item rates in time
-   * tracking transactions.
+   * tracking activities.
    */
   export interface BillingRate {
     /**
@@ -779,23 +779,30 @@ export namespace Employee {
       accrualStartDate: string | null;
 
       /**
-       * The number of sick hours the employee will accrue per accrual period.
+       * The number of sick hours the employee will accrue per accrual period, in ISO
+       * 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is
+       * represented as PT1H30M.
        */
       hoursAccruedPerPeriod: string | null;
 
       /**
-       * The total number of sick hours currently available for the employee to use.
-       * Defaults to 0.
+       * The total number of sick hours currently available for the employee to use, in
+       * ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30
+       * minutes is represented as PT1H30M. Defaults to 0.
        */
       hoursAvailable: string | null;
 
       /**
-       * The number of sick hours the employee has used.
+       * The number of sick hours the employee has used, in ISO 8601 format for time
+       * intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       hoursUsed: string | null;
 
       /**
-       * The maximum number of sick hours the employee can accrue.
+       * The maximum number of sick hours the employee can accrue, in ISO 8601 format for
+       * time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       maximumHours: string | null;
 
@@ -823,23 +830,30 @@ export namespace Employee {
       accrualStartDate: string | null;
 
       /**
-       * The number of vacation hours the employee will accrue per accrual period.
+       * The number of vacation hours the employee will accrue per accrual period, in ISO
+       * 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is
+       * represented as PT1H30M.
        */
       hoursAccruedPerPeriod: string | null;
 
       /**
-       * The total number of vacation hours currently available for the employee to use.
-       * Defaults to 0.
+       * The total number of vacation hours currently available for the employee to use,
+       * in ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30
+       * minutes is represented as PT1H30M. Defaults to 0.
        */
       hoursAvailable: string | null;
 
       /**
-       * The number of vacation hours the employee has used.
+       * The number of vacation hours the employee has used, in ISO 8601 format for time
+       * intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       hoursUsed: string | null;
 
       /**
-       * The maximum number of vacation hours the employee can accrue.
+       * The maximum number of vacation hours the employee can accrue, in ISO 8601 format
+       * for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented
+       * as PT1H30M.
        */
       maximumHours: string | null;
 
@@ -917,7 +931,7 @@ export interface EmployeeCreateParams {
 
   /**
    * Body param: The employee's billing rate, used to override service item rates in
-   * time tracking transactions.
+   * time tracking activities.
    */
   billingRateId?: string;
 
@@ -1448,23 +1462,30 @@ export namespace EmployeeCreateParams {
       accrualStartDate?: string;
 
       /**
-       * The number of sick hours the employee will accrue per accrual period.
+       * The number of sick hours the employee will accrue per accrual period, in ISO
+       * 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is
+       * represented as PT1H30M.
        */
       hoursAccruedPerPeriod?: string;
 
       /**
-       * The total number of sick hours currently available for the employee to use.
-       * Defaults to 0.
+       * The total number of sick hours currently available for the employee to use, in
+       * ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30
+       * minutes is represented as PT1H30M. Defaults to 0.
        */
       hoursAvailable?: string;
 
       /**
-       * The number of sick hours the employee has used.
+       * The number of sick hours the employee has used, in ISO 8601 format for time
+       * intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       hoursUsed?: string;
 
       /**
-       * The maximum number of sick hours the employee can accrue.
+       * The maximum number of sick hours the employee can accrue, in ISO 8601 format for
+       * time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       maximumHours?: string;
 
@@ -1492,23 +1513,30 @@ export namespace EmployeeCreateParams {
       accrualStartDate?: string;
 
       /**
-       * The number of vacation hours the employee will accrue per accrual period.
+       * The number of vacation hours the employee will accrue per accrual period, in ISO
+       * 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is
+       * represented as PT1H30M.
        */
       hoursAccruedPerPeriod?: string;
 
       /**
-       * The total number of vacation hours currently available for the employee to use.
-       * Defaults to 0.
+       * The total number of vacation hours currently available for the employee to use,
+       * in ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30
+       * minutes is represented as PT1H30M. Defaults to 0.
        */
       hoursAvailable?: string;
 
       /**
-       * The number of vacation hours the employee has used.
+       * The number of vacation hours the employee has used, in ISO 8601 format for time
+       * intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       hoursUsed?: string;
 
       /**
-       * The maximum number of vacation hours the employee can accrue.
+       * The maximum number of vacation hours the employee can accrue, in ISO 8601 format
+       * for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented
+       * as PT1H30M.
        */
       maximumHours?: string;
 
@@ -1582,7 +1610,7 @@ export interface EmployeeUpdateParams {
 
   /**
    * Body param: The employee's billing rate, used to override service item rates in
-   * time tracking transactions.
+   * time tracking activities.
    */
   billingRateId?: string;
 
@@ -2095,23 +2123,30 @@ export namespace EmployeeUpdateParams {
       accrualStartDate?: string;
 
       /**
-       * The number of sick hours the employee will accrue per accrual period.
+       * The number of sick hours the employee will accrue per accrual period, in ISO
+       * 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is
+       * represented as PT1H30M.
        */
       hoursAccruedPerPeriod?: string;
 
       /**
-       * The total number of sick hours currently available for the employee to use.
-       * Defaults to 0.
+       * The total number of sick hours currently available for the employee to use, in
+       * ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30
+       * minutes is represented as PT1H30M. Defaults to 0.
        */
       hoursAvailable?: string;
 
       /**
-       * The number of sick hours the employee has used.
+       * The number of sick hours the employee has used, in ISO 8601 format for time
+       * intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       hoursUsed?: string;
 
       /**
-       * The maximum number of sick hours the employee can accrue.
+       * The maximum number of sick hours the employee can accrue, in ISO 8601 format for
+       * time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       maximumHours?: string;
 
@@ -2139,23 +2174,30 @@ export namespace EmployeeUpdateParams {
       accrualStartDate?: string;
 
       /**
-       * The number of vacation hours the employee will accrue per accrual period.
+       * The number of vacation hours the employee will accrue per accrual period, in ISO
+       * 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is
+       * represented as PT1H30M.
        */
       hoursAccruedPerPeriod?: string;
 
       /**
-       * The total number of vacation hours currently available for the employee to use.
-       * Defaults to 0.
+       * The total number of vacation hours currently available for the employee to use,
+       * in ISO 8601 format for time intervals (PTnHnMnS). For example, 1 hour and 30
+       * minutes is represented as PT1H30M. Defaults to 0.
        */
       hoursAvailable?: string;
 
       /**
-       * The number of vacation hours the employee has used.
+       * The number of vacation hours the employee has used, in ISO 8601 format for time
+       * intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented as
+       * PT1H30M.
        */
       hoursUsed?: string;
 
       /**
-       * The maximum number of vacation hours the employee can accrue.
+       * The maximum number of vacation hours the employee can accrue, in ISO 8601 format
+       * for time intervals (PTnHnMnS). For example, 1 hour and 30 minutes is represented
+       * as PT1H30M.
        */
       maximumHours?: string;
 

package/src/resources/qbd/estimates.ts

@@ -2925,14 +2925,14 @@ export interface EstimateListParams extends CursorPageParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for estimates created on or after this date, in ISO 8601
-   * format (YYYY-MM-DD).
+   * Query param: Filter for estimates whose `date` field is on or after this date,
+   * in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for estimates created on or before this date, in ISO 8601
-   * format (YYYY-MM-DD).
+   * Query param: Filter for estimates whose `date` field is on or before this date,
+   * in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/index.ts

@@ -228,7 +228,7 @@ export {
   type PurchaseOrderListParams,
   type PurchaseOrderDeleteParams,
 } from './purchase-orders';
-export { Qbd } from './qbd';
+export { Qbd, type QbdHealthCheckResponse, type QbdHealthCheckParams } from './qbd';
 export {
   ReceivePaymentsCursorPage,
   ReceivePayments,
@@ -315,6 +315,24 @@ export {
   type SubtotalItemUpdateParams,
   type SubtotalItemListParams,
 } from './subtotal-items';
+export {
+  TimeTrackingActivitiesCursorPage,
+  TimeTrackingActivities,
+  type TimeTrackingActivity,
+  type TimeTrackingActivityDeleteResponse,
+  type TimeTrackingActivityCreateParams,
+  type TimeTrackingActivityRetrieveParams,
+  type TimeTrackingActivityUpdateParams,
+  type TimeTrackingActivityListParams,
+  type TimeTrackingActivityDeleteParams,
+} from './time-tracking-activities';
+export {
+  TransactionsCursorPage,
+  Transactions,
+  type Transaction,
+  type TransactionRetrieveParams,
+  type TransactionListParams,
+} from './transactions';
 export {
   TransfersCursorPage,
   Transfers,

package/src/resources/qbd/inventory-adjustments.ts

@@ -960,14 +960,14 @@ export interface InventoryAdjustmentListParams {
   refNumberTo?: string;
 
   /**
-   * Query param: Filter for inventory adjustments created on or after this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for inventory adjustments whose `date` field is on or after
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateFrom?: string;
 
   /**
-   * Query param: Filter for inventory adjustments created on or before this date, in
-   * ISO 8601 format (YYYY-MM-DD).
+   * Query param: Filter for inventory adjustments whose `date` field is on or before
+   * this date, in ISO 8601 format (YYYY-MM-DD).
    */
   transactionDateTo?: string;
 

package/src/resources/qbd/inventory-assembly-items.ts

@@ -229,7 +229,7 @@ export interface InventoryAssemblyItem {
    * The number of units of this inventory assembly item that have been ordered from
    * vendors (as recorded in purchase orders) but not yet received.
    */
-  quantityOnOrder: number | null;
+  quantityOnPurchaseOrder: number | null;
 
   /**
    * The number of units of this inventory assembly item that have been sold (as

package/src/resources/qbd/inventory-items.ts

@@ -210,7 +210,7 @@ export interface InventoryItem {
    * The number of units of this inventory item that have been ordered from vendors
    * (as recorded in purchase orders) but not yet received.
    */
-  quantityOnOrder: number | null;
+  quantityOnPurchaseOrder: number | null;
 
   /**
    * The number of units of this inventory item that have been sold (as recorded in