@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/candidates.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export 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> {
+    return this._client.getAPIList('/candidates', PageCursorURL<CandidateListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+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,
+  };
+}

package/src/resources/companies.ts

@@ -0,0 +1,110 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as LegalEntitiesAPI from './legal-entities';
+import * as Shared from './shared';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+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: CompanyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompaniesPageCursorURL, Company> {
+    return this._client.getAPIList('/companies', PageCursorURL<Company>, { query, ...options });
+  }
+}
+
+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,
+  };
+}

package/src/resources/compensations.ts

@@ -0,0 +1,313 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+import * as WorkersAPI from './workers';
+import { APIPromise } from '../core/api-promise';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export 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> {
+    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: CompensationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CompensationsPageCursorURL, Compensation> {
+    return this._client.getAPIList('/compensations', PageCursorURL<Compensation>, { query, ...options });
+  }
+}
+
+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 namespace Compensation {
+  /**
+   * The worker's annual compensation. This calculation assumes 40-hour work weeks
+   * for workers with an hourly wage.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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.
+   */
+  export 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,
+  };
+}

package/src/resources/custom-fields.ts

@@ -0,0 +1,93 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+
+export 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> {
+    return this._client.getAPIList('/custom-fields', PageCursorURL<CustomFieldListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+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,
+  };
+}