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

package/src/resources/report-runs.ts

@@ -0,0 +1,196 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+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 });
+  }
+
+  /**
+   * 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);
+  }
+}
+
+export interface ReportRunCreateResponse {
+  /**
+   * The ID of this run
+   */
+  id: string;
+
+  /**
+   * The ID of the report associated with this run
+   */
+  report_id: string;
+
+  /**
+   * Report run status
+   */
+  status: 'IN_PROGRESS' | 'SUCCESS' | 'FAILURE';
+
+  /**
+   * Report data, available once the run is complete
+   */
+  result?: ReportRunCreateResponse.Result;
+}
+
+export namespace ReportRunCreateResponse {
+  /**
+   * Report data, available once the run is complete
+   */
+  export interface Result {
+    /**
+     * The expiry time of the execution
+     */
+    expires_at: string;
+
+    /**
+     * The presigned file url
+     */
+    file_url: string;
+
+    /**
+     * The type of the output file
+     */
+    output_type: 'JSON' | 'CSV';
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface ReportRunRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * The ID of this run
+   */
+  id: string;
+
+  /**
+   * The ID of the report associated with this run
+   */
+  report_id: string;
+
+  /**
+   * Report run status
+   */
+  status: 'IN_PROGRESS' | 'SUCCESS' | 'FAILURE';
+
+  /**
+   * Report data, available once the run is complete
+   */
+  result?: ReportRunRetrieveResponse.Result;
+}
+
+export namespace ReportRunRetrieveResponse {
+  /**
+   * Report data, available once the run is complete
+   */
+  export interface Result {
+    /**
+     * The expiry time of the execution
+     */
+    expires_at: string;
+
+    /**
+     * The presigned file url
+     */
+    file_url: string;
+
+    /**
+     * The type of the output file
+     */
+    output_type: 'JSON' | 'CSV';
+  }
+}
+
+export interface ReportRunCreateParams {
+  /**
+   * The ID of the report to run
+   */
+  report_id: string;
+
+  /**
+   * Formatting options for currency fields
+   */
+  format_currency_fields?: ReportRunCreateParams.FormatCurrencyFields | null;
+
+  /**
+   * Formatting options for date fields
+   */
+  format_date_fields?: ReportRunCreateParams.FormatDateFields | null;
+
+  /**
+   * Whether to include object IDs in the report output
+   */
+  include_object_ids?: boolean;
+
+  /**
+   * Whether to include total row count in the report output
+   */
+  include_total_rows?: boolean;
+
+  /**
+   * Output format for the report data
+   */
+  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 {
+  /**
+   * Formatting options for currency fields
+   */
+  export interface FormatCurrencyFields {
+    /**
+     * Currency column format for currency fields
+     */
+    columns: 'TYPE_AND_AMOUNT' | 'VALUE_ONLY';
+
+    /**
+     * Currency type (e.g., 'USD')
+     */
+    currency_type?: string | null;
+  }
+
+  /**
+   * Formatting options for date fields
+   */
+  export interface FormatDateFields {
+    /**
+     * Date format for date fields in the report output
+     */
+    date_format: 'ISO_8601' | 'APPLY_VISUALIZATION_SETTINGS';
+
+    /**
+     * Timezone for datetime fields (e.g., 'America/Los_Angeles')
+     */
+    datetime_timezone?: string | null;
+  }
+}
+
+export declare namespace ReportRuns {
+  export {
+    type ReportRunCreateResponse as ReportRunCreateResponse,
+    type ReportRunRetrieveResponse as ReportRunRetrieveResponse,
+    type ReportRunCreateParams as 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/shared.ts

@@ -1,5 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import * as WorkersAPI from './workers';
+import { PageCursorURL } from '../core/pagination';
+
 export interface Address {
   /**
    * The country component, pursuant to SCIM RFC 7643 4.1.2.
@@ -292,6 +295,45 @@ export type CountryCode =
   | 'ZM'
   | 'ZW';
 
+export interface GroupMember {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The group member's full name.
+   */
+  full_name?: string;
+
+  /**
+   * The group member's associated work email address.
+   */
+  work_email?: string;
+
+  /**
+   * The worker associated with this group member.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The worker's identifier associated with this group member.
+   */
+  worker_id?: string;
+}
+
 /**
  * A list of redacted fields.
  */
@@ -312,3 +354,5 @@ export namespace RedactedFields {
     reason?: string;
   }
 }
+
+export type GroupMembersPageCursorURL = PageCursorURL<GroupMember>;