@rippling/rippling-sdk 0.2.0-alpha.21 → 0.2.0-alpha.23

package/src/resources/shiftassignments.ts

@@ -9,17 +9,6 @@ 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
    *
@@ -38,14 +27,22 @@ export class Shiftassignments extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * 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 });
+  }
 }
 
 export type ShiftassignmentListResponsesPageCursorURL = PageCursorURL<ShiftassignmentListResponse>;
 
-/**
- * Meta information for the response.
- */
-export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
+export interface ShiftassignmentListResponse {
   /**
    * Identifier field
    */
@@ -76,14 +73,14 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
    * 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;
+  published_version?: ShiftassignmentListResponse.PublishedVersion;
 
   /**
    * The schedule
    *
    * Expandable field
    */
-  schedule?: ShiftassignmentRetrieveResponse.Schedule;
+  schedule?: ShiftassignmentListResponse.Schedule;
 
   /**
    * The ID of the schedule
@@ -93,7 +90,7 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
   /**
    * The data of the shift
    */
-  shift_data?: ShiftassignmentRetrieveResponse.ShiftData;
+  shift_data?: ShiftassignmentListResponse.ShiftData;
 
   /**
    * The worker
@@ -108,7 +105,7 @@ export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Met
   worker_id?: string;
 }
 
-export namespace ShiftassignmentRetrieveResponse {
+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.
@@ -237,6 +234,25 @@ export namespace ShiftassignmentRetrieveResponse {
      * 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;
+    }
   }
 
   /**
@@ -301,7 +317,10 @@ export namespace ShiftassignmentRetrieveResponse {
   }
 }
 
-export interface ShiftassignmentListResponse {
+/**
+ * Meta information for the response.
+ */
+export interface ShiftassignmentRetrieveResponse extends BusinessPartnersAPI.Meta {
   /**
    * Identifier field
    */
@@ -332,14 +351,14 @@ export interface 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.
    */
-  published_version?: ShiftassignmentListResponse.PublishedVersion;
+  published_version?: ShiftassignmentRetrieveResponse.PublishedVersion;
 
   /**
    * The schedule
    *
    * Expandable field
    */
-  schedule?: ShiftassignmentListResponse.Schedule;
+  schedule?: ShiftassignmentRetrieveResponse.Schedule;
 
   /**
    * The ID of the schedule
@@ -349,7 +368,7 @@ export interface ShiftassignmentListResponse {
   /**
    * The data of the shift
    */
-  shift_data?: ShiftassignmentListResponse.ShiftData;
+  shift_data?: ShiftassignmentRetrieveResponse.ShiftData;
 
   /**
    * The worker
@@ -364,7 +383,7 @@ export interface ShiftassignmentListResponse {
   worker_id?: string;
 }
 
-export namespace ShiftassignmentListResponse {
+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.
@@ -493,6 +512,25 @@ export namespace ShiftassignmentListResponse {
      * 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;
+    }
   }
 
   /**
@@ -557,10 +595,6 @@ export namespace ShiftassignmentListResponse {
   }
 }
 
-export interface ShiftassignmentRetrieveParams {
-  expand?: string;
-}
-
 export interface ShiftassignmentListParams {
   expand?: string;
 
@@ -569,12 +603,16 @@ export interface ShiftassignmentListParams {
   order_by?: string;
 }
 
+export interface ShiftassignmentRetrieveParams {
+  expand?: string;
+}
+
 export declare namespace Shiftassignments {
   export {
-    type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse,
     type ShiftassignmentListResponse as ShiftassignmentListResponse,
+    type ShiftassignmentRetrieveResponse as ShiftassignmentRetrieveResponse,
     type ShiftassignmentListResponsesPageCursorURL as ShiftassignmentListResponsesPageCursorURL,
-    type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams,
     type ShiftassignmentListParams as ShiftassignmentListParams,
+    type ShiftassignmentRetrieveParams as ShiftassignmentRetrieveParams,
   };
 }

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

@@ -9,17 +9,6 @@ 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.
    *
@@ -37,6 +26,17 @@ export class ExclusionMembers extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * 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 });
+  }
 }
 
 export interface ExclusionMemberUpdateResponse {
@@ -46,6 +46,10 @@ export interface ExclusionMemberUpdateResponse {
   ok?: boolean;
 }
 
+export interface ExclusionMemberListParams {
+  order_by?: string;
+}
+
 export interface ExclusionMemberUpdateParams {
   Operations?: Array<ExclusionMemberUpdateParams.Operation>;
 }
@@ -73,15 +77,11 @@ export namespace ExclusionMemberUpdateParams {
   }
 }
 
-export interface ExclusionMemberListParams {
-  order_by?: string;
-}
-
 export declare namespace ExclusionMembers {
   export {
     type ExclusionMemberUpdateResponse as ExclusionMemberUpdateResponse,
-    type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams,
     type ExclusionMemberListParams as ExclusionMemberListParams,
+    type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams,
   };
 }
 

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

@@ -9,17 +9,6 @@ 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.
    *
@@ -37,6 +26,17 @@ export class InclusionMembers extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * 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 });
+  }
 }
 
 export interface InclusionMemberUpdateResponse {
@@ -46,6 +46,10 @@ export interface InclusionMemberUpdateResponse {
   ok?: boolean;
 }
 
+export interface InclusionMemberListParams {
+  order_by?: string;
+}
+
 export interface InclusionMemberUpdateParams {
   Operations?: Array<InclusionMemberUpdateParams.Operation>;
 }
@@ -73,15 +77,11 @@ export namespace InclusionMemberUpdateParams {
   }
 }
 
-export interface InclusionMemberListParams {
-  order_by?: string;
-}
-
 export declare namespace InclusionMembers {
   export {
     type InclusionMemberUpdateResponse as InclusionMemberUpdateResponse,
-    type InclusionMemberUpdateParams as InclusionMemberUpdateParams,
     type InclusionMemberListParams as InclusionMemberListParams,
+    type InclusionMemberUpdateParams as InclusionMemberUpdateParams,
   };
 }
 

package/src/resources/supergroups/index.ts

@@ -3,14 +3,14 @@
 export {
   ExclusionMembers,
   type ExclusionMemberUpdateResponse,
-  type ExclusionMemberUpdateParams,
   type ExclusionMemberListParams,
+  type ExclusionMemberUpdateParams,
 } from './exclusion-members';
 export {
   InclusionMembers,
   type InclusionMemberUpdateResponse,
-  type InclusionMemberUpdateParams,
   type InclusionMemberListParams,
+  type InclusionMemberUpdateParams,
 } from './inclusion-members';
 export { Members, type GroupMember, type MemberListParams, type GroupMembersPageCursorURL } from './members';
 export {

package/src/resources/supergroups/supergroups.ts

@@ -32,13 +32,6 @@ export class Supergroups extends APIResource {
     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.
    *
@@ -52,6 +45,13 @@ export class Supergroups extends APIResource {
   ): PagePromise<SupergroupsPageCursorURL, Supergroup> {
     return this._client.getAPIList('/supergroups', PageCursorURL<Supergroup>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific supergroup.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<SupergroupRetrieveResponse> {
+    return this._client.get(path`/supergroups/${id}`, options);
+  }
 }
 
 export type SupergroupsPageCursorURL = PageCursorURL<Supergroup>;
@@ -186,14 +186,14 @@ export declare namespace Supergroups {
   export {
     InclusionMembers as InclusionMembers,
     type InclusionMemberUpdateResponse as InclusionMemberUpdateResponse,
-    type InclusionMemberUpdateParams as InclusionMemberUpdateParams,
     type InclusionMemberListParams as InclusionMemberListParams,
+    type InclusionMemberUpdateParams as InclusionMemberUpdateParams,
   };
 
   export {
     ExclusionMembers as ExclusionMembers,
     type ExclusionMemberUpdateResponse as ExclusionMemberUpdateResponse,
-    type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams,
     type ExclusionMemberListParams as ExclusionMemberListParams,
+    type ExclusionMemberUpdateParams as ExclusionMemberUpdateParams,
   };
 }

package/src/resources/teams.ts

@@ -8,17 +8,6 @@ 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
    *
@@ -32,6 +21,17 @@ export class Teams extends APIResource {
   ): PagePromise<TeamsPageCursorURL, Team> {
     return this._client.getAPIList('/teams', PageCursorURL<Team>, { query, ...options });
   }
+
+  /**
+   * Retrieve a specific team
+   */
+  retrieve(
+    id: string,
+    query: TeamRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TeamRetrieveResponse> {
+    return this._client.get(path`/teams/${id}`, { query, ...options });
+  }
 }
 
 export type TeamsPageCursorURL = PageCursorURL<Team>;
@@ -75,22 +75,22 @@ export interface Team {
  */
 export interface TeamRetrieveResponse extends BusinessPartnersAPI.Meta, Team {}
 
-export interface TeamRetrieveParams {
-  expand?: string;
-}
-
 export interface TeamListParams {
   expand?: string;
 
   order_by?: string;
 }
 
+export interface TeamRetrieveParams {
+  expand?: 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,
+    type TeamRetrieveParams as TeamRetrieveParams,
   };
 }

package/src/resources/time-cards.ts

@@ -9,17 +9,6 @@ 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
    *
@@ -34,6 +23,17 @@ export class TimeCards extends APIResource {
   ): PagePromise<TimeCardsPageCursorURL, TimeCard> {
     return this._client.getAPIList('/time-cards', PageCursorURL<TimeCard>, { query, ...options });
   }
+
+  /**
+   * 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 });
+  }
 }
 
 export type TimeCardsPageCursorURL = PageCursorURL<TimeCard>;
@@ -185,10 +185,6 @@ export namespace TimeCard {
  */
 export interface TimeCardRetrieveResponse extends BusinessPartnersAPI.Meta, TimeCard {}
 
-export interface TimeCardRetrieveParams {
-  expand?: string;
-}
-
 export interface TimeCardListParams {
   expand?: string;
 
@@ -197,13 +193,17 @@ export interface TimeCardListParams {
   order_by?: string;
 }
 
+export interface TimeCardRetrieveParams {
+  expand?: 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,
+    type TimeCardRetrieveParams as TimeCardRetrieveParams,
   };
 }