feat(api): update via SDK Studio

Author: stainless-bot

.stats.yml

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

api.md

@@ -116,6 +116,7 @@ Methods:
 - <code title="put /companies/{id}">client.companies.<a href="./src/resources/companies/companies.ts">update</a>(id, { ...params }) -> Company</code>
 - <code title="post /companies/list">client.companies.<a href="./src/resources/companies/companies.ts">list</a>({ ...params }) -> CompanyList</code>
 - <code title="delete /companies/{id}">client.companies.<a href="./src/resources/companies/companies.ts">delete</a>(id, { ...params }) -> DeletedCompanyObject</code>
+- <code title="get /companies">client.companies.<a href="./src/resources/companies/companies.ts">retrieveList</a>({ ...params }) -> CompanyList</code>
 - <code title="get /companies/scroll">client.companies.<a href="./src/resources/companies/companies.ts">scroll</a>({ ...params }) -> CompanyScroll | null</code>
 
 ## Contacts

src/core.ts

@@ -18,7 +18,7 @@ import {
   type HeadersInit,
 } from './_shims/index';
 export { type Response };
-import { isMultipartBody } from './uploads';
+import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
   maybeMultipartFormRequestOptions,
   multipartFormRequestOptions,
@@ -235,7 +235,17 @@ export abstract class APIClient {
     path: string,
     opts?: PromiseOrValue<RequestOptions<Req>>,
   ): APIPromise<Rsp> {
-    return this.request(Promise.resolve(opts).then((opts) => ({ method, path, ...opts })));
+    return this.request(
+      Promise.resolve(opts).then(async (opts) => {
+        const body =
+          opts && isBlobLike(opts?.body) ? new DataView(await opts.body.arrayBuffer())
+          : opts?.body instanceof DataView ? opts.body
+          : opts?.body instanceof ArrayBuffer ? new DataView(opts.body)
+          : opts && ArrayBuffer.isView(opts?.body) ? new DataView(opts.body.buffer)
+          : opts?.body;
+        return { method, path, ...opts, body };
+      }),
+    );
   }
 
   getAPIList<Item, PageClass extends AbstractPage<Item> = AbstractPage<Item>>(
@@ -257,6 +267,8 @@ export abstract class APIClient {
         const encoded = encoder.encode(body);
         return encoded.length.toString();
       }
+    } else if (ArrayBuffer.isView(body)) {
+      return body.byteLength.toString();
     }
 
     return null;
@@ -266,7 +278,9 @@ export abstract class APIClient {
     const { method, path, query, headers: headers = {} } = options;
 
     const body =
-      isMultipartBody(options.body) ? options.body.body
+      ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
+        options.body
+      : isMultipartBody(options.body) ? options.body.body
       : options.body ? JSON.stringify(options.body, null, 2)
       : null;
     const contentLength = this.calculateContentLength(body);
@@ -721,7 +735,9 @@ export type Headers = Record<string, string | null | undefined>;
 export type DefaultQuery = Record<string, string | undefined>;
 export type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
-export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> = {
+export type RequestOptions<
+  Req = unknown | Record<string, unknown> | Readable | BlobLike | ArrayBufferView | ArrayBuffer,
+> = {
   method?: HTTPMethod;
   path?: string;
   query?: Req | undefined;
@@ -735,6 +751,7 @@ export type RequestOptions<Req = unknown | Record<string, unknown> | Readable> =
   signal?: AbortSignal | undefined | null;
   idempotencyKey?: string;
 
+  __binaryRequest?: boolean | undefined;
   __binaryResponse?: boolean | undefined;
 };
 
@@ -755,6 +772,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   signal: true,
   idempotencyKey: true,
 
+  __binaryRequest: true,
   __binaryResponse: true,
 };
 
@@ -767,10 +785,11 @@ export const isRequestOptions = (obj: unknown): obj is RequestOptions => {
   );
 };
 
-export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable> = RequestOptions<Req> & {
-  method: HTTPMethod;
-  path: string;
-};
+export type FinalRequestOptions<Req = unknown | Record<string, unknown> | Readable | DataView> =
+  RequestOptions<Req> & {
+    method: HTTPMethod;
+    path: string;
+  };
 
 declare const Deno: any;
 declare const EdgeRuntime: any;

src/index.ts

@@ -260,6 +260,7 @@ export namespace Intercom {
   export import CompanyUpdateParams = API.CompanyUpdateParams;
   export import CompanyListParams = API.CompanyListParams;
   export import CompanyDeleteParams = API.CompanyDeleteParams;
+  export import CompanyRetrieveListParams = API.CompanyRetrieveListParams;
   export import CompanyScrollParams = API.CompanyScrollParams;
 
   export import Contacts = API.Contacts;

src/resources/companies/companies.ts

@@ -179,6 +179,45 @@ export class Companies extends APIResource {
     });
   }
 
