@rippling/rippling-sdk 0.2.0-alpha.25 → 0.2.0-alpha.27

package/src/resources/leave-accruals.ts

@@ -4,19 +4,31 @@ 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';
 
+/**
+ * Leave accruals for workers
+ */
 export class LeaveAccruals extends APIResource {
   /**
-   * Retrieve a specific leave accrual
-   */
-  retrieve(
-    id: string,
-    query: LeaveAccrualRetrieveParams | null | undefined = {},
+   * A List of leave accruals
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `leave_type_id`, `accrual_date`
+   * - Expandable fields: `worker`, `grantor`
+   * - Sortable fields: `id`, `created_at`, `updated_at`, `accrual_date`,
+   *   `expiration_date`
+   */
+  list(
+    query: LeaveAccrualListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<LeaveAccrualRetrieveResponse> {
-    return this._client.get(path`/leave-accruals/${id}`, { query, ...options });
+  ): PagePromise<LeaveAccrualListResponsesPageCursorURL, LeaveAccrualListResponse> {
+    return this._client.getAPIList('/leave-accruals', PageCursorURL<LeaveAccrualListResponse>, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -25,12 +37,28 @@ export class LeaveAccruals extends APIResource {
   create(body: LeaveAccrualCreateParams, options?: RequestOptions): APIPromise<LeaveAccrualCreateResponse> {
     return this._client.post('/leave-accruals', { body, ...options });
   }
+
+  /**
+   * Retrieve a specific leave accrual
+   */
+  retrieve(
+    id: string,
+    query: LeaveAccrualRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<LeaveAccrualRetrieveResponse> {
+    return this._client.get(path`/leave-accruals/${id}`, { query, ...options });
+  }
 }
 
+export type LeaveAccrualListResponsesPageCursorURL = PageCursorURL<LeaveAccrualListResponse>;
+
 /**
- * Meta information for the response.
+ * Leave accrual resource representing time off credits granted to employees.
+ *
+ *     Leave accruals track the allocation of paid time off (vacation, sick days, etc.)
+ *     to employees based on company policies, manual grants, or other accrual sources.
  */
-export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface LeaveAccrualListResponse {
   /**
    * Identifier field
    */
@@ -67,6 +95,31 @@ export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
    */
   worker_id: string;
 
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
+
   /**
    * The comment for this accrual. This is required if the leave policy requires a
    * comment on accruals.
@@ -153,6 +206,31 @@ export interface LeaveAccrualCreateResponse {
    */
   worker_id: string;
 
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
+
   /**
    * The comment for this accrual. This is required if the leave policy requires a
    * comment on accruals.
@@ -196,8 +274,122 @@ export interface LeaveAccrualCreateResponse {
   worker?: WorkersAPI.Worker;
 }
 
-export interface LeaveAccrualRetrieveParams {
+/**
+ * Meta information for the response.
+ */
+export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The date when this accrual becomes effective
+   */
+  accrual_date: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The ID of the worker who granted this accrual. This is typically the Time Off
+   * admin.
+   */
+  grantor_id: string;
+
+  /**
+   * The company leave type ID associated with this accrual
+   */
+  leave_type_id: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the worker for whom the accrual is for
+   */
+  worker_id: string;
+
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
+
+  /**
+   * The comment for this accrual. This is required if the leave policy requires a
+   * comment on accruals.
+   */
+  comment?: string;
+
+  /**
+   * The date when this accrual expires (if applicable)
+   */
+  expiration_date?: string;
+
+  /**
+   * The worker who granted this accrual. This is typically the Time Off admin.
+   *
+   * Expandable field
+   */
+  grantor?: WorkersAPI.Worker;
+
+  /**
+   * The monetary value of this accrual (for policies with monetary tracking)
+   */
+  monetary_amount_accrued?: number;
+
+  /**
+   * The number of days accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in days.
+   */
+  num_days?: number;
+
+  /**
+   * The number of hours accrued. It can be negative for deductions. This is
+   * applicable if the policy tracks in hours.
+   */
+  num_hours?: number;
+
+  /**
+   * The worker for whom the accrual is for
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export interface LeaveAccrualListParams {
+  cursor?: string;
+
   expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
 }
 
 export interface LeaveAccrualCreateParams {
@@ -222,6 +414,31 @@ export interface LeaveAccrualCreateParams {
    */
   worker_id: string;
 
+  /**
+   * The type of accrual
+   */
+  accrual_type?:
+    | 'AUTO'
+    | 'CARRYOVER_PENALTY'
+    | 'RESET_PENALTY'
+    | 'RESET_NEGATIVE_PENALTY'
+    | 'BALANCE_PENALTY'
+    | 'LEAVE_GRANT'
+    | 'BALANCE_CORRECTION_ADJUSTMENT'
+    | 'PAID_OUT'
+    | 'SUB_BALANCE_EXPIRATION'
+    | 'TANDA_ACCRUAL_BONUS'
+    | 'TILT_ADJUSTMENT'
+    | 'WORKFLOW_ACTION'
+    | 'EXPIRATION_DEDUCTION'
+    | 'EXPIRATION_PAYOUT'
+    | 'MANUAL_BALANCE_PAYOUT'
+    | 'CARRYOVER_PENALTY_PAYOUT'
+    | 'RESET_PENALTY_PAYOUT'
+    | 'HOLIDAY_ADJUSTMENT'
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
+
   /**
    * The comment for this accrual. This is required if the leave policy requires a
    * comment on accruals.
@@ -251,11 +468,18 @@ export interface LeaveAccrualCreateParams {
   num_hours?: number;
 }
 
+export interface LeaveAccrualRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace LeaveAccruals {
   export {
-    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualListResponse as LeaveAccrualListResponse,
     type LeaveAccrualCreateResponse as LeaveAccrualCreateResponse,
-    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
+    type LeaveAccrualRetrieveResponse as LeaveAccrualRetrieveResponse,
+    type LeaveAccrualListResponsesPageCursorURL as LeaveAccrualListResponsesPageCursorURL,
+    type LeaveAccrualListParams as LeaveAccrualListParams,
     type LeaveAccrualCreateParams as LeaveAccrualCreateParams,
+    type LeaveAccrualRetrieveParams as LeaveAccrualRetrieveParams,
   };
 }

package/src/resources/leave-balances.ts

@@ -9,6 +9,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave balances for workers
+ */
 export class LeaveBalances extends APIResource {
   /**
    * A List of leave balances

package/src/resources/leave-requests.ts

@@ -9,6 +9,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave requests submitted by workers
+ */
 export class LeaveRequests extends APIResource {
   /**
    * A List of leave requests

package/src/resources/leave-types.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Leave types used by the company
+ */
 export class LeaveTypes extends APIResource {
   /**
    * A List of leave types

package/src/resources/legal-entities.ts

@@ -9,6 +9,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Legal entities registered by the company
+ */
 export class LegalEntities extends APIResource {
   /**
    * A List of legal entities

package/src/resources/levels.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Levels and tracks used by the company for workers
+ */
 export class Levels extends APIResource {
   /**
    * A List of levels

package/src/resources/location-factors.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Geographic compensation adjustment factors that modify base compensation based on location-specific market conditions and cost of living
+ */
 export class LocationFactors extends APIResource {
   /**
    * A List of location factors

package/src/resources/metadata/components.ts

@@ -0,0 +1,38 @@
+// 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';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Components extends APIResource {
+  /**
+   * A List of metadata components
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<ComponentListResponsesPageCursorURL, ComponentListResponse> {
+    return this._client.getAPIList('/metadata/components', PageCursorURL<ComponentListResponse>, options);
+  }
+}
+
+export type ComponentListResponsesPageCursorURL = PageCursorURL<ComponentListResponse>;
+
+/**
+ * Base DTO model shared across metadata endpoints.
+ */
+export interface ComponentListResponse {
+  /**
+   * Status of the operation
+   */
+  status?: string;
+}
+
+export declare namespace Components {
+  export {
+    type ComponentListResponse as ComponentListResponse,
+    type ComponentListResponsesPageCursorURL as ComponentListResponsesPageCursorURL,
+  };
+}

package/src/resources/metadata/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Components,
+  type ComponentListResponse,
+  type ComponentListResponsesPageCursorURL,
+} from './components';
+export { Metadata, type MetadataListResponse, type MetadataListResponsesPageCursorURL } from './metadata';
+export { Summary, type SummaryListResponse, type SummaryListResponsesPageCursorURL } from './summary';
+export { Types, type TypeListResponse, type TypeListResponsesPageCursorURL } from './types';

package/src/resources/metadata/metadata.ts

@@ -0,0 +1,70 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ComponentsAPI from './components';
+import { ComponentListResponse, ComponentListResponsesPageCursorURL, Components } from './components';
+import * as SummaryAPI from './summary';
+import { Summary, SummaryListResponse, SummaryListResponsesPageCursorURL } from './summary';
+import * as TypesAPI from './types';
+import { TypeListResponse, TypeListResponsesPageCursorURL, Types } from './types';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Metadata extends APIResource {
+  components: ComponentsAPI.Components = new ComponentsAPI.Components(this._client);
+  summary: SummaryAPI.Summary = new SummaryAPI.Summary(this._client);
+  types: TypesAPI.Types = new TypesAPI.Types(this._client);
+
+  /**
+   * A List of metadata components
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<MetadataListResponsesPageCursorURL, MetadataListResponse> {
+    return this._client.getAPIList('/metadata', PageCursorURL<MetadataListResponse>, options);
+  }
+}
+
+export type MetadataListResponsesPageCursorURL = PageCursorURL<MetadataListResponse>;
+
+/**
+ * Base DTO model shared across metadata endpoints.
+ */
+export interface MetadataListResponse {
+  /**
+   * Status of the operation
+   */
+  status?: string;
+}
+
+Metadata.Components = Components;
+Metadata.Summary = Summary;
+Metadata.Types = Types;
+
+export declare namespace Metadata {
+  export {
+    type MetadataListResponse as MetadataListResponse,
+    type MetadataListResponsesPageCursorURL as MetadataListResponsesPageCursorURL,
+  };
+
+  export {
+    Components as Components,
+    type ComponentListResponse as ComponentListResponse,
+    type ComponentListResponsesPageCursorURL as ComponentListResponsesPageCursorURL,
+  };
+
+  export {
+    Summary as Summary,
+    type SummaryListResponse as SummaryListResponse,
+    type SummaryListResponsesPageCursorURL as SummaryListResponsesPageCursorURL,
+  };
+
+  export {
+    Types as Types,
+    type TypeListResponse as TypeListResponse,
+    type TypeListResponsesPageCursorURL as TypeListResponsesPageCursorURL,
+  };
+}

package/src/resources/metadata/summary.ts

@@ -0,0 +1,38 @@
+// 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';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Summary extends APIResource {
+  /**
+   * A List of metadata summary
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<SummaryListResponsesPageCursorURL, SummaryListResponse> {
+    return this._client.getAPIList('/metadata/summary', PageCursorURL<SummaryListResponse>, options);
+  }
+}
+
+export type SummaryListResponsesPageCursorURL = PageCursorURL<SummaryListResponse>;
+
+/**
+ * Base DTO model shared across metadata endpoints.
+ */
+export interface SummaryListResponse {
+  /**
+   * Status of the operation
+   */
+  status?: string;
+}
+
+export declare namespace Summary {
+  export {
+    type SummaryListResponse as SummaryListResponse,
+    type SummaryListResponsesPageCursorURL as SummaryListResponsesPageCursorURL,
+  };
+}

package/src/resources/metadata/types.ts

@@ -0,0 +1,38 @@
+// 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';
+
+/**
+ * Custom objects defined by the company
+ */
+export class Types extends APIResource {
+  /**
+   * A List of metadata types
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(options?: RequestOptions): PagePromise<TypeListResponsesPageCursorURL, TypeListResponse> {
+    return this._client.getAPIList('/metadata/types', PageCursorURL<TypeListResponse>, options);
+  }
+}
+
+export type TypeListResponsesPageCursorURL = PageCursorURL<TypeListResponse>;
+
+/**
+ * Base DTO model shared across metadata endpoints.
+ */
+export interface TypeListResponse {
+  /**
+   * Status of the operation
+   */
+  status?: string;
+}
+
+export declare namespace Types {
+  export {
+    type TypeListResponse as TypeListResponse,
+    type TypeListResponsesPageCursorURL as TypeListResponsesPageCursorURL,
+  };
+}

package/src/resources/metadata.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './metadata/index';

package/src/resources/object-categories.ts

@@ -7,6 +7,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Object Categories defined by the company
+ */
 export class ObjectCategories extends APIResource {
   /**
    * A List of object categories

package/src/resources/platform-capabilities.ts

@@ -0,0 +1,41 @@
+// 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';
+
+/**
+ * Custom objects defined by the company
+ */
+export class PlatformCapabilities extends APIResource {
+  /**
+   * A List of platform capabilities
+   *
+   * - Requires: `API Tier 1`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<PlatformCapabilityListResponsesPageCursorURL, PlatformCapabilityListResponse> {
+    return this._client.getAPIList(
+      '/platform-capabilities',
+      PageCursorURL<PlatformCapabilityListResponse>,
+      options,
+    );
+  }
+}
+
+export type PlatformCapabilityListResponsesPageCursorURL = PageCursorURL<PlatformCapabilityListResponse>;
+
+export interface PlatformCapabilityListResponse {
+  /**
+   * Schema version
+   */
+  version: string;
+}
+
+export declare namespace PlatformCapabilities {
+  export {
+    type PlatformCapabilityListResponse as PlatformCapabilityListResponse,
+    type PlatformCapabilityListResponsesPageCursorURL as PlatformCapabilityListResponsesPageCursorURL,
+  };
+}