@factorialco/api-client 3.0.0-beta.2027010100 → 4.0.0-beta.2027010101

package/dist/esm/errors.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Error types for the Factorial API client.
+ *
+ * Every non-2xx HTTP response is thrown as a {@link FactorialApiError} carrying
+ * the status, method, URL and parsed body. Transport failures (DNS, connection
+ * reset, aborted request) are *not* wrapped — they surface as the underlying
+ * error, typically a `TypeError` from `fetch`.
+ */
+/** Constructor payload for {@link FactorialApiError}. */
+export interface FactorialApiErrorInit {
+    /** HTTP status code, e.g. `401`. */
+    status: number;
+    /** HTTP reason phrase, e.g. `"Unauthorized"`. Empty over HTTP/2. */
+    statusText: string;
+    /** HTTP method of the failed request, e.g. `"GET"`. */
+    method: string;
+    /** Full request URL, including the query string. */
+    url: string;
+    /**
+     * Response body: the parsed JSON when the body was valid JSON, the raw string
+     * for non-JSON bodies, `undefined` when the body was empty.
+     */
+    body: unknown;
+    /** Response headers. Rate-limit and request-id headers live here. */
+    headers?: Headers;
+    /** The raw `Response`, when one was produced. */
+    response?: Response;
+}
+/**
+ * Thrown for every non-2xx response from the Factorial API.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await client.employees.employees.get({ path: { id: "1" } });
+ * } catch (err) {
+ *   if (err instanceof FactorialApiError) {
+ *     console.error(err.status, err.method, err.url, err.body);
+ *   } else {
+ *     throw err; // transport failure (e.g. a fetch TypeError)
+ *   }
+ * }
+ * ```
+ */
+export declare class FactorialApiError extends Error {
+    /** HTTP status code, e.g. `401`. */
+    readonly status: number;
+    /** HTTP reason phrase, e.g. `"Unauthorized"`. Empty over HTTP/2. */
+    readonly statusText: string;
+    /** HTTP method of the failed request, e.g. `"GET"`. */
+    readonly method: string;
+    /** Full request URL, including the query string. */
+    readonly url: string;
+    /**
+     * Response body: the parsed JSON when the body was valid JSON, the raw string
+     * for non-JSON bodies, `undefined` when the body was empty.
+     */
+    readonly body: unknown;
+    /**
+     * Response headers. Rate-limit and request-id headers live here.
+     *
+     * Non-enumerable, so logging the error stays readable.
+     */
+    readonly headers: Headers;
+    /**
+     * The raw `Response`. Its body stream has already been consumed to populate
+     * {@link FactorialApiError.body} — read that instead.
+     *
+     * Non-enumerable, so logging the error stays readable.
+     */
+    readonly response?: Response;
+    constructor(init: FactorialApiErrorInit);
+}
+/**
+ * `instanceof`-safe check for {@link FactorialApiError}.
+ *
+ * Prefer `err instanceof FactorialApiError`. Use this helper when two copies of
+ * the package may be loaded at once (the ESM + CJS dual-package hazard), where
+ * `instanceof` can fail across realm boundaries.
+ */
+export declare function isFactorialApiError(error: unknown): error is FactorialApiError;
+/**
+ * Converts the raw value thrown by the underlying fetch client for a non-2xx
+ * response (the parsed JSON body, the raw text, or `""`) into a
+ * {@link FactorialApiError}.
+ *
+ * Registered as the client's error interceptor by `FactorialClient`. Values
+ * that do not describe an HTTP error response are returned untouched:
+ *
+ * - no `Response` — a transport failure such as a `fetch` `TypeError`
+ * - an ok `Response` — a failure while parsing a 2xx body
+ * - an `Error` instance — already a usable error, e.g. thrown by a user
+ *   interceptor
+ */
+export declare function toFactorialApiError(error: unknown, response: Response | undefined, request: Request | undefined): unknown;
+//# sourceMappingURL=errors.d.ts.map

package/dist/esm/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,yDAAyD;AACzD,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IACd,qEAAqE;IACrE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,oCAAoC;IACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,oEAAoE;IACpE,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,uDAAuD;IACvD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAG,OAAO,CAAC;IAC3B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;gBAEjB,IAAI,EAAE,qBAAqB;CAwBxC;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,iBAAiB,CAO9E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,OAAO,EACd,QAAQ,EAAE,QAAQ,GAAG,SAAS,EAC9B,OAAO,EAAE,OAAO,GAAG,SAAS,GAC3B,OAAO,CAaT"}

package/dist/esm/errors.js

