@credoxa/events-sdk 1.0.0

package/dist/esm/apis/ReplaysApi.d.ts

@@ -0,0 +1,220 @@
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import type { ReplayCreateRequest, ReplayDetail, ReplayRetryRequest } from '../models/index.js';
+export interface ReplaysCancelCreateRequest {
+    replayId: string;
+}
+export interface ReplaysCreateRequest {
+    replayCreateRequest: ReplayCreateRequest;
+}
+export interface ReplaysListRequest {
+    status?: ReplaysListStatusEnum;
+    targetConsumer?: string;
+}
+export interface ReplaysPauseCreateRequest {
+    replayId: string;
+}
+export interface ReplaysResumeCreateRequest {
+    replayId: string;
+}
+export interface ReplaysRetrieveRequest {
+    replayId: string;
+}
+export interface ReplaysRetryCreateRequest {
+    replayId: string;
+    replayRetryRequest?: ReplayRetryRequest;
+}
+/**
+ * ReplaysApi - interface
+ *
+ * @export
+ * @interface ReplaysApiInterface
+ */
+export interface ReplaysApiInterface {
+    /**
+     *
+     * @summary Cancel replay job
+     * @param {string} replayId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysCancelCreateRaw(requestParameters: ReplaysCancelCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Cancel replay job
+     */
+    replaysCancelCreate(requestParameters: ReplaysCancelCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Create and schedule a tenant-scoped replay job.
+     * @summary Create replay job
+     * @param {ReplayCreateRequest} replayCreateRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysCreateRaw(requestParameters: ReplaysCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Create and schedule a tenant-scoped replay job.
+     * Create replay job
+     */
+    replaysCreate(requestParameters: ReplaysCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Return replay jobs belonging to the current organization.
+     * @summary List replay jobs
+     * @param {'cancel_requested' | 'cancelled' | 'completed' | 'failed' | 'paused' | 'pending' | 'running'} [status] Filter replay jobs by status.
+     * @param {string} [targetConsumer] Filter by target consumer UUID.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysListRaw(requestParameters: ReplaysListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReplayDetail>>>;
+    /**
+     * Return replay jobs belonging to the current organization.
+     * List replay jobs
+     */
+    replaysList(requestParameters: ReplaysListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReplayDetail>>;
+    /**
+     *
+     * @summary Pause replay job
+     * @param {string} replayId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysPauseCreateRaw(requestParameters: ReplaysPauseCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Pause replay job
+     */
+    replaysPauseCreate(requestParameters: ReplaysPauseCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     *
+     * @summary Resume replay job
+     * @param {string} replayId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysResumeCreateRaw(requestParameters: ReplaysResumeCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Resume replay job
+     */
+    replaysResumeCreate(requestParameters: ReplaysResumeCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Return one replay job belonging to the current organization.
+     * @summary Retrieve replay job
+     * @param {string} replayId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysRetrieveRaw(requestParameters: ReplaysRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Return one replay job belonging to the current organization.
+     * Retrieve replay job
+     */
+    replaysRetrieve(requestParameters: ReplaysRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     *
+     * @summary Retry failed replay job
+     * @param {string} replayId
+     * @param {ReplayRetryRequest} [replayRetryRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReplaysApiInterface
+     */
+    replaysRetryCreateRaw(requestParameters: ReplaysRetryCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Retry failed replay job
+     */
+    replaysRetryCreate(requestParameters: ReplaysRetryCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+}
+/**
+ *
+ */
+export declare class ReplaysApi extends runtime.BaseAPI implements ReplaysApiInterface {
+    /**
+     * Cancel replay job
+     */
+    replaysCancelCreateRaw(requestParameters: ReplaysCancelCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Cancel replay job
+     */
+    replaysCancelCreate(requestParameters: ReplaysCancelCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Create and schedule a tenant-scoped replay job.
+     * Create replay job
+     */
+    replaysCreateRaw(requestParameters: ReplaysCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Create and schedule a tenant-scoped replay job.
+     * Create replay job
+     */
+    replaysCreate(requestParameters: ReplaysCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Return replay jobs belonging to the current organization.
+     * List replay jobs
+     */
+    replaysListRaw(requestParameters: ReplaysListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ReplayDetail>>>;
+    /**
+     * Return replay jobs belonging to the current organization.
+     * List replay jobs
+     */
+    replaysList(requestParameters?: ReplaysListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ReplayDetail>>;
+    /**
+     * Pause replay job
+     */
+    replaysPauseCreateRaw(requestParameters: ReplaysPauseCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Pause replay job
+     */
+    replaysPauseCreate(requestParameters: ReplaysPauseCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Resume replay job
+     */
+    replaysResumeCreateRaw(requestParameters: ReplaysResumeCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Resume replay job
+     */
+    replaysResumeCreate(requestParameters: ReplaysResumeCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Return one replay job belonging to the current organization.
+     * Retrieve replay job
+     */
+    replaysRetrieveRaw(requestParameters: ReplaysRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Return one replay job belonging to the current organization.
+     * Retrieve replay job
+     */
+    replaysRetrieve(requestParameters: ReplaysRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+    /**
+     * Retry failed replay job
+     */
+    replaysRetryCreateRaw(requestParameters: ReplaysRetryCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReplayDetail>>;
+    /**
+     * Retry failed replay job
+     */
+    replaysRetryCreate(requestParameters: ReplaysRetryCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReplayDetail>;
+}
+/**
+ * @export
+ */
+export declare const ReplaysListStatusEnum: {
+    readonly CancelRequested: "cancel_requested";
+    readonly Cancelled: "cancelled";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly Paused: "paused";
+    readonly Pending: "pending";
+    readonly Running: "running";
+};
+export type ReplaysListStatusEnum = typeof ReplaysListStatusEnum[keyof typeof ReplaysListStatusEnum];

package/dist/esm/apis/ReplaysApi.js

@@ -0,0 +1,290 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime.js';
+import { ReplayCreateRequestToJSON, ReplayDetailFromJSON, ReplayRetryRequestToJSON, } from '../models/index.js';
+/**
+ *
+ */
+export class ReplaysApi extends runtime.BaseAPI {
+    /**
+     * Cancel replay job
+     */
+    replaysCancelCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['replayId'] == null) {
+                throw new runtime.RequiredError('replayId', 'Required parameter "replayId" was null or undefined when calling replaysCancelCreate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/{replay_id}/cancel/`;
+            urlPath = urlPath.replace(`{${"replay_id"}}`, encodeURIComponent(String(requestParameters['replayId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReplayDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Cancel replay job
+     */
+    replaysCancelCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.replaysCancelCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Create and schedule a tenant-scoped replay job.
+     * Create replay job
+     */
+    replaysCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['replayCreateRequest'] == null) {
+                throw new runtime.RequiredError('replayCreateRequest', 'Required parameter "replayCreateRequest" was null or undefined when calling replaysCreate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ReplayCreateRequestToJSON(requestParameters['replayCreateRequest']),
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReplayDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create and schedule a tenant-scoped replay job.
+     * Create replay job
+     */
+    replaysCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.replaysCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Return replay jobs belonging to the current organization.
+     * List replay jobs
+     */
+    replaysListRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            if (requestParameters['targetConsumer'] != null) {
+                queryParameters['target_consumer'] = requestParameters['targetConsumer'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(ReplayDetailFromJSON));
+        });
+    }
+    /**
+     * Return replay jobs belonging to the current organization.
+     * List replay jobs
+     */
+    replaysList() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.replaysListRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Pause replay job
+     */
+    replaysPauseCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['replayId'] == null) {
+                throw new runtime.RequiredError('replayId', 'Required parameter "replayId" was null or undefined when calling replaysPauseCreate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/{replay_id}/pause/`;
+            urlPath = urlPath.replace(`{${"replay_id"}}`, encodeURIComponent(String(requestParameters['replayId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReplayDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Pause replay job
+     */
+    replaysPauseCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.replaysPauseCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Resume replay job
+     */
+    replaysResumeCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['replayId'] == null) {
+                throw new runtime.RequiredError('replayId', 'Required parameter "replayId" was null or undefined when calling replaysResumeCreate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/{replay_id}/resume/`;
+            urlPath = urlPath.replace(`{${"replay_id"}}`, encodeURIComponent(String(requestParameters['replayId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReplayDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Resume replay job
+     */
+    replaysResumeCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.replaysResumeCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Return one replay job belonging to the current organization.
+     * Retrieve replay job
+     */
+    replaysRetrieveRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['replayId'] == null) {
+                throw new runtime.RequiredError('replayId', 'Required parameter "replayId" was null or undefined when calling replaysRetrieve().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/{replay_id}/`;
+            urlPath = urlPath.replace(`{${"replay_id"}}`, encodeURIComponent(String(requestParameters['replayId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReplayDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Return one replay job belonging to the current organization.
+     * Retrieve replay job
+     */
+    replaysRetrieve(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.replaysRetrieveRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Retry failed replay job
+     */
+    replaysRetryCreateRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['replayId'] == null) {
+                throw new runtime.RequiredError('replayId', 'Required parameter "replayId" was null or undefined when calling replaysRetryCreate().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.apiKey) {
+                const apiKeyValue = yield this.configuration.apiKey("sessionid");
+                headerParameters["Cookie"] = "sessionid=" + apiKeyValue; // cookieAuth authentication
+            }
+            let urlPath = `/api/v1/replays/{replay_id}/retry/`;
+            urlPath = urlPath.replace(`{${"replay_id"}}`, encodeURIComponent(String(requestParameters['replayId'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ReplayRetryRequestToJSON(requestParameters['replayRetryRequest']),
+            }, initOverrides, {});
+            return new runtime.JSONApiResponse(response, (jsonValue) => ReplayDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Retry failed replay job
+     */
+    replaysRetryCreate(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.replaysRetryCreateRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+/**
+ * @export
+ */
+export const ReplaysListStatusEnum = {
+    CancelRequested: 'cancel_requested',
+    Cancelled: 'cancelled',
+    Completed: 'completed',
+    Failed: 'failed',
+    Paused: 'paused',
+    Pending: 'pending',
+    Running: 'running'
+};

package/dist/esm/apis/RetentionApi.d.ts

@@ -0,0 +1,166 @@
+/**
+ * Credoxa Events API
+ * Enterprise multi-tenant event infrastructure for Credoxa Cloud.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import type { PatchedRetentionPolicyWriteRequest, RetentionExplanation, RetentionPolicyRead, RetentionPolicyWriteRequest, RetentionPreviewInputRequest } from '../models/index.js';
+export interface RetentionPoliciesCreateRequest {
+    retentionPolicyWriteRequest: RetentionPolicyWriteRequest;
+}
+export interface RetentionPoliciesDestroyRequest {
+    policyId: string;
+}
+export interface RetentionPoliciesPartialUpdateRequest {
+    policyId: string;
+    patchedRetentionPolicyWriteRequest?: PatchedRetentionPolicyWriteRequest;
+}
+export interface RetentionPoliciesRetrieveRequest {
+    policyId: string;
+}
+export interface RetentionPoliciesUpdateRequest {
+    policyId: string;
+    retentionPolicyWriteRequest: RetentionPolicyWriteRequest;
+}
+export interface RetentionPreviewCreateRequest {
+    retentionPreviewInputRequest: RetentionPreviewInputRequest;
+}
+/**
+ * RetentionApi - interface
+ *
+ * @export
+ * @interface RetentionApiInterface
+ */
+export interface RetentionApiInterface {
+    /**
+     *
+     * @param {RetentionPolicyWriteRequest} retentionPolicyWriteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPoliciesCreateRaw(requestParameters: RetentionPoliciesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesCreate(requestParameters: RetentionPoliciesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     *
+     * @param {string} policyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPoliciesDestroyRaw(requestParameters: RetentionPoliciesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    retentionPoliciesDestroy(requestParameters: RetentionPoliciesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPoliciesListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<RetentionPolicyRead>>>;
+    /**
+     */
+    retentionPoliciesList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<RetentionPolicyRead>>;
+    /**
+     *
+     * @param {string} policyId
+     * @param {PatchedRetentionPolicyWriteRequest} [patchedRetentionPolicyWriteRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPoliciesPartialUpdateRaw(requestParameters: RetentionPoliciesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesPartialUpdate(requestParameters: RetentionPoliciesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     *
+     * @param {string} policyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPoliciesRetrieveRaw(requestParameters: RetentionPoliciesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesRetrieve(requestParameters: RetentionPoliciesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     *
+     * @param {string} policyId
+     * @param {RetentionPolicyWriteRequest} retentionPolicyWriteRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPoliciesUpdateRaw(requestParameters: RetentionPoliciesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesUpdate(requestParameters: RetentionPoliciesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     *
+     * @param {RetentionPreviewInputRequest} retentionPreviewInputRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RetentionApiInterface
+     */
+    retentionPreviewCreateRaw(requestParameters: RetentionPreviewCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionExplanation>>;
+    /**
+     */
+    retentionPreviewCreate(requestParameters: RetentionPreviewCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionExplanation>;
+}
+/**
+ *
+ */
+export declare class RetentionApi extends runtime.BaseAPI implements RetentionApiInterface {
+    /**
+     */
+    retentionPoliciesCreateRaw(requestParameters: RetentionPoliciesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesCreate(requestParameters: RetentionPoliciesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     */
+    retentionPoliciesDestroyRaw(requestParameters: RetentionPoliciesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     */
+    retentionPoliciesDestroy(requestParameters: RetentionPoliciesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     */
+    retentionPoliciesListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<RetentionPolicyRead>>>;
+    /**
+     */
+    retentionPoliciesList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesPartialUpdateRaw(requestParameters: RetentionPoliciesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesPartialUpdate(requestParameters: RetentionPoliciesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     */
+    retentionPoliciesRetrieveRaw(requestParameters: RetentionPoliciesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesRetrieve(requestParameters: RetentionPoliciesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     */
+    retentionPoliciesUpdateRaw(requestParameters: RetentionPoliciesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionPolicyRead>>;
+    /**
+     */
+    retentionPoliciesUpdate(requestParameters: RetentionPoliciesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionPolicyRead>;
+    /**
+     */
+    retentionPreviewCreateRaw(requestParameters: RetentionPreviewCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RetentionExplanation>>;
+    /**
+     */
+    retentionPreviewCreate(requestParameters: RetentionPreviewCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RetentionExplanation>;
+}