@tryfinch/finch-api 1.1.0 → 3.0.0

package/resources/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAErD,oCAAgC;AAAvB,0FAAA,GAAG,OAAA;AACZ,wCAAuE;AAA3B,kGAAA,OAAO,OAAA;AACnD,uCAAoE;AAA1B,4FAAA,IAAI,OAAA;AAC9C,4CAAuE;AAApD,gHAAA,mBAAmB,OAAA;AAAE,sGAAA,SAAS,OAAA"}

package/resources/index.mjs

@@ -0,0 +1,6 @@
+// File generated from our OpenAPI spec by Stainless.
+export { ATS } from './ats/ats.mjs';
+export { Account } from './account.mjs';
+export { HRIS } from './hris/hris.mjs';
+export { ProvidersSinglePage, Providers } from './providers.mjs';
+//# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAE9C,EAAE,GAAG,EAAE;OACP,EAAqC,OAAO,EAAE;OAC9C,EAAmC,IAAI,EAAE;OACzC,EAAY,mBAAmB,EAAE,SAAS,EAAE"}

package/{dist/cjs/resources → resources}/providers.d.ts

@@ -1,6 +1,7 @@
-import * as Core from '../core';
-import { APIResource } from '../resource';
-import { SinglePage } from '../pagination';
+import * as Core from '@tryfinch/finch-api/core';
+import { APIResource } from '@tryfinch/finch-api/resource';
+import * as API from './index.js';
+import { SinglePage } from '@tryfinch/finch-api/pagination';
 export declare class Providers extends APIResource {
   /**
    * Return details on all available payroll and HR systems.
@@ -8,7 +9,12 @@ export declare class Providers extends APIResource {
   list(options?: Core.RequestOptions): Core.PagePromise<ProvidersSinglePage>;
 }
 export declare class ProvidersSinglePage extends SinglePage<Provider> {}
+type _ProvidersSinglePage = ProvidersSinglePage;
 export interface Provider {
+  /**
+   * The id of the payroll provider used in Connect.
+   */
+  id?: string;
   /**
    * The display name of the payroll provider.
    */
@@ -17,10 +23,6 @@ export interface Provider {
    * The url to the official icon of the payroll provider.
    */
   icon?: string;
-  /**
-   * The id of the payroll provider used in Connect.
-   */
-  id?: string;
   /**
    * The url to the official logo of the payroll provider.
    */
@@ -43,4 +45,9 @@ export interface Provider {
    */
   products?: Array<string>;
 }
+export declare namespace Providers {
+  export import Provider = API.Provider;
+  type ProvidersSinglePage = _ProvidersSinglePage;
+}
+export {};
 //# sourceMappingURL=providers.d.ts.map

package/resources/providers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.d.ts","sourceRoot":"","sources":["../src/resources/providers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,KAAK,GAAG,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAE5D,qBAAa,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC;CAG3E;AAED,qBAAa,mBAAoB,SAAQ,UAAU,CAAC,QAAQ,CAAC;CAAG;AAEhE,KAAK,oBAAoB,GAAG,mBAAmB,CAAC;AAEhD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,yBAAiB,SAAS,CAAC;IACzB,MAAM,QAAQ,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtC,KAAY,mBAAmB,GAAG,oBAAoB,CAAC;CACxD"}

package/{dist/cjs/resources → resources}/providers.js

@@ -2,8 +2,8 @@
 // File generated from our OpenAPI spec by Stainless.
 Object.defineProperty(exports, '__esModule', { value: true });
 exports.ProvidersSinglePage = exports.Providers = void 0;
-const resource_1 = require('../resource');
-const pagination_1 = require('../pagination');
+const resource_1 = require('@tryfinch/finch-api/resource');
+const pagination_1 = require('@tryfinch/finch-api/pagination');
 class Providers extends resource_1.APIResource {
   /**
    * Return details on all available payroll and HR systems.
@@ -15,4 +15,5 @@ class Providers extends resource_1.APIResource {
 exports.Providers = Providers;
 class ProvidersSinglePage extends pagination_1.SinglePage {}
 exports.ProvidersSinglePage = ProvidersSinglePage;
+(function (Providers) {})((Providers = exports.Providers || (exports.Providers = {})));
 //# sourceMappingURL=providers.js.map

package/resources/providers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.js","sourceRoot":"","sources":["../src/resources/providers.ts"],"names":[],"mappings":";AAAA,qDAAqD;;;AAGrD,2DAA2D;AAE3D,+DAA4D;AAE5D,MAAa,SAAU,SAAQ,sBAAW;IACxC;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAPD,8BAOC;AAED,MAAa,mBAAoB,SAAQ,uBAAoB;CAAG;AAAhE,kDAAgE;AA+ChE,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGzB"}

package/resources/providers.mjs

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless.
+import { APIResource } from '@tryfinch/finch-api/resource';
+import { SinglePage } from '@tryfinch/finch-api/pagination';
+export class Providers extends APIResource {
+  /**
+   * Return details on all available payroll and HR systems.
+   */
+  list(options) {
+    return this.getAPIList('/providers', ProvidersSinglePage, options);
+  }
+}
+export class ProvidersSinglePage extends SinglePage {}
+(function (Providers) {})(Providers || (Providers = {}));
+//# sourceMappingURL=providers.mjs.map

package/resources/providers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"providers.mjs","sourceRoot":"","sources":["../src/resources/providers.ts"],"names":[],"mappings":"AAAA,qDAAqD;OAG9C,EAAE,WAAW,EAAE,MAAM,8BAA8B;OAEnD,EAAE,UAAU,EAAE,MAAM,gCAAgC;AAE3D,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF;AAED,MAAM,OAAO,mBAAoB,SAAQ,UAAoB;CAAG;AA+ChE,WAAiB,SAAS;AAG1B,CAAC,EAHgB,SAAS,KAAT,SAAS,QAGzB"}

package/resources/top-level.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level.d.ts","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC"}

package/resources/top-level.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level.js","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":";AAAA,qDAAqD"}

package/resources/top-level.mjs

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless.
+export {};
+//# sourceMappingURL=top-level.mjs.map

package/resources/top-level.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"top-level.mjs","sourceRoot":"","sources":["../src/resources/top-level.ts"],"names":[],"mappings":"AAAA,qDAAqD"}