@@ -0,0 +1,149 @@
+/**
+ * Error types for the Factorial API client.
+ *
+ * Every non-2xx HTTP response is thrown as a {@link FactorialApiError} carrying
+ * the status, method, URL and parsed body. Transport failures (DNS, connection
+ * reset, aborted request) are *not* wrapped — they surface as the underlying
+ * error, typically a `TypeError` from `fetch`.
+ */
+/**
+ * Thrown for every non-2xx response from the Factorial API.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await client.employees.employees.get({ path: { id: "1" } });
+ * } catch (err) {
+ *   if (err instanceof FactorialApiError) {
+ *     console.error(err.status, err.method, err.url, err.body);
+ *   } else {
+ *     throw err; // transport failure (e.g. a fetch TypeError)
+ *   }
+ * }
+ * ```
+ */
+export class FactorialApiError extends Error {
+    /** HTTP status code, e.g. `401`. */
+    status;
+    /** HTTP reason phrase, e.g. `"Unauthorized"`. Empty over HTTP/2. */
+    statusText;
+    /** HTTP method of the failed request, e.g. `"GET"`. */
+    method;
+    /** Full request URL, including the query string. */
+    url;
+    /**
+     * Response body: the parsed JSON when the body was valid JSON, the raw string
+     * for non-JSON bodies, `undefined` when the body was empty.
+     */
+    body;
+    /**
+     * Response headers. Rate-limit and request-id headers live here.
+     *
+     * Non-enumerable, so logging the error stays readable.
+     */
+    headers;
+    /**
+     * The raw `Response`. Its body stream has already been consumed to populate
+     * {@link FactorialApiError.body} — read that instead.
+     *
+     * Non-enumerable, so logging the error stays readable.
+     */
+    response;
+    constructor(init) {
+        super(formatMessage(init));
+        this.name = "FactorialApiError";
+        this.status = init.status;
+        this.statusText = init.statusText;
+        this.method = init.method;
+        this.url = init.url;
+        this.body = init.body;
+        // `headers` and `response` are hidden from enumeration: console.error(err)
+        // and JSON.stringify(err) would otherwise dump the whole Response object,
+        // burying the fields that identify the failure.
+        Object.defineProperty(this, "headers", {
+            value: init.headers ?? new Headers(),
+            enumerable: false,
+            writable: false,
+            configurable: true,
+        });
+        Object.defineProperty(this, "response", {
+            value: init.response,
+            enumerable: false,
+            writable: false,
+            configurable: true,
+        });
+    }
+}
+/**
+ * `instanceof`-safe check for {@link FactorialApiError}.
+ *
+ * Prefer `err instanceof FactorialApiError`. Use this helper when two copies of
+ * the package may be loaded at once (the ESM + CJS dual-package hazard), where
+ * `instanceof` can fail across realm boundaries.
+ */
+export function isFactorialApiError(error) {
+    return (error instanceof FactorialApiError ||
+        (typeof error === "object" &&
+            error !== null &&
+            error.name === "FactorialApiError"));
+}
+/**
+ * Converts the raw value thrown by the underlying fetch client for a non-2xx
+ * response (the parsed JSON body, the raw text, or `""`) into a
+ * {@link FactorialApiError}.
+ *
+ * Registered as the client's error interceptor by `FactorialClient`. Values
+ * that do not describe an HTTP error response are returned untouched:
+ *
+ * - no `Response` — a transport failure such as a `fetch` `TypeError`
+ * - an ok `Response` — a failure while parsing a 2xx body
+ * - an `Error` instance — already a usable error, e.g. thrown by a user
+ *   interceptor
+ */
+export function toFactorialApiError(error, response, request) {
+    if (response === undefined || response.ok)
+        return error;
+    if (error instanceof Error)
+        return error;
+    return new FactorialApiError({
+        status: response.status,
+        statusText: response.statusText,
+        method: request?.method ?? "UNKNOWN",
+        url: request?.url ?? response.url,
+        // An empty body reaches us as "" because JSON.parse("") throws upstream.
+        body: error === "" ? undefined : error,
+        headers: response.headers,
+        response,
+    });
+}
+/** Longest body excerpt appended to the error message. */
+const EXCERPT_MAX_LENGTH = 200;
+function formatMessage({ status, statusText, method, url, body, }) {
+    const head = `Factorial API ${status}${statusText ? ` ${statusText}` : ""}: ${method} ${url}`;
+    const excerpt = bodyExcerpt(body);
+    return excerpt ? `${head} — ${excerpt}` : head;
+}
+function bodyExcerpt(body) {
+    if (body === undefined || body === null || body === "")
+        return undefined;
+    let text;
+    if (typeof body === "string") {
+        text = body;
+    }
+    else {
+        try {
+            text = JSON.stringify(body) ?? String(body);
+        }
+        catch {
+            // Circular structures and BigInt values make JSON.stringify throw.
+            text = String(body);
+        }
+    }
+    const oneLine = text.replace(/\s+/g, " ").trim();
+    if (!oneLine)
+        return undefined;
+    return oneLine.length > EXCERPT_MAX_LENGTH
+        ? `${oneLine.slice(0, EXCERPT_MAX_LENGTH)}…`
+        : oneLine;
+}
+//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAuBH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,oCAAoC;IAC3B,MAAM,CAAS;IACxB,oEAAoE;IAC3D,UAAU,CAAS;IAC5B,uDAAuD;IAC9C,MAAM,CAAS;IACxB,oDAAoD;IAC3C,GAAG,CAAS;IACrB;;;OAGG;IACM,IAAI,CAAU;IACvB;;;;OAIG;IACM,OAAO,CAAW;IAC3B;;;;;OAKG;IACM,QAAQ,CAAY;IAE7B,YAAY,IAA2B;QACrC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,2EAA2E;QAC3E,0EAA0E;QAC1E,gDAAgD;QAChD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE;YACrC,KAAK,EAAE,IAAI,CAAC,OAAO,IAAI,IAAI,OAAO,EAAE;YACpC,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE;YACtC,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,KAAK;YACf,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAc;IAChD,OAAO,CACL,KAAK,YAAY,iBAAiB;QAClC,CAAC,OAAO,KAAK,KAAK,QAAQ;YACxB,KAAK,KAAK,IAAI;YACb,KAA4B,CAAC,IAAI,KAAK,mBAAmB,CAAC,CAC9D,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,KAAc,EACd,QAA8B,EAC9B,OAA4B;IAE5B,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,YAAY,KAAK;QAAE,OAAO,KAAK,CAAC;IACzC,OAAO,IAAI,iBAAiB,CAAC;QAC3B,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,SAAS;QACpC,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,QAAQ,CAAC,GAAG;QACjC,yEAAyE;QACzE,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK;QACtC,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,QAAQ;KACT,CAAC,CAAC;AACL,CAAC;AAED,0DAA0D;AAC1D,MAAM,kBAAkB,GAAG,GAAG,CAAC;AAE/B,SAAS,aAAa,CAAC,EACrB,MAAM,EACN,UAAU,EACV,MAAM,EACN,GAAG,EACH,IAAI,GACkB;IACtB,MAAM,IAAI,GAAG,iBAAiB,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,IAAI,GAAG,EAAE,CAAC;IAC9F,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACjD,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IAEzE,IAAI,IAAY,CAAC;IACjB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,IAAI,GAAG,IAAI,CAAC;IACd,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,MAAM,CAAC;YACP,mEAAmE;YACnE,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IACjD,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IAC/B,OAAO,OAAO,CAAC,MAAM,GAAG,kBAAkB;QACxC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC,GAAG;QAC5C,CAAC,CAAC,OAAO,CAAC;AACd,CAAC"}

