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

package/src/resources/report-runs.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Report data for company
+ */
 export class ReportRuns extends APIResource {
   /**
    * Trigger a new report run
@@ -115,34 +118,41 @@ export namespace ReportRunRetrieveResponse {
 
 export interface ReportRunCreateParams {
   /**
-   * Whether to include object IDs in the report output
+   * The ID of the report to run
    */
-  include_object_ids: boolean;
+  report_id: string;
 
   /**
-   * Whether to include total row count in the report output
+   * Formatting options for currency fields
    */
-  include_total_rows: boolean;
+  format_currency_fields?: ReportRunCreateParams.FormatCurrencyFields | null;
 
   /**
-   * Output format for the report data
+   * Formatting options for date fields
    */
-  output_type: 'JSON' | 'CSV';
+  format_date_fields?: ReportRunCreateParams.FormatDateFields | null;
 
   /**
-   * The ID of the report to run
+   * Whether to include object IDs in the report output
    */
-  report_id: string;
+  include_object_ids?: boolean;
 
   /**
-   * Formatting options for currency fields
+   * Whether to include total row count in the report output
    */
-  format_currency_fields?: ReportRunCreateParams.FormatCurrencyFields | null;
+  include_total_rows?: boolean;
 
   /**
-   * Formatting options for date fields
+   * Output format for the report data
    */
-  format_date_fields?: ReportRunCreateParams.FormatDateFields | null;
+  output_type?: 'JSON' | 'CSV';
+
+  /**
+   * Controls whose permissions are used when running the report. VIEWER (default)
+   * uses the API token owner's own permissions. OWNER uses the report owner's
+   * permissions (requires owner-level access to the report).
+   */
+  view_as?: 'VIEWER' | 'OWNER';
 }
 
 export namespace ReportRunCreateParams {

package/src/resources/run-query.ts

@@ -0,0 +1,51 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute SQL queries and manage transformations
+ */
+export class RunQuery extends APIResource {
+  /**
+   * Execute a SQL query (Trino dialect) against Data Cloud transformations. Returns
+   * result rows as dictionaries and column metadata (api_name, display_name,
+   * data_type). Permission checks and blocked source validation are enforced
+   * server-side.
+   */
+  create(body: RunQueryCreateParams, options?: RequestOptions): APIPromise<RunQueryCreateResponse> {
+    return this._client.post('/run-query', { body, ...options });
+  }
+}
+
+export interface RunQueryCreateResponse {
+  /**
+   * Query result rows, each row is a dictionary of column name to value
+   */
+  data: unknown;
+
+  /**
+   * Column metadata including api_name, display_name, and data_type
+   */
+  derived_columns: unknown;
+}
+
+export interface RunQueryCreateParams {
+  /**
+   * SQL query to execute in Trino dialect.
+   */
+  query: string;
+
+  /**
+   * Optional product name for request attribution and tracking
+   */
+  product_name?: string | null;
+}
+
+export declare namespace RunQuery {
+  export {
+    type RunQueryCreateResponse as RunQueryCreateResponse,
+    type RunQueryCreateParams as RunQueryCreateParams,
+  };
+}

package/src/resources/schedules.ts

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

package/src/resources/send-email.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendEmail extends APIResource {
+  /**
+   * Send an email to the specified recipients with the given subject and body.
+   */
+  create(body: SendEmailCreateParams, options?: RequestOptions): APIPromise<SendEmailCreateResponse> {
+    return this._client.post('/send-email', { body, ...options });
+  }
+}
+
+export interface SendEmailCreateResponse {
+  /**
+   * Result of the send email action
+   */
+  result: unknown;
+}
+
+export interface SendEmailCreateParams {
+  /**
+   * An enumeration.
+   */
+  action_type: 'INDIVIDUAL_EMAILS' | 'GROUP_EMAIL';
+
+  body: string;
+
+  recipients: Array<string>;
+
+  subject: string;
+
+  bcc?: Array<string> | null;
+
+  cc?: Array<string> | null;
+}
+
+export declare namespace SendEmail {
+  export {
+    type SendEmailCreateResponse as SendEmailCreateResponse,
+    type SendEmailCreateParams as SendEmailCreateParams,
+  };
+}

package/src/resources/send-slack.ts

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Execute workflow actions like sending emails, Slack messages, and notifications
+ */
+export class SendSlack extends APIResource {
+  /**
+   * Send a Slack message to the specified recipients.
+   */
+  create(body: SendSlackCreateParams, options?: RequestOptions): APIPromise<SendSlackCreateResponse> {
+    return this._client.post('/send-slack', { body, ...options });
+  }
+}
+
+export interface SendSlackCreateResponse {
+  /**
+   * Result of the send Slack message action
+   */
+  result: unknown;
+}
+
+export interface SendSlackCreateParams {
+  /**
+   * An enumeration.
+   */
+  action_type: 'SINGLE_DIRECT_MESSAGE' | 'GROUP_DIRECT_MESSAGE' | 'PUBLIC_CHANNEL_MESSAGE';
+
+  body: string;
+
+  recipients: Array<string>;
+}
+
+export declare namespace SendSlack {
+  export {
+    type SendSlackCreateResponse as SendSlackCreateResponse,
+    type SendSlackCreateParams as SendSlackCreateParams,
+  };
+}

package/src/resources/shift-assignments.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Shift assignments assigned to workers
+ */
 export class ShiftAssignments extends APIResource {
   /**
    * Update custom fields for a shift assignment. The request body should contain a

package/src/resources/shift-inputs.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Shift inputs used by the company
+ */
 export class ShiftInputs extends APIResource {
   /**
    * A List of shift inputs

package/src/resources/shiftassignments.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Shift assignments assigned to workers
+ */
 export class Shiftassignments extends APIResource {
   /**
    * A List of shift assignments

package/src/resources/sso-me.ts

@@ -5,6 +5,9 @@ import * as CompaniesAPI from './companies';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Provides the user's SSO information
+ */
 export class SSOMeResource extends APIResource {
   /**
    * SSO information of the current user

package/src/resources/supergroups/exclusion-members.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Supergroups used by the company
+ */
 export class ExclusionMembers extends APIResource {
   /**
    * Retrieve supergroup exclusion members matching the input parameters.

package/src/resources/supergroups/inclusion-members.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Supergroups used by the company
+ */
 export class InclusionMembers extends APIResource {
   /**
    * Retrieve supergroup inclusion members matching the input parameters.

package/src/resources/supergroups/members.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Supergroups used by the company
+ */
 export class Members extends APIResource {
   /**
    * Retrieve supergroup members matching the input parameters.

package/src/resources/supergroups/supergroups.ts

@@ -23,6 +23,9 @@ import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Supergroups used by the company
+ */
 export class Supergroups extends APIResource {
   members: MembersAPI.Members = new MembersAPI.Members(this._client);
   inclusionMembers: InclusionMembersAPI.InclusionMembers = new InclusionMembersAPI.InclusionMembers(

package/src/resources/teams.ts

@@ -7,6 +7,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Teams at the company
+ */
 export class Teams extends APIResource {
   /**
    * A List of teams

package/src/resources/time-cards.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Time entries submitted by workers
+ */
 export class TimeCards extends APIResource {
   /**
    * A List of time cards

package/src/resources/time-entries.ts

@@ -10,12 +10,16 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Time entries submitted by workers
+ */
 export class TimeEntries extends APIResource {
   /**
    * A List of time entries
    *
    * - Requires: `API Tier 2`
-   * - Filterable fields: `worker_id`, `start_time`, `pay_period.start_date`
+   * - Filterable fields: `worker_id`, `start_time`, `pay_period.start_date`,
+   *   `updated_at`
    * - Expandable fields: `worker`, `time_card`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/titles.ts

@@ -8,6 +8,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Job titles used by the company
+ */
 export class Titles extends APIResource {
   /**
    * A List of titles

package/src/resources/tracks.ts

@@ -7,6 +7,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 Tracks extends APIResource {
   /**
    * A List of tracks

package/src/resources/unassigned-shifts.ts

@@ -7,6 +7,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Unassigned shifts that are part of a schedule
+ */
 export class UnassignedShifts extends APIResource {
   /**
    * Update custom fields for a unassigned shift. The request body should contain a

package/src/resources/unassignedshifts.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Unassigned shifts that are part of a schedule
+ */
 export class Unassignedshifts extends APIResource {
   /**
    * A List of unassigned shifts

package/src/resources/users.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Users of the company
+ */
 export class Users extends APIResource {
   /**
    * A List of users

package/src/resources/work-locations.ts

@@ -5,9 +5,13 @@ import * as BusinessPartnersAPI from './business-partners';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { PageCursorURL, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Work locations used by the company
+ */
 export class WorkLocations extends APIResource {
   /**
    * A List of work locations
@@ -42,6 +46,16 @@ export class WorkLocations extends APIResource {
   update(id: string, body: WorkLocationUpdateParams, options?: RequestOptions): APIPromise<WorkLocation> {
     return this._client.patch(path`/work-locations/${id}`, { body, ...options });
   }
+
+  /**
+   * Delete a work location
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/work-locations/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
 }
 
 export type WorkLocationsPageCursorURL = PageCursorURL<WorkLocation>;

package/src/resources/workers.ts

@@ -14,6 +14,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Workers who work or have worked at the company
+ */
 export class Workers extends APIResource {
   /**
    * A List of workers
@@ -64,14 +67,18 @@ export interface Worker {
   updated_at: string;
 
   /**
-   * Worker's assigned business partners
+   * Worker's assigned business partners. This field is only populated when
+   * explicitly requested via the expand parameter (e.g., ?expand=business_partners).
+   * When expanded, returns an empty list ([]) if the worker has no business
+   * partners.
    *
    * Expandable field
    */
   business_partners?: Array<BusinessPartnersAPI.BusinessPartner>;
 
   /**
-   * Worker's assigned business partners unique identifiers
+   * Worker's assigned business partners unique identifiers. Returns an empty list
+   * ([]) if the worker has no business partners.
    */
   business_partners_id?: Array<string>;
 
@@ -599,7 +606,7 @@ export interface Worker {
   country_fields?: Worker.CountryFields;
 
   /**
-   * Custom fields for the worker
+   * Custom field values defined on the Employee object for this worker
    *
    * Expandable field
    */
@@ -650,6 +657,7 @@ export interface Worker {
     | 'ASIAN'
     | 'AMERICAN_INDIAN_OR_ALASKA_NATIVE'
     | 'TWO_OR_MORE_RACES'
+    | 'MIDDLE_EASTERN_OR_NORTH_AFRICAN'
     | 'DECLINE_TO_SELF_IDENTIFY'
     | 'AFRICAN'
     | 'COLOURED'

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.26'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.27'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.26";
+export declare const VERSION = "0.2.0-alpha.27";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.26";
+export declare const VERSION = "0.2.0-alpha.27";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.26'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.27'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.26'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.27'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map