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

package/src/resources/auth-sessions.ts

@@ -5,31 +5,24 @@ import * as Core from '../core';
 
 export class AuthSessions extends APIResource {
   /**
-   * To launch the authentication flow, create an AuthSession and pass the returned
-   * session’s `authFlowUrl` to the client for your end-user to visit in their
+   * To launch the authentication flow, create an auth session and pass the returned
+   * session's `authFlowUrl` to the client for your end-user to visit in their
    * browser.
    */
   create(body: AuthSessionCreateParams, options?: Core.RequestOptions): Core.APIPromise<AuthSession> {
     return this._client.post('/auth-sessions', { body, ...options });
   }
-
-  /**
-   * Retrieves the details of an AuthSession that has previously been created.
-   */
-  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<AuthSession> {
-    return this._client.get(`/auth-sessions/${id}`, options);
-  }
 }
 
 export interface AuthSession {
   /**
-   * The unique identifier for this AuthSession.
+   * The unique identifier for this auth session.
    */
   id: string;
 
   /**
    * The URL of the authentication flow that you will pass to your client for your
-   * user to set up their IntegrationConnection.
+   * user to set up their integration connection.
    */
   authFlowUrl: string;
 
@@ -39,19 +32,19 @@ export interface AuthSession {
   clientSecret: string;
 
   /**
-   * The date and time when this AuthSession record was created.
+   * The date and time when this auth session record was created.
    */
   createdAt: string;
 
   /**
-   * The ID of the EndUser for whom to create an IntegrationConnection.
+   * The ID of the end-user for whom to create an integration connection.
    */
   endUserId: string;
 
   /**
-   * The date and time when this AuthSession expires. By default, this value is 30
+   * The date and time when this auth session expires. By default, this value is 30
    * minutes from creation. You can extend this time by setting `linkExpiryMins` when
-   * [creating the AuthSession](/apis/auth-sessions/create).
+   * creating the auth session.
    */
   expiresAt: string;
 
@@ -70,18 +63,18 @@ export interface AuthSession {
 
 export interface AuthSessionCreateParams {
   /**
-   * The ID of the EndUser for whom to create the IntegrationConnection.
+   * The ID of the end-user for whom to create the integration connection.
    */
   endUserId: string;
 
   /**
-   * Your Conductor publishable key, which we use to create the session’s
+   * Your Conductor publishable key, which we use to create the auth session's
    * `authFlowUrl`.
    */
   publishableKey: string;
 
   /**
-   * The number of minutes after which the AuthSession will expire. Must be at least
+   * The number of minutes after which the auth session will expire. Must be at least
    * 15 minutes and no more than 7 days. If not provided, defaults to 30 minutes.
    */
   linkExpiryMins?: number;

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/employees.ts

@@ -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;
 
@@ -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;
 
@@ -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/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,17 @@ 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 {
   TransfersCursorPage,
   Transfers,

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

package/src/resources/qbd/qbd.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
+import * as Core from '../../core';
 import * as AccountsAPI from './accounts';
 import {
   Account,
@@ -347,6 +348,18 @@ import {
   SubtotalItems,
   SubtotalItemsCursorPage,
 } from './subtotal-items';
+import * as TimeTrackingActivitiesAPI from './time-tracking-activities';
+import {
+  TimeTrackingActivities,
+  TimeTrackingActivitiesCursorPage,
+  TimeTrackingActivity,
+  TimeTrackingActivityCreateParams,
+  TimeTrackingActivityDeleteParams,
+  TimeTrackingActivityDeleteResponse,
+  TimeTrackingActivityListParams,
+  TimeTrackingActivityRetrieveParams,
+  TimeTrackingActivityUpdateParams,
+} from './time-tracking-activities';
 import * as TransfersAPI from './transfers';
 import {
   Transfer,
@@ -427,9 +440,50 @@ export class Qbd extends APIResource {
   serviceItems: ServiceItemsAPI.ServiceItems = new ServiceItemsAPI.ServiceItems(this._client);
   standardTerms: StandardTermsAPI.StandardTerms = new StandardTermsAPI.StandardTerms(this._client);
   subtotalItems: SubtotalItemsAPI.SubtotalItems = new SubtotalItemsAPI.SubtotalItems(this._client);
+  timeTrackingActivities: TimeTrackingActivitiesAPI.TimeTrackingActivities =
+    new TimeTrackingActivitiesAPI.TimeTrackingActivities(this._client);
   transfers: TransfersAPI.Transfers = new TransfersAPI.Transfers(this._client);
   vendorCredits: VendorCreditsAPI.VendorCredits = new VendorCreditsAPI.VendorCredits(this._client);
   vendors: VendorsAPI.Vendors = new VendorsAPI.Vendors(this._client);
+
+  /**
+   * Checks whether the specified QuickBooks Desktop connection is active and can
+   * process requests end-to-end. This is useful for showing a "connection status"
+   * indicator in your app. If an error occurs, the typical Conductor error response
+   * will be returned. As with any request to QuickBooks Desktop, the health check
+   * may fail if the application is not running, the wrong company file is open, or
+   * if a modal dialog is open. Timeout is 60 seconds.
+   */
+  healthCheck(
+    params: QbdHealthCheckParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<QbdHealthCheckResponse> {
+    const { conductorEndUserId } = params;
+    return this._client.get('/quickbooks-desktop/health-check', {
+      ...options,
+      headers: { 'Conductor-End-User-Id': conductorEndUserId, ...options?.headers },
+    });
+  }
+}
+
+export interface QbdHealthCheckResponse {
+  /**
+   * The time, in milliseconds, that it took to perform the health check.
+   */
+  duration: number;
+
+  /**
+   * The status of the health check.
+   */
+  status: 'ok';
+}
+
+export interface QbdHealthCheckParams {
+  /**
+   * The ID of the EndUser to receive this request (e.g.,
+   * `"Conductor-End-User-Id: {{END_USER_ID}}"`).
+   */
+  conductorEndUserId: string;
 }
 
 Qbd.Accounts = Accounts;
@@ -488,6 +542,8 @@ Qbd.ServiceItemsCursorPage = ServiceItemsCursorPage;
 Qbd.StandardTerms = StandardTerms;
 Qbd.SubtotalItems = SubtotalItems;
 Qbd.SubtotalItemsCursorPage = SubtotalItemsCursorPage;
+Qbd.TimeTrackingActivities = TimeTrackingActivities;
+Qbd.TimeTrackingActivitiesCursorPage = TimeTrackingActivitiesCursorPage;
 Qbd.Transfers = Transfers;
 Qbd.TransfersCursorPage = TransfersCursorPage;
 Qbd.VendorCredits = VendorCredits;
@@ -496,6 +552,11 @@ Qbd.Vendors = Vendors;
 Qbd.VendorsCursorPage = VendorsCursorPage;
 
 export declare namespace Qbd {
+  export {
+    type QbdHealthCheckResponse as QbdHealthCheckResponse,
+    type QbdHealthCheckParams as QbdHealthCheckParams,
+  };
+
   export {
     Accounts as Accounts,
     type Account as Account,
@@ -842,6 +903,18 @@ export declare namespace Qbd {
     type SubtotalItemListParams as SubtotalItemListParams,
   };
 
+  export {
+    TimeTrackingActivities as TimeTrackingActivities,
+    type TimeTrackingActivity as TimeTrackingActivity,
+    type TimeTrackingActivityDeleteResponse as TimeTrackingActivityDeleteResponse,
+    TimeTrackingActivitiesCursorPage as TimeTrackingActivitiesCursorPage,
+    type TimeTrackingActivityCreateParams as TimeTrackingActivityCreateParams,
+    type TimeTrackingActivityRetrieveParams as TimeTrackingActivityRetrieveParams,
+    type TimeTrackingActivityUpdateParams as TimeTrackingActivityUpdateParams,
+    type TimeTrackingActivityListParams as TimeTrackingActivityListParams,
+    type TimeTrackingActivityDeleteParams as TimeTrackingActivityDeleteParams,
+  };
+
   export {
     Transfers as Transfers,
     type Transfer as Transfer,