@rippling/rippling-sdk 0.2.0-alpha.87 → 0.2.0-alpha.89

package/src/resources/scheduled-job-assignments.ts

@@ -193,6 +193,11 @@ export interface ScheduledJobAssignmentRetrieveResponse extends BusinessPartners
 export interface ScheduledJobAssignmentListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/schedules.ts

@@ -397,6 +397,11 @@ export interface ScheduleListParams {
 
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/shift-inputs.ts

@@ -326,6 +326,11 @@ export interface ShiftInputListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/shiftassignments.ts

@@ -1328,6 +1328,11 @@ export interface ShiftassignmentListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/sites.ts

@@ -4,15 +4,15 @@ import { APIResource } from '../core/resource';
 import * as BusinessPartnersAPI from './business-partners';
 import { APIPromise } from '../core/api-promise';
 import { PageCursorURL, PagePromise } from '../core/pagination';
-import { type Uploadable } from '../core/uploads';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
-import { multipartFormRequestOptions } from '../internal/uploads';
 import { path } from '../internal/utils/path';
 
 export class Sites extends APIResource {
   /**
-   * Retrieves sites that the user has view or edit access on.
+   * Retrieves sites that the user has view or edit access on. Optional query param
+   * name filters by case-insensitive substring on display name. Use GET
+   * /sites/{api_name}/ for an exact api_name lookup.
    *
    * @example
    * ```ts
@@ -22,26 +22,28 @@ export class Sites extends APIResource {
    * }
    * ```
    */
-  list(options?: RequestOptions): PagePromise<SiteListResponsesPageCursorURL, SiteListResponse> {
-    return this._client.getAPIList('/sites/', PageCursorURL<SiteListResponse>, options);
+  list(
+    query: SiteListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SiteListResponsesPageCursorURL, SiteListResponse> {
+    return this._client.getAPIList('/sites/', PageCursorURL<SiteListResponse>, { query, ...options });
   }
 
   /**
-   * Create a new site via multipart/form-data. Requires name, api_name, and an asset
-   * file (HTML or zip).
+   * Create a new site from a staged upload.
    *
    * @example
    * ```ts
    * const site = await client.sites.create({
    *   api_name: 'my_portal',
-   *   asset: fs.createReadStream('path/to/file'),
+   *   file_id: 'file_id_1',
    *   name: 'My Portal',
    *   entry_path: 'index.html',
    * });
    * ```
    */
   create(body: SiteCreateParams, options?: RequestOptions): APIPromise<SiteCreateResponse> {
-    return this._client.post('/sites/', multipartFormRequestOptions({ body, ...options }, this._client));
+    return this._client.post('/sites/', { body, ...options });
   }
 
   /**
@@ -57,14 +59,14 @@ export class Sites extends APIResource {
   }
 
   /**
-   * Update a site via multipart/form-data. Provide asset when replacing the bundle;
-   * asset is required when entry_path is set.
+   * Update a site. To replace the bundle, pass a file_id from
+   * upload-batches/presign.
    *
    * @example
    * ```ts
    * const site = await client.sites.update('employee_portal', {
-   *   asset: fs.createReadStream('path/to/file'),
    *   entry_path: 'index.html',
+   *   file_id: 'file_id_1',
    *   name: 'My Portal',
    * });
    * ```
@@ -74,10 +76,7 @@ export class Sites extends APIResource {
     body: SiteUpdateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<SiteUpdateResponse> {
-    return this._client.patch(
-      path`/sites/${apiName}/`,
-      multipartFormRequestOptions({ body, ...options }, this._client),
-    );
+    return this._client.patch(path`/sites/${apiName}/`, { body, ...options });
   }
 
   /**
@@ -96,28 +95,22 @@ export class Sites extends APIResource {
   }
 
   /**
-   * Upload one or more files into Custom Sites staging storage and return active
-   * file_id values for later file-operations puts.
-   *
-   * Send multipart/form-data with fileMeta plus one binary part named
-   * file[<client_ref>] for each metadata entry.
+   * Create staged upload records and return presigned S3 POST credentials.
    *
    * @example
    * ```ts
-   * const response = await client.sites.uploadBatches({
-   *   fileMeta: [{ client_ref: 'index', path: 'index.html' }],
-   *   'file[index]': fs.createReadStream('path/to/file'),
+   * const response = await client.sites.uploadBatchesPresign({
+   *   file_intents: [
+   *     { client_ref: 'index', file_name: 'index.html' },
+   *   ],
    * });
    * ```
    */
-  uploadBatches(
-    body: SiteUploadBatchesParams,
+  uploadBatchesPresign(
+    body: SiteUploadBatchesPresignParams,
     options?: RequestOptions,
-  ): APIPromise<SiteUploadBatchesResponse> {
-    return this._client.post(
-      '/sites/upload-batches/',
-      multipartFormRequestOptions({ body, ...options }, this._client),
-    );
+  ): APIPromise<SiteUploadBatchesPresignResponse> {
+    return this._client.post('/sites/upload-batches/presign/', { body, ...options });
   }
 
   /**
@@ -184,6 +177,9 @@ export class Sites extends APIResource {
 
 export type SiteListResponsesPageCursorURL = PageCursorURL<SiteListResponse>;
 
+/**
+ * Response/resource shape for a custom site.
+ */
 export interface SiteListResponse {
   /**
    * Identifier field
@@ -215,11 +211,6 @@ export interface SiteListResponse {
    */
   current_bundle_id?: string;
 
-  /**
-   * The entry path inside the uploaded asset
-   */
-  entry_path?: string;
-
   /**
    * A Rippling-owned logo URL for the custom site
    */
@@ -236,6 +227,9 @@ export interface SiteListResponse {
   viewer_group_id?: string;
 }
 
+/**
+ * Response/resource shape for a custom site.
+ */
 export interface SiteCreateResponse {
   /**
    * Identifier field
@@ -267,11 +261,6 @@ export interface SiteCreateResponse {
    */
   current_bundle_id?: string;
 
-  /**
-   * The entry path inside the uploaded asset
-   */
-  entry_path?: string;
-
   /**
    * A Rippling-owned logo URL for the custom site
    */
@@ -322,11 +311,6 @@ export interface SiteRetrieveResponse extends BusinessPartnersAPI.Meta {
    */
   current_bundle_id?: string;
 
-  /**
-   * The entry path inside the uploaded asset
-   */
-  entry_path?: string;
-
   /**
    * A Rippling-owned logo URL for the custom site
    */
@@ -343,6 +327,9 @@ export interface SiteRetrieveResponse extends BusinessPartnersAPI.Meta {
   viewer_group_id?: string;
 }
 
+/**
+ * Response/resource shape for a custom site.
+ */
 export interface SiteUpdateResponse {
   /**
    * Identifier field
@@ -374,11 +361,6 @@ export interface SiteUpdateResponse {
    */
   current_bundle_id?: string;
 
-  /**
-   * The entry path inside the uploaded asset
-   */
-  entry_path?: string;
-
   /**
    * A Rippling-owned logo URL for the custom site
    */
@@ -395,11 +377,11 @@ export interface SiteUpdateResponse {
   viewer_group_id?: string;
 }
 
-export interface SiteUploadBatchesResponse {
+export interface SiteUploadBatchesPresignResponse {
   /**
    * Staged files created by the upload batch.
    */
-  files?: Array<SiteUploadBatchesResponse.File>;
+  files?: Array<SiteUploadBatchesPresignResponse.File>;
 
   /**
    * Identifier for the staged upload batch.
@@ -407,27 +389,39 @@ export interface SiteUploadBatchesResponse {
   upload_batch_id?: string;
 }
 
-export namespace SiteUploadBatchesResponse {
+export namespace SiteUploadBatchesPresignResponse {
   export interface File {
     /**
-     * Client-provided reference that maps to the multipart file field name.
+     * Any unique client-chosen id echoed with the staged file_id for correlation. Not
+     * used server-side beyond the response.
      */
     client_ref?: string;
 
     /**
-     * Active staged upload identifier for use in file operations.
+     * Staged upload identifier for use in create, update, or file operations.
      */
     file_id?: string;
 
     /**
-     * Normalized Custom Sites path for the uploaded file.
+     * Staged file name from the presign file_name intent.
      */
-    path?: string;
+    file_name?: string;
 
     /**
-     * Upload status. New uploads are returned as active.
+     * Upload status. Presigned uploads return awaiting_upload until the file is
+     * uploaded to S3 and consumed.
      */
     status?: string;
+
+    /**
+     * Form fields required for the S3 POST (send these before the file part).
+     */
+    upload_fields?: unknown;
+
+    /**
+     * Presigned S3 POST URL for uploading the file bytes.
+     */
+    upload_url?: string;
   }
 }
 
@@ -514,6 +508,9 @@ export namespace SiteFilesResponse {
   }
 }
 
+/**
+ * Response/resource shape for a custom site.
+ */
 export interface SiteFileOperationsResponse {
   /**
    * Identifier field
@@ -545,11 +542,6 @@ export interface SiteFileOperationsResponse {
    */
   current_bundle_id?: string;
 
-  /**
-   * The entry path inside the uploaded asset
-   */
-  entry_path?: string;
-
   /**
    * A Rippling-owned logo URL for the custom site
    */
@@ -566,85 +558,93 @@ export interface SiteFileOperationsResponse {
   viewer_group_id?: string;
 }
 
+export interface SiteListParams {
+  cursor?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+}
+
 export interface SiteCreateParams {
   /**
-   * The unique api name of the custom site.
+   * The unique api name of the custom site
    */
   api_name: string;
 
   /**
-   * Site asset file. Accepts a single HTML file (text/html) or a zip archive
-   * (application/zip) of the site bundle.
+   * Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes
+   * to S3. Required to create a site or replace the bundle.
    */
-  asset: Uploadable;
+  file_id: string;
 
   /**
-   * The display name of the custom site.
+   * The display name of the custom site
    */
   name: string;
 
   /**
-   * Entry path inside the uploaded asset (for example index.html). Required only
-   * when the asset does not already contain an index.html entry; optional otherwise
-   * (including zip uploads that include index.html).
+   * Entry path inside the uploaded asset (for example index.html). Required with
+   * file_id when the zip has no index.html.
    */
   entry_path?: string;
 
   /**
-   * Optional Rippling-owned logo URL for the custom site.
+   * A Rippling-owned logo URL for the custom site
    */
   logo?: string;
 }
 
 export interface SiteUpdateParams {
   /**
-   * Site asset file. Accepts a single HTML file (text/html) or a zip archive
-   * (application/zip) of the site bundle.
+   * The unique api name of the custom site
    */
-  asset?: Uploadable;
+  api_name?: string;
 
   /**
-   * Entry path inside the uploaded asset (for example index.html). Required only
-   * when the asset does not already contain an index.html entry; optional otherwise
-   * (including zip uploads that include index.html).
+   * Entry path inside the uploaded asset (for example index.html). Required with
+   * file_id when the zip has no index.html.
    */
   entry_path?: string;
 
   /**
-   * Optional Rippling-owned logo URL for the custom site.
+   * Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes
+   * to S3. Required to create a site or replace the bundle.
    */
-  logo?: string;
+  file_id?: string;
 
   /**
-   * The display name of the custom site.
+   * A Rippling-owned logo URL for the custom site
    */
-  name?: string;
-}
+  logo?: string;
 
-export interface SiteUploadBatchesParams {
   /**
-   * File metadata for each multipart upload part.
+   * The display name of the custom site
    */
-  fileMeta: Array<SiteUploadBatchesParams.FileMeta>;
+  name?: string;
+}
 
+export interface SiteUploadBatchesPresignParams {
   /**
-   * Binary file contents for client_ref index. Repeat as file[<client_ref>] for each
-   * fileMeta entry.
+   * Non-empty array of file upload intents to stage with presigned S3 upload URLs.
    */
-  'file[index]'?: Uploadable;
+  file_intents: Array<SiteUploadBatchesPresignParams.FileIntent>;
 }
 
-export namespace SiteUploadBatchesParams {
-  export interface FileMeta {
+export namespace SiteUploadBatchesPresignParams {
+  export interface FileIntent {
     /**
-     * Client-provided reference that maps to the multipart file field name.
+     * Any unique client-chosen id echoed with the staged file_id for correlation. Not
+     * used server-side beyond the response.
      */
     client_ref: string;
 
     /**
-     * Normalized Custom Sites path for the uploaded file.
+     * File name with extension (e.g. site.zip). Used to derive Content-Type and
+     * create/PATCH asset type.
      */
-    path: string;
+    file_name: string;
   }
 }
 
@@ -690,7 +690,8 @@ export namespace SiteFileOperationsParams {
     op: string;
 
     /**
-     * Staged upload file_id. Required for put operations on files.
+     * Staged upload id from POST /sites/upload-batches/presign/ after uploading bytes
+     * to S3. Required for put operations on files.
      */
     file_id?: string;
 
@@ -723,13 +724,14 @@ export declare namespace Sites {
     type SiteCreateResponse as SiteCreateResponse,
     type SiteRetrieveResponse as SiteRetrieveResponse,
     type SiteUpdateResponse as SiteUpdateResponse,
-    type SiteUploadBatchesResponse as SiteUploadBatchesResponse,
+    type SiteUploadBatchesPresignResponse as SiteUploadBatchesPresignResponse,
     type SiteFilesResponse as SiteFilesResponse,
     type SiteFileOperationsResponse as SiteFileOperationsResponse,
     type SiteListResponsesPageCursorURL as SiteListResponsesPageCursorURL,
+    type SiteListParams as SiteListParams,
     type SiteCreateParams as SiteCreateParams,
     type SiteUpdateParams as SiteUpdateParams,
-    type SiteUploadBatchesParams as SiteUploadBatchesParams,
+    type SiteUploadBatchesPresignParams as SiteUploadBatchesPresignParams,
     type SiteFilesParams as SiteFilesParams,
     type SiteFileOperationsParams as SiteFileOperationsParams,
   };

package/src/resources/software-deployments.ts

@@ -537,6 +537,11 @@ export interface SoftwareDeploymentListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/sso-me.ts

@@ -58,6 +58,11 @@ export interface SSOMeListParams {
   cursor?: string;
 
   expand?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
 }
 
 export declare namespace SSOMeResource {

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

@@ -51,8 +51,15 @@ export interface ExclusionMemberUpdateResponse {
 }
 
 export interface ExclusionMemberListParams {
+  cursor?: string;
+
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

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

@@ -51,8 +51,15 @@ export interface InclusionMemberUpdateResponse {
 }
 
 export interface InclusionMemberListParams {
+  cursor?: string;
+
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/supergroups/members.ts

@@ -32,8 +32,15 @@ export class Members extends APIResource {
 }
 
 export interface MemberListParams {
+  cursor?: string;
+
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/supergroups/supergroups.ts

@@ -162,8 +162,15 @@ export interface Supergroup {
 export interface SupergroupRetrieveResponse extends BusinessPartnersAPI.Meta, Supergroup {}
 
 export interface SupergroupListParams {
+  cursor?: string;
+
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/teams.ts

@@ -112,6 +112,11 @@ export interface TeamListParams {
 
   expand?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/time-cards.ts

@@ -195,6 +195,11 @@ export interface TimeCardListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/time-entries.ts

@@ -1503,6 +1503,11 @@ export interface TimeEntryListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/titles.ts

@@ -153,6 +153,11 @@ export interface TitleUpdateResponse {
 export interface TitleListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/tracks.ts

@@ -108,6 +108,11 @@ export interface TrackRetrieveResponse extends BusinessPartnersAPI.Meta, Track {
 export interface TrackListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/unassignedshifts.ts

@@ -1328,6 +1328,11 @@ export interface UnassignedshiftListParams {
 
   filter?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/users.ts

@@ -247,6 +247,11 @@ export interface UserRetrieveResponse extends BusinessPartnersAPI.Meta, User {}
 export interface UserListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }
 

package/src/resources/work-locations.ts

@@ -95,6 +95,11 @@ export interface WorkLocationRetrieveResponse extends BusinessPartnersAPI.Meta,
 export interface WorkLocationListParams {
   cursor?: string;
 
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
   order_by?: string;
 }