package/dist/esm/generated/sdk.gen.d.ts

@@ -1295,13 +1295,13 @@ export declare const getApi20270101ResourcesEmployeeUpdatesAbsencesById: <ThrowO
 /**
  * Reads all Contract changes
  *
- * This endpoint can be used to retrieve a list of contract changes `employee updates` details.
+ * This endpoint can be used to retrieve a list of contract changes `employee updates` details. It covers updates to the contract conditions as well as the activity changes of fixed-discontinuous contracts, told apart by `type`.
  */
 export declare const getApi20270101ResourcesEmployeeUpdatesContractChanges: <ThrowOnError extends boolean = false>(options?: Options<GetApi20270101ResourcesEmployeeUpdatesContractChangesData, ThrowOnError>) => RequestResult<GetApi20270101ResourcesEmployeeUpdatesContractChangesResponses, unknown, ThrowOnError>;
 /**
  * Reads a single Contract change
  *
- * This endpoint can be used to retrieve a list of contract changes `employee updates` details.
+ * This endpoint can be used to retrieve a list of contract changes `employee updates` details. It covers updates to the contract conditions as well as the activity changes of fixed-discontinuous contracts, told apart by `type`.
  */
 export declare const getApi20270101ResourcesEmployeeUpdatesContractChangesById: <ThrowOnError extends boolean = false>(options: Options<GetApi20270101ResourcesEmployeeUpdatesContractChangesByIdData, ThrowOnError>) => RequestResult<GetApi20270101ResourcesEmployeeUpdatesContractChangesByIdResponses, unknown, ThrowOnError>;
 /**

package/dist/esm/generated/sdk.gen.js

@@ -2425,7 +2425,7 @@ export const getApi20270101ResourcesEmployeeUpdatesAbsencesById = (options) => (
 /**
  * Reads all Contract changes
  *
- * This endpoint can be used to retrieve a list of contract changes `employee updates` details.
+ * This endpoint can be used to retrieve a list of contract changes `employee updates` details. It covers updates to the contract conditions as well as the activity changes of fixed-discontinuous contracts, told apart by `type`.
  */
 export const getApi20270101ResourcesEmployeeUpdatesContractChanges = (options) => (options?.client ?? client).get({
     security: [{ scheme: 'bearer', type: 'http' }, { name: 'x-api-key', type: 'apiKey' }],
@@ -2435,7 +2435,7 @@ export const getApi20270101ResourcesEmployeeUpdatesContractChanges = (options) =
 /**
  * Reads a single Contract change
  *
- * This endpoint can be used to retrieve a list of contract changes `employee updates` details.
+ * This endpoint can be used to retrieve a list of contract changes `employee updates` details. It covers updates to the contract conditions as well as the activity changes of fixed-discontinuous contracts, told apart by `type`.
  */
 export const getApi20270101ResourcesEmployeeUpdatesContractChangesById = (options) => (options.client ?? client).get({
     security: [{ scheme: 'bearer', type: 'http' }, { name: 'x-api-key', type: 'apiKey' }],

package/dist/esm/generated/types.gen.d.ts

@@ -3337,6 +3337,14 @@ export type EmployeeUpdatesContractChange = {
      * The status of the contract change incidence
      */
     status: string;
+    /**
+     * The kind of contract change. `contract` is an update to the contract conditions. `contract_deactivation` and `contract_reactivation` close and reopen an activity period of a fixed-discontinuous contract, and carry the conditions of the contract version in force on that date.
+     */
+    type: string;
+    /**
+     * The date the activity period closed or reopened, for a `contract_deactivation` or `contract_reactivation`. Null for a plain `contract` change, whose date is `effective_on`. The other dates on this payload belong to the contract version in force on this date, not to the activity change itself.
+     */
+    activity_changed_on?: string;
     /**
      * The effective date of the contract
      */
@@ -3489,6 +3497,9 @@ export type EmployeeUpdatesContractChange = {
      * The work type name on the contract change
      */
     fr_work_type_name?: string;
+    /**
+     * The ids of the additional compensations on the contract change
+     */
     compensation_ids?: Array<string>;
     /**
      * The contract type id on the contract change
@@ -3514,7 +3525,13 @@ export type EmployeeUpdatesContractChange = {
      * The contract type name on the contract change
      */
     pt_contract_type_name?: string;
+    /**
+     * Time the contract change incidence was created
+     */
     created_at: string;
+    /**
+     * Time the contract change incidence was last updated
+     */
     updated_at: string;
 };
 export type EmployeeUpdatesNewHire = {
@@ -3990,7 +4007,7 @@ export type ExpensesExpense = {
      */
     external_authorization_id?: string;
     /**
-     * The id of the card
+     * The id of the Factorial card the expense was paid with. It is set on every expense raised from a Factorial card payment or dispute and null on every other expense, including one paid with a card from another provider, so it is how to tell Factorial card spend apart. GraphQL exposes it as the `factorialCard` relation and deprecates the raw id.
      */
     expenses_card_id?: string;
     /**
@@ -4046,11 +4063,11 @@ export type ExpensesExpense = {
      */
     document_type?: string;
     /**
-     * The payment of the expense
+     * Who paid, one of 'reimbursable' (the employee paid with their own money and is owed it back) or 'not_reimbursable' (the company paid, with a Factorial card, another corporate card or company cash).
      */
     payment?: 'reimbursable' | 'not_reimbursable';
     /**
-     * The method of the payment
+     * How the expense was paid, as the id of an option in the company's payment-method list, or null when the employee left it empty. The built-in ids are 'personal_debit_card', 'personal_credit_card' and 'cash' under a reimbursable payment, and 'factorial_card', 'corporate_debit_card', 'corporate_credit_card' and 'company_cash' under a not-reimbursable one; a company can add options with ids of its own. A corporate card from another provider is one of the 'corporate_*' options, chosen by the employee. To tell Factorial card spend apart, use `expenses_card_id` — the `factorialCard` relation in GraphQL — rather than 'factorial_card'.
      */
     payment_method?: string;
     /**