import { APIResource } from "../core/resource.js"; import { APIPromise } from "../core/api-promise.js"; import { RequestOptions } from "../internal/request-options.js"; /** * Author, publish, and install Unity Packages V2 packages */ export declare class PackageSandboxLinks extends APIResource { /** * Link a package to a sandbox in EDIT or INSTALL mode. * * @example HTTP * Representative request and response shapes. * ``` * POST /package-sandbox-links/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * { * "mode": "mode", * "package_key": "package_key", * "sandbox_company_id": "sandbox_company_id" * } * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "package_key": "string", * "sandbox_company_id": "string", * "mode": "string", * "status": "string", * "package_version_id": "string", * "installation_tracker_id": "string", * "error_message": "string", * "installation_record_id": "string", * "post_install_landing_component": {}, * "progress": [ * null * ] * } * ``` */ create(body: PackageSandboxLinkCreateParams, options?: RequestOptions): APIPromise; /** * Retrieve the status of a package sandbox link. * * @example HTTP * Representative request and response shapes. * ``` * GET /package-sandbox-links/{tracker_id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "package_key": "string", * "sandbox_company_id": "string", * "mode": "string", * "status": "string", * "package_version_id": "string", * "installation_tracker_id": "string", * "error_message": "string", * "installation_record_id": "string", * "post_install_landing_component": {}, * "progress": [ * null * ] * } * ``` */ retrieve(trackerID: string, options?: RequestOptions): APIPromise; } /** * Request to link a package to a sandbox, or poll an EDIT-mode installation * tracker. */ export interface PackageSandboxLinkCreateResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * How the sandbox is linked to the package (INSTALL or EDIT) */ mode: string; /** * The package key to link into the sandbox */ package_key: string; /** * The company receiving the sandbox package installation */ sandbox_company_id: string; /** * Record update date */ updated_at: string; /** * Error message when EDIT-mode linking failed */ error_message?: string; /** * Installation record ID when EDIT-mode linking completes */ installation_record_id?: string; /** * The internal sandbox installation tracker ID */ installation_tracker_id?: string; /** * The package version being linked in EDIT mode */ package_version_id?: string; /** * Component to open after EDIT-mode linking completes */ post_install_landing_component?: unknown; /** * EDIT-mode installation progress entries */ progress?: Array; /** * INSTALL completion status, or EDIT installation tracker status */ status?: string; } /** * Request to link a package to a sandbox, or poll an EDIT-mode installation * tracker. */ export interface PackageSandboxLinkRetrieveResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * How the sandbox is linked to the package (INSTALL or EDIT) */ mode: string; /** * The package key to link into the sandbox */ package_key: string; /** * The company receiving the sandbox package installation */ sandbox_company_id: string; /** * Record update date */ updated_at: string; /** * Error message when EDIT-mode linking failed */ error_message?: string; /** * Installation record ID when EDIT-mode linking completes */ installation_record_id?: string; /** * The internal sandbox installation tracker ID */ installation_tracker_id?: string; /** * The package version being linked in EDIT mode */ package_version_id?: string; /** * Component to open after EDIT-mode linking completes */ post_install_landing_component?: unknown; /** * EDIT-mode installation progress entries */ progress?: Array; /** * INSTALL completion status, or EDIT installation tracker status */ status?: string; } export interface PackageSandboxLinkCreateParams { /** * How the sandbox is linked to the package (INSTALL or EDIT) */ mode: string; /** * The package key to link into the sandbox */ package_key: string; /** * The company receiving the sandbox package installation */ sandbox_company_id: string; } export declare namespace PackageSandboxLinks { export { type PackageSandboxLinkCreateResponse as PackageSandboxLinkCreateResponse, type PackageSandboxLinkRetrieveResponse as PackageSandboxLinkRetrieveResponse, type PackageSandboxLinkCreateParams as PackageSandboxLinkCreateParams, }; } //# sourceMappingURL=package-sandbox-links.d.ts.map