+  /**
+   * You can fetch a single company by passing in `company_id` or `name`.
+   *
+   * `https://api.intercom.io/companies?name={name}`
+   *
+   * `https://api.intercom.io/companies?company_id={company_id}`
+   *
+   * You can fetch all companies and filter by `segment_id` or `tag_id` as a query
+   * parameter.
+   *
+   * `https://api.intercom.io/companies?tag_id={tag_id}`
+   *
+   * `https://api.intercom.io/companies?segment_id={segment_id}`
+   */
+  retrieveList(
+    params?: CompanyRetrieveListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CompanyList>;
+  retrieveList(options?: Core.RequestOptions): Core.APIPromise<CompanyList>;
+  retrieveList(
+    params: CompanyRetrieveListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CompanyList> {
+    if (isRequestOptions(params)) {
+      return this.retrieveList({}, params);
+    }
+    const { 'Intercom-Version': intercomVersion, ...query } = params;
+    return this._client.get('/companies', {
+      query,
+      ...options,
+      headers: {
+        ...(intercomVersion?.toString() != null ?
+          { 'Intercom-Version': intercomVersion?.toString() }
+        : undefined),
+        ...options?.headers,
+      },
+    });
+  }
+
   /**
    * The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.
    *
@@ -591,6 +630,62 @@ export interface CompanyDeleteParams {
     | 'Unstable';
 }
 
+export interface CompanyRetrieveListParams {
+  /**
+   * Query param: The `company_id` of the company to filter by.
+   */
+  company_id?: string;
+
+  /**
+   * Query param: The `name` of the company to filter by.
+   */
+  name?: string;
+
+  /**
+   * Query param: The page of results to fetch. Defaults to first page
+   */
+  page?: number;
+
+  /**
+   * Query param: How many results to display per page. Defaults to 15
+   */
+  per_page?: number;
+
+  /**
+   * Query param: The `segment_id` of the company to filter by.
+   */
+  segment_id?: string;
+
+  /**
+   * Query param: The `tag_id` of the company to filter by.
+   */
+  tag_id?: string;
+
+  /**
+   * Header param: Intercom API version.By default, it's equal to the version set in
+   * the app package.
+   */
+  'Intercom-Version'?:
+    | '1.0'
+    | '1.1'
+    | '1.2'
+    | '1.3'
+    | '1.4'
+    | '2.0'
+    | '2.1'
+    | '2.2'
+    | '2.3'
+    | '2.4'
+    | '2.5'
+    | '2.6'
+    | '2.7'
+    | '2.8'
+    | '2.9'
+    | '2.10'
+    | '2.11'
+    | 'Unstable';
+}
+
 export interface CompanyScrollParams {
   /**
    * Query param:
@@ -631,6 +726,7 @@ export namespace Companies {
   export import CompanyUpdateParams = CompaniesAPI.CompanyUpdateParams;
   export import CompanyListParams = CompaniesAPI.CompanyListParams;
   export import CompanyDeleteParams = CompaniesAPI.CompanyDeleteParams;
+  export import CompanyRetrieveListParams = CompaniesAPI.CompanyRetrieveListParams;
   export import CompanyScrollParams = CompaniesAPI.CompanyScrollParams;
   export import Contacts = ContactsAPI.Contacts;
   export import CompanyAttachedContacts = ContactsAPI.CompanyAttachedContacts;

src/resources/companies/index.ts

@@ -11,6 +11,7 @@ export {
   CompanyUpdateParams,
   CompanyListParams,
   CompanyDeleteParams,
+  CompanyRetrieveListParams,
   CompanyScrollParams,
   Companies,
 } from './companies';

src/resources/index.ts

@@ -25,6 +25,7 @@ export {
   CompanyUpdateParams,
   CompanyListParams,
   CompanyDeleteParams,
+  CompanyRetrieveListParams,
   CompanyScrollParams,
   Companies,
 } from './companies/companies';

tests/api-resources/companies/companies.test.ts

@@ -165,6 +165,42 @@ describe('resource companies', () => {
     ).rejects.toThrow(Intercom.NotFoundError);
   });
 
+  test('retrieveList', async () => {
+    const responsePromise = intercom.companies.retrieveList();
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('retrieveList: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(intercom.companies.retrieveList({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      Intercom.NotFoundError,
+    );
+  });
+
+  test('retrieveList: request options and params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(
+      intercom.companies.retrieveList(
+        {
+          company_id: 'string',
+          name: 'string',
+          page: 0,
+          per_page: 0,
+          segment_id: 'string',
+          tag_id: 'string',
+          'Intercom-Version': '2.11',
+        },
+        { path: '/_stainless_unknown_path' },
+      ),
+    ).rejects.toThrow(Intercom.NotFoundError);
+  });
+
   test('scroll', async () => {
     const responsePromise = intercom.companies.scroll();
     const rawResponse = await responsePromise.asResponse();