conductor-node 12.0.0-beta.2 → 12.0.0-beta.21

package/resources.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"resources.mjs","sourceRoot":"","sources":["src/resources.ts"],"names":[],"mappings":""}

package/src/core.ts

@@ -48,8 +48,8 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
   }
 
   const contentType = response.headers.get('content-type');
-  const isJSON =
-    contentType?.includes('application/json') || contentType?.includes('application/vnd.api+json');
+  const mediaType = contentType?.split(';')[0]?.trim();
+  const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
   if (isJSON) {
     const json = await response.json();
 
@@ -395,7 +395,7 @@ export abstract class APIClient {
       !headers ? {}
       : Symbol.iterator in headers ?
         Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
-      : { ...headers }
+      : { ...(headers as any as Record<string, string>) }
     );
   }
 

package/src/index.ts

@@ -16,10 +16,9 @@ import {
   EndUserListResponse,
   EndUserPassthroughParams,
   EndUserPassthroughResponse,
-  EndUserPingResponse,
   EndUsers,
 } from './resources/end-users';
-import { Qbd } from './resources/qbd/qbd';
+import { Qbd, QbdHealthCheckParams, QbdHealthCheckResponse } from './resources/qbd/qbd';
 
 export interface ClientOptions {
   /**
@@ -199,12 +198,15 @@ export declare namespace Conductor {
     type EndUserListResponse as EndUserListResponse,
     type EndUserDeleteResponse as EndUserDeleteResponse,
     type EndUserPassthroughResponse as EndUserPassthroughResponse,
-    type EndUserPingResponse as EndUserPingResponse,
     type EndUserCreateParams as EndUserCreateParams,
     type EndUserPassthroughParams as EndUserPassthroughParams,
   };
 
-  export { Qbd as Qbd };
+  export {
+    Qbd as Qbd,
+    type QbdHealthCheckResponse as QbdHealthCheckResponse,
+    type QbdHealthCheckParams as QbdHealthCheckParams,
+  };
 }
 
 export { toFile, fileFromPath } from './uploads';

package/src/pagination.ts

@@ -53,7 +53,7 @@ export class CursorPage<Item> extends AbstractPage<Item> implements CursorPageRe
 
     return {
       params: {
-        cursor: cursor,
+        cursor,
       },
     };
   }

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
-   * browser.
+   * 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. Demo: https://connect.conductor.is/qbd/demo
    */
   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/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

@@ -1705,10 +1705,9 @@ export interface BillCreateParams {
   itemLines?: Array<BillCreateParams.ItemLine>;
 
   /**
-   * Body param: IDs of existing transactions that you wish to link to this bill,
-   * such as payments applied, credits used, or associated purchase orders. Note that
-   * this links entire transactions, not individual transaction lines. If you want to
-   * link individual lines in a transaction, instead use the field
+   * Body param: IDs of existing purchase orders that you wish to link to this bill.
+   * Note that this links entire transactions, not individual transaction lines. If
+   * you want to link individual lines in a transaction, instead use the field
    * `linkToTransactionLine` on this bill's lines, if available.
    *
    * Transactions can only be linked when creating this bill and cannot be unlinked
@@ -2984,14 +2983,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;