@cirrobio/api-client 0.12.14 → 0.12.15

package/dist/esm/apis/AppRegistrationsApi.js

@@ -0,0 +1,300 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * 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';
+import { AppRegistrationFromJSON, AppRegistrationDetailFromJSON, AppRegistrationInputToJSON, AppRegistrationSecretResponseFromJSON, PaginatedResponseAppRegistrationDtoFromJSON, } from '../models/index';
+/**
+ *
+ */
+export class AppRegistrationsApi extends runtime.BaseAPI {
+    /**
+     * Archives an app registration. Archived registrations cannot authenticate.
+     * Archive app registration
+     */
+    archiveAppRegistrationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.id === null || requestParameters.id === undefined) {
+                throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling archiveAppRegistration.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+                method: 'DELETE',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Archives an app registration. Archived registrations cannot authenticate.
+     * Archive app registration
+     */
+    archiveAppRegistration(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.archiveAppRegistrationRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates a new OAuth client app registration. Returns the client secret which is only shown once.
+     * Create app registration
+     */
+    createAppRegistrationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.appRegistrationInput === null || requestParameters.appRegistrationInput === undefined) {
+                throw new runtime.RequiredError('appRegistrationInput', 'Required parameter requestParameters.appRegistrationInput was null or undefined when calling createAppRegistration.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations`,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AppRegistrationInputToJSON(requestParameters.appRegistrationInput),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AppRegistrationSecretResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Creates a new OAuth client app registration. Returns the client secret which is only shown once.
+     * Create app registration
+     */
+    createAppRegistration(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createAppRegistrationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Gets detailed information about an app registration.
+     * Get app registration
+     */
+    getAppRegistrationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.id === null || requestParameters.id === undefined) {
+                throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling getAppRegistration.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AppRegistrationDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Gets detailed information about an app registration.
+     * Get app registration
+     */
+    getAppRegistration(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getAppRegistrationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lists all app registrations in the system.
+     * List app registrations
+     */
+    listAppRegistrationsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.limit === null || requestParameters.limit === undefined) {
+                throw new runtime.RequiredError('limit', 'Required parameter requestParameters.limit was null or undefined when calling listAppRegistrations.');
+            }
+            if (requestParameters.nextToken === null || requestParameters.nextToken === undefined) {
+                throw new runtime.RequiredError('nextToken', 'Required parameter requestParameters.nextToken was null or undefined when calling listAppRegistrations.');
+            }
+            const queryParameters = {};
+            if (requestParameters.limit !== undefined) {
+                queryParameters['limit'] = requestParameters.limit;
+            }
+            if (requestParameters.nextToken !== undefined) {
+                queryParameters['nextToken'] = requestParameters.nextToken;
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedResponseAppRegistrationDtoFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Lists all app registrations in the system.
+     * List app registrations
+     */
+    listAppRegistrations(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listAppRegistrationsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Lists app registrations created by the current user.
+     * List my app registrations
+     */
+    listMyAppRegistrationsRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations/mine`,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(AppRegistrationFromJSON));
+        });
+    }
+    /**
+     * Lists app registrations created by the current user.
+     * List my app registrations
+     */
+    listMyAppRegistrations(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.listMyAppRegistrationsRaw(initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Generates a new client secret for the app registration. The old secret is invalidated.
+     * Regenerate client secret
+     */
+    regenerateSecretRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.id === null || requestParameters.id === undefined) {
+                throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling regenerateSecret.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations/{id}:regenerate-secret`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AppRegistrationSecretResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Generates a new client secret for the app registration. The old secret is invalidated.
+     * Regenerate client secret
+     */
+    regenerateSecret(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.regenerateSecretRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Updates an existing app registration.
+     * Update app registration
+     */
+    updateAppRegistrationRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters.id === null || requestParameters.id === undefined) {
+                throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling updateAppRegistration.');
+            }
+            if (requestParameters.appRegistrationInput === null || requestParameters.appRegistrationInput === undefined) {
+                throw new runtime.RequiredError('appRegistrationInput', 'Required parameter requestParameters.appRegistrationInput was null or undefined when calling updateAppRegistration.');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("accessToken", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            const response = yield this.request({
+                path: `/app-registrations/{id}`.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters.id))),
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: AppRegistrationInputToJSON(requestParameters.appRegistrationInput),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => AppRegistrationDetailFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Updates an existing app registration.
+     * Update app registration
+     */
+    updateAppRegistration(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateAppRegistrationRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -1,3 +1,4 @@
+export * from './AppRegistrationsApi';
 export * from './AuditApi';
 export * from './BillingApi';
 export * from './ComputeEnvironmentApi';

package/dist/esm/apis/index.js

@@ -1,5 +1,6 @@
 /* tslint:disable */
 /* eslint-disable */
+export * from './AppRegistrationsApi';
 export * from './AuditApi';
 export * from './BillingApi';
 export * from './ComputeEnvironmentApi';

package/dist/esm/models/AppRegistration.d.ts

@@ -0,0 +1,93 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AppType } from './AppType';
+import type { PrincipalType } from './PrincipalType';
+/**
+ *
+ * @export
+ * @interface AppRegistration
+ */
+export interface AppRegistration {
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistration
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistration
+     */
+    clientId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistration
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistration
+     */
+    description: string;
+    /**
+     *
+     * @type {PrincipalType}
+     * @memberof AppRegistration
+     */
+    principalType: PrincipalType;
+    /**
+     *
+     * @type {AppType}
+     * @memberof AppRegistration
+     */
+    type: AppType;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistration
+     */
+    secretExpiresAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AppRegistration
+     */
+    isArchived: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistration
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistration
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistration
+     */
+    createdBy: string;
+}
+/**
+ * Check if a given object implements the AppRegistration interface.
+ */
+export declare function instanceOfAppRegistration(value: object): boolean;
+export declare function AppRegistrationFromJSON(json: any): AppRegistration;
+export declare function AppRegistrationFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppRegistration;
+export declare function AppRegistrationToJSON(value?: AppRegistration | null): any;

package/dist/esm/models/AppRegistration.js

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { exists } from '../runtime';
+import { AppTypeFromJSON, AppTypeToJSON, } from './AppType';
+import { PrincipalTypeFromJSON, PrincipalTypeToJSON, } from './PrincipalType';
+/**
+ * Check if a given object implements the AppRegistration interface.
+ */
+export function instanceOfAppRegistration(value) {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "clientId" in value;
+    isInstance = isInstance && "name" in value;
+    isInstance = isInstance && "description" in value;
+    isInstance = isInstance && "principalType" in value;
+    isInstance = isInstance && "type" in value;
+    isInstance = isInstance && "isArchived" in value;
+    isInstance = isInstance && "updatedAt" in value;
+    isInstance = isInstance && "createdAt" in value;
+    isInstance = isInstance && "createdBy" in value;
+    return isInstance;
+}
+export function AppRegistrationFromJSON(json) {
+    return AppRegistrationFromJSONTyped(json, false);
+}
+export function AppRegistrationFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'clientId': json['clientId'],
+        'name': json['name'],
+        'description': json['description'],
+        'principalType': PrincipalTypeFromJSON(json['principalType']),
+        'type': AppTypeFromJSON(json['type']),
+        'secretExpiresAt': !exists(json, 'secretExpiresAt') ? undefined : (json['secretExpiresAt'] === null ? null : new Date(json['secretExpiresAt'])),
+        'isArchived': json['isArchived'],
+        'updatedAt': (new Date(json['updatedAt'])),
+        'createdAt': (new Date(json['createdAt'])),
+        'createdBy': json['createdBy'],
+    };
+}
+export function AppRegistrationToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'id': value.id,
+        'clientId': value.clientId,
+        'name': value.name,
+        'description': value.description,
+        'principalType': PrincipalTypeToJSON(value.principalType),
+        'type': AppTypeToJSON(value.type),
+        'secretExpiresAt': value.secretExpiresAt === undefined ? undefined : (value.secretExpiresAt === null ? null : value.secretExpiresAt.toISOString()),
+        'isArchived': value.isArchived,
+        'updatedAt': (value.updatedAt.toISOString()),
+        'createdAt': (value.createdAt.toISOString()),
+        'createdBy': value.createdBy,
+    };
+}

package/dist/esm/models/AppRegistrationDetail.d.ts

@@ -0,0 +1,125 @@
+/**
+ * Cirro Data
+ * Cirro Data Platform service API
+ *
+ * The version of the OpenAPI document: latest
+ * Contact: support@cirro.bio
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { AppType } from './AppType';
+import type { Permission } from './Permission';
+import type { PrincipalType } from './PrincipalType';
+import type { ProjectPermissionSet } from './ProjectPermissionSet';
+/**
+ *
+ * @export
+ * @interface AppRegistrationDetail
+ */
+export interface AppRegistrationDetail {
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistrationDetail
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistrationDetail
+     */
+    clientId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistrationDetail
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistrationDetail
+     */
+    description: string;
+    /**
+     *
+     * @type {PrincipalType}
+     * @memberof AppRegistrationDetail
+     */
+    principalType: PrincipalType;
+    /**
+     *
+     * @type {AppType}
+     * @memberof AppRegistrationDetail
+     */
+    type: AppType;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof AppRegistrationDetail
+     */
+    allowedIps: Array<string>;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistrationDetail
+     */
+    secretExpiresAt?: Date | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistrationDetail
+     */
+    secretGeneratedAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistrationDetail
+     */
+    secretGeneratedBy: string;
+    /**
+     *
+     * @type {Array<ProjectPermissionSet>}
+     * @memberof AppRegistrationDetail
+     */
+    projectPermissions: Array<ProjectPermissionSet>;
+    /**
+     *
+     * @type {Array<Permission>}
+     * @memberof AppRegistrationDetail
+     */
+    globalPermissions: Array<Permission>;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AppRegistrationDetail
+     */
+    isArchived: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistrationDetail
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof AppRegistrationDetail
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof AppRegistrationDetail
+     */
+    createdBy: string;
+}
+/**
+ * Check if a given object implements the AppRegistrationDetail interface.
+ */
+export declare function instanceOfAppRegistrationDetail(value: object): boolean;
+export declare function AppRegistrationDetailFromJSON(json: any): AppRegistrationDetail;
+export declare function AppRegistrationDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): AppRegistrationDetail;
+export declare function AppRegistrationDetailToJSON(value?: AppRegistrationDetail | null): any;