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

package/resources/unassignedshifts.d.ts

@@ -0,0 +1,866 @@
+import { APIResource } from "../core/resource.js";
+import * as BusinessPartnersAPI from "./business-partners.js";
+import * as WorkersAPI from "./workers.js";
+import { APIPromise } from "../core/api-promise.js";
+import { PageCursorURL, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare 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>;
+    /**
+     * Create a new unassigned shift
+     */
+    create(body: UnassignedshiftCreateParams, options?: RequestOptions): APIPromise<UnassignedshiftCreateResponse>;
+    /**
+     * Retrieve a specific unassigned shift
+     */
+    retrieve(id: string, query?: UnassignedshiftRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<UnassignedshiftRetrieveResponse>;
+}
+export type UnassignedshiftListResponsesPageCursorURL = PageCursorURL<UnassignedshiftListResponse>;
+export interface UnassignedshiftListResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * 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 number of assigned shifts
+     */
+    assigned_count?: number;
+    /**
+     * The IDs of the assigned shifts that are part of this unassigned shift
+     */
+    assigned_shift_ids?: Array<string>;
+    /**
+     * Configuration for an open shift. If present, this is an open shift (workers can
+     * sign up). If absent/None, this is an empty shift (placeholder).
+     */
+    open_shift_config?: unknown;
+    /**
+     * The published version of the shift
+     */
+    published_version?: UnassignedshiftListResponse.PublishedVersion;
+    /**
+     * The schedule
+     *
+     * Expandable field
+     */
+    schedule?: UnassignedshiftListResponse.Schedule;
+}
+export declare namespace UnassignedshiftListResponse {
+    /**
+     * The data of the shift
+     */
+    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>;
+    }
+    namespace ShiftData {
+        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;
+        }
+        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
+     */
+    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>;
+    }
+    namespace PublishedVersion {
+        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;
+        }
+        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
+     */
+    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;
+    }
+    namespace Schedule {
+        /**
+         * The settings of the schedule.
+         */
+        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 UnassignedshiftCreateResponse {
+    /**
+     * Identifier field
+     */
+    id: string;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * Whether the shift is published
+     */
+    is_published: boolean;
+    /**
+     * The ID of the schedule
+     */
+    schedule_id: string;
+    /**
+     * The data of the shift
+     */
+    shift_data: UnassignedshiftCreateResponse.ShiftData;
+    /**
+     * The target count of the shift
+     */
+    target_count: number;
+    /**
+     * Record update date
+     */
+    updated_at: string;
+    /**
+     * The number of assigned shifts
+     */
+    assigned_count?: number;
+    /**
+     * The IDs of the assigned shifts that are part of this unassigned shift
+     */
+    assigned_shift_ids?: Array<string>;
+    /**
+     * Configuration for an open shift. If present, this is an open shift (workers can
+     * sign up). If absent/None, this is an empty shift (placeholder).
+     */
+    open_shift_config?: unknown;
+    /**
+     * The published version of the shift
+     */
+    published_version?: UnassignedshiftCreateResponse.PublishedVersion;
+    /**
+     * The schedule
+     *
+     * Expandable field
+     */
+    schedule?: UnassignedshiftCreateResponse.Schedule;
+}
+export declare namespace UnassignedshiftCreateResponse {
+    /**
+     * The data of the shift
+     */
+    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>;
+    }
+    namespace ShiftData {
+        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;
+        }
+        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
+     */
+    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>;
+    }
+    namespace PublishedVersion {
+        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;
+        }
+        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
+     */
+    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;
+    }
+    namespace Schedule {
+        /**
+         * The settings of the schedule.
+         */
+        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;
+    /**
+     * Record creation date
+     */
+    created_at: string;
+    /**
+     * 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 number of assigned shifts
+     */
+    assigned_count?: number;
+    /**
+     * The IDs of the assigned shifts that are part of this unassigned shift
+     */
+    assigned_shift_ids?: Array<string>;
+    /**
+     * Configuration for an open shift. If present, this is an open shift (workers can
+     * sign up). If absent/None, this is an empty shift (placeholder).
+     */
+    open_shift_config?: unknown;
+    /**
+     * The published version of the shift
+     */
+    published_version?: UnassignedshiftRetrieveResponse.PublishedVersion;
+    /**
+     * The schedule
+     *
+     * Expandable field
+     */
+    schedule?: UnassignedshiftRetrieveResponse.Schedule;
+}
+export declare namespace UnassignedshiftRetrieveResponse {
+    /**
+     * The data of the shift
+     */
+    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>;
+    }
+    namespace ShiftData {
+        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;
+        }
+        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
+     */
+    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>;
+    }
+    namespace PublishedVersion {
+        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;
+        }
+        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
+     */
+    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;
+    }
+    namespace Schedule {
+        /**
+         * The settings of the schedule.
+         */
+        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 UnassignedshiftCreateParams {
+    /**
+     * Whether the shift is published
+     */
+    is_published: boolean;
+    /**
+     * The ID of the schedule
+     */
+    schedule_id: string;
+    /**
+     * The data of the shift
+     */
+    shift_data: UnassignedshiftCreateParams.ShiftData;
+    /**
+     * The target count of the shift
+     */
+    target_count: number;
+    /**
+     * Configuration for an open shift. If present, this is an open shift (workers can
+     * sign up). If absent/None, this is an empty shift (placeholder).
+     */
+    open_shift_config?: unknown;
+}
+export declare namespace UnassignedshiftCreateParams {
+    /**
+     * The data of the shift
+     */
+    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>;
+    }
+    namespace ShiftData {
+        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';
+        }
+        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 IDs of the job codes associated with the shift segment
+             */
+            job_codes_id?: Array<string>;
+        }
+    }
+}
+export interface UnassignedshiftRetrieveParams {
+    expand?: string;
+}
+export declare namespace Unassignedshifts {
+    export { type UnassignedshiftListResponse as UnassignedshiftListResponse, type UnassignedshiftCreateResponse as UnassignedshiftCreateResponse, type UnassignedshiftRetrieveResponse as UnassignedshiftRetrieveResponse, type UnassignedshiftListResponsesPageCursorURL as UnassignedshiftListResponsesPageCursorURL, type UnassignedshiftListParams as UnassignedshiftListParams, type UnassignedshiftCreateParams as UnassignedshiftCreateParams, type UnassignedshiftRetrieveParams as UnassignedshiftRetrieveParams, };
+}
+//# sourceMappingURL=unassignedshifts.d.ts.map