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

package/resources/unassigned-shifts.d.ts

@@ -0,0 +1,337 @@
+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 { RequestOptions } from "../internal/request-options.js";
+/**
+ * Unassigned shifts that are part of a schedule
+ */
+export declare class UnassignedShifts extends APIResource {
+    /**
+     * Update custom fields for a unassigned shift. The request body should contain a
+     * dictionary mapping custom field names to their values.
+     *
+     * - Requires: `API Tier 2`
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.unassignedShifts.updateCustomfields('id');
+     * ```
+     */
+    updateCustomfields(id: string, body: UnassignedShiftUpdateCustomfieldsParams, options?: RequestOptions): APIPromise<UnassignedShiftUpdateCustomfieldsResponse>;
+    /**
+     * Assign a worker to an unassigned shift (open shift). The shift must be an open
+     * shift and not at capacity.
+     *
+     * - Requires: `API Tier 2`
+     *
+     * @example
+     * ```ts
+     * const response = await client.unassignedShifts.assign(
+     *   'id',
+     *   { worker_id: 'worker_id' },
+     * );
+     * ```
+     */
+    assign(id: string, body: UnassignedShiftAssignParams, options?: RequestOptions): APIPromise<UnassignedShiftAssignResponse>;
+}
+/**
+ * Meta information for the response.
+ */
+export interface UnassignedShiftUpdateCustomfieldsResponse 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: UnassignedShiftUpdateCustomfieldsResponse.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>;
+    /**
+     * Custom fields for the unassigned shift
+     */
+    custom_fields?: Array<unknown>;
+    /**
+     * 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?: UnassignedShiftUpdateCustomfieldsResponse.PublishedVersion;
+    /**
+     * The schedule
+     *
+     * Expandable field
+     */
+    schedule?: UnassignedShiftUpdateCustomfieldsResponse.Schedule;
+}
+export declare namespace UnassignedShiftUpdateCustomfieldsResponse {
+    /**
+     * 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;
+        /**
+         * 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>;
+    }
+    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;
+        /**
+         * 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>;
+    }
+    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 UnassignedShiftAssignResponse {
+    /**
+     * The current number of assigned workers for this shift
+     */
+    assigned_count?: number;
+    /**
+     * List of shift assignment IDs for this shift
+     */
+    assigned_shift_ids?: Array<string>;
+    /**
+     * The ID of the newly created shift assignment
+     */
+    assignment_id?: string;
+    /**
+     * The target number of workers for this shift
+     */
+    target_count?: number;
+}
+export interface UnassignedShiftUpdateCustomfieldsParams {
+    /**
+     * Example custom field name. Replace with your actual custom field names.
+     */
+    FieldName1?: string;
+    [k: string]: unknown;
+}
+export interface UnassignedShiftAssignParams {
+    /**
+     * The ID of the worker (role) to assign to the shift
+     */
+    worker_id: string;
+}
+export declare namespace UnassignedShifts {
+    export { type UnassignedShiftUpdateCustomfieldsResponse as UnassignedShiftUpdateCustomfieldsResponse, type UnassignedShiftAssignResponse as UnassignedShiftAssignResponse, type UnassignedShiftUpdateCustomfieldsParams as UnassignedShiftUpdateCustomfieldsParams, type UnassignedShiftAssignParams as UnassignedShiftAssignParams, };
+}
+//# sourceMappingURL=unassigned-shifts.d.ts.map

