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

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

package/src/resources/report-runs.ts

@@ -6,19 +6,22 @@ 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
    */
   create(body: ReportRunCreateParams, options?: RequestOptions): APIPromise<ReportRunCreateResponse> {
-    return this._client.post('/report-runs', { body, ...options });
+    return this._client.post('/report-runs/', { body, ...options });
   }
 
   /**
    * Retrieve the status and data for a specific report run
    */
   retrieve(runID: string, options?: RequestOptions): APIPromise<ReportRunRetrieveResponse> {
-    return this._client.get(path`/report-runs/${runID}`, options);
+    return this._client.get(path`/report-runs/${runID}/`, options);
   }
 }
 
@@ -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
@@ -20,7 +23,7 @@ export class Schedules extends APIResource {
     query: ScheduleListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ScheduleListResponsesPageCursorURL, ScheduleListResponse> {
-    return this._client.getAPIList('/schedules', PageCursorURL<ScheduleListResponse>, { query, ...options });
+    return this._client.getAPIList('/schedules/', PageCursorURL<ScheduleListResponse>, { query, ...options });
   }
 
   /**
@@ -30,7 +33,7 @@ export class Schedules extends APIResource {
     body: ScheduleCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ScheduleCreateResponse> {
-    return this._client.post('/schedules', { body, ...options });
+    return this._client.post('/schedules/', { body, ...options });
   }
 
   /**
@@ -41,7 +44,7 @@ export class Schedules extends APIResource {
     query: ScheduleRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ScheduleRetrieveResponse> {
-    return this._client.get(path`/schedules/${id}`, { query, ...options });
+    return this._client.get(path`/schedules/${id}/`, { query, ...options });
   }
 
   /**
@@ -52,7 +55,7 @@ export class Schedules extends APIResource {
     body: ScheduleUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ScheduleUpdateResponse> {
-    return this._client.patch(path`/schedules/${id}`, { body, ...options });
+    return this._client.patch(path`/schedules/${id}/`, { body, ...options });
   }
 }
 

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
@@ -25,7 +28,7 @@ export class ShiftAssignments extends APIResource {
     body: ShiftAssignmentUpdateCustomfieldsParams,
     options?: RequestOptions,
   ): APIPromise<ShiftAssignmentUpdateCustomfieldsResponse> {
-    return this._client.patch(path`/shiftassignments/${id}/customfields`, { body, ...options });
+    return this._client.patch(path`/shiftassignments/${id}/customfields/`, { body, ...options });
   }
 }
 

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
@@ -22,7 +25,7 @@ export class ShiftInputs extends APIResource {
     query: ShiftInputListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ShiftInputListResponsesPageCursorURL, ShiftInputListResponse> {
-    return this._client.getAPIList('/shift-inputs', PageCursorURL<ShiftInputListResponse>, {
+    return this._client.getAPIList('/shift-inputs/', PageCursorURL<ShiftInputListResponse>, {
       query,
       ...options,
     });
@@ -32,7 +35,7 @@ export class ShiftInputs extends APIResource {
    * Create a new shift input
    */
   create(body: ShiftInputCreateParams, options?: RequestOptions): APIPromise<ShiftInputCreateResponse> {
-    return this._client.post('/shift-inputs', { body, ...options });
+    return this._client.post('/shift-inputs/', { body, ...options });
   }
 
   /**
@@ -43,7 +46,7 @@ export class ShiftInputs extends APIResource {
     query: ShiftInputRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ShiftInputRetrieveResponse> {
-    return this._client.get(path`/shift-inputs/${id}`, { query, ...options });
+    return this._client.get(path`/shift-inputs/${id}/`, { query, ...options });
   }
 
   /**
@@ -54,14 +57,14 @@ export class ShiftInputs extends APIResource {
     body: ShiftInputUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ShiftInputUpdateResponse> {
-    return this._client.patch(path`/shift-inputs/${id}`, { body, ...options });
+    return this._client.patch(path`/shift-inputs/${id}/`, { body, ...options });
   }
 
   /**
    * Delete a shift input
    */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/shift-inputs/${id}`, {
+    return this._client.delete(path`/shift-inputs/${id}/`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });

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
@@ -22,7 +25,7 @@ export class Shiftassignments extends APIResource {
     query: ShiftassignmentListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<ShiftassignmentListResponsesPageCursorURL, ShiftassignmentListResponse> {
-    return this._client.getAPIList('/shiftassignments', PageCursorURL<ShiftassignmentListResponse>, {
+    return this._client.getAPIList('/shiftassignments/', PageCursorURL<ShiftassignmentListResponse>, {
       query,
       ...options,
     });
@@ -35,7 +38,7 @@ export class Shiftassignments extends APIResource {
     body: ShiftassignmentCreateParams,
     options?: RequestOptions,
   ): APIPromise<ShiftassignmentCreateResponse> {
-    return this._client.post('/shiftassignments', { body, ...options });
+    return this._client.post('/shiftassignments/', { body, ...options });
   }
 
   /**
@@ -46,7 +49,7 @@ export class Shiftassignments extends APIResource {
     query: ShiftassignmentRetrieveParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ShiftassignmentRetrieveResponse> {
-    return this._client.get(path`/shiftassignments/${id}`, { query, ...options });
+    return this._client.get(path`/shiftassignments/${id}/`, { query, ...options });
   }
 
   /**
@@ -57,7 +60,7 @@ export class Shiftassignments extends APIResource {
     body: ShiftassignmentUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ShiftassignmentUpdateResponse> {
-    return this._client.patch(path`/shiftassignments/${id}`, { body, ...options });
+    return this._client.patch(path`/shiftassignments/${id}/`, { body, ...options });
   }
 }
 

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
@@ -12,8 +15,8 @@ export class SSOMeResource extends APIResource {
    * - Requires: `API Tier 1`
    * - Expandable fields: `company`
    */
-  retrieve(query: SSOMeRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
-    return this._client.get('/sso-me', { query, ...options });
+  list(query: SSOMeListParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
+    return this._client.get('/sso-me/', { query, ...options });
   }
 }
 
@@ -51,12 +54,12 @@ export interface SSOMe {
   work_email?: string;
 }
 
-export interface SSOMeRetrieveParams {
+export interface SSOMeListParams {
   cursor?: string;
 
   expand?: string;
 }
 
 export declare namespace SSOMeResource {
-  export { type SSOMe as SSOMe, type SSOMeRetrieveParams as SSOMeRetrieveParams };
+  export { type SSOMe as SSOMe, type SSOMeListParams as SSOMeListParams };
 }

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.
@@ -22,7 +25,7 @@ export class ExclusionMembers extends APIResource {
     options?: RequestOptions,
   ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
     return this._client.getAPIList(
-      path`/supergroups/${groupID}/exclusion-members`,
+      path`/supergroups/${groupID}/exclusion-members/`,
       PageCursorURL<Shared.GroupMember>,
       { query, ...options },
     );
@@ -36,7 +39,7 @@ export class ExclusionMembers extends APIResource {
     body: ExclusionMemberUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<ExclusionMemberUpdateResponse> {
-    return this._client.patch(path`/supergroups/${groupID}/exclusion-members`, { body, ...options });
+    return this._client.patch(path`/supergroups/${groupID}/exclusion-members/`, { body, ...options });
   }
 }
 

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.
@@ -22,7 +25,7 @@ export class InclusionMembers extends APIResource {
     options?: RequestOptions,
   ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
     return this._client.getAPIList(
-      path`/supergroups/${groupID}/inclusion-members`,
+      path`/supergroups/${groupID}/inclusion-members/`,
       PageCursorURL<Shared.GroupMember>,
       { query, ...options },
     );
@@ -36,7 +39,7 @@ export class InclusionMembers extends APIResource {
     body: InclusionMemberUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<InclusionMemberUpdateResponse> {
-    return this._client.patch(path`/supergroups/${groupID}/inclusion-members`, { body, ...options });
+    return this._client.patch(path`/supergroups/${groupID}/inclusion-members/`, { body, ...options });
   }
 }
 

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.
@@ -20,10 +23,11 @@ export class Members extends APIResource {
     query: MemberListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
-    return this._client.getAPIList(path`/supergroups/${groupID}/members`, PageCursorURL<Shared.GroupMember>, {
-      query,
-      ...options,
-    });
+    return this._client.getAPIList(
+      path`/supergroups/${groupID}/members/`,
+      PageCursorURL<Shared.GroupMember>,
+      { query, ...options },
+    );
   }
 }
 

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(
@@ -43,14 +46,14 @@ export class Supergroups extends APIResource {
     query: SupergroupListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<SupergroupsPageCursorURL, Supergroup> {
-    return this._client.getAPIList('/supergroups', PageCursorURL<Supergroup>, { query, ...options });
+    return this._client.getAPIList('/supergroups/', PageCursorURL<Supergroup>, { query, ...options });
   }
 
   /**
    * Retrieve a specific supergroup.
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<SupergroupRetrieveResponse> {
-    return this._client.get(path`/supergroups/${id}`, options);
+    return this._client.get(path`/supergroups/${id}/`, options);
   }
 }