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

package/src/resources/sites.ts

@@ -0,0 +1,736 @@
+// 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 { 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.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const siteListResponse of client.sites.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(options?: RequestOptions): PagePromise<SiteListResponsesPageCursorURL, SiteListResponse> {
+    return this._client.getAPIList('/sites/', PageCursorURL<SiteListResponse>, options);
+  }
+
+  /**
+   * Create a new site via multipart/form-data. Requires name, api_name, and an asset
+   * file (HTML or zip).
+   *
+   * @example
+   * ```ts
+   * const site = await client.sites.create({
+   *   api_name: 'my_portal',
+   *   asset: fs.createReadStream('path/to/file'),
+   *   name: 'My Portal',
+   *   entry_path: 'index.html',
+   * });
+   * ```
+   */
+  create(body: SiteCreateParams, options?: RequestOptions): APIPromise<SiteCreateResponse> {
+    return this._client.post('/sites/', multipartFormRequestOptions({ body, ...options }, this._client));
+  }
+
+  /**
+   * Retrieve a specific site.
+   *
+   * @example
+   * ```ts
+   * const site = await client.sites.retrieve('employee_portal');
+   * ```
+   */
+  retrieve(apiName: string, options?: RequestOptions): APIPromise<SiteRetrieveResponse> {
+    return this._client.get(path`/sites/${apiName}/`, options);
+  }
+
+  /**
+   * Update a site via multipart/form-data. Provide asset when replacing the bundle;
+   * asset is required when entry_path is set.
+   *
+   * @example
+   * ```ts
+   * const site = await client.sites.update('employee_portal', {
+   *   asset: fs.createReadStream('path/to/file'),
+   *   entry_path: 'index.html',
+   *   name: 'My Portal',
+   * });
+   * ```
+   */
+  update(
+    apiName: string,
+    body: SiteUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SiteUpdateResponse> {
+    return this._client.patch(
+      path`/sites/${apiName}/`,
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * Delete a site.
+   *
+   * @example
+   * ```ts
+   * await client.sites.delete('employee_portal');
+   * ```
+   */
+  delete(apiName: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/sites/${apiName}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * 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.
+   *
+   * @example
+   * ```ts
+   * const response = await client.sites.uploadBatches({
+   *   fileMeta: [{ client_ref: 'index', path: 'index.html' }],
+   *   'file[index]': fs.createReadStream('path/to/file'),
+   * });
+   * ```
+   */
+  uploadBatches(
+    body: SiteUploadBatchesParams,
+    options?: RequestOptions,
+  ): APIPromise<SiteUploadBatchesResponse> {
+    return this._client.post(
+      '/sites/upload-batches/',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * List files and persisted directories from the active bundle manifest.
+   *
+   * @example
+   * ```ts
+   * const response = await client.sites.files(
+   *   'employee_portal',
+   * );
+   * ```
+   */
+  files(
+    apiName: string,
+    query: SiteFilesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SiteFilesResponse> {
+    return this._client.get(path`/sites/${apiName}/files/`, { query, ...options });
+  }
+
+  /**
+   * Apply file and directory operations atomically against the active bundle.
+   *
+   * @example
+   * ```ts
+   * const response = await client.sites.fileOperations('employee_portal', {
+   *   base_bundle_id: 'bundle_id',
+   *   operations: [
+   *     {
+   *       op: 'put',
+   *       kind: 'file',
+   *       path: 'assets/logo.png',
+   *       file_id: 'file_id_1',
+   *     },
+   *     {
+   *       op: 'put',
+   *       kind: 'directory',
+   *       path: 'assets/images',
+   *     },
+   *     {
+   *       op: 'rename',
+   *       kind: 'file',
+   *       from_path: 'home.html',
+   *       to_path: 'index.html',
+   *     },
+   *     {
+   *       op: 'delete',
+   *       kind: 'file',
+   *       path: 'old.js',
+   *     },
+   *   ],
+   *   entry_path: 'index.html',
+   * });
+   * ```
+   */
+  fileOperations(
+    apiName: string,
+    body: SiteFileOperationsParams,
+    options?: RequestOptions,
+  ): APIPromise<SiteFileOperationsResponse> {
+    return this._client.post(path`/sites/${apiName}/file-operations/`, { body, ...options });
+  }
+}
+
+export type SiteListResponsesPageCursorURL = PageCursorURL<SiteListResponse>;
+
+export interface SiteListResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * The admin group id for the custom site
+   */
+  admin_group_id?: string;
+
+  /**
+   * The unique api name of the custom site
+   */
+  api_name?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the custom site
+   */
+  created_by?: string;
+
+  /**
+   * The active bundle id for the custom site
+   */
+  current_bundle_id?: string;
+
+  /**
+   * The entry path inside the uploaded asset
+   */
+  entry_path?: string;
+
+  /**
+   * A Rippling-owned logo URL for the custom site
+   */
+  logo?: string;
+
+  /**
+   * The display name of the custom site
+   */
+  name?: string;
+
+  /**
+   * The viewer group id for the custom site
+   */
+  viewer_group_id?: string;
+}
+
+export interface SiteCreateResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * The admin group id for the custom site
+   */
+  admin_group_id?: string;
+
+  /**
+   * The unique api name of the custom site
+   */
+  api_name?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the custom site
+   */
+  created_by?: string;
+
+  /**
+   * The active bundle id for the custom site
+   */
+  current_bundle_id?: string;
+
+  /**
+   * The entry path inside the uploaded asset
+   */
+  entry_path?: string;
+
+  /**
+   * A Rippling-owned logo URL for the custom site
+   */
+  logo?: string;
+
+  /**
+   * The display name of the custom site
+   */
+  name?: string;
+
+  /**
+   * The viewer group id for the custom site
+   */
+  viewer_group_id?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface SiteRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * The admin group id for the custom site
+   */
+  admin_group_id?: string;
+
+  /**
+   * The unique api name of the custom site
+   */
+  api_name?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the custom site
+   */
+  created_by?: string;
+
+  /**
+   * The active bundle id for the custom site
+   */
+  current_bundle_id?: string;
+
+  /**
+   * The entry path inside the uploaded asset
+   */
+  entry_path?: string;
+
+  /**
+   * A Rippling-owned logo URL for the custom site
+   */
+  logo?: string;
+
+  /**
+   * The display name of the custom site
+   */
+  name?: string;
+
+  /**
+   * The viewer group id for the custom site
+   */
+  viewer_group_id?: string;
+}
+
+export interface SiteUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * The admin group id for the custom site
+   */
+  admin_group_id?: string;
+
+  /**
+   * The unique api name of the custom site
+   */
+  api_name?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the custom site
+   */
+  created_by?: string;
+
+  /**
+   * The active bundle id for the custom site
+   */
+  current_bundle_id?: string;
+
+  /**
+   * The entry path inside the uploaded asset
+   */
+  entry_path?: string;
+
+  /**
+   * A Rippling-owned logo URL for the custom site
+   */
+  logo?: string;
+
+  /**
+   * The display name of the custom site
+   */
+  name?: string;
+
+  /**
+   * The viewer group id for the custom site
+   */
+  viewer_group_id?: string;
+}
+
+export interface SiteUploadBatchesResponse {
+  /**
+   * Staged files created by the upload batch.
+   */
+  files?: Array<SiteUploadBatchesResponse.File>;
+
+  /**
+   * Identifier for the staged upload batch.
+   */
+  upload_batch_id?: string;
+}
+
+export namespace SiteUploadBatchesResponse {
+  export interface File {
+    /**
+     * Client-provided reference that maps to the multipart file field name.
+     */
+    client_ref?: string;
+
+    /**
+     * Active staged upload identifier for use in file operations.
+     */
+    file_id?: string;
+
+    /**
+     * Normalized Custom Sites path for the uploaded file.
+     */
+    path?: string;
+
+    /**
+     * Upload status. New uploads are returned as active.
+     */
+    status?: string;
+  }
+}
+
+export interface SiteFilesResponse {
+  /**
+   * Active bundle identifier.
+   */
+  bundle_id?: string;
+
+  /**
+   * Directories in the listing scope.
+   */
+  directories?: Array<SiteFilesResponse.Directory>;
+
+  /**
+   * Entry path for the active bundle.
+   */
+  entry_path?: string;
+
+  /**
+   * Files in the listing scope.
+   */
+  files?: Array<SiteFilesResponse.File>;
+
+  /**
+   * Directory path used for the listing.
+   */
+  parent_path?: string;
+
+  /**
+   * Whether the listing was recursive.
+   */
+  recursive?: boolean;
+}
+
+export namespace SiteFilesResponse {
+  export interface Directory {
+    /**
+     * Directory name.
+     */
+    name?: string;
+
+    /**
+     * Parent directory path.
+     */
+    parent_path?: string;
+
+    /**
+     * Normalized directory path inside the active bundle.
+     */
+    path?: string;
+  }
+
+  export interface File {
+    /**
+     * MIME content type.
+     */
+    content_type?: string;
+
+    /**
+     * File name.
+     */
+    name?: string;
+
+    /**
+     * Parent directory path.
+     */
+    parent_path?: string;
+
+    /**
+     * Normalized file path inside the active bundle.
+     */
+    path?: string;
+
+    /**
+     * SHA-256 hash of the file contents.
+     */
+    sha256?: string;
+
+    /**
+     * File size in bytes.
+     */
+    size_bytes?: number;
+  }
+}
+
+export interface SiteFileOperationsResponse {
+  /**
+   * Identifier field
+   */
+  id?: string;
+
+  /**
+   * The admin group id for the custom site
+   */
+  admin_group_id?: string;
+
+  /**
+   * The unique api name of the custom site
+   */
+  api_name?: string;
+
+  /**
+   * Record creation date
+   */
+  created_at?: string;
+
+  /**
+   * The ID of the role that created the custom site
+   */
+  created_by?: string;
+
+  /**
+   * The active bundle id for the custom site
+   */
+  current_bundle_id?: string;
+
+  /**
+   * The entry path inside the uploaded asset
+   */
+  entry_path?: string;
+
+  /**
+   * A Rippling-owned logo URL for the custom site
+   */
+  logo?: string;
+
+  /**
+   * The display name of the custom site
+   */
+  name?: string;
+
+  /**
+   * The viewer group id for the custom site
+   */
+  viewer_group_id?: string;
+}
+
+export interface SiteCreateParams {
+  /**
+   * 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.
+   */
+  asset: Uploadable;
+
+  /**
+   * 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?: string;
+
+  /**
+   * Optional 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.
+   */
+  asset?: Uploadable;
+
+  /**
+   * 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?: string;
+
+  /**
+   * Optional Rippling-owned logo URL for the custom site.
+   */
+  logo?: string;
+
+  /**
+   * The display name of the custom site.
+   */
+  name?: string;
+}
+
+export interface SiteUploadBatchesParams {
+  /**
+   * File metadata for each multipart upload part.
+   */
+  fileMeta: Array<SiteUploadBatchesParams.FileMeta>;
+
+  /**
+   * Binary file contents for client_ref index. Repeat as file[<client_ref>] for each
+   * fileMeta entry.
+   */
+  'file[index]'?: Uploadable;
+}
+
+export namespace SiteUploadBatchesParams {
+  export interface FileMeta {
+    /**
+     * Client-provided reference that maps to the multipart file field name.
+     */
+    client_ref: string;
+
+    /**
+     * Normalized Custom Sites path for the uploaded file.
+     */
+    path: string;
+  }
+}
+
+export interface SiteFilesParams {
+  /**
+   * Directory path to list. Defaults to the bundle root.
+   */
+  parent_path?: string;
+
+  /**
+   * Whether to list files recursively. Defaults to false.
+   */
+  recursive?: boolean;
+}
+
+export interface SiteFileOperationsParams {
+  /**
+   * Must match the site's current active bundle. Returns 409 when stale.
+   */
+  base_bundle_id: string;
+
+  /**
+   * Non-empty array of file or directory operations.
+   */
+  operations: Array<SiteFileOperationsParams.Operation>;
+
+  /**
+   * Optional bundle entry path. When omitted, the current entry path is kept.
+   */
+  entry_path?: string;
+}
+
+export namespace SiteFileOperationsParams {
+  export interface Operation {
+    /**
+     * Target kind. Supported values are file and directory.
+     */
+    kind: string;
+
+    /**
+     * Operation type. Supported values are put, rename, move, and delete.
+     */
+    op: string;
+
+    /**
+     * Staged upload file_id. Required for put operations on files.
+     */
+    file_id?: string;
+
+    /**
+     * Source path for rename and move operations.
+     */
+    from_path?: string;
+
+    /**
+     * Target path for put and delete operations.
+     */
+    path?: string;
+
+    /**
+     * When true, delete directory removes nested files. Used by delete directory
+     * operations.
+     */
+    recursive?: boolean;
+
+    /**
+     * Destination path for rename and move operations.
+     */
+    to_path?: string;
+  }
+}
+
+export declare namespace Sites {
+  export {
+    type SiteListResponse as SiteListResponse,
+    type SiteCreateResponse as SiteCreateResponse,
+    type SiteRetrieveResponse as SiteRetrieveResponse,
+    type SiteUpdateResponse as SiteUpdateResponse,
+    type SiteUploadBatchesResponse as SiteUploadBatchesResponse,
+    type SiteFilesResponse as SiteFilesResponse,
+    type SiteFileOperationsResponse as SiteFileOperationsResponse,
+    type SiteListResponsesPageCursorURL as SiteListResponsesPageCursorURL,
+    type SiteCreateParams as SiteCreateParams,
+    type SiteUpdateParams as SiteUpdateParams,
+    type SiteUploadBatchesParams as SiteUploadBatchesParams,
+    type SiteFilesParams as SiteFilesParams,
+    type SiteFileOperationsParams as SiteFileOperationsParams,
+  };
+}