@rippling/rippling-sdk 0.2.0-alpha.22 → 0.2.0-alpha.24

package/src/resources/sso-me.ts

@@ -52,6 +52,8 @@ export interface SSOMe {
 }
 
 export interface SSOMeRetrieveParams {
+  cursor?: string;
+
   expand?: string;
 }
 

package/src/resources/teams.ts

@@ -76,6 +76,8 @@ export interface Team {
 export interface TeamRetrieveResponse extends BusinessPartnersAPI.Meta, Team {}
 
 export interface TeamListParams {
+  cursor?: string;
+
   expand?: string;
 
   order_by?: string;

package/src/resources/time-cards.ts

@@ -186,6 +186,8 @@ export namespace TimeCard {
 export interface TimeCardRetrieveResponse extends BusinessPartnersAPI.Meta, TimeCard {}
 
 export interface TimeCardListParams {
+  cursor?: string;
+
   expand?: string;
 
   filter?: string;

package/src/resources/time-entries.ts

@@ -1493,6 +1493,8 @@ export namespace TimeEntryUpdateResponse {
 }
 
 export interface TimeEntryListParams {
+  cursor?: string;
+
   expand?: string;
 
   filter?: string;

package/src/resources/tracks.ts

@@ -59,6 +59,8 @@ export interface Track {
 export interface TrackRetrieveResponse extends BusinessPartnersAPI.Meta, Track {}
 
 export interface TrackListParams {
+  cursor?: string;
+
   order_by?: string;
 }
 

package/src/resources/unassignedshifts.ts

@@ -0,0 +1,664 @@
+// 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 { PageCursorURL, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Unassignedshifts extends APIResource {
+  /**
+   * A List of unassigned shifts
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `schedule_id`, `shift_data.start_time`,
+   *   `shift_data.end_time`
+   * - Expandable fields: `schedule`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: UnassignedshiftListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<UnassignedshiftListResponsesPageCursorURL, UnassignedshiftListResponse> {
+    return this._client.getAPIList('/unassignedshifts', PageCursorURL<UnassignedshiftListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve a specific unassigned shift
+   */
+  retrieve(
+    id: string,
+    query: UnassignedshiftRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<UnassignedshiftRetrieveResponse> {
+    return this._client.get(path`/unassignedshifts/${id}`, { query, ...options });
+  }
+}
+
+export type UnassignedshiftListResponsesPageCursorURL = PageCursorURL<UnassignedshiftListResponse>;
+
+export interface UnassignedshiftListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The number of assigned shifts
+   */
+  assigned_count: number;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Whether the shift is open or empty
+   */
+  is_open: boolean;
+
+  /**
+   * Whether the shift is published
+   */
+  is_published: boolean;
+
+  /**
+   * The ID of the schedule
+   */
+  schedule_id: string;
+
+  /**
+   * The data of the shift
+   */
+  shift_data: UnassignedshiftListResponse.ShiftData;
+
+  /**
+   * The target count of the shift
+   */
+  target_count: number;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The IDs of the assigned shifts that are part of this unassigned shift
+   */
+  assigned_shift_ids?: Array<string>;
+
+  /**
+   * The published version of the shift
+   */
+  published_version?: UnassignedshiftListResponse.PublishedVersion;
+
+  /**
+   * The schedule
+   *
+   * Expandable field
+   */
+  schedule?: UnassignedshiftListResponse.Schedule;
+}
+
+export namespace UnassignedshiftListResponse {
+  /**
+   * 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;
+
+    /**
+     * 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
+   */
+  export interface PublishedVersion {
+    /**
+     * The end time of the shift
+     */
+    end_time: string;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: 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;
+    }
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface UnassignedshiftRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The number of assigned shifts
+   */
+  assigned_count: number;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Whether the shift is open or empty
+   */
+  is_open: boolean;
+
+  /**
+   * Whether the shift is published
+   */
+  is_published: boolean;
+
+  /**
+   * The ID of the schedule
+   */
+  schedule_id: string;
+
+  /**
+   * The data of the shift
+   */
+  shift_data: UnassignedshiftRetrieveResponse.ShiftData;
+
+  /**
+   * The target count of the shift
+   */
+  target_count: number;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The IDs of the assigned shifts that are part of this unassigned shift
+   */
+  assigned_shift_ids?: Array<string>;
+
+  /**
+   * The published version of the shift
+   */
+  published_version?: UnassignedshiftRetrieveResponse.PublishedVersion;
+
+  /**
+   * The schedule
+   *
+   * Expandable field
+   */
+  schedule?: UnassignedshiftRetrieveResponse.Schedule;
+}
+
+export namespace UnassignedshiftRetrieveResponse {
+  /**
+   * 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;
+
+    /**
+     * 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
+   */
+  export interface PublishedVersion {
+    /**
+     * The end time of the shift
+     */
+    end_time: string;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: 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 UnassignedshiftListParams {
+  cursor?: string;
+
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export interface UnassignedshiftRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace Unassignedshifts {
+  export {
+    type UnassignedshiftListResponse as UnassignedshiftListResponse,
+    type UnassignedshiftRetrieveResponse as UnassignedshiftRetrieveResponse,
+    type UnassignedshiftListResponsesPageCursorURL as UnassignedshiftListResponsesPageCursorURL,
+    type UnassignedshiftListParams as UnassignedshiftListParams,
+    type UnassignedshiftRetrieveParams as UnassignedshiftRetrieveParams,
+  };
+}

package/src/resources/users.ts

@@ -242,6 +242,8 @@ export namespace User {
 export interface UserRetrieveResponse extends BusinessPartnersAPI.Meta, User {}
 
 export interface UserListParams {
+  cursor?: string;
+
   order_by?: string;
 }
 

package/src/resources/work-locations.ts

@@ -65,6 +65,8 @@ export interface WorkLocation {
 export interface WorkLocationRetrieveResponse extends BusinessPartnersAPI.Meta, WorkLocation {}
 
 export interface WorkLocationListParams {
+  cursor?: string;
+
   order_by?: string;
 }