featurebase-node 0.0.2 → 0.2.0

package/src/resources/products/products.ts

@@ -0,0 +1,135 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ConversationTagsAPI from './conversation-tags';
+import {
+  ConversationTag,
+  ConversationTagCreateOrRenameParams,
+  ConversationTagDeleteParams,
+  ConversationTagDeleteResponse,
+  ConversationTagListParams,
+  ConversationTagListResponse,
+  ConversationTagRetrieveParams,
+  ConversationTags,
+} from './conversation-tags';
+import * as SurveysAPI from './surveys';
+import {
+  Survey,
+  SurveyListParams,
+  SurveyListResponse,
+  SurveyNextAction,
+  SurveyRetrieveParams,
+  SurveyRetrieveResponsesParams,
+  SurveyRetrieveResponsesResponse,
+  Surveys,
+} from './surveys';
+import * as ConversationsAPI from './conversations/conversations';
+import {
+  Conversation,
+  ConversationCreateParams,
+  ConversationDeleteParams,
+  ConversationDeleteResponse,
+  ConversationListParams,
+  ConversationListResponse,
+  ConversationPart,
+  ConversationPartAuthor,
+  ConversationParticipant,
+  ConversationRedactParams,
+  ConversationReplyParams,
+  ConversationRetrieveParams,
+  ConversationTagApplication,
+  ConversationUpdateParams,
+  Conversations,
+  CsatEmailDelivery,
+  CsatRatedAgent,
+  CsatWorkflowLink,
+  EmailRecipients,
+} from './conversations/conversations';
+import * as TicketsAPI from './tickets/tickets';
+import {
+  AuthorInput,
+  Ticket,
+  TicketCreateParams,
+  TicketDeleteParams,
+  TicketDeleteResponse,
+  TicketListParams,
+  TicketListResponse,
+  TicketReplyParams,
+  TicketRetrieveParams,
+  TicketUpdateParams,
+  Tickets,
+} from './tickets/tickets';
+
+export class Products extends APIResource {
+  surveys: SurveysAPI.Surveys = new SurveysAPI.Surveys(this._client);
+  conversations: ConversationsAPI.Conversations = new ConversationsAPI.Conversations(this._client);
+  conversationTags: ConversationTagsAPI.ConversationTags = new ConversationTagsAPI.ConversationTags(
+    this._client,
+  );
+  tickets: TicketsAPI.Tickets = new TicketsAPI.Tickets(this._client);
+}
+
+Products.Surveys = Surveys;
+Products.Conversations = Conversations;
+Products.ConversationTags = ConversationTags;
+Products.Tickets = Tickets;
+
+export declare namespace Products {
+  export {
+    Surveys as Surveys,
+    type Survey as Survey,
+    type SurveyNextAction as SurveyNextAction,
+    type SurveyListResponse as SurveyListResponse,
+    type SurveyRetrieveResponsesResponse as SurveyRetrieveResponsesResponse,
+    type SurveyRetrieveParams as SurveyRetrieveParams,
+    type SurveyListParams as SurveyListParams,
+    type SurveyRetrieveResponsesParams as SurveyRetrieveResponsesParams,
+  };
+
+  export {
+    Conversations as Conversations,
+    type Conversation as Conversation,
+    type ConversationPart as ConversationPart,
+    type ConversationPartAuthor as ConversationPartAuthor,
+    type ConversationParticipant as ConversationParticipant,
+    type ConversationTagApplication as ConversationTagApplication,
+    type CsatEmailDelivery as CsatEmailDelivery,
+    type CsatRatedAgent as CsatRatedAgent,
+    type CsatWorkflowLink as CsatWorkflowLink,
+    type EmailRecipients as EmailRecipients,
+    type ConversationListResponse as ConversationListResponse,
+    type ConversationDeleteResponse as ConversationDeleteResponse,
+    type ConversationCreateParams as ConversationCreateParams,
+    type ConversationRetrieveParams as ConversationRetrieveParams,
+    type ConversationUpdateParams as ConversationUpdateParams,
+    type ConversationListParams as ConversationListParams,
+    type ConversationDeleteParams as ConversationDeleteParams,
+    type ConversationRedactParams as ConversationRedactParams,
+    type ConversationReplyParams as ConversationReplyParams,
+  };
+
+  export {
+    ConversationTags as ConversationTags,
+    type ConversationTag as ConversationTag,
+    type ConversationTagListResponse as ConversationTagListResponse,
+    type ConversationTagDeleteResponse as ConversationTagDeleteResponse,
+    type ConversationTagRetrieveParams as ConversationTagRetrieveParams,
+    type ConversationTagListParams as ConversationTagListParams,
+    type ConversationTagDeleteParams as ConversationTagDeleteParams,
+    type ConversationTagCreateOrRenameParams as ConversationTagCreateOrRenameParams,
+  };
+
+  export {
+    Tickets as Tickets,
+    type AuthorInput as AuthorInput,
+    type Ticket as Ticket,
+    type TicketListResponse as TicketListResponse,
+    type TicketDeleteResponse as TicketDeleteResponse,
+    type TicketCreateParams as TicketCreateParams,
+    type TicketRetrieveParams as TicketRetrieveParams,
+    type TicketUpdateParams as TicketUpdateParams,
+    type TicketListParams as TicketListParams,
+    type TicketDeleteParams as TicketDeleteParams,
+    type TicketReplyParams as TicketReplyParams,
+  };
+}

