@lorikeetai/node-sdk 0.13.2 → 0.14.0

package/src/resources/customer/customer.ts

@@ -0,0 +1,386 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+import * as ProfileAPI from './profile';
+import { Profile, ProfileSyncParams, ProfileSyncResponse } from './profile';
+
+export class Customer extends APIResource {
+  profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
+
+  /**
+   * @example
+   * ```ts
+   * const customer = await client.customer.create();
+   * ```
+   */
+  create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomerCreateResponse> {
+    return this._client.post('/v1/customer', { body, ...options });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * const customer = await client.customer.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    body: CustomerUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerUpdateResponse> {
+    return this._client.put(`/v1/customer/${id}`, { body, ...options });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * const customer = await client.customer.get(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  get(id: string, options?: Core.RequestOptions): Core.APIPromise<CustomerGetResponse> {
+    return this._client.get(`/v1/customer/${id}`, options);
+  }
+
+  /**
+   * @example
+   * ```ts
+   * const response = await client.customer.token();
+   * ```
+   */
+  token(body: CustomerTokenParams, options?: Core.RequestOptions): Core.APIPromise<string> {
+    return this._client.post('/v1/customer/token', { body, ...options });
+  }
+}
+
+export interface CustomerCreateResponse {
+  /**
+   * 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 interface CustomerUpdateResponse {
+  /**
+   * 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 interface CustomerGetResponse {
+  /**
+   * 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 CustomerTokenResponse = string;
+
+export interface CustomerCreateParams {
+  /**
+   * 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 interface CustomerUpdateParams {
+  /**
+   * 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 interface CustomerTokenParams {
+  /**
+   * The URL of the customer avatar
+   */
+  avatarUrl?: string;
+
+  /**
+   * The display name of the customer
+   */
+  displayName?: string;
+
+  /**
+   * The email of the customer
+   */
+  email?: string;
+
+  /**
+   * The expiry of the conversation initialization token, if not provided it will be
+   * set to 1 hour
+   */
+  expiry?: 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;
+}
+
+Customer.Profile = Profile;
+
+export declare namespace Customer {
+  export {
+    type CustomerCreateResponse as CustomerCreateResponse,
+    type CustomerUpdateResponse as CustomerUpdateResponse,
+    type CustomerGetResponse as CustomerGetResponse,
+    type CustomerTokenResponse as CustomerTokenResponse,
+    type CustomerCreateParams as CustomerCreateParams,
+    type CustomerUpdateParams as CustomerUpdateParams,
+    type CustomerTokenParams as CustomerTokenParams,
+  };
+
+  export {
+    Profile as Profile,
+    type ProfileSyncResponse as ProfileSyncResponse,
+    type ProfileSyncParams as ProfileSyncParams,
+  };
+}

package/src/resources/customer/index.ts

@@ -0,0 +1,13 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Customer,
+  type CustomerCreateResponse,
+  type CustomerUpdateResponse,
+  type CustomerGetResponse,
+  type CustomerTokenResponse,
+  type CustomerCreateParams,
+  type CustomerUpdateParams,
+  type CustomerTokenParams,
+} from './customer';
+export { Profile, type ProfileSyncResponse, type ProfileSyncParams } from './profile';

package/src/resources/customer/profile.ts

@@ -0,0 +1,89 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Profile extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * const response = await client.customer.profile.sync(
+   *   '123e4567-e89b-12d3-a456-426614174000',
+   *   { data: { foo: 'string' } },
+   * );
+   * ```
+   */
+  sync(
+    id: string,
+    body: ProfileSyncParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ProfileSyncResponse> {
+    return this._client.put(`/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 interface ProfileSyncParams {
+  /**
+   * The profile data to update - should be provided as key value object
+   */
+  data: { [key: string]: string | boolean | number | unknown | Array<unknown> };
+}
+
+export declare namespace Profile {
+  export { type ProfileSyncResponse as ProfileSyncResponse, type ProfileSyncParams as ProfileSyncParams };
+}