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

package/src/resources/shift-assignments.ts

@@ -0,0 +1,365 @@
+// 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';
+
+/**
+ * Shift assignments assigned to workers
+ */
+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,
+  };
+}

package/src/resources/shift-inputs.ts

@@ -9,6 +9,9 @@ import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Shift inputs used by the company
+ */
 export class ShiftInputs extends APIResource {
   /**
    * A List of shift inputs

package/src/resources/shiftassignments.ts

@@ -8,6 +8,9 @@ import { PageCursorURL, PagePromise } from '../core/pagination';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Shift assignments assigned to workers
+ */
 export class Shiftassignments extends APIResource {
   /**
    * A List of shift assignments
@@ -106,6 +109,11 @@ export interface ShiftassignmentListResponse {
    */
   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.
@@ -142,6 +150,11 @@ export namespace ShiftassignmentListResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -215,6 +228,11 @@ export namespace ShiftassignmentListResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -404,6 +422,11 @@ export interface ShiftassignmentCreateResponse {
    */
   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.
@@ -440,6 +463,11 @@ export namespace ShiftassignmentCreateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -513,6 +541,11 @@ export namespace ShiftassignmentCreateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -705,6 +738,11 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
    */
   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.
@@ -741,6 +779,11 @@ export namespace ShiftassignmentRetrieveResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -814,6 +857,11 @@ export namespace ShiftassignmentRetrieveResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1003,6 +1051,11 @@ export interface ShiftassignmentUpdateResponse {
    */
   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.
@@ -1039,6 +1092,11 @@ export namespace ShiftassignmentUpdateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1112,6 +1170,11 @@ export namespace ShiftassignmentUpdateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1307,6 +1370,11 @@ export namespace ShiftassignmentCreateParams {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1366,11 +1434,6 @@ export interface ShiftassignmentUpdateParams {
    */
   is_published: boolean;
 
-  /**
-   * The ID of the schedule
-   */
-  schedule_id: string;
-
   /**
    * The data of the shift
    */
@@ -1398,6 +1461,11 @@ export namespace ShiftassignmentUpdateParams {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */

package/src/resources/sso-me.ts

@@ -5,6 +5,9 @@ import * as CompaniesAPI from './companies';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Provides the user's SSO information
+ */
 export class SSOMeResource extends APIResource {
   /**
    * SSO information of the current user

package/src/resources/supergroups/exclusion-members.ts

@@ -1,13 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as MembersAPI from './members';
-import { GroupMembersPageCursorURL } from './members';
+import * as Shared from '../shared';
+import { GroupMembersPageCursorURL } from '../shared';
 import { APIPromise } from '../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Supergroups used by the company
+ */
 export class ExclusionMembers extends APIResource {
   /**
    * Retrieve supergroup exclusion members matching the input parameters.
@@ -20,10 +23,10 @@ export class ExclusionMembers extends APIResource {
     groupID: string,
     query: ExclusionMemberListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<GroupMembersPageCursorURL, MembersAPI.GroupMember> {
+  ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
     return this._client.getAPIList(
       path`/supergroups/${groupID}/exclusion-members`,
-      PageCursorURL<MembersAPI.GroupMember>,
+      PageCursorURL<Shared.GroupMember>,
       { query, ...options },
     );
   }

package/src/resources/supergroups/inclusion-members.ts

@@ -1,13 +1,16 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as MembersAPI from './members';
-import { GroupMembersPageCursorURL } from './members';
+import * as Shared from '../shared';
+import { GroupMembersPageCursorURL } from '../shared';
 import { APIPromise } from '../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
+/**
+ * Supergroups used by the company
+ */
 export class InclusionMembers extends APIResource {
   /**
    * Retrieve supergroup inclusion members matching the input parameters.
@@ -20,10 +23,10 @@ export class InclusionMembers extends APIResource {
     groupID: string,
     query: InclusionMemberListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<GroupMembersPageCursorURL, MembersAPI.GroupMember> {
+  ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
     return this._client.getAPIList(
       path`/supergroups/${groupID}/inclusion-members`,
-      PageCursorURL<MembersAPI.GroupMember>,
+      PageCursorURL<Shared.GroupMember>,
       { query, ...options },
     );
   }

package/src/resources/supergroups/index.ts

@@ -12,7 +12,7 @@ export {
   type InclusionMemberListParams,
   type InclusionMemberUpdateParams,
 } from './inclusion-members';
-export { Members, type GroupMember, type MemberListParams, type GroupMembersPageCursorURL } from './members';
+export { Members, type MemberListParams } from './members';
 export {
   Supergroups,
   type Supergroup,