package/src/_shims/agent.node.ts

@@ -0,0 +1,22 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import KeepAliveAgent from 'agentkeepalive';
+import type { Agent } from 'node:http';
+import { AbortController as AbortControllerPolyfill } from 'abort-controller';
+
+export type { Agent };
+
+const defaultHttpAgent: Agent = new KeepAliveAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+const defaultHttpsAgent: Agent = new KeepAliveAgent.HttpsAgent({ keepAlive: true, timeout: 5 * 60 * 1000 });
+
+// Polyfill global object if needed.
+if (typeof AbortController === 'undefined') {
+  AbortController = AbortControllerPolyfill as any as typeof AbortController;
+}
+
+export const getDefaultAgent = (url: string): Agent | undefined => {
+  if (defaultHttpsAgent && url.startsWith('https')) return defaultHttpsAgent;
+  return defaultHttpAgent;
+};

package/src/_shims/agent.ts

@@ -0,0 +1,12 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ *
+ * This is a stub for non-node environments.
+ * In node environments, it gets replaced agent.node.ts by the package export map
+ */
+
+export type Agent = any;
+
+export const getDefaultAgent = (url: string): any => {
+  return undefined;
+};

package/src/_shims/fetch.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// Use builtin web types if present; else never (user should
+// add appropriate lib or types to tsconfig)
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `fetch` types for your environment.
+ */
+
+// @ts-ignore
+type _fetch = unknown extends typeof fetch ? never : typeof fetch;
+// @ts-ignore
+type _Request = unknown extends Request ? never : Request;
+// @ts-ignore
+type _RequestInfo = unknown extends RequestInfo ? never : RequestInfo;
+// @ts-ignore
+type _RequestInit = unknown extends RequestInit ? never : RequestInit;
+// @ts-ignore
+type _Response = unknown extends Response ? never : Response;
+// @ts-ignore
+type _ResponseInit = unknown extends ResponseInit ? never : ResponseInit;
+// @ts-ignore
+type _BodyInit = unknown extends BodyInit ? never : BodyInit;
+// @ts-ignore
+type _Headers = unknown extends Headers ? never : Headers;
+// @ts-ignore
+type _HeadersInit = unknown extends HeadersInit ? never : HeadersInit;
+
+declare const _fetch: _fetch;
+declare const _Request: {
+  prototype: _Request;
+  new (input: _RequestInfo | URL, init?: _RequestInit): _Request;
+};
+declare const _Response: {
+  prototype: _Response;
+  new (body?: _BodyInit | null, init?: _ResponseInit): _Response;
+};
+declare const _Headers: {
+  prototype: _Headers;
+  new (init?: _HeadersInit): _Headers;
+};
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+export type { _RequestInit as RequestInit, _RequestInfo as RequestInfo, _BodyInit as BodyInit };

