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 PackageUninstalls extends APIResource { /** * Start uninstalling a managed package install asynchronously. * * @example HTTP * Representative request and response shapes. * ``` * POST /package-uninstalls/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * { * "install_key": "install_key", * "package_key": "package_key" * } * * HTTP/1.1 202 Accepted * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "managed_install_id": "string", * "package_key": "string", * "install_key": "string", * "installed_version_id": "string", * "status": "string", * "error_message": "string", * "uninstall_plan": {}, * "uninstalled_components": [ * null * ] * } * ``` */ create(body: PackageUninstallCreateParams, options?: RequestOptions): APIPromise; /** * Retrieve the status of a managed package uninstallation. * * @example HTTP * Representative request and response shapes. * ``` * GET /package-uninstalls/{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", * "managed_install_id": "string", * "package_key": "string", * "install_key": "string", * "installed_version_id": "string", * "status": "string", * "error_message": "string", * "uninstall_plan": {}, * "uninstalled_components": [ * null * ] * } * ``` */ retrieve(trackerID: string, options?: RequestOptions): APIPromise; } /** * Async managed package uninstall tracker for subscriber companies. */ export interface PackageUninstallCreateResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Error message when uninstallation failed */ error_message?: string; /** * The install key of the managed package install */ install_key?: string; /** * The installed package version being uninstalled */ installed_version_id?: string; /** * The managed package install being uninstalled */ managed_install_id?: string; /** * The package key of the managed package */ package_key?: string; /** * Uninstallation status (IN_PROGRESS, COMPLETE, or FAILED) */ status?: string; /** * Uninstall plan snapshot when available */ uninstall_plan?: unknown; /** * Components uninstalled so far */ uninstalled_components?: Array; } /** * Async managed package uninstall tracker for subscriber companies. */ export interface PackageUninstallRetrieveResponse { /** * Identifier field */ id: string; /** * Record creation date */ created_at: string; /** * Record update date */ updated_at: string; /** * Error message when uninstallation failed */ error_message?: string; /** * The install key of the managed package install */ install_key?: string; /** * The installed package version being uninstalled */ installed_version_id?: string; /** * The managed package install being uninstalled */ managed_install_id?: string; /** * The package key of the managed package */ package_key?: string; /** * Uninstallation status (IN_PROGRESS, COMPLETE, or FAILED) */ status?: string; /** * Uninstall plan snapshot when available */ uninstall_plan?: unknown; /** * Components uninstalled so far */ uninstalled_components?: Array; } export interface PackageUninstallCreateParams { /** * The install key of the managed package install to uninstall. */ install_key: string; /** * The package key of the managed package to uninstall. */ package_key: string; } export declare namespace PackageUninstalls { export { type PackageUninstallCreateResponse as PackageUninstallCreateResponse, type PackageUninstallRetrieveResponse as PackageUninstallRetrieveResponse, type PackageUninstallCreateParams as PackageUninstallCreateParams, }; } //# sourceMappingURL=package-uninstalls.d.ts.map