feat(api): update via SDK Studio

Author: stainless-bot

.github/workflows/ci.yml

@@ -2,10 +2,10 @@ name: CI
 on:
   push:
     branches:
-      - main
+      - v3
   pull_request:
     branches:
-      - main
+      - v3
 
 jobs:
   lint:

.github/workflows/create-releases.yml

@@ -4,12 +4,12 @@ on:
     - cron: '0 5 * * *' # every day at 5am UTC
   push:
     branches:
-      - main
+      - v3
 
 jobs:
   release:
     name: release
-    if: github.ref == 'refs/heads/main' && github.repository == 'intercom/intercom-node'
+    if: github.ref == 'refs/heads/v3' && github.repository == 'intercom/intercom-node'
     runs-on: ubuntu-latest
 
     steps:

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 106
+configured_endpoints: 107
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/intercom%2Fintercom-a202b2b4aa0e356eb61376a3bf484132be2e9e3bff3796e1fe4606ab2a3734fd.yml

README.md

@@ -11,9 +11,12 @@ It is generated with [Stainless](https://www.stainlessapi.com/).
 ## Installation
 
 ```sh
-npm install intercom-client
+npm install git+ssh://[email protected]:intercom/intercom-node.git
 ```
 
+> [!NOTE]
+> Once this package is [published to npm](https://app.stainlessapi.com/docs/guides/publish), this will become: `npm install intercom-client`
+
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
@@ -217,7 +220,7 @@ import Intercom from 'intercom-client';
 ```
 
 To do the inverse, add `import "intercom-client/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/intercom/intercom-node/tree/main/src/_shims#readme)).
+This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/intercom/intercom-node/tree/v3/src/_shims#readme)).
 
 ### Logging and middleware
 

api.md

@@ -7,14 +7,20 @@ Types:
 - <code><a href="./src/resources/shared.ts">ArticleTranslatedContent</a></code>
 - <code><a href="./src/resources/shared.ts">Company</a></code>
 - <code><a href="./src/resources/shared.ts">Contact</a></code>
+- <code><a href="./src/resources/shared.ts">ContactReference</a></code>
 - <code><a href="./src/resources/shared.ts">Conversation</a></code>
+- <code><a href="./src/resources/shared.ts">CursorPages</a></code>
 - <code><a href="./src/resources/shared.ts">GroupContent</a></code>
 - <code><a href="./src/resources/shared.ts">GroupTranslatedContent</a></code>
 - <code><a href="./src/resources/shared.ts">Message</a></code>
 - <code><a href="./src/resources/shared.ts">MultipleFilterSearchRequest</a></code>
 - <code><a href="./src/resources/shared.ts">Note</a></code>
 - <code><a href="./src/resources/shared.ts">PaginatedResponse</a></code>
+- <code><a href="./src/resources/shared.ts">PartAttachment</a></code>
+- <code><a href="./src/resources/shared.ts">Reference</a></code>
 - <code><a href="./src/resources/shared.ts">SearchRequest</a></code>
+- <code><a href="./src/resources/shared.ts">SingleFilterSearchRequest</a></code>
+- <code><a href="./src/resources/shared.ts">StartingAfterPaging</a></code>
 - <code><a href="./src/resources/shared.ts">SubscriptionTypeList</a></code>
 - <code><a href="./src/resources/shared.ts">Tag</a></code>
 - <code><a href="./src/resources/shared.ts">TagList</a></code>
@@ -168,6 +174,7 @@ Types:
 
 Methods:
 
+- <code title="post /contacts/{contact_id}/companies">client.contacts.companies.<a href="./src/resources/contacts/companies.ts">create</a>(contactId, { ...params }) -> Company</code>
 - <code title="delete /contacts/{contact_id}/companies/{id}">client.contacts.companies.<a href="./src/resources/contacts/companies.ts">delete</a>(contactId, id, { ...params }) -> Company</code>
 
 ## Notes
@@ -216,13 +223,14 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/conversations/conversations.ts">ConversationList</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">ConversationListResponse</a></code>
 
 Methods:
 
 - <code title="post /conversations">client.conversations.<a href="./src/resources/conversations/conversations.ts">create</a>({ ...params }) -> Message</code>
 - <code title="get /conversations/{id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">retrieve</a>(id, { ...params }) -> Conversation</code>
 - <code title="put /conversations/{id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">update</a>(id, { ...params }) -> Conversation</code>
-- <code title="get /conversations">client.conversations.<a href="./src/resources/conversations/conversations.ts">list</a>({ ...params }) -> PaginatedResponse</code>
+- <code title="get /conversations">client.conversations.<a href="./src/resources/conversations/conversations.ts">list</a>({ ...params }) -> ConversationListResponsesCursorPagination</code>
 - <code title="post /conversations/{id}/convert">client.conversations.<a href="./src/resources/conversations/conversations.ts">convert</a>(id, { ...params }) -> Ticket | null</code>
 - <code title="post /conversations/redact">client.conversations.<a href="./src/resources/conversations/conversations.ts">redact</a>({ ...params }) -> Conversation</code>
 - <code title="post /conversations/search">client.conversations.<a href="./src/resources/conversations/conversations.ts">search</a>({ ...params }) -> ConversationList</code>

src/index.ts

@@ -5,6 +5,7 @@ import * as Errors from './error';
 import { type Agent } from './_shims/index';
 import * as Uploads from './uploads';
 import * as qs from 'qs';
+import * as Pagination from './pagination';
 import * as API from './resources/index';
 
 const environments = {
@@ -227,6 +228,10 @@ export import fileFromPath = Uploads.fileFromPath;
 export namespace Intercom {
   export import RequestOptions = Core.RequestOptions;
 
+  export import CursorPagination = Pagination.CursorPagination;
+  export import CursorPaginationParams = Pagination.CursorPaginationParams;
+  export import CursorPaginationResponse = Pagination.CursorPaginationResponse;
+
   export import Me = API.Me;
   export import AdminWithApp = API.AdminWithApp;
   export import MeRetrieveParams = API.MeRetrieveParams;
@@ -280,6 +285,8 @@ export namespace Intercom {
 
   export import Conversations = API.Conversations;
   export import ConversationList = API.ConversationList;
+  export import ConversationListResponse = API.ConversationListResponse;
+  export import ConversationListResponsesCursorPagination = API.ConversationListResponsesCursorPagination;
   export import ConversationCreateParams = API.ConversationCreateParams;
   export import ConversationRetrieveParams = API.ConversationRetrieveParams;
   export import ConversationUpdateParams = API.ConversationUpdateParams;
@@ -372,14 +379,20 @@ export namespace Intercom {
   export import ArticleTranslatedContent = API.ArticleTranslatedContent;
   export import Company = API.Company;
   export import Contact = API.Contact;
+  export import ContactReference = API.ContactReference;
   export import Conversation = API.Conversation;
+  export import CursorPages = API.CursorPages;
   export import GroupContent = API.GroupContent;
   export import GroupTranslatedContent = API.GroupTranslatedContent;
   export import Message = API.Message;
   export import MultipleFilterSearchRequest = API.MultipleFilterSearchRequest;
   export import Note = API.Note;
   export import PaginatedResponse = API.PaginatedResponse;
+  export import PartAttachment = API.PartAttachment;
+  export import Reference = API.Reference;
   export import SearchRequest = API.SearchRequest;
+  export import SingleFilterSearchRequest = API.SingleFilterSearchRequest;
+  export import StartingAfterPaging = API.StartingAfterPaging;
   export import SubscriptionTypeList = API.SubscriptionTypeList;
   export import Tag = API.Tag;
   export import TagList = API.TagList;

src/pagination.ts

@@ -0,0 +1,91 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { AbstractPage, Response, APIClient, FinalRequestOptions, PageInfo } from './core';
+
+export interface CursorPaginationResponse<Item> {
+  pages: CursorPaginationResponse.Pages;
+
+  total_count: number;
+
+  data: Array<Item>;
+}
+
+export namespace CursorPaginationResponse {
+  export interface Pages {
+    next?: Pages.Next;
+
+    page?: number;
+
+    total_pages?: number;
+
+    type?: string;
+  }
+
+  export namespace Pages {
+    export interface Next {
+      page?: number;
+
+      starting_after?: string;
+    }
+  }
+}
+
+export interface CursorPaginationParams {
+  /**
+   * The pagination cursor value.
+   */
+  starting_after?: string;
+
+  /**
+   * Number of results to return per page.
+   */
+  per_page?: number;
+}
+
+export class CursorPagination<Item> extends AbstractPage<Item> implements CursorPaginationResponse<Item> {
+  pages: CursorPaginationResponse.Pages;
+
+  total_count: number;
+
+  data: Array<Item>;
+
+  constructor(
+    client: APIClient,
+    response: Response,
+    body: CursorPaginationResponse<Item>,
+    options: FinalRequestOptions,
+  ) {
+    super(client, response, body, options);
+
+    this.pages = body.pages || {};
+    this.total_count = body.total_count || 0;
+    this.data = body.data || [];
+  }
+
+  getPaginatedItems(): Item[] {
+    return this.data ?? [];
+  }
+
+  // @deprecated Please use `nextPageInfo()` instead
+  nextPageParams(): Partial<CursorPaginationParams> | null {
+    const info = this.nextPageInfo();
+    if (!info) return null;
+    if ('params' in info) return info.params;
+    const params = Object.fromEntries(info.url.searchParams);
+    if (!Object.keys(params).length) return null;
+    return params;
+  }
+
+  nextPageInfo(): PageInfo | null {
+    const cursor = this.pages?.next?.starting_after;
+    if (!cursor) {
+      return null;
+    }
+
+    return {
+      params: {
+        starting_after: cursor,
+      },
+    };
+  }
+}

src/resources/admins/activity-logs.ts

@@ -3,6 +3,7 @@
 import * as Core from '../../core';
 import { APIResource } from '../../resource';
 import * as ActivityLogsAPI from './activity-logs';
+import * as Shared from '../shared';
 
 export class ActivityLogs extends APIResource {
   /**
@@ -38,7 +39,7 @@ export interface ActivityLogList {
    * the current position in the result set, allowing the API to return the data in
    * small chunks or "pages" as needed.
    */
-  pages?: ActivityLogList.Pages | null;
+  pages?: Shared.CursorPages | null;
 
   /**
    * String representing the object's type. Always has the value `activity_log.list`.
@@ -222,50 +223,6 @@ export namespace ActivityLogList {
       type?: string;
     }
   }
-
-  /**
-   * Cursor-based pagination is a technique used in the Intercom API to navigate
-   * through large amounts of data. A "cursor" or pointer is used to keep track of
-   * the current position in the result set, allowing the API to return the data in
-   * small chunks or "pages" as needed.
-   */
-  export interface Pages {
-    next?: Pages.Next | null;
-
-    /**
-     * The current page
-     */
-    page?: number;
-
-    /**
-     * Number of results per page
-     */
-    per_page?: number;
-
-    /**
-     * Total number of pages
-     */
-    total_pages?: number;
-
-    /**
-     * the type of object `pages`.
-     */
-    type?: 'pages';
-  }
-
-  export namespace Pages {
-    export interface Next {
-      /**
-       * The number of results to fetch per page.
-       */
-      per_page?: number;
-
-      /**
-       * The cursor to use in the next request to get the next page of results.
-       */
-      starting_after?: string | null;
-    }
-  }
 }
 
 export interface ActivityLogListParams {