package/src/_shims/fetch.js

@@ -0,0 +1,13 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// If we accidentally call fetch with the wrong this binding,
+// in the browser it would throw:
+//   TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+exports.fetch = fetch.bind(undefined);
+exports.Request = Request;
+exports.Response = Response;
+exports.Headers = Headers;
+
+exports.isPolyfilled = true;

package/src/_shims/fetch.mjs

@@ -0,0 +1,15 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// If we accidentally call fetch with the wrong this binding,
+// in the browser it would throw:
+//   TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
+const _fetch = fetch.bind(undefined);
+const _Request = Request;
+const _Response = Response;
+const _Headers = Headers;
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };

package/src/_shims/fetch.node.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as nf from 'node-fetch';
+
+// Use builtin web types if present; else node-fetch types
+
+/**
+ * >>> Confused? <<<
+ *
+ * If you're getting errors from these types, try adding "lib": ["DOM"]
+ * to your tsconfig.json, or otherwise configure the appropriate builtin
+ * `fetch` types for your environment.
+ */
+
+// @ts-ignore
+type _fetch = unknown extends typeof fetch ? typeof nf.default : typeof fetch;
+// @ts-ignore
+type _Request = unknown extends Request ? nf.Request : Request;
+// @ts-ignore
+type _RequestInfo = unknown extends RequestInfo ? nf.RequestInfo : RequestInfo;
+// @ts-ignore
+type _RequestInit = unknown extends RequestInit ? nf.RequestInit : RequestInit;
+// @ts-ignore
+type _Response = unknown extends Response ? nf.Response : Response;
+// @ts-ignore
+type _ResponseInit = unknown extends ResponseInit ? nf.ResponseInit : ResponseInit;
+// @ts-ignore
+type _BodyInit = unknown extends BodyInit ? nf.BodyInit : BodyInit;
+// @ts-ignore
+type _Headers = unknown extends Headers ? nf.Headers : Headers;
+// @ts-ignore
+type _HeadersInit = unknown extends HeadersInit ? nf.HeadersInit : HeadersInit;
+
+declare const _fetch: _fetch;
+declare const _Request: {
+  prototype: _Request;
+  new (input: _RequestInfo | URL, init?: _RequestInit): _Request;
+};
+declare const _Response: {
+  prototype: _Response;
+  new (body?: _BodyInit | null, init?: _ResponseInit): _Response;
+};
+declare const _Headers: {
+  prototype: _Headers;
+  new (init?: _HeadersInit): _Headers;
+};
+
+export const isPolyfilled = false;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+export type { _RequestInit as RequestInit, _RequestInfo as RequestInfo, _BodyInit as BodyInit };

package/src/_shims/fetch.node.js

@@ -0,0 +1,12 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const nf = require('node-fetch');
+
+exports.fetch = nf.default;
+exports.Request = nf.Request;
+exports.Response = nf.Response;
+exports.Headers = nf.Headers;
+
+exports.isPolyfilled = true;

