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

package/src/resources/draft-hires.ts

@@ -5,6 +5,9 @@ import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Candidates who have not yet started work at the company
+ */
 export class DraftHires extends APIResource {
   /**
    * Create bulk draft hire

package/src/resources/employment-types.ts

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

package/src/resources/entitlements.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Availability of API features to the company or Partners.
+ */
 export class Entitlements extends APIResource {
   /**
    * A List of entitlements

package/src/resources/functions/deployments.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Deployments extends APIResource {
   /**
    * A List of function deployments

package/src/resources/functions/executions.ts

@@ -6,6 +6,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Executions extends APIResource {
   /**
    * A List of function executions

package/src/resources/functions/functions.ts

@@ -27,6 +27,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Functions defined by the company
+ */
 export class Functions extends APIResource {
   deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
   executions: ExecutionsAPI.Executions = new ExecutionsAPI.Executions(this._client);
@@ -118,6 +121,11 @@ export interface Function {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -156,6 +164,11 @@ export interface FunctionCreateParams {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */
@@ -183,6 +196,11 @@ export interface FunctionUpdateParams {
    */
   description?: string;
 
+  /**
+   * Whether this function runs asynchronously
+   */
+  is_async?: boolean;
+
   /**
    * The function name
    */

package/src/resources/headcount-positions.ts

@@ -14,6 +14,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Headcount allocations for the company
+ */
 export class HeadcountPositions extends APIResource {
   /**
    * A List of headcount positions

package/src/resources/headcount-priorities.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Organizational classifications used to categorize hiring needs based on business urgency and strategic importance
+ */
 export class HeadcountPriorities extends APIResource {
   /**
    * A List of headcount priorities

package/src/resources/index.ts

@@ -49,6 +49,21 @@ export {
   type CompensationRetrieveParams,
   type CompensationsPageCursorURL,
 } from './compensations';
+export {
+  CreateAppNotification,
+  type CreateAppNotificationCreateResponse,
+  type CreateAppNotificationCreateParams,
+} from './create-app-notification';
+export {
+  CustomApps,
+  type CustomAppListResponse,
+  type CustomAppCreateResponse,
+  type CustomAppRetrieveResponse,
+  type CustomAppUpdateResponse,
+  type CustomAppCreateParams,
+  type CustomAppUpdateParams,
+  type CustomAppListResponsesPageCursorURL,
+} from './custom-apps';
 export {
   CustomFields,
   type CustomFieldListResponse,
@@ -62,6 +77,16 @@ export {
   type CustomObjectUpdateParams,
   type CustomObjectsPageCursorURL,
 } from './custom-objects/custom-objects';
+export {
+  CustomPages,
+  type CustomPageListResponse,
+  type CustomPageCreateResponse,
+  type CustomPageRetrieveResponse,
+  type CustomPageUpdateResponse,
+  type CustomPageCreateParams,
+  type CustomPageUpdateParams,
+  type CustomPageListResponsesPageCursorURL,
+} from './custom-pages';
 export {
   CustomSettings,
   type CustomSettingListResponse,
@@ -256,6 +281,11 @@ export {
   type LocationFactorListParams,
   type LocationFactorListResponsesPageCursorURL,
 } from './location-factors';
+export {
+  Metadata,
+  type MetadataListResponse,
+  type MetadataListResponsesPageCursorURL,
+} from './metadata/metadata';
 export {
   ObjectCategories,
   type ObjectCategory,
@@ -263,12 +293,18 @@ export {
   type ObjectCategoryUpdateParams,
   type ObjectCategoriesPageCursorURL,
 } from './object-categories';
+export {
+  PlatformCapabilities,
+  type PlatformCapabilityListResponse,
+  type PlatformCapabilityListResponsesPageCursorURL,
+} from './platform-capabilities';
 export {
   ReportRuns,
   type ReportRunCreateResponse,
   type ReportRunRetrieveResponse,
   type ReportRunCreateParams,
 } from './report-runs';
+export { RunQuery, type RunQueryCreateResponse, type RunQueryCreateParams } from './run-query';
 export { SSOMeResource, type SSOMe, type SSOMeRetrieveParams } from './sso-me';
 export {
   Schedules,
@@ -282,6 +318,8 @@ export {
   type ScheduleUpdateParams,
   type ScheduleListResponsesPageCursorURL,
 } from './schedules';
+export { SendEmail, type SendEmailCreateResponse, type SendEmailCreateParams } from './send-email';
+export { SendSlack, type SendSlackCreateResponse, type SendSlackCreateParams } from './send-slack';
 export {
   ShiftAssignments,
   type ShiftAssignmentUpdateCustomfieldsResponse,

package/src/resources/job-assignments.ts

@@ -11,6 +11,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobAssignments extends APIResource {
   /**
    * A List of job assignments

package/src/resources/job-codes.ts

@@ -15,6 +15,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobCodes extends APIResource {
   /**
    * A List of job codes

package/src/resources/job-dimensions.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobDimensions extends APIResource {
   /**
    * A List of job dimensions

package/src/resources/job-functions.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Organizational job categories that group similar roles and responsibilities within a company
+ */
 export class JobFunctions extends APIResource {
   /**
    * A List of job functions

package/src/resources/job-pay-rate-exceptions.ts

@@ -10,6 +10,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job related information for the company
+ */
 export class JobPayRateExceptions extends APIResource {
   /**
    * A List of job pay rate exceptions

package/src/resources/job-requisitions-write.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * A request for a job to be filled by a candidate
+ */
 export class JobRequisitionsWrite extends APIResource {
   /**
    * Create a new job requisition

package/src/resources/job-requisitions.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * A request for a job to be filled by a candidate
+ */
 export class JobRequisitions extends APIResource {
   /**
    * A List of job requisitions

package/src/resources/kiosk-badges.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Badge information used with Timeclock Kiosk
+ */
 export class KioskBadges extends APIResource {
   /**
    * A List of kiosk badges

package/src/resources/leave-accruals.ts

@@ -8,6 +8,9 @@ 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 {
   /**
    * A List of leave accruals
@@ -114,7 +117,8 @@ export interface LeaveAccrualListResponse {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -224,7 +228,8 @@ export interface LeaveAccrualCreateResponse {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -331,7 +336,8 @@ export interface LeaveAccrualRetrieveResponse extends BusinessPartnersAPI.Meta {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a
@@ -430,7 +436,8 @@ export interface LeaveAccrualCreateParams {
     | 'CARRYOVER_PENALTY_PAYOUT'
     | 'RESET_PENALTY_PAYOUT'
     | 'HOLIDAY_ADJUSTMENT'
-    | 'HOURS_WORKED_TANDA';
+    | 'HOURS_WORKED_TANDA'
+    | 'TENURE_MILESTONE';
 
   /**
    * The comment for this accrual. This is required if the leave policy requires a

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,
+  };
+}