@rippling/rippling-sdk 0.2.0-alpha.20

package/resources/compensations.d.ts

@@ -0,0 +1,250 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import * as WorkersAPI from "./workers.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Compensations extends APIResource {
+    /**
+     * Retrieves the Compensation for the Worker with the ID provided in the URL path.
+     */
+    retrieve(id: string, query?: CompensationRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<CompensationRetrieveResponse>;
+    /**
+     * A List of compensations
+     *
+     * - Requires: `API Tier 2`
+     * - Expandable fields: `worker`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: CompensationListParams | null | undefined, options?: RequestOptions): PagePromise<CompensationsPageCursorURL, Compensation>;
+}
+export type CompensationsPageCursorURL = PageCursorURL<Compensation>;
+export interface Compensation {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The worker's annual compensation. This calculation assumes 40-hour work weeks
+     * for workers with an hourly wage.
+     */
+    annual_compensation?: Compensation.AnnualCompensation;
+    /**
+     * The worker's annual salary equivalent, for insurance purposes. It will be equal
+     * to the worker's annual compensation, except for owners that are receiving no
+     * cashcompensation.
+     */
+    annual_salary_equivalent?: Compensation.AnnualSalaryEquivalent;
+    /**
+     * The worker's bonus schedule.
+     */
+    bonus_schedule?: string;
+    /**
+     * The worker's hourly wage. This calculation assumes 40-hour work weeks for
+     * workers with fixed compensation.
+     */
+    hourly_wage?: Compensation.HourlyWage;
+    /**
+     * The worker's monthly compensation. This calculation assumes 40-hour work weeks
+     * for workers with an hourly wage.
+     */
+    monthly_compensation?: Compensation.MonthlyCompensation;
+    /**
+     * The worker's on-target commission.
+     */
+    on_target_commission?: Compensation.OnTargetCommission;
+    /**
+     * The payment terms for an worker's compensation.
+     */
+    payment_terms?: string;
+    /**
+     * The payment type for an worker's compensation.
+     */
+    payment_type?: string;
+    /**
+     * The worker's hourly wage. This calculation assumes 40-hour work weeks for
+     * workers with fixed compensation.
+     */
+    relocation_reimbursement?: Compensation.RelocationReimbursement;
+    /**
+     * Salary effective date
+     */
+    salary_effective_date?: string;
+    /**
+     * The worker's signing bonus.
+     */
+    signing_bonus?: Compensation.SigningBonus;
+    /**
+     * The worker's target annual bonus amount.
+     */
+    target_annual_bonus?: Compensation.TargetAnnualBonus;
+    /**
+     * The worker's target annual bonus as a percent of annual compensation.
+     */
+    target_annual_bonus_percent?: number;
+    /**
+     * The worker's weekly compensation. This calculation assumes 40-hour work weeks
+     * for workers with an hourly wage.
+     */
+    weekly_compensation?: Compensation.WeeklyCompensation;
+    /**
+     * The worker's details.
+     *
+     * Expandable field
+     */
+    worker?: WorkersAPI.Worker;
+    /**
+     * The worker's ID.
+     */
+    worker_id?: string;
+}
+export declare namespace Compensation {
+    /**
+     * The worker's annual compensation. This calculation assumes 40-hour work weeks
+     * for workers with an hourly wage.
+     */
+    interface AnnualCompensation {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's annual salary equivalent, for insurance purposes. It will be equal
+     * to the worker's annual compensation, except for owners that are receiving no
+     * cashcompensation.
+     */
+    interface AnnualSalaryEquivalent {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's hourly wage. This calculation assumes 40-hour work weeks for
+     * workers with fixed compensation.
+     */
+    interface HourlyWage {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's monthly compensation. This calculation assumes 40-hour work weeks
+     * for workers with an hourly wage.
+     */
+    interface MonthlyCompensation {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's on-target commission.
+     */
+    interface OnTargetCommission {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's hourly wage. This calculation assumes 40-hour work weeks for
+     * workers with fixed compensation.
+     */
+    interface RelocationReimbursement {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's signing bonus.
+     */
+    interface SigningBonus {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's target annual bonus amount.
+     */
+    interface TargetAnnualBonus {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+    /**
+     * The worker's weekly compensation. This calculation assumes 40-hour work weeks
+     * for workers with an hourly wage.
+     */
+    interface WeeklyCompensation {
+        /**
+         * The currency type, ex: USD, EUR, etc.
+         */
+        currency_type?: string;
+        /**
+         * The decimal amount for the currency.
+         */
+        value?: number;
+    }
+}
+/**
+ * Meta information for the response.
+ */
+export interface CompensationRetrieveResponse extends BusinessPartnersAPI.Meta, Compensation {
+}
+export interface CompensationRetrieveParams {
+    expand?: string;
+}
+export interface CompensationListParams {
+    expand?: string;
+    order_by?: string;
+}
+export declare namespace Compensations {
+    export { type Compensation as Compensation, type CompensationRetrieveResponse as CompensationRetrieveResponse, type CompensationsPageCursorURL as CompensationsPageCursorURL, type CompensationRetrieveParams as CompensationRetrieveParams, type CompensationListParams as CompensationListParams, };
+}
+//# sourceMappingURL=compensations.d.ts.map

package/resources/compensations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compensations.d.ts","sourceRoot":"","sources":["../src/resources/compensations.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,0BAA0B,EAAE,YAAY,CAAC;CAGzD;AAED,MAAM,MAAM,0BAA0B,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAErE,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;IAEtD;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,YAAY,CAAC,sBAAsB,CAAC;IAE/D;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;IAEtC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,YAAY,CAAC,mBAAmB,CAAC;IAExD;;OAEG;IACH,oBAAoB,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;IAEvD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,YAAY,CAAC,uBAAuB,CAAC;IAEhE;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IAE1C;;OAEG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;IAErD;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;IAEtD;;;;OAIG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,YAAY,CAAC;IAC5B;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;;OAIG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,mBAAmB,CAAC,IAAI,EAAE,YAAY;CAAG;AAE/F,MAAM,WAAW,0BAA0B;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/compensations.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Compensations = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class Compensations extends resource_1.APIResource {
+    /**
+     * Retrieves the Compensation for the Worker with the ID provided in the URL path.
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/compensations/${id}`, { query, ...options });
+    }
+    /**
+     * A List of compensations
+     *
+     * - Requires: `API Tier 2`
+     * - Expandable fields: `worker`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/compensations', (pagination_1.PageCursorURL), { query, ...options });
+    }
+}
+exports.Compensations = Compensations;
+//# sourceMappingURL=compensations.js.map

package/resources/compensations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compensations.js","sourceRoot":"","sources":["../src/resources/compensations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,kBAAkB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,0BAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF;AAzBD,sCAyBC"}

package/resources/compensations.mjs

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Compensations extends APIResource {
+    /**
+     * Retrieves the Compensation for the Worker with the ID provided in the URL path.
+     */
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/compensations/${id}`, { query, ...options });
+    }
+    /**
+     * A List of compensations
+     *
+     * - Requires: `API Tier 2`
+     * - Expandable fields: `worker`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/compensations', (PageCursorURL), { query, ...options });
+    }
+}
+//# sourceMappingURL=compensations.mjs.map

package/resources/compensations.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"compensations.mjs","sourceRoot":"","sources":["../src/resources/compensations.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,aAAa,EAAe;OAE9B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,kBAAkB,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CACF,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,aAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;CACF"}

package/resources/custom-fields.d.mts

@@ -0,0 +1,50 @@
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class CustomFields extends APIResource {
+    /**
+     * A List of custom fields
+     *
+     * - Requires: `API Tier 1`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: CustomFieldListParams | null | undefined, options?: RequestOptions): PagePromise<CustomFieldListResponsesPageCursorURL, CustomFieldListResponse>;
+}
+export type CustomFieldListResponsesPageCursorURL = PageCursorURL<CustomFieldListResponse>;
+export interface CustomFieldListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * The name of the custom field.
+     */
+    name: string;
+    /**
+     * The data type of the custom field.
+     */
+    type: 'TEXT' | 'DATE' | 'NUMBER' | 'CURRENCY' | 'PERCENTAGE' | 'SELECT' | 'FILE' | 'ID' | 'RADIO' | 'TEXTAREA' | 'RANGE' | 'REFERENCE_ID' | 'BOOLEAN' | 'ADDRESS' | 'OG_REFERENCE_FIELD' | 'NATIVE_EDGE' | 'DATETIME' | 'EMAIL' | 'URL';
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The description of the custom field.
+     */
+    description?: string;
+    /**
+     * Whether the custom field is required.
+     */
+    required?: boolean;
+}
+export interface CustomFieldListParams {
+    order_by?: string;
+}
+export declare namespace CustomFields {
+    export { type CustomFieldListResponse as CustomFieldListResponse, type CustomFieldListResponsesPageCursorURL as CustomFieldListResponsesPageCursorURL, type CustomFieldListParams as CustomFieldListParams, };
+}
+//# sourceMappingURL=custom-fields.d.mts.map

package/resources/custom-fields.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.mts","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;CAM/E;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,MAAM,GACN,MAAM,GACN,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,IAAI,GACJ,OAAO,GACP,UAAU,GACV,OAAO,GACP,cAAc,GACd,SAAS,GACT,SAAS,GACT,oBAAoB,GACpB,aAAa,GACb,UAAU,GACV,OAAO,GACP,KAAK,CAAC;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/custom-fields.d.ts

@@ -0,0 +1,50 @@
+import { APIResource } from "../core/resource.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class CustomFields extends APIResource {
+    /**
+     * A List of custom fields
+     *
+     * - Requires: `API Tier 1`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: CustomFieldListParams | null | undefined, options?: RequestOptions): PagePromise<CustomFieldListResponsesPageCursorURL, CustomFieldListResponse>;
+}
+export type CustomFieldListResponsesPageCursorURL = PageCursorURL<CustomFieldListResponse>;
+export interface CustomFieldListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * The name of the custom field.
+     */
+    name: string;
+    /**
+     * The data type of the custom field.
+     */
+    type: 'TEXT' | 'DATE' | 'NUMBER' | 'CURRENCY' | 'PERCENTAGE' | 'SELECT' | 'FILE' | 'ID' | 'RADIO' | 'TEXTAREA' | 'RANGE' | 'REFERENCE_ID' | 'BOOLEAN' | 'ADDRESS' | 'OG_REFERENCE_FIELD' | 'NATIVE_EDGE' | 'DATETIME' | 'EMAIL' | 'URL';
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The description of the custom field.
+     */
+    description?: string;
+    /**
+     * Whether the custom field is required.
+     */
+    required?: boolean;
+}
+export interface CustomFieldListParams {
+    order_by?: string;
+}
+export declare namespace CustomFields {
+    export { type CustomFieldListResponse as CustomFieldListResponse, type CustomFieldListResponsesPageCursorURL as CustomFieldListResponsesPageCursorURL, type CustomFieldListParams as CustomFieldListParams, };
+}
+//# sourceMappingURL=custom-fields.d.ts.map

package/resources/custom-fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.d.ts","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,uBAAuB,CAAC;CAM/E;AAED,MAAM,MAAM,qCAAqC,GAAG,aAAa,CAAC,uBAAuB,CAAC,CAAC;AAE3F,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EACA,MAAM,GACN,MAAM,GACN,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,IAAI,GACJ,OAAO,GACP,UAAU,GACV,OAAO,GACP,cAAc,GACd,SAAS,GACT,SAAS,GACT,oBAAoB,GACpB,aAAa,GACb,UAAU,GACV,OAAO,GACP,KAAK,CAAC;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/custom-fields.js

@@ -0,0 +1,22 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFields = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+class CustomFields extends resource_1.APIResource {
+    /**
+     * A List of custom fields
+     *
+     * - Requires: `API Tier 1`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/custom-fields', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+}
+exports.CustomFields = CustomFields;
+//# sourceMappingURL=custom-fields.js.map

package/resources/custom-fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.js","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;OAKG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,0BAAsC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAhBD,oCAgBC"}

package/resources/custom-fields.mjs

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { PageCursorURL } from "../core/pagination.mjs";
+export class CustomFields extends APIResource {
+    /**
+     * A List of custom fields
+     *
+     * - Requires: `API Tier 1`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/custom-fields', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=custom-fields.mjs.map

package/resources/custom-fields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-fields.mjs","sourceRoot":"","sources":["../src/resources/custom-fields.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,aAAa,EAAe;AAGrC,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;OAKG;IACH,IAAI,CACF,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,aAAsC,CAAA,EAAE;YACvF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/custom-objects/custom-objects.d.mts

@@ -0,0 +1,103 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as FieldsAPI from "./fields.mjs";
+import { CustomObjectField, CustomObjectFieldsPageCursorURL, FieldCreateParams, FieldUpdateParams, Fields } from "./fields.mjs";
+import * as RecordsAPI from "./records.mjs";
+import { CustomObjectDataRow, CustomObjectDataRowsPageCursorURL, RecordBulkCreateParams, RecordBulkCreateResponse, RecordBulkDeleteParams, RecordBulkUpdateParams, RecordBulkUpdateResponse, RecordCreateParams, RecordCreateResponse, RecordQueryParams, RecordQueryResponse, RecordUpdateParams, RecordUpdateResponse, Records } from "./records.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { PageCursorURL, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class CustomObjects extends APIResource {
+    fields: FieldsAPI.Fields;
+    records: RecordsAPI.Records;
+    /**
+     * Create a new custom object
+     */
+    create(body?: CustomObjectCreateParams | null | undefined, options?: RequestOptions): APIPromise<CustomObject>;
+    /**
+     * Retrieve a specific custom object
+     */
+    retrieve(customObjectAPIName: string, options?: RequestOptions): APIPromise<CustomObject>;
+    /**
+     * Updated a specific custom object
+     */
+    update(customObjectAPIName: string, body?: CustomObjectUpdateParams | null | undefined, options?: RequestOptions): APIPromise<CustomObject>;
+    /**
+     * A List of custom objects
+     *
+     * - Requires: `API Tier 1`
+     */
+    list(options?: RequestOptions): PagePromise<CustomObjectsPageCursorURL, CustomObject>;
+    /**
+     * Delete a custom object
+     */
+    delete(customObjectAPIName: string, options?: RequestOptions): APIPromise<void>;
+}
+export type CustomObjectsPageCursorURL = PageCursorURL<CustomObject>;
+export interface CustomObject {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * The category of the custom object
+     */
+    category_id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Whether to record the history of the custom object
+     */
+    enable_history: boolean;
+    /**
+     * The name of the custom object
+     */
+    name: string;
+    /**
+     * The plural label of the custom object
+     */
+    plural_label: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The api name of the custom object
+     */
+    api_name?: string;
+    /**
+     * The description of the custom object
+     */
+    description?: string;
+    /**
+     * The id of the package which the custom object belongs to
+     */
+    managed_package_install_id?: string;
+    /**
+     * The native category of the custom object if belongs to
+     */
+    native_category_id?: string;
+    /**
+     * The id of the owner for the custom object
+     */
+    owner_id?: string;
+}
+export interface CustomObjectCreateParams {
+    category?: string;
+    description?: string;
+    name?: string;
+}
+export interface CustomObjectUpdateParams {
+    category?: string;
+    description?: string;
+    name?: string;
+    owner_role?: string;
+    plural_label?: string;
+}
+export declare namespace CustomObjects {
+    export { type CustomObject as CustomObject, type CustomObjectsPageCursorURL as CustomObjectsPageCursorURL, type CustomObjectCreateParams as CustomObjectCreateParams, type CustomObjectUpdateParams as CustomObjectUpdateParams, };
+    export { Fields as Fields, type CustomObjectField as CustomObjectField, type CustomObjectFieldsPageCursorURL as CustomObjectFieldsPageCursorURL, type FieldCreateParams as FieldCreateParams, type FieldUpdateParams as FieldUpdateParams, };
+    export { Records as Records, type CustomObjectDataRow as CustomObjectDataRow, type RecordCreateResponse as RecordCreateResponse, type RecordUpdateResponse as RecordUpdateResponse, type RecordBulkCreateResponse as RecordBulkCreateResponse, type RecordBulkUpdateResponse as RecordBulkUpdateResponse, type RecordQueryResponse as RecordQueryResponse, type CustomObjectDataRowsPageCursorURL as CustomObjectDataRowsPageCursorURL, type RecordCreateParams as RecordCreateParams, type RecordUpdateParams as RecordUpdateParams, type RecordBulkCreateParams as RecordBulkCreateParams, type RecordBulkDeleteParams as RecordBulkDeleteParams, type RecordBulkUpdateParams as RecordBulkUpdateParams, type RecordQueryParams as RecordQueryParams, };
+}
+//# sourceMappingURL=custom-objects.d.mts.map

package/resources/custom-objects/custom-objects.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-objects.d.mts","sourceRoot":"","sources":["../../src/resources/custom-objects/custom-objects.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,EACL,iBAAiB,EACjB,+BAA+B,EAC/B,iBAAiB,EACjB,iBAAiB,EACjB,MAAM,EACP;OACM,KAAK,UAAU;OACf,EACL,mBAAmB,EACnB,iCAAiC,EACjC,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,OAAO,EACR;OACM,EAAE,UAAU,EAAE;OACd,EAAE,aAAa,EAAE,WAAW,EAAE;OAE9B,EAAE,cAAc,EAAE;AAGzB,qBAAa,aAAc,SAAQ,WAAW;IAC5C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAC9D,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;IAEnE;;OAEG;IACH,MAAM,CACJ,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;OAEG;IACH,QAAQ,CAAC,mBAAmB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIzF;;OAEG;IACH,MAAM,CACJ,mBAAmB,EAAE,MAAM,EAC3B,IAAI,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,YAAY,CAAC;IAI3B;;;;OAIG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,WAAW,CAAC,0BAA0B,EAAE,YAAY,CAAC;IAIrF;;OAEG;IACH,MAAM,CAAC,mBAAmB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAMhF;AAED,MAAM,MAAM,0BAA0B,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;AAErE,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAKD,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}