package/src/_shims/fetch.node.mjs

@@ -0,0 +1,14 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as nf from 'node-fetch';
+
+const _fetch = nf.default;
+const _Request = nf.Request;
+const _Response = nf.Response;
+const _Headers = nf.Headers;
+
+export { _fetch as fetch, _Request as Request, _Response as Response, _Headers as Headers };
+
+export const isPolyfilled = true;

package/src/_shims/fileFromPath.node.ts

@@ -0,0 +1,29 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { fileFromPath as _fileFromPath } from 'formdata-node/file-from-path';
+import type { File, FilePropertyBag } from './formdata.node';
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+let warned = false;
+
+/**
+ * @deprecated use fs.createReadStream('./my/file.txt') instead
+ */
+export async function fileFromPath(path: string): Promise<File>;
+export async function fileFromPath(path: string, filename?: string): Promise<File>;
+export async function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>;
+export async function fileFromPath(
+  path: string,
+  filename?: string,
+  options?: FileFromPathOptions,
+): Promise<File>;
+export async function fileFromPath(path: string, ...args: any[]): Promise<File> {
+  if (!warned) {
+    console.warn(`fileFromPath is deprecated; use fs.createReadStream(${JSON.stringify(path)}) instead`);
+    warned = true;
+  }
+  return await _fileFromPath(path, ...args);
+}

package/src/_shims/fileFromPath.ts

@@ -0,0 +1,29 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ *
+ * This is a stub that gets replaced by fileFromPath.node.js for node environments
+ * in the package export map
+ */
+
+import type { FilePropertyBag, File } from './formdata';
+
+export type FileFromPathOptions = Omit<FilePropertyBag, 'lastModified'>;
+
+/**
+ * This is a stub for non-node environments that just throws an error.
+ * In node environments, this module will be replaced by util/node/fileFromPath by the
+ * package import map.
+ */
+export async function fileFromPath(path: string): Promise<File>;
+export async function fileFromPath(path: string, filename?: string): Promise<File>;
+export async function fileFromPath(path: string, options?: FileFromPathOptions): Promise<File>;
+export async function fileFromPath(
+  path: string,
+  filename?: string,
+  options?: FileFromPathOptions,
+): Promise<File>;
+export async function fileFromPath(): Promise<File> {
+  throw new Error(
+    'The `fileFromPath` function is only supported in Node. See the README for more details: https://www.github.com/Finch-API/finch-api-node#file-uploads',
+  );
+}

package/src/_shims/formdata.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import type { BlobPart } from '../uploads';
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+// Use builtin web types if present; else never (user should
+// add appropriate lib or types to tsconfig)
+
+// @ts-ignore
+type _FormData = unknown extends FormData ? never : FormData;
+// @ts-ignore
+type _File = unknown extends File ? never : File;
+// @ts-ignore
+type _Blob = unknown extends Blob ? never : Blob;
+
+declare const _FormData: {
+  new (form?: any): _FormData;
+  prototype: _FormData;
+};
+declare const _File: {
+  new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): _File;
+  prototype: _File;
+};
+declare const _Blob: {
+  new (blobParts?: BlobPart[] | undefined, options?: BlobPropertyBag | undefined): _Blob;
+  prototype: _Blob;
+};
+
+export const isPolyfilled = false;
+
+export { _FormData as FormData, _File as File, _Blob as Blob };

package/src/_shims/formdata.js

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+exports.FormData = FormData;
+exports.File = File;
+exports.Blob = Blob;
+
+exports.isPolyfilled = false;

package/src/_shims/formdata.mjs

@@ -0,0 +1,11 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const _FormData = FormData;
+const _File = File;
+const _Blob = Blob;
+
+export { _FormData as FormData, _File as File, _Blob as Blob };
+
+export const isPolyfilled = false;

