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

package/src/resources/report-runs.ts

@@ -0,0 +1,186 @@
+// 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';
+
+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 {
+  /**
+   * 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';
+
+  /**
+   * 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;
+}
+
+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/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>;

package/src/resources/shift-assignments.ts

@@ -0,0 +1,362 @@
+// 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 * as WorkersAPI from './workers';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class ShiftAssignments extends APIResource {
+  /**
+   * Update custom fields for a shift assignment. The request body should contain a
+   * dictionary mapping custom field names to their values.
+   *
+   * - Requires: `API Tier 2`
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.shiftAssignments.updateCustomfields('id');
+   * ```
+   */
+  updateCustomfields(
+    id: string,
+    body: ShiftAssignmentUpdateCustomfieldsParams,
+    options?: RequestOptions,
+  ): APIPromise<ShiftAssignmentUpdateCustomfieldsResponse> {
+    return this._client.patch(path`/shiftassignments/${id}/customfields`, { body, ...options });
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface ShiftAssignmentUpdateCustomfieldsResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Whether the shift assignment is published. If true, the published_version will
+   * be the same as the shift_data
+   */
+  is_published: boolean;
+
+  /**
+   * The ID of the schedule
+   */
+  schedule_id: string;
+
+  /**
+   * The data of the shift
+   */
+  shift_data: ShiftAssignmentUpdateCustomfieldsResponse.ShiftData;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
+   */
+  worker_id: string;
+
+  /**
+   * Whether the shift assignment can be edited
+   */
+  can_edit?: boolean;
+
+  /**
+   * Custom fields for the shift assignment
+   */
+  custom_fields?: Array<unknown>;
+
+  /**
+   * The published version of the shift assignment, if it exists. If filled but
+   * is_published is false, the shift_data is the latest version.
+   */
+  published_version?: ShiftAssignmentUpdateCustomfieldsResponse.PublishedVersion;
+
+  /**
+   * The schedule
+   *
+   * Expandable field
+   */
+  schedule?: ShiftAssignmentUpdateCustomfieldsResponse.Schedule;
+
+  /**
+   * The worker
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace ShiftAssignmentUpdateCustomfieldsResponse {
+  /**
+   * The data of the shift
+   */
+  export interface ShiftData {
+    /**
+     * The end time of the shift
+     */
+    end_time: string;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: string;
+
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
+    /**
+     * The breaks of the shift
+     */
+    shift_breaks?: Array<ShiftData.ShiftBreak>;
+
+    /**
+     * The segments of the shift
+     */
+    shift_segments?: Array<ShiftData.ShiftSegment>;
+  }
+
+  export namespace ShiftData {
+    export interface ShiftBreak {
+      /**
+       * The duration of the shift break in minutes (input only for creation)
+       */
+      duration_minutes: number;
+
+      /**
+       * The start time of the shift break
+       */
+      start_time: string;
+
+      /**
+       * The type of the shift break
+       */
+      type: 'MEAL' | 'REST';
+
+      /**
+       * The end time of the shift break (calculated from start_time + duration_minutes)
+       */
+      end_time?: string;
+    }
+
+    export interface ShiftSegment {
+      /**
+       * The duration of the shift segment in minutes (input only for creation)
+       */
+      duration_minutes: number;
+
+      /**
+       * The start time of the shift segment
+       */
+      start_time: string;
+
+      /**
+       * The end time of the shift segment (calculated from start_time +
+       * duration_minutes)
+       */
+      end_time?: string;
+
+      /**
+       * The IDs of the job codes associated with the shift segment
+       */
+      job_codes_id?: Array<string>;
+    }
+  }
+
+  /**
+   * The published version of the shift assignment, if it exists. If filled but
+   * is_published is false, the shift_data is the latest version.
+   */
+  export interface PublishedVersion {
+    /**
+     * The end time of the shift
+     */
+    end_time: string;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: string;
+
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
+    /**
+     * The breaks of the shift
+     */
+    shift_breaks?: Array<PublishedVersion.ShiftBreak>;
+
+    /**
+     * The segments of the shift
+     */
+    shift_segments?: Array<PublishedVersion.ShiftSegment>;
+  }
+
+  export namespace PublishedVersion {
+    export interface ShiftBreak {
+      /**
+       * The duration of the shift break in minutes (input only for creation)
+       */
+      duration_minutes: number;
+
+      /**
+       * The start time of the shift break
+       */
+      start_time: string;
+
+      /**
+       * The type of the shift break
+       */
+      type: 'MEAL' | 'REST';
+
+      /**
+       * The end time of the shift break (calculated from start_time + duration_minutes)
+       */
+      end_time?: string;
+    }
+
+    export interface ShiftSegment {
+      /**
+       * The duration of the shift segment in minutes (input only for creation)
+       */
+      duration_minutes: number;
+
+      /**
+       * The start time of the shift segment
+       */
+      start_time: string;
+
+      /**
+       * The end time of the shift segment (calculated from start_time +
+       * duration_minutes)
+       */
+      end_time?: string;
+
+      /**
+       * The IDs of the job codes associated with the shift segment
+       */
+      job_codes_id?: Array<string>;
+    }
+  }
+
+  /**
+   * The schedule
+   *
+   * Expandable field
+   */
+  export interface Schedule {
+    /**
+     * Identifier field
+     */
+    id: string;
+
+    /**
+     * Record creation date
+     */
+    created_at: string;
+
+    /**
+     * Record update date
+     */
+    updated_at: string;
+
+    /**
+     * Whether the requesting role can edit the schedule.
+     */
+    can_edit?: boolean;
+
+    /**
+     * The managers of the schedule.
+     *
+     * Expandable field
+     */
+    managers?: Array<WorkersAPI.Worker>;
+
+    /**
+     * The IDs of the managers of the schedule.
+     */
+    managers_id?: Array<string>;
+
+    /**
+     * The members of the schedule.
+     *
+     * Expandable field
+     */
+    members?: Array<WorkersAPI.Worker>;
+
+    /**
+     * The IDs of the members of the schedule.
+     */
+    members_id?: Array<string>;
+
+    /**
+     * The name of the schedule.
+     */
+    name?: string;
+
+    /**
+     * The observers of the schedule.
+     *
+     * Expandable field
+     */
+    observers?: Array<WorkersAPI.Worker>;
+
+    /**
+     * The IDs of the observers of the schedule.
+     */
+    observers_id?: Array<string>;
+
+    /**
+     * The settings of the schedule.
+     */
+    settings?: Schedule.Settings;
+  }
+
+  export namespace Schedule {
+    /**
+     * The settings of the schedule.
+     */
+    export interface Settings {
+      /**
+       * The IANA timezone identifier for the schedule (e.g., 'America/New_York').
+       * Accepted values are defined by the tz database, listed here:
+       * https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+       */
+      timezone?: string;
+    }
+  }
+}
+
+export interface ShiftAssignmentUpdateCustomfieldsParams {
+  /**
+   * Example custom field name. Replace with your actual custom field names.
+   */
+  FieldName1?: string;
+
+  [k: string]: unknown;
+}
+
+export declare namespace ShiftAssignments {
+  export {
+    type ShiftAssignmentUpdateCustomfieldsResponse as ShiftAssignmentUpdateCustomfieldsResponse,
+    type ShiftAssignmentUpdateCustomfieldsParams as ShiftAssignmentUpdateCustomfieldsParams,
+  };
+}