@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/shiftassignments.ts

@@ -0,0 +1,580 @@
+// 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 Shiftassignments extends APIResource {
+  /**
+   * Retrieve a specific shift assignment
+   */
+  retrieve(
+    id: string,
+    query: ShiftassignmentRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ShiftassignmentRetrieveResponse> {
+    return this._client.get(path`/shiftassignments/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of shift assignments
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `worker_id`, `schedule_id`, `shift_data.start_time`,
+   *   `shift_data.end_time`
+   * - Expandable fields: `worker`, `schedule`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: ShiftassignmentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ShiftassignmentListResponsesPageCursorURL, ShiftassignmentListResponse> {
+    return this._client.getAPIList('/shiftassignments', PageCursorURL<ShiftassignmentListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type ShiftassignmentListResponsesPageCursorURL = PageCursorURL<ShiftassignmentListResponse>;
+
+/**
+ * Meta information for the response.
+ */
+export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Whether the shift assignment can be edited
+   */
+  can_edit: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * Record update date
+   */
+  updated_at: 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.
+   */
+  published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
+
+  /**
+   * The schedule
+   *
+   * Expandable field
+   */
+  schedule?: ShiftassignmentRetrieveResponse.Schedule;
+
+  /**
+   * The ID of the schedule
+   */
+  schedule_id?: string;
+
+  /**
+   * The data of the shift
+   */
+  shift_data?: ShiftassignmentRetrieveResponse.ShiftData;
+
+  /**
+   * The worker
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker
+   */
+  worker_id?: string;
+}
+
+export namespace ShiftassignmentRetrieveResponse {
+  /**
+   * 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 breaks of the shift
+     */
+    shift_breaks: Array<PublishedVersion.ShiftBreak>;
+
+    /**
+     * The segments of the shift
+     */
+    shift_segments: Array<PublishedVersion.ShiftSegment>;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: string;
+  }
+
+  export namespace PublishedVersion {
+    export interface ShiftBreak {
+      /**
+       * The end time of the shift break
+       */
+      end_time: string;
+
+      /**
+       * The start time of the shift break
+       */
+      start_time: string;
+
+      /**
+       * The type of the shift break
+       */
+      type: string;
+    }
+
+    export interface ShiftSegment {
+      /**
+       * The end time of the shift segment
+       */
+      end_time: string;
+
+      /**
+       * 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>;
+    }
+  }
+
+  /**
+   * 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 data of the shift
+   */
+  export interface ShiftData {
+    /**
+     * The end time of the shift
+     */
+    end_time: string;
+
+    /**
+     * The breaks of the shift
+     */
+    shift_breaks: Array<ShiftData.ShiftBreak>;
+
+    /**
+     * The segments of the shift
+     */
+    shift_segments: Array<ShiftData.ShiftSegment>;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: string;
+  }
+
+  export namespace ShiftData {
+    export interface ShiftBreak {
+      /**
+       * The end time of the shift break
+       */
+      end_time: string;
+
+      /**
+       * The start time of the shift break
+       */
+      start_time: string;
+
+      /**
+       * The type of the shift break
+       */
+      type: string;
+    }
+
+    export interface ShiftSegment {
+      /**
+       * The end time of the shift segment
+       */
+      end_time: string;
+
+      /**
+       * 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 ShiftassignmentListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Whether the shift assignment can be edited
+   */
+  can_edit: boolean;
+
+  /**
+   * 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;
+
+  /**
+   * Record update date
+   */
+  updated_at: 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.
+   */
+  published_version?: ShiftassignmentListResponse.PublishedVersion;
+
+  /**
+   * The schedule
+   *
+   * Expandable field
+   */
+  schedule?: ShiftassignmentListResponse.Schedule;
+
+  /**
+   * The ID of the schedule
+   */
+  schedule_id?: string;
+
+  /**
+   * The data of the shift
+   */
+  shift_data?: ShiftassignmentListResponse.ShiftData;
+
+  /**
+   * The worker
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+
+  /**
+   * The ID of the worker
+   */
+  worker_id?: string;
+}
+
+export namespace ShiftassignmentListResponse {
+  /**
+   * 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 breaks of the shift
+     */
+    shift_breaks: Array<PublishedVersion.ShiftBreak>;
+
+    /**
+     * The segments of the shift
+     */
+    shift_segments: Array<PublishedVersion.ShiftSegment>;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: string;
+  }
+
+  export namespace PublishedVersion {
+    export interface ShiftBreak {
+      /**
+       * The end time of the shift break
+       */
+      end_time: string;
+
+      /**
+       * The start time of the shift break
+       */
+      start_time: string;
+
+      /**
+       * The type of the shift break
+       */
+      type: string;
+    }
+
+    export interface ShiftSegment {
+      /**
+       * The end time of the shift segment
+       */
+      end_time: string;
+
+      /**
+       * 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>;
+    }
+  }
+
+  /**
+   * 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 data of the shift
+   */
+  export interface ShiftData {
+    /**
+     * The end time of the shift
+     */
+    end_time: string;
+
+    /**
+     * The breaks of the shift
+     */
+    shift_breaks: Array<ShiftData.ShiftBreak>;
+
+    /**
+     * The segments of the shift
+     */
+    shift_segments: Array<ShiftData.ShiftSegment>;
+
+    /**
+     * The start time of the shift
+     */
+    start_time: string;
+  }
+
+  export namespace ShiftData {
+    export interface ShiftBreak {
+      /**
+       * The end time of the shift break
+       */
+      end_time: string;
+
+      /**
+       * The start time of the shift break
+       */
+      start_time: string;
+
+      /**
+       * The type of the shift break
+       */
+      type: string;
+    }
+
+    export interface ShiftSegment {
+      /**
+       * The end time of the shift segment
+       */
+      end_time: string;
+
+      /**
+       * 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 ShiftassignmentRetrieveParams {
+  expand?: string;
+}
+
+export interface ShiftassignmentListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export declare namespace Shiftassignments {
+  export {
+    type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse,
+    type ShiftassignmentListResponse as ShiftassignmentListResponse,
+    type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL,
+    type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams,
+    type ShiftassignmentListParams as ShiftassignmentListParams,
+  };
+}

package/src/resources/sso-me.ts

@@ -0,0 +1,60 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as CompaniesAPI from './companies';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class SSOMeResource extends APIResource {
+  /**
+   * SSO information of the current user
+   *
+   * - Requires: `API Tier 1`
+   * - Expandable fields: `company`
+   */
+  retrieve(query: SSOMeRetrieveParams | null | undefined = {}, options?: RequestOptions): APIPromise<SSOMe> {
+    return this._client.get('/sso-me', { query, ...options });
+  }
+}
+
+export interface SSOMe {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The company of the user.
+   *
+   * Expandable field
+   */
+  company?: CompaniesAPI.Company;
+
+  /**
+   * The company ID of the user.
+   */
+  company_id?: string;
+
+  /**
+   * The user's work email address.
+   */
+  work_email?: string;
+}
+
+export interface SSOMeRetrieveParams {
+  expand?: string;
+}
+
+export declare namespace SSOMeResource {
+  export { type SSOMe as SSOMe, type SSOMeRetrieveParams as SSOMeRetrieveParams };
+}

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

@@ -0,0 +1,88 @@
+// 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 { 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 ExclusionMembers extends APIResource {
+  /**
+   * Update the list of supergroup exclusion members.
+   */
+  update(
+    groupID: string,
+    body: ExclusionMemberUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ExclusionMemberUpdateResponse> {
+    return this._client.patch(path`/supergroups/${groupID}/exclusion-members`, { body, ...options });
+  }
+
+  /**
+   * Retrieve supergroup exclusion members matching the input parameters.
+   *
+   * - Requires: `API Tier 1`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    groupID: string,
+    query: ExclusionMemberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<GroupMembersPageCursorURL, MembersAPI.GroupMember> {
+    return this._client.getAPIList(
+      path`/supergroups/${groupID}/exclusion-members`,
+      PageCursorURL<MembersAPI.GroupMember>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface ExclusionMemberUpdateResponse {
+  /**
+   * Whether the operation succeeded.
+   */
+  ok?: boolean;
+}
+
+export interface ExclusionMemberUpdateParams {
+  Operations?: Array<ExclusionMemberUpdateParams.Operation>;
+}
+
+export namespace ExclusionMemberUpdateParams {
+  export interface Operation {
+    /**
+     * add or remove
+     */
+    op?: string;
+
+    /**
+     * The members to add or remove.
+     */
+    value?: Array<Operation.Value>;
+  }
+
+  export namespace Operation {
+    export interface Value {
+      /**
+       * A member id.
+       */
+      id?: string;
+    }
+  }
+}
+
+export interface ExclusionMemberListParams {
+  order_by?: string;
+}
+
+export declare namespace ExclusionMembers {
+  export {
+    type ExclusionMemberUpdateResponse as ExclusionMemberUpdateResponse,
+    type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams,
+    type ExclusionMemberListParams as ExclusionMemberListParams,
+  };
+}
+
+export { type GroupMembersPageCursorURL };