package/src/_shims/formdata.node.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import * as fd from 'formdata-node';
+
+import type { BlobPart } from '../uploads';
+
+type EndingType = 'native' | 'transparent';
+
+export interface BlobPropertyBag {
+  endings?: EndingType;
+  type?: string;
+}
+
+export interface FilePropertyBag extends BlobPropertyBag {
+  lastModified?: number;
+}
+
+// Use builtin web types if present; else formdata-node types
+
+// @ts-ignore
+type _FormData = unknown extends FormData ? fd.FormData : FormData;
+// @ts-ignore
+type _File = unknown extends File ? fd.File : File;
+// @ts-ignore
+type _Blob = unknown extends Blob ? fd.Blob : Blob;
+
+declare const _FormData: {
+  new (form?: any): _FormData;
+  prototype: _FormData;
+};
+declare const _File: {
+  new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): _File;
+  prototype: _File;
+};
+declare const _Blob: {
+  new (blobParts?: BlobPart[] | undefined, options?: BlobPropertyBag | undefined): _Blob;
+  prototype: _Blob;
+};
+
+export const isPolyfilled = false;
+
+export { _FormData as FormData, _File as File, _Blob as Blob };

package/src/_shims/formdata.node.js

@@ -0,0 +1,11 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+const fd = require('formdata-node');
+
+exports.FormData = fd.FormData;
+exports.File = fd.File;
+exports.Blob = fd.Blob;
+
+exports.isPolyfilled = true;

package/src/_shims/formdata.node.mjs

@@ -0,0 +1,9 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { FormData, File, Blob } from 'formdata-node';
+
+export { FormData, File, Blob };
+
+export const isPolyfilled = true;

package/src/_shims/getMultipartRequestOptions.node.ts

@@ -0,0 +1,25 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { FormData } from './formdata.node';
+import type { RequestOptions } from '../core';
+import { Readable } from 'node:stream';
+import { FormDataEncoder } from 'form-data-encoder';
+import { MultipartBody } from '../uploads';
+
+export async function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+  form: FormData,
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T>> {
+  const encoder = new FormDataEncoder(form);
+  const readable = Readable.from(encoder);
+  const body = new MultipartBody(readable);
+  const headers = {
+    ...opts.headers,
+    ...encoder.headers,
+    'Content-Length': encoder.contentLength,
+  };
+
+  return { ...opts, body: body as any, headers };
+}

package/src/_shims/getMultipartRequestOptions.ts

@@ -0,0 +1,14 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+import { FormData } from './formdata';
+import type { RequestOptions } from '../core';
+import { MultipartBody } from '../uploads';
+
+export async function getMultipartRequestOptions<T extends {} = Record<string, unknown>>(
+  form: FormData,
+  opts: RequestOptions<T>,
+): Promise<RequestOptions<T>> {
+  return { ...opts, body: new MultipartBody(form) as any };
+}

package/src/_shims/node-readable.node.ts

@@ -0,0 +1,10 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+export type { Readable } from 'node:stream';
+import { ReadStream as FsReadStream } from 'node:fs';
+export type { FsReadStream };
+
+export function isFsReadStream(value: any): value is FsReadStream {
+  return value instanceof FsReadStream;
+}

package/src/_shims/node-readable.ts

@@ -0,0 +1,30 @@
+/**
+ * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
+ */
+
+// shim these Node types to avoid importing @types/node and polluting the user's
+// type environment in non-node projects
+
+export declare class Readable {
+  readable: boolean;
+  readonly readableEnded: boolean;
+  readonly readableFlowing: boolean | null;
+  readonly readableHighWaterMark: number;
+  readonly readableLength: number;
+  readonly readableObjectMode: boolean;
+  destroyed: boolean;
+  read(size?: number): any;
+  pause(): this;
+  resume(): this;
+  isPaused(): boolean;
+  destroy(error?: Error): this;
+  [Symbol.asyncIterator](): AsyncIterableIterator<any>;
+}
+
+export declare class FsReadStream extends Readable {
+  path: {}; // node type is string | Buffer
+}
+
+export function isFsReadStream(value: any): value is FsReadStream {
+  return false;
+}