@lorikeetai/node-sdk 1.4.0 → 2.0.0

package/src/resources/customer/customer.ts

@@ -1,11 +1,13 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as ProfileAPI from './profile';
 import { Profile, ProfileSyncParams, ProfileSyncResponse } from './profile';
 import * as RemoteAPI from './remote';
 import { Remote, RemoteGetResponse, RemoteUpdateParams, RemoteUpdateResponse } from './remote';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Customer extends APIResource {
   remote: RemoteAPI.Remote = new RemoteAPI.Remote(this._client);
@@ -17,7 +19,7 @@ export class Customer extends APIResource {
    * const customer = await client.customer.create();
    * ```
    */
-  create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomerCreateResponse> {
+  create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<CustomerCreateResponse> {
     return this._client.post('/v1/customer', { body, ...options });
   }
 
@@ -32,21 +34,22 @@ export class Customer extends APIResource {
   update(
     id: string,
     body: CustomerUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<CustomerUpdateResponse> {
-    return this._client.put(`/v1/customer/${id}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<CustomerUpdateResponse> {
+    return this._client.put(path`/v1/customer/${id}`, { body, ...options });
   }
 
   /**
    * @example
    * ```ts
-   * const customer = await client.customer.get(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
+   * const customer = await client.customer.get();
    * ```
    */
-  get(id: string, options?: Core.RequestOptions): Core.APIPromise<CustomerGetResponse> {
-    return this._client.get(`/v1/customer/${id}`, options);
+  get(
+    query: CustomerGetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerGetResponse> {
+    return this._client.get('/v1/customer', { query, ...options });
   }
 
   /**
@@ -55,7 +58,7 @@ export class Customer extends APIResource {
    * const response = await client.customer.token();
    * ```
    */
-  token(body: CustomerTokenParams, options?: Core.RequestOptions): Core.APIPromise<string> {
+  token(body: CustomerTokenParams, options?: RequestOptions): APIPromise<string> {
     return this._client.post('/v1/customer/token', { body, ...options });
   }
 }
@@ -96,6 +99,11 @@ export interface CustomerCreateResponse {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -151,6 +159,11 @@ export interface CustomerUpdateResponse {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -206,6 +219,11 @@ export interface CustomerGetResponse {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -253,6 +271,11 @@ export interface CustomerCreateParams {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -298,6 +321,11 @@ export interface CustomerUpdateParams {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -317,6 +345,18 @@ export interface CustomerUpdateParams {
   subscriberToken?: string;
 }
 
+export interface CustomerGetParams {
+  /**
+   * The phone number of the customer
+   */
+  phoneNumber?: string;
+
+  /**
+   * The remote id of the customer in your system
+   */
+  remoteId?: string;
+}
+
 export interface CustomerTokenParams {
   /**
    * The URL of the customer avatar
@@ -349,6 +389,11 @@ export interface CustomerTokenParams {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -379,6 +424,7 @@ export declare namespace Customer {
     type CustomerTokenResponse as CustomerTokenResponse,
     type CustomerCreateParams as CustomerCreateParams,
     type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerGetParams as CustomerGetParams,
     type CustomerTokenParams as CustomerTokenParams,
   };
 

package/src/resources/customer/index.ts

@@ -8,6 +8,7 @@ export {
   type CustomerTokenResponse,
   type CustomerCreateParams,
   type CustomerUpdateParams,
+  type CustomerGetParams,
   type CustomerTokenParams,
 } from './customer';
 export { Profile, type ProfileSyncResponse, type ProfileSyncParams } from './profile';

package/src/resources/customer/profile.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Profile extends APIResource {
   /**
@@ -13,69 +15,14 @@ export class Profile extends APIResource {
    * );
    * ```
    */
-  sync(
-    id: string,
-    body: ProfileSyncParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<ProfileSyncResponse> {
-    return this._client.put(`/v1/customer/profile/${id}`, { body, ...options });
+  sync(id: string, body: ProfileSyncParams, options?: RequestOptions): APIPromise<ProfileSyncResponse> {
+    return this._client.put(path`/v1/customer/profile/${id}`, { body, ...options });
   }
 }
 
-export interface ProfileSyncResponse {
-  /**
-   * The id of the customer in the subscriber system
-   */
-  id: string;
-
-  /**
-   * The timestamp of the when the customer was created in our system
-   */
-  createdAt: string;
-
-  /**
-   * The URL of the customer avatar
-   */
-  avatarUrl?: string;
-
-  /**
-   * The display name of the customer
-   */
-  displayName?: string;
-
-  /**
-   * The email of the customer
-   */
-  email?: string;
-
-  /**
-   * The first name of the customer
-   */
-  firstName?: string;
-
-  /**
-   * The last name of the customer
-   */
-  lastName?: string;
-
-  /**
-   * The id of the customer in the ticketing system. For the SDK this needs to be
-   * stable and unique
-   */
-  remoteId?: string;
-
-  /**
-   * The id of the customer in your own primary database or a unique identifier, for
-   * example a cookie
-   */
-  subscriberCustomerId?: string;
-
-  /**
-   * A token that can be used to authenticate the customer in the your system, like a
-   * JWT
-   */
-  subscriberToken?: string;
-}
+export type ProfileSyncResponse = {
+  [key: string]: string | boolean | number | unknown | Array<unknown> | null;
+};
 
 export interface ProfileSyncParams {
   /**

package/src/resources/customer/remote.ts

@@ -1,7 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 export class Remote extends APIResource {
   /**
@@ -13,11 +15,11 @@ export class Remote extends APIResource {
    * ```
    */
   update(
-    pathRemoteId: string,
+    remoteID: string,
     body: RemoteUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<RemoteUpdateResponse> {
-    return this._client.patch(`/v1/customer/remote/${pathRemoteId}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<RemoteUpdateResponse> {
+    return this._client.patch(path`/v1/customer/remote/${remoteID}`, { body, ...options });
   }
 
   /**
@@ -26,8 +28,8 @@ export class Remote extends APIResource {
    * const remote = await client.customer.remote.get('remoteId');
    * ```
    */
-  get(remoteId: string, options?: Core.RequestOptions): Core.APIPromise<RemoteGetResponse> {
-    return this._client.get(`/v1/customer/remote/${remoteId}`, options);
+  get(remoteID: string, options?: RequestOptions): APIPromise<RemoteGetResponse> {
+    return this._client.get(path`/v1/customer/remote/${remoteID}`, options);
   }
 }
 
@@ -67,6 +69,11 @@ export interface RemoteUpdateResponse {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -122,6 +129,11 @@ export interface RemoteGetResponse {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique
@@ -167,6 +179,11 @@ export interface RemoteUpdateParams {
    */
   lastName?: string;
 
+  /**
+   * The phone number of the customer (in international / E.164 format)
+   */
+  phoneNumber?: string;
+
   /**
    * The id of the customer in the ticketing system. For the SDK this needs to be
    * stable and unique

package/src/resources/index.ts

@@ -1,14 +1,17 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  APIKeys,
+  type APIKeyCreateResponse,
+  type APIKeyListResponse,
+  type APIKeyGetResponse,
+  type APIKeyCreateParams,
+} from './api-keys';
 export {
   Conversation,
   type AttachmentDto,
   type TicketEvent,
   type TicketMessageDto,
-  type ConversationCreateResponse,
-  type ConversationRetrieveTranscriptResponse,
-  type ConversationCreateParams,
-  type ConversationRetrieveTranscriptParams,
 } from './conversation/conversation';
 export {
   Customer,
@@ -18,11 +21,7 @@ export {
   type CustomerTokenResponse,
   type CustomerCreateParams,
   type CustomerUpdateParams,
+  type CustomerGetParams,
   type CustomerTokenParams,
 } from './customer/customer';
-export { File } from './file';
-export { Ingest, type IngestTestParams } from './ingest';
-export { OAuth, type OAuthAuthorizeParams, type OAuthCallbackParams } from './oauth/oauth';
-export { Suggestion } from './suggestion';
-export { Webhooks } from './webhooks';
-export { Workflow } from './workflow';
+export { Ingest, type IngestSubmitParams, type IngestTestParams } from './ingest';

package/src/resources/ingest.ts

@@ -1,54 +1,56 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class Ingest extends APIResource {
-  retrieve(options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.get('/v1/ingest', { ...options, headers: { Accept: '*/*', ...options?.headers } });
-  }
-
-  submit(
-    toolId: string,
-    ticketId: string,
-    inputHash: string,
-    workflowId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<void> {
-    return this._client.post(`/ingest/${toolId}/${ticketId}/${inputHash}/${workflowId}`, {
+  submit(workflowID: string, params: IngestSubmitParams, options?: RequestOptions): APIPromise<void> {
+    const { toolId, ticketId, inputHash } = params;
+    return this._client.post(path`/ingest/${toolId}/${ticketId}/${inputHash}/${workflowID}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  test(toolId: unknown, body: IngestTestParams, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.post(`/ingest/test/${toolId}`, {
+  test(toolID: string, body: IngestTestParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/ingest/test/${toolID}`, {
       body,
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  validate(options?: Core.RequestOptions): Core.APIPromise<void> {
+  validate(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/ingest/validate', {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
+export interface IngestSubmitParams {
+  toolId: string;
+
+  ticketId: string;
+
+  inputHash: string;
+}
+
 export interface IngestTestParams {
   /**
-   * The data to simulate a test response for.
+   * The input data to simulate a test response for.
    */
   inputs: unknown;
 
   /**
-   * The subscriber id to simulate a test response for.
+   * Optional execution environment ID for integration endpoint tools.
    */
-  subscriberId: string;
+  envId?: string;
 }
 
 export declare namespace Ingest {
-  export { type IngestTestParams as IngestTestParams };
+  export { type IngestSubmitParams as IngestSubmitParams, type IngestTestParams as IngestTestParams };
 }

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }