@rippling/rippling-sdk 0.2.0-alpha.20

package/resources/candidates.d.ts

@@ -0,0 +1,54 @@
+import { APIResource } from "../core/resource.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Candidates extends APIResource {
+    /**
+     * A List of candidates
+     *
+     * - Requires: `API Tier 2`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: CandidateListParams | null | undefined, options?: RequestOptions): PagePromise<CandidateListResponsesPageCursorURL, CandidateListResponse>;
+}
+export type CandidateListResponsesPageCursorURL = PageCursorURL<CandidateListResponse>;
+export interface CandidateListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * Candidate email
+     */
+    email?: string;
+    /**
+     * Candidate first name
+     */
+    first_name?: string;
+    /**
+     * Candidate last name
+     */
+    last_name?: string;
+    /**
+     * Candidate phone number
+     */
+    phone_number?: string;
+    /**
+     * Candidate timezone
+     */
+    timezone?: string;
+}
+export interface CandidateListParams {
+    order_by?: string;
+}
+export declare namespace Candidates {
+    export { type CandidateListResponse as CandidateListResponse, type CandidateListResponsesPageCursorURL as CandidateListResponsesPageCursorURL, type CandidateListParams as CandidateListParams, };
+}
+//# sourceMappingURL=candidates.d.ts.map

package/resources/candidates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"candidates.d.ts","sourceRoot":"","sources":["../src/resources/candidates.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;OAKG;IACH,IAAI,CACF,KAAK,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,mCAAmC,EAAE,qBAAqB,CAAC;CAM3E;AAED,MAAM,MAAM,mCAAmC,GAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;AAEvF,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/candidates.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.Candidates = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+class Candidates extends resource_1.APIResource {
+    /**
+     * A List of candidates
+     *
+     * - Requires: `API Tier 2`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/candidates', (pagination_1.PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+}
+exports.Candidates = Candidates;
+//# sourceMappingURL=candidates.js.map

package/resources/candidates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"candidates.js","sourceRoot":"","sources":["../src/resources/candidates.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAC/C,sDAAgE;AAGhE,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;OAKG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,0BAAoC,CAAA,EAAE;YAClF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAhBD,gCAgBC"}

package/resources/candidates.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 Candidates extends APIResource {
+    /**
+     * A List of candidates
+     *
+     * - Requires: `API Tier 2`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/candidates', (PageCursorURL), {
+            query,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=candidates.mjs.map

package/resources/candidates.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"candidates.mjs","sourceRoot":"","sources":["../src/resources/candidates.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,aAAa,EAAe;AAGrC,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;OAKG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,EAAE,CAAA,aAAoC,CAAA,EAAE;YAClF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/companies.d.mts

@@ -0,0 +1,82 @@
+import { APIResource } from "../core/resource.mjs";
+import * as LegalEntitiesAPI from "./legal-entities.mjs";
+import * as Shared from "./shared.mjs";
+import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Companies extends APIResource {
+    /**
+     * A List of companies
+     *
+     * - Requires: `API Tier 1`
+     * - Expandable fields: `parent_legal_entity`, `legal_entities`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: CompanyListParams | null | undefined, options?: RequestOptions): PagePromise<CompaniesPageCursorURL, Company>;
+}
+export type CompaniesPageCursorURL = PageCursorURL<Company>;
+export interface Company {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * A list of the company's entities.
+     *
+     * Expandable field
+     */
+    legal_entities: Array<LegalEntitiesAPI.LegalEntity>;
+    /**
+     * A list of the company's entities.
+     */
+    legal_entities_id: Array<string>;
+    /**
+     * The name of the company.
+     */
+    name: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The doing business as name for the company.
+     */
+    doing_business_as_name?: string;
+    /**
+     * The legal name of the company.
+     */
+    legal_name?: string;
+    /**
+     * The company's ultimate holding entity.
+     *
+     * Expandable field
+     */
+    parent_legal_entity?: LegalEntitiesAPI.LegalEntity;
+    /**
+     * The company's ultimate holding entity.
+     */
+    parent_legal_entity_id?: string;
+    /**
+     * The phone number for the company.
+     */
+    phone?: string;
+    /**
+     * The physical address of the holding entity.
+     */
+    physical_address?: Shared.Address;
+    /**
+     * The email address used when registering this company.
+     */
+    primary_email?: string;
+}
+export interface CompanyListParams {
+    expand?: string;
+    order_by?: string;
+}
+export declare namespace Companies {
+    export { type Company as Company, type CompaniesPageCursorURL as CompaniesPageCursorURL, type CompanyListParams as CompanyListParams, };
+}
+//# sourceMappingURL=companies.d.mts.map

package/resources/companies.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"companies.d.mts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,KAAK,MAAM;OACX,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC;CAGhD;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAE5D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAEpD;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC;IAEnD;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/companies.d.ts

@@ -0,0 +1,82 @@
+import { APIResource } from "../core/resource.js";
+import * as LegalEntitiesAPI from "./legal-entities.js";
+import * as Shared from "./shared.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Companies extends APIResource {
+    /**
+     * A List of companies
+     *
+     * - Requires: `API Tier 1`
+     * - Expandable fields: `parent_legal_entity`, `legal_entities`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query?: CompanyListParams | null | undefined, options?: RequestOptions): PagePromise<CompaniesPageCursorURL, Company>;
+}
+export type CompaniesPageCursorURL = PageCursorURL<Company>;
+export interface Company {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * A list of the company's entities.
+     *
+     * Expandable field
+     */
+    legal_entities: Array<LegalEntitiesAPI.LegalEntity>;
+    /**
+     * A list of the company's entities.
+     */
+    legal_entities_id: Array<string>;
+    /**
+     * The name of the company.
+     */
+    name: string;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The doing business as name for the company.
+     */
+    doing_business_as_name?: string;
+    /**
+     * The legal name of the company.
+     */
+    legal_name?: string;
+    /**
+     * The company's ultimate holding entity.
+     *
+     * Expandable field
+     */
+    parent_legal_entity?: LegalEntitiesAPI.LegalEntity;
+    /**
+     * The company's ultimate holding entity.
+     */
+    parent_legal_entity_id?: string;
+    /**
+     * The phone number for the company.
+     */
+    phone?: string;
+    /**
+     * The physical address of the holding entity.
+     */
+    physical_address?: Shared.Address;
+    /**
+     * The email address used when registering this company.
+     */
+    primary_email?: string;
+}
+export interface CompanyListParams {
+    expand?: string;
+    order_by?: string;
+}
+export declare namespace Companies {
+    export { type Company as Company, type CompaniesPageCursorURL as CompaniesPageCursorURL, type CompanyListParams as CompanyListParams, };
+}
+//# sourceMappingURL=companies.d.ts.map

package/resources/companies.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"companies.d.ts","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,gBAAgB;OACrB,KAAK,MAAM;OACX,EAAE,aAAa,EAAE,WAAW,EAAE;OAC9B,EAAE,cAAc,EAAE;AAEzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,OAAO,CAAC;CAGhD;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;AAE5D,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,EAAE,KAAK,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAEpD;;OAEG;IACH,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,gBAAgB,CAAC,WAAW,CAAC;IAEnD;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/companies.js

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

package/resources/companies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"companies.js","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgE;AAGhE,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;OAMG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,0BAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF;AAdD,8BAcC"}

package/resources/companies.mjs

@@ -0,0 +1,16 @@
+// 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 Companies extends APIResource {
+    /**
+     * A List of companies
+     *
+     * - Requires: `API Tier 1`
+     * - Expandable fields: `parent_legal_entity`, `legal_entities`
+     * - Sortable fields: `id`, `created_at`, `updated_at`
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/companies', (PageCursorURL), { query, ...options });
+    }
+}
+//# sourceMappingURL=companies.mjs.map

package/resources/companies.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"companies.mjs","sourceRoot":"","sources":["../src/resources/companies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,aAAa,EAAe;AAGrC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;OAMG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,aAAsB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF"}

package/resources/compensations.d.mts

@@ -0,0 +1,250 @@
+import { APIResource } from "../core/resource.mjs";
+import * as BusinessPartnersAPI from "./business-partners.mjs";
+import * as WorkersAPI from "./workers.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 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.mts.map

package/resources/compensations.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compensations.d.mts","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"}