@rippling/rippling-sdk 0.2.0-alpha.29 → 0.2.0-alpha.30

package/src/resources/custom-objects/custom-objects.ts

@@ -40,7 +40,7 @@ export class CustomObjects extends APIResource {
   records: RecordsAPI.Records = new RecordsAPI.Records(this._client);
 
   /**
-   * A List of custom objects
+   * A list of custom objects.
    *
    * - Requires: `API Tier 1`
    */
@@ -49,7 +49,7 @@ export class CustomObjects extends APIResource {
   }
 
   /**
-   * Create a new custom object
+   * Create a new custom object.
    */
   create(
     body: CustomObjectCreateParams | null | undefined = {},
@@ -59,14 +59,14 @@ export class CustomObjects extends APIResource {
   }
 
   /**
-   * Retrieve a specific custom object
+   * Retrieve a specific custom object.
    */
   retrieve(customObjectAPIName: string, options?: RequestOptions): APIPromise<CustomObject> {
     return this._client.get(path`/custom-objects/${customObjectAPIName}/`, options);
   }
 
   /**
-   * Updated a specific custom object
+   * Update a specific custom object.
    */
   update(
     customObjectAPIName: string,
@@ -77,7 +77,7 @@ export class CustomObjects extends APIResource {
   }
 
   /**
-   * Delete a custom object
+   * Delete a custom object.
    */
   delete(customObjectAPIName: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/custom-objects/${customObjectAPIName}/`, {
@@ -152,22 +152,46 @@ export interface CustomObject {
 }
 
 export interface CustomObjectCreateParams {
+  /**
+   * The category that this custom object belongs to.
+   */
   category?: string;
 
+  /**
+   * A description of the custom object.
+   */
   description?: string;
 
+  /**
+   * The name of the custom object.
+   */
   name?: string;
 }
 
 export interface CustomObjectUpdateParams {
+  /**
+   * The category that this custom object belongs to.
+   */
   category?: string;
 
+  /**
+   * A description of the custom object.
+   */
   description?: string;
 
+  /**
+   * The name of the custom object.
+   */
   name?: string;
 
+  /**
+   * The role that owns this custom object.
+   */
   owner_role?: string;
 
+  /**
+   * The plural label for the custom object.
+   */
   plural_label?: string;
 }
 

package/src/resources/custom-objects/fields.ts

@@ -12,7 +12,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Fields extends APIResource {
   /**
-   * A List of custom object fields
+   * A list of custom object fields.
    *
    * - Requires: `API Tier 1`
    */
@@ -28,7 +28,7 @@ export class Fields extends APIResource {
   }
 
   /**
-   * Create a new custom object field
+   * Create a new custom object field.
    */
   create(
     customObjectAPIName: string,
@@ -39,7 +39,7 @@ export class Fields extends APIResource {
   }
 
   /**
-   * Retrieve a specific custom object field
+   * Retrieve a specific custom object field.
    */
   retrieve(
     customObjectAPIName: string,
@@ -50,7 +50,7 @@ export class Fields extends APIResource {
   }
 
   /**
-   * Updated a specific custom object field
+   * Update a specific custom object field.
    */
   update(
     customObjectAPIName: string,
@@ -65,7 +65,7 @@ export class Fields extends APIResource {
   }
 
   /**
-   * Delete a custom object field
+   * Delete a custom object field.
    */
   delete(customObjectAPIName: string, fieldAPIName: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/custom-objects/${customObjectAPIName}/fields/${fieldAPIName}/`, {
@@ -145,50 +145,116 @@ export interface CustomObjectField {
 }
 
 export interface FieldCreateParams {
+  /**
+   * The data type configuration for the field.
+   */
   data_type?: unknown;
 
+  /**
+   * Configuration for derived aggregated fields.
+   */
   derived_aggregated_field?: unknown;
 
+  /**
+   * The formula for derived fields.
+   */
   derived_field_formula?: string;
 
+  /**
+   * A description of the field.
+   */
   description?: string;
 
+  /**
+   * Whether to track history for this field.
+   */
   enable_history?: boolean;
 
+  /**
+   * Metadata for formula attributes.
+   */
   formula_attr_metas?: unknown;
 
+  /**
+   * Whether field values must be unique.
+   */
   is_unique?: boolean;
 
+  /**
+   * The name of the field.
+   */
   name?: string;
 
+  /**
+   * Whether this field is required.
+   */
   required?: boolean;
 
+  /**
+   * The RQL definition for computed fields.
+   */
   rql_definition?: unknown;
 
+  /**
+   * The section configuration for the field.
+   */
   section?: unknown;
 }
 
 export interface FieldUpdateParams {
+  /**
+   * The data type configuration for the field.
+   */
   data_type?: unknown;
 
+  /**
+   * The formula for derived fields.
+   */
   derived_field_formula?: string;
 
+  /**
+   * A description of the field.
+   */
   description?: string;
 
+  /**
+   * Whether to track history for this field.
+   */
   enable_history?: boolean;
 
+  /**
+   * Metadata for formula attributes.
+   */
   formula_attr_metas?: unknown;
 
+  /**
+   * Whether field values must be unique.
+   */
   is_unique?: boolean;
 
+  /**
+   * The name of the field.
+   */
   name?: string;
 
+  /**
+   * Configuration for name field display.
+   */
   name_field_details?: unknown;
 
+  /**
+   * Whether this field is required.
+   */
   required?: boolean;
 
+  /**
+   * The RQL definition for computed fields.
+   */
   rql_definition?: unknown;
 
+  /**
+   * The section configuration for the field.
+   */
   section?: unknown;
 }
 

package/src/resources/custom-objects/records.ts

@@ -12,7 +12,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Records extends APIResource {
   /**
-   * A List of custom object records
+   * A list of custom object records.
    *
    * - Requires: `API Tier 1`
    */
@@ -28,7 +28,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Create a new custom object record
+   * Create a new custom object record.
    */
   create(
     customObjectAPIName: string,
@@ -39,7 +39,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * A List of custom object records filtered by querying
+   * A list of custom object records filtered by query.
    */
   query(
     customObjectAPIName: string,
@@ -53,7 +53,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Retrieve a specific custom object record
+   * Retrieve a specific custom object record.
    */
   retrieve(
     customObjectAPIName: string,
@@ -64,7 +64,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Updated a specific custom object record
+   * Update a specific custom object record.
    */
   update(
     customObjectAPIName: string,
@@ -79,7 +79,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Delete a custom object record
+   * Delete a custom object record.
    */
   delete(customObjectAPIName: string, codrID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/custom-objects/${customObjectAPIName}/records/${codrID}/`, {
@@ -89,7 +89,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Retrieve a specific custom object record by its external_id
+   * Retrieve a specific custom object record by its external_id.
    */
   retrieveByExternalID(
     customObjectAPIName: string,
@@ -103,7 +103,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * bulk create new custom object records
+   * Bulk create new custom object records.
    */
   bulkCreate(
     customObjectAPIName: string,
@@ -117,7 +117,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Bulk Updated a specific custom object records
+   * Bulk update custom object records.
    */
   bulkUpdate(
     customObjectAPIName: string,
@@ -131,7 +131,7 @@ export class Records extends APIResource {
   }
 
   /**
-   * Bulk Delete custom object records
+   * Bulk delete custom object records.
    */
   bulkDelete(
     customObjectAPIName: string,
@@ -180,6 +180,9 @@ export interface CustomObjectDataRow {
 
   owner_role?: CustomObjectDataRow.OwnerRole;
 
+  /**
+   * The timestamp when the record was last updated by the system.
+   */
   system_updated_at?: string;
 
   [k: string]: unknown;
@@ -187,26 +190,53 @@ export interface CustomObjectDataRow {
 
 export namespace CustomObjectDataRow {
   export interface CreatedBy {
+    /**
+     * The unique identifier of the role.
+     */
     id?: string;
 
+    /**
+     * The display name of the role.
+     */
     display_value?: string;
 
+    /**
+     * The URL of the role's profile image.
+     */
     image?: string;
   }
 
   export interface LastModifiedBy {
+    /**
+     * The unique identifier of the role.
+     */
     id?: string;
 
+    /**
+     * The display name of the role.
+     */
     display_value?: string;
 
+    /**
+     * The URL of the role's profile image.
+     */
     image?: string;
   }
 
   export interface OwnerRole {
+    /**
+     * The unique identifier of the role.
+     */
     id?: string;
 
+    /**
+     * The display name of the role.
+     */
     display_value?: string;
 
+    /**
+     * The URL of the role's profile image.
+     */
     image?: string;
   }
 }
@@ -236,32 +266,59 @@ export interface RecordBulkUpdateResponse {
 export type RecordCreateParams = { [key: string]: unknown };
 
 export interface RecordQueryParams {
+  /**
+   * A cursor for pagination to fetch the next page of results.
+   */
   cursor?: string;
 
+  /**
+   * The maximum number of results to return.
+   */
   limit?: number;
 
+  /**
+   * The query string to filter results.
+   */
   query?: string;
 }
 
 export type RecordUpdateParams = { [key: string]: unknown };
 
 export interface RecordBulkCreateParams {
+  /**
+   * If true, the entire operation fails if any record fails. If false, partial
+   * success is allowed.
+   */
   all_or_nothing?: boolean;
 
+  /**
+   * The list of records to create.
+   */
   rows_to_write?: Array<{ [key: string]: unknown }>;
 }
 
 export interface RecordBulkUpdateParams {
+  /**
+   * If true, the entire operation fails if any record fails. If false, partial
+   * success is allowed.
+   */
   all_or_nothing?: boolean;
 
+  /**
+   * The list of records to update.
+   */
   rows_to_update?: Array<{ [key: string]: unknown }>;
 }
 
 export interface RecordBulkDeleteParams {
+  /**
+   * If true, the entire operation fails if any record fails. If false, partial
+   * success is allowed.
+   */
   all_or_nothing?: boolean;
 
   /**
-   * a list of ids, e.g. [id_1, id_2].
+   * A list of record IDs to delete, e.g. [id_1, id_2].
    */
   rows_to_delete?: Array<string>;
 }

package/src/resources/custom-pages.ts

@@ -10,9 +10,9 @@ import { path } from '../internal/utils/path';
 
 export class CustomPages extends APIResource {
   /**
-   * A List of CustomPage
+   * A list of CustomPage.
    *
-   * - Requires: `API Tier 1`
+   * - Requires: `Custom Apps Platform API`
    */
   list(options?: RequestOptions): PagePromise<CustomPageListResponsesPageCursorURL, CustomPageListResponse> {
     return this._client.getAPIList('/custom-pages/', PageCursorURL<CustomPageListResponse>, options);
@@ -36,7 +36,7 @@ export class CustomPages extends APIResource {
   }
 
   /**
-   * Updated a specific CustomPage
+   * Update a specific CustomPage.
    */
   update(
     id: string,

package/src/resources/custom-settings.ts

@@ -10,7 +10,7 @@ import { path } from '../internal/utils/path';
 
 export class CustomSettings extends APIResource {
   /**
-   * A List of Setting
+   * A list of Setting.
    *
    * - Requires: `Functions API`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -43,7 +43,7 @@ export class CustomSettings extends APIResource {
   }
 
   /**
-   * Updated a specific Setting
+   * Update a specific Setting.
    */
   update(
     id: string,

package/src/resources/departments.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class Departments extends APIResource {
   /**
-   * A List of departments
+   * A list of departments.
    *
    * - Requires: `API Tier 1`
    * - Expandable fields: `parent`, `department_hierarchy`
@@ -44,7 +44,7 @@ export class Departments extends APIResource {
   }
 
   /**
-   * Updated a specific department
+   * Update a specific department.
    */
   update(id: string, body: DepartmentUpdateParams, options?: RequestOptions): APIPromise<Department> {
     return this._client.patch(path`/departments/${id}/`, { body, ...options });

package/src/resources/earning-types.ts

@@ -0,0 +1,64 @@
+// 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';
+
+/**
+ * Earning types configured for the company
+ */
+export class EarningTypes extends APIResource {
+  /**
+   * A list of earning-types.
+   *
+   * - Requires: `Payroll API`
+   */
+  list(
+    options?: RequestOptions,
+  ): PagePromise<EarningTypeListResponsesPageCursorURL, EarningTypeListResponse> {
+    return this._client.getAPIList('/earning-types/', PageCursorURL<EarningTypeListResponse>, options);
+  }
+}
+
+export type EarningTypeListResponsesPageCursorURL = PageCursorURL<EarningTypeListResponse>;
+
+/**
+ * V2 DTO representing a company earning type.
+ *
+ *     Used by:
+ *       - GET /earning-types/  (list)
+ */
+export interface EarningTypeListResponse {
+  /**
+   * Unique identifier for the earning type.
+   */
+  id?: string;
+
+  /**
+   * Company entity relationship identifier (CER ID) linking the earning type to the
+   * HRIS legal entity.
+   */
+  company_entity_id?: string;
+
+  /**
+   * ISO country code where the earning type applies.
+   */
+  country_code?: string;
+
+  /**
+   * Human-readable name of the earning type.
+   */
+  display_name?: string;
+
+  /**
+   * Code identifying the earning type (e.g. regular_salary, commission).
+   */
+  earning_code?: string;
+}
+
+export declare namespace EarningTypes {
+  export {
+    type EarningTypeListResponse as EarningTypeListResponse,
+    type EarningTypeListResponsesPageCursorURL as EarningTypeListResponsesPageCursorURL,
+  };
+}

package/src/resources/employment-types.ts

@@ -12,7 +12,7 @@ import { path } from '../internal/utils/path';
  */
 export class EmploymentTypes extends APIResource {
   /**
-   * A List of employment types
+   * A list of employment types.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/entitlements.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Entitlements extends APIResource {
   /**
-   * A List of entitlements
+   * A list of entitlements.
    *
    * - Requires: `API Tier 1`
    */

package/src/resources/functions/deployments.ts

@@ -10,7 +10,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Deployments extends APIResource {
   /**
-   * A List of function deployments
+   * A list of function deployments.
    *
    * - Requires: `API Tier 2`
    */
@@ -19,7 +19,7 @@ export class Deployments extends APIResource {
   }
 
   /**
-   * Create a new function deployment
+   * Create a new function deployment.
    */
   create(
     functionAPIName: string,
@@ -30,7 +30,7 @@ export class Deployments extends APIResource {
   }
 
   /**
-   * Retrieve a specific function deployment
+   * Retrieve a specific function deployment.
    */
   retrieve(
     deploymentID: string,
@@ -42,7 +42,7 @@ export class Deployments extends APIResource {
   }
 
   /**
-   * A List of function deployment logs
+   * A list of function deployment logs.
    *
    * - Requires: `API Tier 2`
    */
@@ -193,10 +193,16 @@ export interface DeploymentCreateParams {
 }
 
 export interface DeploymentRetrieveParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 
 export interface DeploymentListLogsParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 

package/src/resources/functions/executions.ts

@@ -11,7 +11,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Executions extends APIResource {
   /**
-   * A List of function executions
+   * A list of function executions.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`
@@ -29,7 +29,7 @@ export class Executions extends APIResource {
   }
 
   /**
-   * Create a new function execution
+   * Create a new function execution.
    */
   create(
     functionAPIName: string,
@@ -40,7 +40,7 @@ export class Executions extends APIResource {
   }
 
   /**
-   * Retrieve a specific function execution
+   * Retrieve a specific function execution.
    */
   retrieve(
     executionID: string,
@@ -52,7 +52,7 @@ export class Executions extends APIResource {
   }
 
   /**
-   * A List of function execution logs
+   * A list of function execution logs.
    *
    * - Requires: `API Tier 2`
    */
@@ -160,10 +160,16 @@ export interface ExecutionCreateParams {
 }
 
 export interface ExecutionRetrieveParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }
 
 export interface ExecutionListLogsParams {
+  /**
+   * The API name of the function.
+   */
   function_api_name: string;
 }