@rippling/rippling-sdk 0.2.0-alpha.20

package/src/resources/supergroups/inclusion-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 InclusionMembers extends APIResource {
+  /**
+   * Update the list of supergroup inclusion members.
+   */
+  update(
+    groupID: string,
+    body: InclusionMemberUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InclusionMemberUpdateResponse> {
+    return this._client.patch(path`/supergroups/${groupID}/inclusion-members`, { body, ...options });
+  }
+
+  /**
+   * Retrieve supergroup inclusion members matching the input parameters.
+   *
+   * - Requires: `API Tier 1`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    groupID: string,
+    query: InclusionMemberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<GroupMembersPageCursorURL, MembersAPI.GroupMember> {
+    return this._client.getAPIList(
+      path`/supergroups/${groupID}/inclusion-members`,
+      PageCursorURL<MembersAPI.GroupMember>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface InclusionMemberUpdateResponse {
+  /**
+   * Whether the operation succeeded.
+   */
+  ok?: boolean;
+}
+
+export interface InclusionMemberUpdateParams {
+  Operations?: Array<InclusionMemberUpdateParams.Operation>;
+}
+
+export namespace InclusionMemberUpdateParams {
+  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 InclusionMemberListParams {
+  order_by?: string;
+}
+
+export declare namespace InclusionMembers {
+  export {
+    type InclusionMemberUpdateResponse as InclusionMemberUpdateResponse,
+    type InclusionMemberUpdateParams as InclusionMemberUpdateParams,
+    type InclusionMemberListParams as InclusionMemberListParams,
+  };
+}
+
+export { type GroupMembersPageCursorURL };

package/src/resources/supergroups/index.ts

@@ -0,0 +1,22 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ExclusionMembers,
+  type ExclusionMemberUpdateResponse,
+  type ExclusionMemberUpdateParams,
+  type ExclusionMemberListParams,
+} from './exclusion-members';
+export {
+  InclusionMembers,
+  type InclusionMemberUpdateResponse,
+  type InclusionMemberUpdateParams,
+  type InclusionMemberListParams,
+} from './inclusion-members';
+export { Members, type GroupMember, type MemberListParams, type GroupMembersPageCursorURL } from './members';
+export {
+  Supergroups,
+  type Supergroup,
+  type SupergroupRetrieveResponse,
+  type SupergroupListParams,
+  type SupergroupsPageCursorURL,
+} from './supergroups';

package/src/resources/supergroups/members.ts

@@ -0,0 +1,66 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Members extends APIResource {
+  /**
+   * Retrieve supergroup members matching the input parameters.
+   *
+   * - Requires: `API Tier 1`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    groupID: string,
+    query: MemberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<GroupMembersPageCursorURL, GroupMember> {
+    return this._client.getAPIList(path`/supergroups/${groupID}/members`, PageCursorURL<GroupMember>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type GroupMembersPageCursorURL = PageCursorURL<GroupMember>;
+
+export interface GroupMember {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The group member's full name.
+   */
+  full_name?: string;
+
+  /**
+   * The group member's associated work email address.
+   */
+  work_email?: string;
+}
+
+export interface MemberListParams {
+  order_by?: string;
+}
+
+export declare namespace Members {
+  export {
+    type GroupMember as GroupMember,
+    type GroupMembersPageCursorURL as GroupMembersPageCursorURL,
+    type MemberListParams as MemberListParams,
+  };
+}

package/src/resources/supergroups/supergroups.ts

@@ -0,0 +1,199 @@
+// 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 ExclusionMembersAPI from './exclusion-members';
+import {
+  ExclusionMemberListParams,
+  ExclusionMemberUpdateParams,
+  ExclusionMemberUpdateResponse,
+  ExclusionMembers,
+} from './exclusion-members';
+import * as InclusionMembersAPI from './inclusion-members';
+import {
+  InclusionMemberListParams,
+  InclusionMemberUpdateParams,
+  InclusionMemberUpdateResponse,
+  InclusionMembers,
+} from './inclusion-members';
+import * as MembersAPI from './members';
+import { GroupMember, GroupMembersPageCursorURL, MemberListParams, Members } 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 Supergroups extends APIResource {
+  members: MembersAPI.Members = new MembersAPI.Members(this._client);
+  inclusionMembers: InclusionMembersAPI.InclusionMembers = new InclusionMembersAPI.InclusionMembers(
+    this._client,
+  );
+  exclusionMembers: ExclusionMembersAPI.ExclusionMembers = new ExclusionMembersAPI.ExclusionMembers(
+    this._client,
+  );
+
+  /**
+   * Retrieve a specific supergroup.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SupergroupRetrieveResponse> {
+    return this._client.get(path`/supergroups/${id}`, options);
+  }
+
+  /**
+   * Retrieve supergroups matching the input parameters.
+   *
+   * - Requires: `API Tier 1`
+   * - Filterable fields: `app_owner_id`, `group_type`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: SupergroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SupergroupsPageCursorURL, Supergroup> {
+    return this._client.getAPIList('/supergroups', PageCursorURL<Supergroup>, { query, ...options });
+  }
+}
+
+export type SupergroupsPageCursorURL = PageCursorURL<Supergroup>;
+
+export interface Supergroup {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Whether the group allows non employees
+   */
+  allow_non_employees?: boolean;
+
+  /**
+   * The id of the group's app owner.
+   */
+  app_owner_id?: string;
+
+  /**
+   * Whether the group can override role states
+   */
+  can_override_role_states?: boolean;
+
+  /**
+   * Whether the group is the cumulatively exhaustive default
+   */
+  cumulatively_exhaustive_default?: boolean;
+
+  /**
+   * The group's description.
+   */
+  description?: string;
+
+  /**
+   * The group's display name.
+   */
+  display_name?: string;
+
+  /**
+   * The group type
+   */
+  group_type?: string;
+
+  /**
+   * Whether to ignore provisioning group matching when determining group membership
+   */
+  ignore_prov_group_matching?: boolean;
+
+  /**
+   * Whether the group include terminated roles
+   */
+  include_terminated?: boolean;
+
+  /**
+   * Whether the group is invisible
+   */
+  is_invisible?: boolean;
+
+  /**
+   * The group's mutually exclusive key
+   */
+  mutually_exclusive_key?: string;
+
+  /**
+   * The group's name.
+   */
+  name?: string;
+
+  /**
+   * The group's parent.
+   */
+  parent?: string;
+
+  /**
+   * The group's priority when calculating mutual exclusivity
+   */
+  priority?: number;
+
+  /**
+   * Whether the group is read only.
+   */
+  read_only?: boolean;
+
+  /**
+   * The sub group type
+   */
+  sub_group_type?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface SupergroupRetrieveResponse extends BusinessPartnersAPI.Meta, Supergroup {}
+
+export interface SupergroupListParams {
+  filter?: string;
+
+  order_by?: string;
+}
+
+Supergroups.Members = Members;
+Supergroups.InclusionMembers = InclusionMembers;
+Supergroups.ExclusionMembers = ExclusionMembers;
+
+export declare namespace Supergroups {
+  export {
+    type Supergroup as Supergroup,
+    type SupergroupRetrieveResponse as SupergroupRetrieveResponse,
+    type SupergroupsPageCursorURL as SupergroupsPageCursorURL,
+    type SupergroupListParams as SupergroupListParams,
+  };
+
+  export {
+    Members as Members,
+    type GroupMember as GroupMember,
+    type GroupMembersPageCursorURL as GroupMembersPageCursorURL,
+    type MemberListParams as MemberListParams,
+  };
+
+  export {
+    InclusionMembers as InclusionMembers,
+    type InclusionMemberUpdateResponse as InclusionMemberUpdateResponse,
+    type InclusionMemberUpdateParams as InclusionMemberUpdateParams,
+    type InclusionMemberListParams as InclusionMemberListParams,
+  };
+
+  export {
+    ExclusionMembers as ExclusionMembers,
+    type ExclusionMemberUpdateResponse as ExclusionMemberUpdateResponse,
+    type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams,
+    type ExclusionMemberListParams as ExclusionMemberListParams,
+  };
+}

package/src/resources/supergroups.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './supergroups/index';

package/src/resources/teams.ts

@@ -0,0 +1,96 @@
+// 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 { 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 Teams extends APIResource {
+  /**
+   * Retrieve a specific team
+   */
+  retrieve(
+    id: string,
+    query: TeamRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TeamRetrieveResponse> {
+    return this._client.get(path`/teams/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of teams
+   *
+   * - Requires: `API Tier 1`
+   * - Expandable fields: `parent`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: TeamListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TeamsPageCursorURL, Team> {
+    return this._client.getAPIList('/teams', PageCursorURL<Team>, { query, ...options });
+  }
+}
+
+export type TeamsPageCursorURL = PageCursorURL<Team>;
+
+export interface Team {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the team.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The parent team
+   *
+   * Expandable field
+   */
+  parent?: Team;
+
+  /**
+   * The parent team
+   */
+  parent_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface TeamRetrieveResponse extends BusinessPartnersAPI.Meta, Team {}
+
+export interface TeamRetrieveParams {
+  expand?: string;
+}
+
+export interface TeamListParams {
+  expand?: string;
+
+  order_by?: string;
+}
+
+export declare namespace Teams {
+  export {
+    type Team as Team,
+    type TeamRetrieveResponse as TeamRetrieveResponse,
+    type TeamsPageCursorURL as TeamsPageCursorURL,
+    type TeamRetrieveParams as TeamRetrieveParams,
+    type TeamListParams as TeamListParams,
+  };
+}

package/src/resources/time-cards.ts

@@ -0,0 +1,209 @@
+// 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 TimeCards extends APIResource {
+  /**
+   * Retrieve a specific time card
+   */
+  retrieve(
+    id: string,
+    query: TimeCardRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TimeCardRetrieveResponse> {
+    return this._client.get(path`/time-cards/${id}`, { query, ...options });
+  }
+
+  /**
+   * A List of time cards
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `pay_period.start_date`, `worker_id`
+   * - Expandable fields: `worker`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: TimeCardListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TimeCardsPageCursorURL, TimeCard> {
+    return this._client.getAPIList('/time-cards', PageCursorURL<TimeCard>, { query, ...options });
+  }
+}
+
+export type TimeCardsPageCursorURL = PageCursorURL<TimeCard>;
+
+export interface PayPeriod {
+  /**
+   * The end date of the pay period.
+   */
+  end_date?: string;
+
+  /**
+   * The ID of the pay schedule associated with the pay period.
+   */
+  pay_schedule_id?: string;
+
+  /**
+   * The start date of the pay period.
+   */
+  start_date?: string;
+}
+
+export interface TimeCard {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the worker associated with the time card.
+   */
+  worker_id: string;
+
+  /**
+   * The pay period associated with the time card.
+   */
+  pay_period?: PayPeriod;
+
+  /**
+   * The summary of the time card.
+   */
+  summary?: TimeCard.Summary;
+
+  /**
+   * The worker associated with the time card.
+   *
+   * Expandable field
+   */
+  worker?: WorkersAPI.Worker;
+}
+
+export namespace TimeCard {
+  /**
+   * The summary of the time card.
+   */
+  export interface Summary {
+    /**
+     * The approved hours for the pay period.
+     */
+    approved_hours?: number;
+
+    /**
+     * The total number of doubletime hours worked during the pay period.
+     */
+    double_overtime_hours?: number;
+
+    /**
+     * The earnings for the pay period.
+     */
+    earnings?: number;
+
+    /**
+     * The amount of hours worked for each job code for the pay period.
+     */
+    hours_worked_by_job_code?: Array<Summary.HoursWorkedByJobCode>;
+
+    /**
+     * The total number of overtime hours worked during the pay period.
+     */
+    overtime_hours?: number;
+
+    /**
+     * The paid hours for the pay period.
+     */
+    paid_hours?: number;
+
+    /**
+     * The premiums for the pay period.
+     */
+    premiums?: number;
+
+    /**
+     * The total number of regular hours worked during the pay period.
+     */
+    regular_hours?: number;
+
+    /**
+     * The total holiday hours for the pay period.
+     */
+    total_holiday_hours?: number;
+
+    /**
+     * The total hours for the pay period.
+     */
+    total_hours?: number;
+
+    /**
+     * The total paid time off hours for the pay period.
+     */
+    total_paid_time_off_hours?: number;
+
+    /**
+     * The total unpaid time off hours for the pay period.
+     */
+    total_unpaid_time_off_hours?: number;
+
+    /**
+     * The map of time entry to unpaidBreakHours in seconds
+     */
+    unpaid_break_hours_by_entry?: number;
+  }
+
+  export namespace Summary {
+    export interface HoursWorkedByJobCode {
+      /**
+       * The total hours worked for the job codes.
+       */
+      hours_worked?: number;
+
+      /**
+       * List of job code ids that this summary is tracking hours for.
+       */
+      job_codes_id?: Array<string>;
+    }
+  }
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface TimeCardRetrieveResponse extends BusinessPartnersAPI.Meta, TimeCard {}
+
+export interface TimeCardRetrieveParams {
+  expand?: string;
+}
+
+export interface TimeCardListParams {
+  expand?: string;
+
+  filter?: string;
+
+  order_by?: string;
+}
+
+export declare namespace TimeCards {
+  export {
+    type PayPeriod as PayPeriod,
+    type TimeCard as TimeCard,
+    type TimeCardRetrieveResponse as TimeCardRetrieveResponse,
+    type TimeCardsPageCursorURL as TimeCardsPageCursorURL,
+    type TimeCardRetrieveParams as TimeCardRetrieveParams,
+    type TimeCardListParams as TimeCardListParams,
+  };
+}