package/resources/unassigned-shifts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unassigned-shifts.d.ts","sourceRoot":"","sources":["../src/resources/unassigned-shifts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,mBAAmB;OACxB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,uCAAuC,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yCAAyC,CAAC;IAIxD;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAG7C;AAED;;GAEG;AACH,MAAM,WAAW,yCAA0C,SAAQ,mBAAmB,CAAC,IAAI;IACzF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,yCAAyC,CAAC,SAAS,CAAC;IAEhE;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE/B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,yCAAyC,CAAC,gBAAgB,CAAC;IAE/E;;;;OAIG;IACH,QAAQ,CAAC,EAAE,yCAAyC,CAAC,QAAQ,CAAC;CAC/D;AAED,yBAAiB,yCAAyC,CAAC;IACzD;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAE3C;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;KAChD;IAED,UAAiB,SAAS,CAAC;QACzB,UAAiB,UAAU;YACzB;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC9B;KACF;IAED;;OAEG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAElD;;WAEG;QACH,cAAc,CAAC,EAAE,KAAK,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;KACvD;IAED,UAAiB,gBAAgB,CAAC;QAChC,UAAiB,UAAU;YACzB;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,gBAAgB,EAAE,MAAM,CAAC;YAEzB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SAC9B;KACF;IAED;;;;OAIG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAEpC;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;;;WAIG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAErC;;WAEG;QACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B;;WAEG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;KAC9B;IAED,UAAiB,QAAQ,CAAC;QACxB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;;eAIG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uCAAuC;IACtD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,yCAAyC,IAAI,yCAAyC,EAC3F,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;CACH"}

package/resources/unassigned-shifts.js

@@ -0,0 +1,45 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnassignedShifts = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Unassigned shifts that are part of a schedule
+ */
+class UnassignedShifts extends resource_1.APIResource {
+    /**
+     * Update custom fields for a unassigned shift. The request body should contain a
+     * dictionary mapping custom field names to their values.
+     *
+     * - Requires: `API Tier 2`
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.unassignedShifts.updateCustomfields('id');
+     * ```
+     */
+    updateCustomfields(id, body, options) {
+        return this._client.patch((0, path_1.path) `/unassignedshifts/${id}/customfields`, { body, ...options });
+    }
+    /**
+     * Assign a worker to an unassigned shift (open shift). The shift must be an open
+     * shift and not at capacity.
+     *
+     * - Requires: `API Tier 2`
+     *
+     * @example
+     * ```ts
+     * const response = await client.unassignedShifts.assign(
+     *   'id',
+     *   { worker_id: 'worker_id' },
+     * );
+     * ```
+     */
+    assign(id, body, options) {
+        return this._client.post((0, path_1.path) `/unassignedshifts/${id}/assign`, { body, ...options });
+    }
+}
+exports.UnassignedShifts = UnassignedShifts;
+//# sourceMappingURL=unassigned-shifts.js.map

package/resources/unassigned-shifts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unassigned-shifts.js","sourceRoot":"","sources":["../src/resources/unassigned-shifts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAK/C,oDAA8C;AAE9C;;GAEG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,EAAU,EACV,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF;AA1CD,4CA0CC"}

package/resources/unassigned-shifts.mjs

@@ -0,0 +1,41 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Unassigned shifts that are part of a schedule
+ */
+export class UnassignedShifts extends APIResource {
+    /**
+     * Update custom fields for a unassigned shift. The request body should contain a
+     * dictionary mapping custom field names to their values.
+     *
+     * - Requires: `API Tier 2`
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.unassignedShifts.updateCustomfields('id');
+     * ```
+     */
+    updateCustomfields(id, body, options) {
+        return this._client.patch(path `/unassignedshifts/${id}/customfields`, { body, ...options });
+    }
+    /**
+     * Assign a worker to an unassigned shift (open shift). The shift must be an open
+     * shift and not at capacity.
+     *
+     * - Requires: `API Tier 2`
+     *
+     * @example
+     * ```ts
+     * const response = await client.unassignedShifts.assign(
+     *   'id',
+     *   { worker_id: 'worker_id' },
+     * );
+     * ```
+     */
+    assign(id, body, options) {
+        return this._client.post(path `/unassignedshifts/${id}/assign`, { body, ...options });
+    }
+}
+//# sourceMappingURL=unassigned-shifts.mjs.map

package/resources/unassigned-shifts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"unassigned-shifts.mjs","sourceRoot":"","sources":["../src/resources/unassigned-shifts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAKf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;;;;OAWG;IACH,kBAAkB,CAChB,EAAU,EACV,IAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,qBAAqB,EAAE,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,qBAAqB,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;CACF"}