@tryfinch/finch-api 5.0.0 → 5.2.0

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

@@ -1,64 +0,0 @@
-/**
- * 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;
-type _ResponseType =
-  // @ts-ignore
-  unknown extends ResponseType ? 'basic' | 'cors' | 'default' | 'error' | 'opaque' | 'opaqueredirect'
-  : // @ts-ignore
-    ResponseType;
-// @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,
-  _ResponseType as ResponseType,
-  _BodyInit as BodyInit,
-  _HeadersInit as HeadersInit,
-};

package/src/_shims/fetch.node.js

@@ -1,12 +0,0 @@
-/**
- * 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

@@ -1,14 +0,0 @@
-/**
- * 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

@@ -1,29 +0,0 @@
-/**
- * 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.js';
-
-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

@@ -1,29 +0,0 @@
-/**
- * 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.js';
-
-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

@@ -1,43 +0,0 @@
-/**
- * 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.deno.ts

@@ -1,16 +0,0 @@
-type _BlobPropertyBag = BlobPropertyBag;
-type _FilePropertyBag = FilePropertyBag;
-
-const _FormData = FormData;
-const _File = File;
-const _Blob = Blob;
-
-export const isPolyfilled = false;
-
-export {
-  _FormData as FormData,
-  _File as File,
-  _Blob as Blob,
-  type _BlobPropertyBag as BlobPropertyBag,
-  type _FilePropertyBag as FilePropertyBag,
-};

package/src/_shims/formdata.js

@@ -1,17 +0,0 @@
-/**
- * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
- */
-
-exports.FormData = FormData;
-exports.Blob = Blob;
-exports.File =
-  typeof File !== 'undefined' ? File : (
-    // Bun doesn't implement File yet, so just make a shim that throws a helpful error message
-    class File extends Blob {
-      constructor() {
-        throw new Error(`file uploads aren't supported in this environment yet as 'File' is not defined`);
-      }
-    }
-  );
-
-exports.isPolyfilled = false;

package/src/_shims/formdata.mjs

@@ -1,20 +0,0 @@
-/**
- * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
- */
-
-const _FormData = FormData;
-const _Blob = Blob;
-
-const _File =
-  typeof File !== 'undefined' ? File : (
-    // Bun doesn't implement File yet, so just make a shim that throws a helpful error message
-    class File extends Blob {
-      constructor() {
-        throw new Error(`file uploads aren't supported in this environment yet as 'File' is not defined`);
-      }
-    }
-  );
-
-export { _FormData as FormData, _File as File, _Blob as Blob };
-
-export const isPolyfilled = false;

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

@@ -1,45 +0,0 @@
-/**
- * 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;
-  /** MIME type, e.g., "text/plain" */
-  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

@@ -1,11 +0,0 @@
-/**
- * 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

@@ -1,9 +0,0 @@
-/**
- * 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

@@ -1,25 +0,0 @@
-/**
- * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
- */
-
-import { FormData } from './formdata.node.js';
-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

@@ -1,14 +0,0 @@
-/**
- * Disclaimer: modules in _shims aren't intended to be imported by SDK users.
- */
-
-import { FormData } from './formdata.js';
-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

@@ -1,10 +0,0 @@
-/**
- * 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

@@ -1,30 +0,0 @@
-/**
- * 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;
-}

package/src/resources/ats/applications.ts

@@ -1,64 +0,0 @@
-// File generated from our OpenAPI spec by Stainless.
-
-import * as Core from '../../core';
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Stages from './stages';
-import * as API from './index';
-import { ApplicationsPage, ApplicationsPageParams } from '../../pagination';
-
-export class Applications extends APIResource {
-  /**
-   * Gets an application from an organization.
-   */
-  retrieve(applicationId: string, options?: Core.RequestOptions): Core.APIPromise<Application> {
-    return this.get(`/ats/applications/${applicationId}`, options);
-  }
-
-  /**
-   * Gets all of an organization's applications.
-   */
-  list(
-    query?: ApplicationListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<ApplicationsPage, Application>;
-  list(options?: Core.RequestOptions): Core.PagePromise<ApplicationsPage, Application>;
-  list(
-    query: ApplicationListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<ApplicationsPage, Application> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this.getAPIList('/ats/applications', ApplicationsPage, { query, ...options });
-  }
-}
-
-export interface Application {
-  id: string;
-
-  candidate_id: string;
-
-  job_id: string;
-
-  offer_id: string | null;
-
-  rejected_at: string | null;
-
-  rejected_reason: Application.RejectedReason | null;
-
-  stage: Stages.Stage | null;
-}
-
-export namespace Application {
-  export interface RejectedReason {
-    text?: string | null;
-  }
-}
-
-export interface ApplicationListParams extends ApplicationsPageParams {}
-
-export namespace Applications {
-  export import Application = API.Application;
-  export import ApplicationListParams = API.ApplicationListParams;
-}

package/src/resources/ats/ats.ts

