@contentchef/contentchef-types 10.1.0-alpha.10 → 10.1.0-alpha.11

package/dist/api/Space.d.ts

@@ -240,3 +240,107 @@ export type UpdateSpacePublishingLocalesRequest = {
  * Return type of `updateSpacePublishingLocales`
  */
 export type UpdateSpacePublishingLocalesResponse = SpaceLocale;
+/**
+ * This enum represent the lifecycle of a space deletion. A freshly requested deletion is
+ * `requested` and stays revocable until [[SpaceDeletionResponse.deleteAfter]], after which it
+ * becomes `running` and can no longer be withdrawn
+ */
+export declare enum SpaceDeletionStatus {
+    /**
+     * Asked for, inside the revocation window, still revocable
+     */
+    REQUESTED = "requested",
+    /**
+     * Withdrawn inside the revocation window, nothing has been deleted
+     */
+    REVOKED = "revoked",
+    RUNNING = "running",
+    DELETED = "deleted",
+    FAILED = "failed",
+    /**
+     * A dry run, only started by hand: it reports what it would delete and changes nothing
+     */
+    INSPECTED = "inspected"
+}
+/**
+ * This type represent the model of a space deletion, the only record that outlives a deleted space
+ */
+export type SpaceDeletionResponse = {
+    /**
+     * The space the deletion refers to
+     */
+    spaceId: string;
+    /**
+     * The current status of the deletion
+     */
+    status: SpaceDeletionStatus;
+    /**
+     * The name the space had, captured when the deletion was requested because deleting the space
+     * destroys it
+     */
+    spaceName?: string;
+    /**
+     * The subscription the space was claimed under, preserved for the same reason as [[spaceName]]
+     */
+    subscriptionId?: string;
+    /**
+     * The account that requested the deletion
+     */
+    requestedBy?: string;
+    /**
+     * The account that withdrew the deletion, only set when [[status]] is `revoked`
+     */
+    revokedBy?: string;
+    /**
+     * The ISO date the revocation window shuts at: until then the deletion can be withdrawn with
+     * [[SystemFacade.revokeSpaceDeletion]], after it the deletion starts
+     */
+    deleteAfter?: string;
+    /**
+     * The arn of the workflow execution performing the deletion
+     */
+    executionArn?: string;
+    /**
+     * Whether the deletion only reported what it would delete, without deleting anything
+     */
+    dryRun?: boolean;
+    /**
+     * How many rows have been deleted, per domain and per table. Written when the deletion ends
+     */
+    counts?: {
+        [domain: string]: {
+            [table: string]: number;
+        };
+    };
+    /**
+     * The message describing why the deletion failed, only set when [[status]] is `failed`
+     */
+    error?: string;
+    /**
+     * The ISO date the deletion record was last written at
+     */
+    updatedAt?: string;
+};
+/**
+ * This type represent the response of a delete space API request. The deletion has not happened
+ * yet: it is only requested, and stays revocable for [[revocableForHours]]
+ */
+export type DeleteSpaceResponse = {
+    /**
+     * Always true, the request has been accepted
+     */
+    requested: boolean;
+    /**
+     * How long the deletion stays revocable, in hours
+     */
+    revocableForHours: number;
+};
+/**
+ * Return type of `revokeSpaceDeletion`, the withdrawn deletion record
+ */
+export type RevokeSpaceDeletionResponse = SpaceDeletionResponse;
+/**
+ * Return type of `getSpaceDeletionStatus`. It is null when the space has never had a deletion
+ * requested: no request is a normal answer, not a missing resource
+ */
+export type GetSpaceDeletionStatusResponse = SpaceDeletionResponse | null;

package/dist/api/Space.js

@@ -1,2 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpaceDeletionStatus = void 0;
+/**
+ * This enum represent the lifecycle of a space deletion. A freshly requested deletion is
+ * `requested` and stays revocable until [[SpaceDeletionResponse.deleteAfter]], after which it
+ * becomes `running` and can no longer be withdrawn
+ */
+var SpaceDeletionStatus;
+(function (SpaceDeletionStatus) {
+    /**
+     * Asked for, inside the revocation window, still revocable
+     */
+    SpaceDeletionStatus["REQUESTED"] = "requested";
+    /**
+     * Withdrawn inside the revocation window, nothing has been deleted
+     */
+    SpaceDeletionStatus["REVOKED"] = "revoked";
+    SpaceDeletionStatus["RUNNING"] = "running";
+    SpaceDeletionStatus["DELETED"] = "deleted";
+    SpaceDeletionStatus["FAILED"] = "failed";
+    /**
+     * A dry run, only started by hand: it reports what it would delete and changes nothing
+     */
+    SpaceDeletionStatus["INSPECTED"] = "inspected";
+})(SpaceDeletionStatus || (exports.SpaceDeletionStatus = SpaceDeletionStatus = {}));

package/lib/api/Space.ts

@@ -258,3 +258,108 @@ export type UpdateSpacePublishingLocalesRequest = {
  * Return type of `updateSpacePublishingLocales`
  */
 export type UpdateSpacePublishingLocalesResponse = SpaceLocale;
+
+/**
+ * This enum represent the lifecycle of a space deletion. A freshly requested deletion is
+ * `requested` and stays revocable until [[SpaceDeletionResponse.deleteAfter]], after which it
+ * becomes `running` and can no longer be withdrawn
+ */
+export enum SpaceDeletionStatus {
+    /**
+     * Asked for, inside the revocation window, still revocable
+     */
+    REQUESTED = 'requested',
+    /**
+     * Withdrawn inside the revocation window, nothing has been deleted
+     */
+    REVOKED = 'revoked',
+    RUNNING = 'running',
+    DELETED = 'deleted',
+    FAILED = 'failed',
+    /**
+     * A dry run, only started by hand: it reports what it would delete and changes nothing
+     */
+    INSPECTED = 'inspected'
+}
+
+/**
+ * This type represent the model of a space deletion, the only record that outlives a deleted space
+ */
+export type SpaceDeletionResponse = {
+    /**
+     * The space the deletion refers to
+     */
+    spaceId: string;
+    /**
+     * The current status of the deletion
+     */
+    status: SpaceDeletionStatus;
+    /**
+     * The name the space had, captured when the deletion was requested because deleting the space
+     * destroys it
+     */
+    spaceName?: string;
+    /**
+     * The subscription the space was claimed under, preserved for the same reason as [[spaceName]]
+     */
+    subscriptionId?: string;
+    /**
+     * The account that requested the deletion
+     */
+    requestedBy?: string;
+    /**
+     * The account that withdrew the deletion, only set when [[status]] is `revoked`
+     */
+    revokedBy?: string;
+    /**
+     * The ISO date the revocation window shuts at: until then the deletion can be withdrawn with
+     * [[SystemFacade.revokeSpaceDeletion]], after it the deletion starts
+     */
+    deleteAfter?: string;
+    /**
+     * The arn of the workflow execution performing the deletion
+     */
+    executionArn?: string;
+    /**
+     * Whether the deletion only reported what it would delete, without deleting anything
+     */
+    dryRun?: boolean;
+    /**
+     * How many rows have been deleted, per domain and per table. Written when the deletion ends
+     */
+    counts?: { [domain: string]: { [table: string]: number; }; };
+    /**
+     * The message describing why the deletion failed, only set when [[status]] is `failed`
+     */
+    error?: string;
+    /**
+     * The ISO date the deletion record was last written at
+     */
+    updatedAt?: string;
+};
+
+/**
+ * This type represent the response of a delete space API request. The deletion has not happened
+ * yet: it is only requested, and stays revocable for [[revocableForHours]]
+ */
+export type DeleteSpaceResponse = {
+    /**
+     * Always true, the request has been accepted
+     */
+    requested: boolean;
+    /**
+     * How long the deletion stays revocable, in hours
+     */
+    revocableForHours: number;
+};
+
+/**
+ * Return type of `revokeSpaceDeletion`, the withdrawn deletion record
+ */
+export type RevokeSpaceDeletionResponse = SpaceDeletionResponse;
+
+/**
+ * Return type of `getSpaceDeletionStatus`. It is null when the space has never had a deletion
+ * requested: no request is a normal answer, not a missing resource
+ */
+export type GetSpaceDeletionStatusResponse = SpaceDeletionResponse | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentchef/contentchef-types",
-  "version": "10.1.0-alpha.10",
+  "version": "10.1.0-alpha.11",
   "description": "ContentChef types",
   "author": "PierpaoloIannone <piannone@byte-code.com>",
   "homepage": "https://github.com/ContentChef/contentchef-management-js-client#readme",
@@ -34,5 +34,5 @@
   "devDependencies": {
     "typescript": "^5.9.3"
   },
-  "gitHead": "0cc1e6b2a9468100a09fed18ab3ffaca0bcb53e8"
+  "gitHead": "ea72e6f60f7e98e9b54477fc72ec7673502d9e93"
 }