@rippling/rippling-sdk 0.2.0-alpha.24 → 0.2.0-alpha.26

package/src/resources/shiftassignments.ts

@@ -96,7 +96,8 @@ export interface ShiftassignmentListResponse {
   updated_at: string;
 
   /**
-   * The ID of the worker
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
    */
   worker_id: string;
 
@@ -105,6 +106,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.
@@ -141,6 +147,11 @@ export namespace ShiftassignmentListResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -214,6 +225,11 @@ export namespace ShiftassignmentListResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -393,7 +409,8 @@ export interface ShiftassignmentCreateResponse {
   updated_at: string;
 
   /**
-   * The ID of the worker
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
    */
   worker_id: string;
 
@@ -402,6 +419,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.
@@ -438,6 +460,11 @@ export namespace ShiftassignmentCreateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -511,6 +538,11 @@ export namespace ShiftassignmentCreateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -693,7 +725,8 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
   updated_at: string;
 
   /**
-   * The ID of the worker
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
    */
   worker_id: string;
 
@@ -702,6 +735,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.
@@ -738,6 +776,11 @@ export namespace ShiftassignmentRetrieveResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -811,6 +854,11 @@ export namespace ShiftassignmentRetrieveResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -990,7 +1038,8 @@ export interface ShiftassignmentUpdateResponse {
   updated_at: string;
 
   /**
-   * The ID of the worker
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
    */
   worker_id: string;
 
@@ -999,6 +1048,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.
@@ -1035,6 +1089,11 @@ export namespace ShiftassignmentUpdateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1108,6 +1167,11 @@ export namespace ShiftassignmentUpdateResponse {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1282,7 +1346,8 @@ export interface ShiftassignmentCreateParams {
   shift_data: ShiftassignmentCreateParams.ShiftData;
 
   /**
-   * The ID of the worker
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
    */
   worker_id: string;
 }
@@ -1302,6 +1367,11 @@ export namespace ShiftassignmentCreateParams {
      */
     start_time: string;
 
+    /**
+     * Notes for the shift, max length 256 characters
+     */
+    notes?: string;
+
     /**
      * The breaks of the shift
      */
@@ -1361,18 +1431,14 @@ export interface ShiftassignmentUpdateParams {
    */
   is_published: boolean;
 
-  /**
-   * The ID of the schedule
-   */
-  schedule_id: string;
-
   /**
    * The data of the shift
    */
   shift_data: ShiftassignmentUpdateParams.ShiftData;
 
   /**
-   * The ID of the worker
+   * The ID of the worker. Empty string '' to unassign if shift is from an open/empty
+   * shift.
    */
   worker_id: string;
 }
@@ -1392,6 +1458,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/supergroups/exclusion-members.ts

@@ -1,8 +1,8 @@
 // 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';
@@ -13,16 +13,17 @@ export class ExclusionMembers extends APIResource {
    * Retrieve supergroup exclusion members matching the input parameters.
    *
    * - Requires: `API Tier 1`
+   * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
     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 },
     );
   }
@@ -47,6 +48,8 @@ export interface ExclusionMemberUpdateResponse {
 }
 
 export interface ExclusionMemberListParams {
+  expand?: string;
+
   order_by?: string;
 }
 

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

@@ -1,8 +1,8 @@
 // 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';
@@ -13,16 +13,17 @@ export class InclusionMembers extends APIResource {
    * Retrieve supergroup inclusion members matching the input parameters.
    *
    * - Requires: `API Tier 1`
+   * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(
     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 },
     );
   }
@@ -47,6 +48,8 @@ export interface InclusionMemberUpdateResponse {
 }
 
 export interface InclusionMemberListParams {
+  expand?: string;
+
   order_by?: string;
 }
 

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,

package/src/resources/supergroups/members.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { GroupMembersPageCursorURL } from '../shared';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -10,57 +12,29 @@ export class Members extends APIResource {
    * Retrieve supergroup members matching the input parameters.
    *
    * - Requires: `API Tier 1`
+   * - Expandable fields: `worker`
    * - 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>, {
+  ): PagePromise<GroupMembersPageCursorURL, Shared.GroupMember> {
+    return this._client.getAPIList(path`/supergroups/${groupID}/members`, PageCursorURL<Shared.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 {
+  expand?: string;
+
   order_by?: string;
 }
 
 export declare namespace Members {
-  export {
-    type GroupMember as GroupMember,
-    type GroupMembersPageCursorURL as GroupMembersPageCursorURL,
-    type MemberListParams as MemberListParams,
-  };
+  export { type MemberListParams as MemberListParams };
 }
+
+export { type GroupMembersPageCursorURL };

package/src/resources/supergroups/supergroups.ts

@@ -17,7 +17,7 @@ import {
   InclusionMembers,
 } from './inclusion-members';
 import * as MembersAPI from './members';
-import { GroupMember, GroupMembersPageCursorURL, MemberListParams, Members } from './members';
+import { MemberListParams, Members } from './members';
 import { APIPromise } from '../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -176,12 +176,7 @@ export declare namespace Supergroups {
     type SupergroupListParams as SupergroupListParams,
   };
 
-  export {
-    Members as Members,
-    type GroupMember as GroupMember,
-    type GroupMembersPageCursorURL as GroupMembersPageCursorURL,
-    type MemberListParams as MemberListParams,
-  };
+  export { Members as Members, type MemberListParams as MemberListParams };
 
   export {
     InclusionMembers as InclusionMembers,

package/src/resources/titles.ts

@@ -0,0 +1,181 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Titles extends APIResource {
+  /**
+   * A List of titles
+   *
+   * - Requires: `API Tier 1`
+   * - Sortable fields: `id`, `created_at`, `updated_at`
+   */
+  list(
+    query: TitleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TitleListResponsesPageCursorURL, TitleListResponse> {
+    return this._client.getAPIList('/titles', PageCursorURL<TitleListResponse>, { query, ...options });
+  }
+
+  /**
+   * Create a new title
+   */
+  create(body: TitleCreateParams, options?: RequestOptions): APIPromise<TitleCreateResponse> {
+    return this._client.post('/titles', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific title
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<TitleRetrieveResponse> {
+    return this._client.get(path`/titles/${id}`, options);
+  }
+
+  /**
+   * Updated a specific title
+   */
+  update(id: string, body: TitleUpdateParams, options?: RequestOptions): APIPromise<TitleUpdateResponse> {
+    return this._client.patch(path`/titles/${id}`, { body, ...options });
+  }
+
+  /**
+   * Delete a title
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/titles/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type TitleListResponsesPageCursorURL = PageCursorURL<TitleListResponse>;
+
+export interface TitleListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the title.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+export interface TitleCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the title.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface TitleRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the title.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+export interface TitleUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The name of the title.
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+}
+
+export interface TitleListParams {
+  cursor?: string;
+
+  order_by?: string;
+}
+
+export interface TitleCreateParams {
+  /**
+   * The name of the title.
+   */
+  name: string;
+}
+
+export interface TitleUpdateParams {
+  /**
+   * The name of the title.
+   */
+  name: string;
+}
+
+export declare namespace Titles {
+  export {
+    type TitleListResponse as TitleListResponse,
+    type TitleCreateResponse as TitleCreateResponse,
+    type TitleRetrieveResponse as TitleRetrieveResponse,
+    type TitleUpdateResponse as TitleUpdateResponse,
+    type TitleListResponsesPageCursorURL as TitleListResponsesPageCursorURL,
+    type TitleListParams as TitleListParams,
+    type TitleCreateParams as TitleCreateParams,
+    type TitleUpdateParams as TitleUpdateParams,
+  };
+}