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

package/resources/{send-slack.mjs → workflow-action-executions.mjs}

@@ -3,12 +3,12 @@ import { APIResource } from "../core/resource.mjs";
 /**
  * Execute workflow actions like sending emails, Slack messages, and notifications
  */
-export class SendSlack extends APIResource {
+export class WorkflowActionExecutions extends APIResource {
     /**
-     * Send a Slack message to the specified recipients.
+     * Execute a workflow action
      */
     create(body, options) {
-        return this._client.post('/send-slack/', { body, ...options });
+        return this._client.post('/workflow-action-executions/', { body, ...options });
     }
 }
-//# sourceMappingURL=send-slack.mjs.map
+//# sourceMappingURL=workflow-action-executions.mjs.map

package/resources/workflow-action-executions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-action-executions.mjs","sourceRoot":"","sources":["../src/resources/workflow-action-executions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,WAAW;IACvD;;OAEG;IACH,MAAM,CACJ,IAAyC,EACzC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;CACF"}

package/src/client.ts

@@ -67,11 +67,6 @@ import {
   Compensations,
   CompensationsPageCursorURL,
 } from './resources/compensations';
-import {
-  CreateAppNotification,
-  CreateAppNotificationCreateParams,
-  CreateAppNotificationCreateResponse,
-} from './resources/create-app-notification';
 import {
   CustomAppCreateParams,
   CustomAppCreateResponse,
@@ -120,6 +115,11 @@ import {
   DepartmentsPageCursorURL,
 } from './resources/departments';
 import { DraftHireCreateParams, DraftHireCreateResponse, DraftHires } from './resources/draft-hires';
+import {
+  EarningTypeListResponse,
+  EarningTypeListResponsesPageCursorURL,
+  EarningTypes,
+} from './resources/earning-types';
 import {
   CompanyEmploymentType,
   CompanyEmploymentTypesPageCursorURL,
@@ -290,6 +290,13 @@ import {
   ObjectCategoryCreateParams,
   ObjectCategoryUpdateParams,
 } from './resources/object-categories';
+import {
+  PayrollRunListParams,
+  PayrollRunListResponse,
+  PayrollRunListResponsesPageCursorURL,
+  PayrollRunRetrieveResponse,
+  PayrollRuns,
+} from './resources/payroll-runs';
 import {
   PlatformCapabilities,
   PlatformCapabilityListResponse,
@@ -301,7 +308,6 @@ import {
   ReportRunRetrieveResponse,
   ReportRuns,
 } from './resources/report-runs';
-import { RunQuery, RunQueryCreateParams, RunQueryCreateResponse } from './resources/run-query';
 import {
   ScheduleCreateParams,
   ScheduleCreateResponse,
@@ -314,8 +320,6 @@ import {
   ScheduleUpdateResponse,
   Schedules,
 } from './resources/schedules';
-import { SendEmail, SendEmailCreateParams, SendEmailCreateResponse } from './resources/send-email';
-import { SendSlack, SendSlackCreateParams, SendSlackCreateResponse } from './resources/send-slack';
 import {
   ShiftAssignmentUpdateCustomfieldsParams,
   ShiftAssignmentUpdateCustomfieldsResponse,
@@ -432,6 +436,11 @@ import {
   Workers,
   WorkersPageCursorURL,
 } from './resources/workers';
+import {
+  WorkflowActionExecutionCreateParams,
+  WorkflowActionExecutionCreateResponse,
+  WorkflowActionExecutions,
+} from './resources/workflow-action-executions';
 import {
   CustomObject,
   CustomObjectCreateParams,
@@ -441,6 +450,7 @@ import {
 } from './resources/custom-objects/custom-objects';
 import {
   Function,
+  FunctionCreateDevBundleParams,
   FunctionCreateDevBundleResponse,
   FunctionCreateParams,
   FunctionListParams,
@@ -453,6 +463,7 @@ import {
   MetadataListResponse,
   MetadataListResponsesPageCursorURL,
 } from './resources/metadata/metadata';
+import { ReportRetrieveResponse, Reports } from './resources/reports/reports';
 import {
   Supergroup,
   SupergroupListParams,
@@ -1317,10 +1328,6 @@ export class RipplingSDK {
    * Compensation bands details associated with workers
    */
   compensationBandsDetails: API.CompensationBandsDetails = new API.CompensationBandsDetails(this);
-  /**
-   * Execute workflow actions like sending emails, Slack messages, and notifications
-   */
-  createAppNotification: API.CreateAppNotification = new API.CreateAppNotification(this);
   customApps: API.CustomApps = new API.CustomApps(this);
   /**
    * Custom fields defined by the company
@@ -1332,6 +1339,10 @@ export class RipplingSDK {
    * Candidates who have not yet started work at the company
    */
   draftHires: API.DraftHires = new API.DraftHires(this);
+  /**
+   * Earning types configured for the company
+   */
+  earningTypes: API.EarningTypes = new API.EarningTypes(this);
   /**
    * Availability of API features to the company or Partners.
    */
@@ -1364,6 +1375,10 @@ export class RipplingSDK {
    * Custom objects defined by the company
    */
   metadata: API.Metadata = new API.Metadata(this);
+  /**
+   * Payroll runs for the company
+   */
+  payrollRuns: API.PayrollRuns = new API.PayrollRuns(this);
   /**
    * Custom objects defined by the company
    */
@@ -1371,23 +1386,15 @@ export class RipplingSDK {
   /**
    * Report data for company
    */
-  reportRuns: API.ReportRuns = new API.ReportRuns(this);
+  reports: API.Reports = new API.Reports(this);
   /**
-   * Execute SQL queries and manage transformations
+   * Report data for company
    */
-  runQuery: API.RunQuery = new API.RunQuery(this);
+  reportRuns: API.ReportRuns = new API.ReportRuns(this);
   /**
    * Schedules used by the company
    */
   schedules: API.Schedules = new API.Schedules(this);
-  /**
-   * Execute workflow actions like sending emails, Slack messages, and notifications
-   */
-  sendEmail: API.SendEmail = new API.SendEmail(this);
-  /**
-   * Execute workflow actions like sending emails, Slack messages, and notifications
-   */
-  sendSlack: API.SendSlack = new API.SendSlack(this);
   /**
    * Shift assignments assigned to workers
    */
@@ -1400,6 +1407,10 @@ export class RipplingSDK {
    * Unassigned shifts that are part of a schedule
    */
   unassignedshifts: API.Unassignedshifts = new API.Unassignedshifts(this);
+  /**
+   * Execute workflow actions like sending emails, Slack messages, and notifications
+   */
+  workflowActionExecutions: API.WorkflowActionExecutions = new API.WorkflowActionExecutions(this);
   /**
    * Shift assignments assigned to workers
    */
@@ -1443,12 +1454,12 @@ RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
 RipplingSDK.Candidates = Candidates;
 RipplingSDK.CandidateApplications = CandidateApplications;
 RipplingSDK.CompensationBandsDetails = CompensationBandsDetails;
-RipplingSDK.CreateAppNotification = CreateAppNotification;
 RipplingSDK.CustomApps = CustomApps;
 RipplingSDK.CustomFields = CustomFields;
 RipplingSDK.CustomPages = CustomPages;
 RipplingSDK.CustomSettings = CustomSettings;
 RipplingSDK.DraftHires = DraftHires;
+RipplingSDK.EarningTypes = EarningTypes;
 RipplingSDK.Entitlements = Entitlements;
 RipplingSDK.HeadcountPositions = HeadcountPositions;
 RipplingSDK.HeadcountPriorities = HeadcountPriorities;
@@ -1457,15 +1468,15 @@ RipplingSDK.JobRequisitionsWrite = JobRequisitionsWrite;
 RipplingSDK.LeaveAccruals = LeaveAccruals;
 RipplingSDK.LocationFactors = LocationFactors;
 RipplingSDK.Metadata = Metadata;
+RipplingSDK.PayrollRuns = PayrollRuns;
 RipplingSDK.PlatformCapabilities = PlatformCapabilities;
+RipplingSDK.Reports = Reports;
 RipplingSDK.ReportRuns = ReportRuns;
-RipplingSDK.RunQuery = RunQuery;
 RipplingSDK.Schedules = Schedules;
-RipplingSDK.SendEmail = SendEmail;
-RipplingSDK.SendSlack = SendSlack;
 RipplingSDK.Shiftassignments = Shiftassignments;
 RipplingSDK.Titles = Titles;
 RipplingSDK.Unassignedshifts = Unassignedshifts;
+RipplingSDK.WorkflowActionExecutions = WorkflowActionExecutions;
 RipplingSDK.ShiftAssignments = ShiftAssignments;
 RipplingSDK.UnassignedShifts = UnassignedShifts;
 
@@ -1741,6 +1752,7 @@ export declare namespace RipplingSDK {
     type FunctionListParams as FunctionListParams,
     type FunctionCreateParams as FunctionCreateParams,
     type FunctionUpdateParams as FunctionUpdateParams,
+    type FunctionCreateDevBundleParams as FunctionCreateDevBundleParams,
   };
 
   export {
@@ -1790,12 +1802,6 @@ export declare namespace RipplingSDK {
     type CompensationBandsDetailRetrieveParams as CompensationBandsDetailRetrieveParams,
   };
 
-  export {
-    CreateAppNotification as CreateAppNotification,
-    type CreateAppNotificationCreateResponse as CreateAppNotificationCreateResponse,
-    type CreateAppNotificationCreateParams as CreateAppNotificationCreateParams,
-  };
-
   export {
     CustomApps as CustomApps,
     type CustomAppListResponse as CustomAppListResponse,
@@ -1843,6 +1849,12 @@ export declare namespace RipplingSDK {
     type DraftHireCreateParams as DraftHireCreateParams,
   };
 
+  export {
+    EarningTypes as EarningTypes,
+    type EarningTypeListResponse as EarningTypeListResponse,
+    type EarningTypeListResponsesPageCursorURL as EarningTypeListResponsesPageCursorURL,
+  };
+
   export {
     Entitlements as Entitlements,
     type EntitlementListResponse as EntitlementListResponse,
@@ -1905,12 +1917,22 @@ export declare namespace RipplingSDK {
     type MetadataListResponsesPageCursorURL as MetadataListResponsesPageCursorURL,
   };
 
+  export {
+    PayrollRuns as PayrollRuns,
+    type PayrollRunListResponse as PayrollRunListResponse,
+    type PayrollRunRetrieveResponse as PayrollRunRetrieveResponse,
+    type PayrollRunListResponsesPageCursorURL as PayrollRunListResponsesPageCursorURL,
+    type PayrollRunListParams as PayrollRunListParams,
+  };
+
   export {
     PlatformCapabilities as PlatformCapabilities,
     type PlatformCapabilityListResponse as PlatformCapabilityListResponse,
     type PlatformCapabilityListResponsesPageCursorURL as PlatformCapabilityListResponsesPageCursorURL,
   };
 
+  export { Reports as Reports, type ReportRetrieveResponse as ReportRetrieveResponse };
+
   export {
     ReportRuns as ReportRuns,
     type ReportRunCreateResponse as ReportRunCreateResponse,
@@ -1918,12 +1940,6 @@ export declare namespace RipplingSDK {
     type ReportRunCreateParams as ReportRunCreateParams,
   };
 
-  export {
-    RunQuery as RunQuery,
-    type RunQueryCreateResponse as RunQueryCreateResponse,
-    type RunQueryCreateParams as RunQueryCreateParams,
-  };
-
   export {
     Schedules as Schedules,
     type ScheduleListResponse as ScheduleListResponse,
@@ -1937,18 +1953,6 @@ export declare namespace RipplingSDK {
     type ScheduleUpdateParams as ScheduleUpdateParams,
   };
 
-  export {
-    SendEmail as SendEmail,
-    type SendEmailCreateResponse as SendEmailCreateResponse,
-    type SendEmailCreateParams as SendEmailCreateParams,
-  };
-
-  export {
-    SendSlack as SendSlack,
-    type SendSlackCreateResponse as SendSlackCreateResponse,
-    type SendSlackCreateParams as SendSlackCreateParams,
-  };
-
   export {
     Shiftassignments as Shiftassignments,
     type ShiftassignmentListResponse as ShiftassignmentListResponse,
@@ -1987,6 +1991,12 @@ export declare namespace RipplingSDK {
     type UnassignedshiftUpdateParams as UnassignedshiftUpdateParams,
   };
 
+  export {
+    WorkflowActionExecutions as WorkflowActionExecutions,
+    type WorkflowActionExecutionCreateResponse as WorkflowActionExecutionCreateResponse,
+    type WorkflowActionExecutionCreateParams as WorkflowActionExecutionCreateParams,
+  };
+
   export {
     ShiftAssignments as ShiftAssignments,
     type ShiftAssignmentUpdateCustomfieldsResponse as ShiftAssignmentUpdateCustomfieldsResponse,

package/src/internal/utils/env.ts

@@ -9,10 +9,10 @@
  */
 export const readEnv = (env: string): string | undefined => {
   if (typeof (globalThis as any).process !== 'undefined') {
-    return (globalThis as any).process.env?.[env]?.trim() ?? undefined;
+    return (globalThis as any).process.env?.[env]?.trim() || undefined;
   }
   if (typeof (globalThis as any).Deno !== 'undefined') {
-    return (globalThis as any).Deno.env?.get?.(env)?.trim();
+    return (globalThis as any).Deno.env?.get?.(env)?.trim() || undefined;
   }
   return undefined;
 };

package/src/resources/business-partner-groups.ts

@@ -14,7 +14,7 @@ import { path } from '../internal/utils/path';
  */
 export class BusinessPartnerGroups extends APIResource {
   /**
-   * A List of business partner groups
+   * A list of business partner groups.
    *
    * - Requires: `API Tier 1`
    * - Expandable fields: `default_business_partner`

package/src/resources/business-partners.ts

@@ -15,7 +15,7 @@ import { path } from '../internal/utils/path';
  */
 export class BusinessPartners extends APIResource {
   /**
-   * A List of business partners
+   * A list of business partners.
    *
    * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `business_partner_group_id`

package/src/resources/candidate-applications.ts

@@ -10,7 +10,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class CandidateApplications extends APIResource {
   /**
-   * A List of candidate applications
+   * A list of candidate applications.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `job`

package/src/resources/candidates.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Candidates extends APIResource {
   /**
-   * A List of candidates
+   * A list of candidates.
    *
    * - Requires: `API Tier 2`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/companies.ts

@@ -11,7 +11,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Companies extends APIResource {
   /**
-   * A List of companies
+   * A list of companies.
    *
    * - Requires: `API Tier 1`
    * - Expandable fields: `parent_legal_entity`, `legal_entities`

package/src/resources/compensation-bands-details.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class CompensationBandsDetails extends APIResource {
   /**
-   * A List of compensation bands details
+   * A list of compensation bands details.
    *
    * - Requires: `API Tier 2`
    * - Filterable fields: `created_at`, `updated_at`, `internal_job_code`,

package/src/resources/compensations.ts

@@ -13,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Compensations extends APIResource {
   /**
-   * A List of compensations
+   * A list of compensations.
    *
    * - Requires: `API Tier 2`
    * - Expandable fields: `worker`

package/src/resources/custom-apps.ts

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

package/src/resources/custom-fields.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class CustomFields extends APIResource {
   /**
-   * A List of custom fields
+   * A list of custom fields.
    *
    * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`

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