@@ -1,39 +0,0 @@
-// File generated from our OpenAPI spec by Stainless.
-
-import { APIResource } from '../../resource';
-import { Candidates } from './candidates';
-import { Applications } from './applications';
-import { Stages } from './stages';
-import { Jobs } from './jobs';
-import { Offers } from './offers';
-import * as API from './index';
-
-export class ATS extends APIResource {
-  candidates: Candidates = new Candidates(this.client);
-  applications: Applications = new Applications(this.client);
-  stages: Stages = new Stages(this.client);
-  jobs: Jobs = new Jobs(this.client);
-  offers: Offers = new Offers(this.client);
-}
-
-export namespace ATS {
-  export import Candidates = API.Candidates;
-  export import Candidate = API.Candidate;
-  export import CandidateListParams = API.CandidateListParams;
-
-  export import Applications = API.Applications;
-  export import Application = API.Application;
-  export import ApplicationListParams = API.ApplicationListParams;
-
-  export import Stages = API.Stages;
-  export import Stage = API.Stage;
-  export import StagesSinglePage = API.StagesSinglePage;
-
-  export import Jobs = API.Jobs;
-  export import Job = API.Job;
-  export import JobListParams = API.JobListParams;
-
-  export import Offers = API.Offers;
-  export import Offer = API.Offer;
-  export import OfferListParams = API.OfferListParams;
-}

package/src/resources/ats/candidates.ts

@@ -1,83 +0,0 @@
-// File generated from our OpenAPI spec by Stainless.
-
-import * as Core from '../../core';
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as API from './index';
-import { CandidatesPage, CandidatesPageParams } from '../../pagination';
-
-export class Candidates extends APIResource {
-  /**
-   * Gets a candidate from an organization. A candidate represents an individual
-   * associated with one or more applications.
-   */
-  retrieve(candidateId: string, options?: Core.RequestOptions): Core.APIPromise<Candidate> {
-    return this.get(`/ats/candidates/${candidateId}`, options);
-  }
-
-  /**
-   * Gets all of an organization's candidates. A candidate represents an individual
-   * associated with one or more applications.
-   */
-  list(
-    query?: CandidateListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<CandidatesPage, Candidate>;
-  list(options?: Core.RequestOptions): Core.PagePromise<CandidatesPage, Candidate>;
-  list(
-    query: CandidateListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<CandidatesPage, Candidate> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this.getAPIList('/ats/candidates', CandidatesPage, { query, ...options });
-  }
-}
-
-/**
- * A candidate represents an individual associated with one or more applications.
- */
-export interface Candidate {
-  id: string;
-
-  /**
-   * Array of Finch uuids corresponding to `application`s for this individual
-   */
-  application_ids: Array<string>;
-
-  created_at: string;
-
-  emails: Array<Candidate.Email>;
-
-  first_name: string | null;
-
-  full_name: string | null;
-
-  last_activity_at: string;
-
-  last_name: string | null;
-
-  phone_numbers: Array<Candidate.PhoneNumber>;
-}
-
-export namespace Candidate {
-  export interface Email {
-    data?: string | null;
-
-    type?: string | null;
-  }
-
-  export interface PhoneNumber {
-    data?: string | null;
-
-    type?: string | null;
-  }
-}
-
-export interface CandidateListParams extends CandidatesPageParams {}
-
-export namespace Candidates {
-  export import Candidate = API.Candidate;
-  export import CandidateListParams = API.CandidateListParams;
-}

package/src/resources/ats/index.ts

@@ -1,8 +0,0 @@
-// File generated from our OpenAPI spec by Stainless.
-
-export { ATS } from './ats';
-export { Application, ApplicationListParams, Applications } from './applications';
-export { Candidate, CandidateListParams, Candidates } from './candidates';
-export { Job, JobListParams, Jobs } from './jobs';
-export { Offer, OfferListParams, Offers } from './offers';
-export { Stage, StagesSinglePage, Stages } from './stages';

package/src/resources/ats/jobs.ts

@@ -1,76 +0,0 @@
-// File generated from our OpenAPI spec by Stainless.
-
-import * as Core from '../../core';
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as API from './index';
-import { JobsPage, JobsPageParams } from '../../pagination';
-
-export class Jobs extends APIResource {
-  /**
-   * Gets a job from an organization.
-   */
-  retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<Job> {
-    return this.get(`/ats/jobs/${jobId}`, options);
-  }
-
-  /**
-   * Gets all of an organization's jobs.
-   */
-  list(query?: JobListParams, options?: Core.RequestOptions): Core.PagePromise<JobsPage, Job>;
-  list(options?: Core.RequestOptions): Core.PagePromise<JobsPage, Job>;
-  list(
-    query: JobListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<JobsPage, Job> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this.getAPIList('/ats/jobs', JobsPage, { query, ...options });
-  }
-}
-
-export interface Job {
-  id: string;
-
-  closed_at: string | null;
-
-  created_at: string | null;
-
-  department: Job.Department;
-
-  hiring_team: Job.HiringTeam;
-
-  name: string | null;
-
-  status: 'open' | 'closed' | 'on_hold' | 'draft' | 'archived' | null;
-}
-
-export namespace Job {
-  export interface Department {
-    name?: string | null;
-  }
-
-  export interface HiringTeam {
-    hiring_managers?: Array<HiringTeam.HiringManager> | null;
-
-    recruiters?: Array<HiringTeam.Recruiter> | null;
-  }
-
-  export namespace HiringTeam {
-    export interface HiringManager {
-      name?: string;
-    }
-
-    export interface Recruiter {
-      name?: string;
-    }
-  }
-}
-
-export interface JobListParams extends JobsPageParams {}
-
-export namespace Jobs {
-  export import Job = API.Job;
-  export import JobListParams = API.JobListParams;
-}