package/src/resources/{surveys.ts → products/surveys.ts}

@@ -1,12 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
+import { APIResource } from '../../core/resource';
 import * as SurveysAPI from './surveys';
-import * as ContactsAPI from './contacts/contacts';
-import { APIPromise } from '../core/api-promise';
-import { buildHeaders } from '../internal/headers';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
+import * as ContactsAPI from '../users/contacts/contacts';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * Surveys allow you to collect targeted feedback from your users within your product. Surveys can be targeted to specific user segments or pages and can contain multiple questions with conditional logic.
@@ -44,6 +44,13 @@ export class Surveys extends APIResource {
    * ### Errors
    *
    * - `404` - Survey not found in your organization
+   *
+   * @example
+   * ```ts
+   * const survey = await client.products.surveys.retrieve(
+   *   '6743752ca81ae59d25cf834b',
+   * );
+   * ```
    */
   retrieve(
     id: string,
@@ -91,6 +98,11 @@ export class Surveys extends APIResource {
    * - `pages` - Array of survey pages/questions
    * - `createdAt` - ISO 8601 timestamp when created
    * - `updatedAt` - ISO 8601 timestamp when last updated
+   *
+   * @example
+   * ```ts
+   * const surveys = await client.products.surveys.list();
+   * ```
    */
   list(
     params: SurveyListParams | null | undefined = {},
@@ -144,6 +156,14 @@ export class Surveys extends APIResource {
    * ### Errors
    *
    * - `404` - Survey not found in your organization
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.products.surveys.retrieveResponses(
+   *     '6743752ca81ae59d25cf834b',
+   *   );
+   * ```
    */
   retrieveResponses(
     id: string,

package/src/resources/{tickets → products/tickets}/categories.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as BoardsAPI from '../boards';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import * as BoardsAPI from '../../feedback/boards';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
@@ -19,9 +19,10 @@ export class Categories extends APIResource {
    *
    * @example
    * ```ts
-   * const board = await client.tickets.categories.retrieve(
-   *   '507f1f77bcf86cd799439011',
-   * );
+   * const board =
+   *   await client.products.tickets.categories.retrieve(
+   *     '507f1f77bcf86cd799439011',
+   *   );
    * ```
    */
   retrieve(
@@ -56,7 +57,8 @@ export class Categories extends APIResource {
    *
    * @example
    * ```ts
-   * const boards = await client.tickets.categories.list();
+   * const boards =
+   *   await client.products.tickets.categories.list();
    * ```
    */
   list(

package/src/resources/{tickets → products/tickets}/custom-fields.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as CustomFieldsAPI from '../custom-fields';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import * as CustomFieldsAPI from '../../feedback/custom-fields';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
@@ -31,7 +31,7 @@ export class CustomFields extends APIResource {
    * @example
    * ```ts
    * const customField =
-   *   await client.tickets.customFields.retrieve(
+   *   await client.products.tickets.customFields.retrieve(
    *     '65d26304b2e65b1e1278170c',
    *   );
    * ```
@@ -74,7 +74,7 @@ export class CustomFields extends APIResource {
    * @example
    * ```ts
    * const customFieldList =
-   *   await client.tickets.customFields.list();
+   *   await client.products.tickets.customFields.list();
    * ```
    */
   list(

package/src/resources/{tickets → products/tickets}/statuses.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as PostStatusesAPI from '../post-statuses';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+import { APIResource } from '../../../core/resource';
+import * as PostStatusesAPI from '../../feedback/post-statuses';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
@@ -18,9 +18,10 @@ export class Statuses extends APIResource {
    *
    * @example
    * ```ts
-   * const postStatus = await client.tickets.statuses.retrieve(
-   *   '507f1f77bcf86cd799439011',
-   * );
+   * const postStatus =
+   *   await client.products.tickets.statuses.retrieve(
+   *     '507f1f77bcf86cd799439011',
+   *   );
    * ```
    */
   retrieve(
@@ -52,7 +53,8 @@ export class Statuses extends APIResource {
    *
    * @example
    * ```ts
-   * const postStatuses = await client.tickets.statuses.list();
+   * const postStatuses =
+   *   await client.products.tickets.statuses.list();
    * ```
    */
   list(

package/src/resources/{tickets → products/tickets}/tickets.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
-import * as PostStatusesAPI from '../post-statuses';
+import { APIResource } from '../../../core/resource';
+import * as PostStatusesAPI from '../../feedback/post-statuses';
 import * as ConversationsAPI from '../conversations/conversations';
 import * as CategoriesAPI from './categories';
 import { Categories, CategoryListParams, CategoryListResponse, CategoryRetrieveParams } from './categories';
@@ -9,10 +9,10 @@ import * as CustomFieldsAPI from './custom-fields';
 import { CustomFieldListParams, CustomFieldRetrieveParams, CustomFields } from './custom-fields';
 import * as StatusesAPI from './statuses';
 import { StatusListParams, StatusListResponse, StatusRetrieveParams, Statuses } from './statuses';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Tickets represent support requests in your Featurebase organization. Create, update, reply to, and manage tickets via these endpoints.
@@ -78,7 +78,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.tickets.create({
+   * const ticket = await client.products.tickets.create({
    *   author: {},
    *   ticketCategoryId: '507f1f77bcf86cd799439011',
    *   title: 'Cannot login to dashboard',
@@ -111,7 +111,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.tickets.retrieve(1);
+   * const ticket = await client.products.tickets.retrieve(1);
    * ```
    */
   retrieve(
@@ -172,7 +172,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.tickets.update(1);
+   * const ticket = await client.products.tickets.update(1);
    * ```
    */
   update(id: number, params: TicketUpdateParams, options?: RequestOptions): APIPromise<Ticket> {
@@ -210,7 +210,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const tickets = await client.tickets.list();
+   * const tickets = await client.products.tickets.list();
    * ```
    */
   list(
@@ -259,7 +259,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.tickets.delete(1);
+   * const ticket = await client.products.tickets.delete(1);
    * ```
    */
   delete(
@@ -318,7 +318,7 @@ export class Tickets extends APIResource {
    *
    * @example
    * ```ts
-   * const ticket = await client.tickets.reply(1, {
+   * const ticket = await client.products.tickets.reply(1, {
    *   body: '<p>Thank you for your help!</p>',
    *   type: 'contact',
    * });

package/src/resources/products.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './products/index';

package/src/resources/{companies → users/companies}/companies.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../core/resource';
+import { APIResource } from '../../../core/resource';
 import * as ContactsAPI from './contacts';
 import {
   ContactAttachParams,
@@ -10,10 +10,10 @@ import {
   ContactRemoveResponse,
   Contacts,
 } from './contacts';
-import { APIPromise } from '../../core/api-promise';
-import { buildHeaders } from '../../internal/headers';
-import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
@@ -77,7 +77,7 @@ export class Companies extends APIResource {
    *
    * @example
    * ```ts
-   * const company = await client.companies.retrieve(
+   * const company = await client.users.companies.retrieve(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -164,7 +164,7 @@ export class Companies extends APIResource {
    *
    * @example
    * ```ts
-   * const companies = await client.companies.list();
+   * const companies = await client.users.companies.list();
    * ```
    */
   list(
@@ -213,7 +213,7 @@ export class Companies extends APIResource {
    *
    * @example
    * ```ts
-   * const deletedCompany = await client.companies.delete(
+   * const deletedCompany = await client.users.companies.delete(
    *   '507f1f77bcf86cd799439011',
    * );
    * ```
@@ -303,10 +303,9 @@ export class Companies extends APIResource {
    *
    * @example
    * ```ts
-   * const company = await client.companies.createOrUpdate({
-   *   companyId: 'comp_12345',
-   *   name: 'Acme Inc',
-   * });
+   * const company = await client.users.companies.createOrUpdate(
+   *   { companyId: 'comp_12345', name: 'Acme Inc' },
+   * );
    * ```
    */
   createOrUpdate(params: CompanyCreateOrUpdateParams, options?: RequestOptions): APIPromise<Company> {
@@ -369,7 +368,9 @@ export class Companies extends APIResource {
    * @example
    * ```ts
    * const deletedCompany =
-   *   await client.companies.deleteByCompanyID('comp_12345');
+   *   await client.users.companies.deleteByCompanyID(
+   *     'comp_12345',
+   *   );
    * ```
    */
   deleteByCompanyID(

package/src/resources/{companies → users/companies}/contacts.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-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';
-import * as ContactsAPI_ from '../contacts/contacts';
+import { APIResource } from '../../../core/resource';
+import * as UsersContactsAPI from '../contacts/contacts';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
 
 /**
  * Companies represent organizations or businesses that your users belong to. Use this endpoint to list and retrieve company information.
@@ -65,16 +65,17 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contactList = await client.companies.contacts.list(
-   *   '507f1f77bcf86cd799439011',
-   * );
+   * const contactList =
+   *   await client.users.companies.contacts.list(
+   *     '507f1f77bcf86cd799439011',
+   *   );
    * ```
    */
   list(
     id: string,
     params: ContactListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<ContactsAPI_.ContactList> {
+  ): APIPromise<UsersContactsAPI.ContactList> {
     const { 'Featurebase-Version': featurebaseVersion, ...query } = params ?? {};
     return this._client.get(path`/v2/companies/${id}/contacts`, {
       query,
@@ -146,10 +147,11 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.companies.contacts.attach(
-   *   '507f1f77bcf86cd799439011',
-   *   { contactId: '507f1f77bcf86cd799439012' },
-   * );
+   * const response =
+   *   await client.users.companies.contacts.attach(
+   *     '507f1f77bcf86cd799439011',
+   *     { contactId: '507f1f77bcf86cd799439012' },
+   *   );
    * ```
    */
   attach(
@@ -209,10 +211,11 @@ export class Contacts extends APIResource {
    *
    * @example
    * ```ts
-   * const contact = await client.companies.contacts.remove(
-   *   '507f1f77bcf86cd799439012',
-   *   { id: '507f1f77bcf86cd799439011' },
-   * );
+   * const contact =
+   *   await client.users.companies.contacts.remove(
+   *     '507f1f77bcf86cd799439012',
+   *     { id: '507f1f77bcf86cd799439011' },
+   *   );
    * ```
    */
   remove(
@@ -234,12 +237,12 @@ export class Contacts extends APIResource {
 /**
  * User who submitted the response
  */
-export type ContactAttachResponse = ContactsAPI_.Contact | (null & {});
+export type ContactAttachResponse = UsersContactsAPI.Contact | (null & {});
 
 /**
  * User who submitted the response
  */
-export type ContactRemoveResponse = ContactsAPI_.Contact | (null & {});
+export type ContactRemoveResponse = UsersContactsAPI.Contact | (null & {});
 
 export interface ContactListParams {
   /**

package/src/resources/{contacts → users/contacts}/by-user-id/by-user-id.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../core/resource';
+import { APIResource } from '../../../../core/resource';
 import * as ContactsAPI from '../contacts';
 import * as EmailPreferencesAPI from './email-preferences';
 import {
@@ -8,10 +8,10 @@ import {
   EmailPreferenceUpdateParams,
   EmailPreferences,
 } from './email-preferences';
-import { APIPromise } from '../../../core/api-promise';
-import { buildHeaders } from '../../../internal/headers';
-import { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
+import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
 
 /**
  * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
@@ -74,9 +74,10 @@ export class ByUserID extends APIResource {
    *
    * @example
    * ```ts
-   * const byUserID = await client.contacts.byUserID.retrieve(
-   *   'usr_12345',
-   * );
+   * const byUserID =
+   *   await client.users.contacts.byUserID.retrieve(
+   *     'usr_12345',
+   *   );
    * ```
    */
   retrieve(
@@ -143,7 +144,7 @@ export class ByUserID extends APIResource {
    * @example
    * ```ts
    * const deletedContact =
-   *   await client.contacts.byUserID.delete('usr_12345');
+   *   await client.users.contacts.byUserID.delete('usr_12345');
    * ```
    */
   delete(

package/src/resources/{contacts → users/contacts}/by-user-id/email-preferences.ts

@@ -1,11 +1,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../core/resource';
+import { APIResource } from '../../../../core/resource';
 import * as EmailPreferencesAPI from '../email-preferences';
-import { APIPromise } from '../../../core/api-promise';
-import { buildHeaders } from '../../../internal/headers';
-import { RequestOptions } from '../../../internal/request-options';
-import { path } from '../../../internal/utils/path';
+import { APIPromise } from '../../../../core/api-promise';
+import { buildHeaders } from '../../../../internal/headers';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
 
 /**
  * Contacts are the customers and leads in your Featurebase organization. Use this endpoint to list and retrieve contact information.
@@ -58,7 +58,7 @@ export class EmailPreferences extends APIResource {
    * @example
    * ```ts
    * const preferencesOutput =
-   *   await client.contacts.byUserID.emailPreferences.retrieve(
+   *   await client.users.contacts.byUserID.emailPreferences.retrieve(
    *     'usr_12345',
    *   );
    * ```
@@ -161,7 +161,7 @@ export class EmailPreferences extends APIResource {
    * @example
    * ```ts
    * const preferencesOutput =
-   *   await client.contacts.byUserID.emailPreferences.update(
+   *   await client.users.contacts.byUserID.emailPreferences.update(
    *     'usr_12345',
    *     { preferences: {} },
    *   );