@picteus/extension-sdk 0.3.3 → 0.4.0

package/dist/picteus-ws-client/apis/ImageAttachmentApi.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/MiscellaneousApi.d.ts

@@ -0,0 +1,98 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * 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';
+export interface MiscellaneousApiMiscellaneousInstallChromeExtensionRequest {
+    body: Blob;
+}
+/**
+ * MiscellaneousApi - interface
+ *
+ * @export
+ * @interface MiscellaneousApiInterface
+ */
+export interface MiscellaneousApiInterface {
+    /**
+     * It will only work provided the server is hosted by an Electron application.
+     * @summary Installs a Chrome extension
+     * @param {Blob} body The Chrome extension tarball archive
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MiscellaneousApiInterface
+     */
+    miscellaneousInstallChromeExtensionRaw(requestParameters: MiscellaneousApiMiscellaneousInstallChromeExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * It will only work provided the server is hosted by an Electron application.
+     * Installs a Chrome extension
+     */
+    miscellaneousInstallChromeExtension(requestParameters: MiscellaneousApiMiscellaneousInstallChromeExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Enables to check that the service is accessible.
+     * @summary Pings the service
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MiscellaneousApiInterface
+     */
+    miscellaneousPingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Enables to check that the service is accessible.
+     * Pings the service
+     */
+    miscellaneousPing(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * This endpoint is for experimentation only.
+     * @summary Runs a test
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof MiscellaneousApiInterface
+     */
+    miscellaneousTestRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * This endpoint is for experimentation only.
+     * Runs a test
+     */
+    miscellaneousTest(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+}
+/**
+ *
+ */
+export declare class MiscellaneousApi extends runtime.BaseAPI implements MiscellaneousApiInterface {
+    /**
+     * It will only work provided the server is hosted by an Electron application.
+     * Installs a Chrome extension
+     */
+    miscellaneousInstallChromeExtensionRaw(requestParameters: MiscellaneousApiMiscellaneousInstallChromeExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * It will only work provided the server is hosted by an Electron application.
+     * Installs a Chrome extension
+     */
+    miscellaneousInstallChromeExtension(requestParameters: MiscellaneousApiMiscellaneousInstallChromeExtensionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Enables to check that the service is accessible.
+     * Pings the service
+     */
+    miscellaneousPingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Enables to check that the service is accessible.
+     * Pings the service
+     */
+    miscellaneousPing(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * This endpoint is for experimentation only.
+     * Runs a test
+     */
+    miscellaneousTestRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * This endpoint is for experimentation only.
+     * Runs a test
+     */
+    miscellaneousTest(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+}

package/dist/picteus-ws-client/apis/MiscellaneousApi.js

@@ -0,0 +1,114 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * 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';
+/**
+ *
+ */
+export class MiscellaneousApi extends runtime.BaseAPI {
+    /**
+     * It will only work provided the server is hosted by an Electron application.
+     * Installs a Chrome extension
+     */
+    async miscellaneousInstallChromeExtensionRaw(requestParameters, initOverrides) {
+        if (requestParameters['body'] == null) {
+            throw new runtime.RequiredError('body', 'Required parameter "body" was null or undefined when calling miscellaneousInstallChromeExtension().');
+        }
+        const queryParameters = {};
+        const headerParameters = {};
+        headerParameters['Content-Type'] = 'application/zip';
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/miscellaneous/installChromeExtension`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: requestParameters['body'],
+        }, initOverrides);
+        return new runtime.VoidApiResponse(response);
+    }
+    /**
+     * It will only work provided the server is hosted by an Electron application.
+     * Installs a Chrome extension
+     */
+    async miscellaneousInstallChromeExtension(requestParameters, initOverrides) {
+        await this.miscellaneousInstallChromeExtensionRaw(requestParameters, initOverrides);
+    }
+    /**
+     * Enables to check that the service is accessible.
+     * Pings the service
+     */
+    async miscellaneousPingRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/miscellaneous/ping`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse(response);
+        }
+        else {
+            return new runtime.TextApiResponse(response);
+        }
+    }
+    /**
+     * Enables to check that the service is accessible.
+     * Pings the service
+     */
+    async miscellaneousPing(initOverrides) {
+        const response = await this.miscellaneousPingRaw(initOverrides);
+        return await response.value();
+    }
+    /**
+     * This endpoint is for experimentation only.
+     * Runs a test
+     */
+    async miscellaneousTestRaw(initOverrides) {
+        const queryParameters = {};
+        const headerParameters = {};
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["X-API-KEY"] = await this.configuration.apiKey("X-API-KEY"); // api-key authentication
+        }
+        let urlPath = `/miscellaneous/test`;
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse(response);
+        }
+        else {
+            return new runtime.TextApiResponse(response);
+        }
+    }
+    /**
+     * This endpoint is for experimentation only.
+     * Runs a test
+     */
+    async miscellaneousTest(initOverrides) {
+        const response = await this.miscellaneousTestRaw(initOverrides);
+        return await response.value();
+    }
+}

package/dist/picteus-ws-client/apis/PingApi.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.3.5
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/PingApi.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.3.5
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/RepositoryApi.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/RepositoryApi.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/SettingsApi.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/SettingsApi.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/apis/index.d.ts

@@ -1,8 +1,8 @@
 export * from './AdministrationApi.js';
-export * from './ExperimentApi.js';
+export * from './ApiSecretApi.js';
 export * from './ExtensionApi.js';
 export * from './ImageApi.js';
 export * from './ImageAttachmentApi.js';
-export * from './PingApi.js';
+export * from './MiscellaneousApi.js';
 export * from './RepositoryApi.js';
 export * from './SettingsApi.js';

package/dist/picteus-ws-client/apis/index.js

@@ -1,10 +1,10 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './AdministrationApi.js';
-export * from './ExperimentApi.js';
+export * from './ApiSecretApi.js';
 export * from './ExtensionApi.js';
 export * from './ImageApi.js';
 export * from './ImageAttachmentApi.js';
-export * from './PingApi.js';
+export * from './MiscellaneousApi.js';
 export * from './RepositoryApi.js';
 export * from './SettingsApi.js';

package/dist/picteus-ws-client/models/ApiSecret.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * 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 { ApiSecretType } from './ApiSecretType.js';
+/**
+ *
+ * @export
+ * @interface ApiSecret
+ */
+export interface ApiSecret {
+    /**
+     * The secret identifier
+     * @type {number}
+     * @memberof ApiSecret
+     */
+    id: number;
+    /**
+     * The secret type
+     * @type {ApiSecretType}
+     * @memberof ApiSecret
+     */
+    type: ApiSecretType;
+    /**
+     * The entity creation date
+     * @type {number}
+     * @memberof ApiSecret
+     */
+    creationDate: number;
+    /**
+     * The entity expiration date
+     * @type {number}
+     * @memberof ApiSecret
+     */
+    expirationDate?: number;
+    /**
+     * The secret name
+     * @type {string}
+     * @memberof ApiSecret
+     */
+    name: string;
+    /**
+     * The secret comment
+     * @type {string}
+     * @memberof ApiSecret
+     */
+    comment?: string;
+    /**
+     * The secret scope
+     * @type {string}
+     * @memberof ApiSecret
+     */
+    scope?: string;
+    /**
+     * The secret value
+     * @type {string}
+     * @memberof ApiSecret
+     */
+    value: string;
+}
+/**
+ * Check if a given object implements the ApiSecret interface.
+ */
+export declare function instanceOfApiSecret(value: object): value is ApiSecret;
+export declare function ApiSecretFromJSON(json: any): ApiSecret;
+export declare function ApiSecretFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiSecret;
+export declare function ApiSecretToJSON(json: any): ApiSecret;
+export declare function ApiSecretToJSONTyped(value?: ApiSecret | null, ignoreDiscriminator?: boolean): any;

package/dist/picteus-ws-client/models/ApiSecret.js

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApiSecretTypeFromJSON, ApiSecretTypeToJSON, } from './ApiSecretType.js';
+/**
+ * Check if a given object implements the ApiSecret interface.
+ */
+export function instanceOfApiSecret(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('creationDate' in value) || value['creationDate'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('value' in value) || value['value'] === undefined)
+        return false;
+    return true;
+}
+export function ApiSecretFromJSON(json) {
+    return ApiSecretFromJSONTyped(json, false);
+}
+export function ApiSecretFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'type': ApiSecretTypeFromJSON(json['type']),
+        'creationDate': json['creationDate'],
+        'expirationDate': json['expirationDate'] == null ? undefined : json['expirationDate'],
+        'name': json['name'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+        'scope': json['scope'] == null ? undefined : json['scope'],
+        'value': json['value'],
+    };
+}
+export function ApiSecretToJSON(json) {
+    return ApiSecretToJSONTyped(json, false);
+}
+export function ApiSecretToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': ApiSecretTypeToJSON(value['type']),
+        'creationDate': value['creationDate'],
+        'expirationDate': value['expirationDate'],
+        'name': value['name'],
+        'comment': value['comment'],
+        'scope': value['scope'],
+        'value': value['value'],
+    };
+}

package/dist/picteus-ws-client/models/ApiSecretSummary.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * 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 { ApiSecretType } from './ApiSecretType.js';
+/**
+ *
+ * @export
+ * @interface ApiSecretSummary
+ */
+export interface ApiSecretSummary {
+    /**
+     * The secret identifier
+     * @type {number}
+     * @memberof ApiSecretSummary
+     */
+    id: number;
+    /**
+     * The secret type
+     * @type {ApiSecretType}
+     * @memberof ApiSecretSummary
+     */
+    type: ApiSecretType;
+    /**
+     * The entity creation date
+     * @type {number}
+     * @memberof ApiSecretSummary
+     */
+    creationDate: number;
+    /**
+     * The entity expiration date
+     * @type {number}
+     * @memberof ApiSecretSummary
+     */
+    expirationDate?: number;
+    /**
+     * The secret name
+     * @type {string}
+     * @memberof ApiSecretSummary
+     */
+    name: string;
+    /**
+     * The secret comment
+     * @type {string}
+     * @memberof ApiSecretSummary
+     */
+    comment?: string;
+}
+/**
+ * Check if a given object implements the ApiSecretSummary interface.
+ */
+export declare function instanceOfApiSecretSummary(value: object): value is ApiSecretSummary;
+export declare function ApiSecretSummaryFromJSON(json: any): ApiSecretSummary;
+export declare function ApiSecretSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiSecretSummary;
+export declare function ApiSecretSummaryToJSON(json: any): ApiSecretSummary;
+export declare function ApiSecretSummaryToJSONTyped(value?: ApiSecretSummary | null, ignoreDiscriminator?: boolean): any;

package/dist/picteus-ws-client/models/ApiSecretSummary.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ApiSecretTypeFromJSON, ApiSecretTypeToJSON, } from './ApiSecretType.js';
+/**
+ * Check if a given object implements the ApiSecretSummary interface.
+ */
+export function instanceOfApiSecretSummary(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('creationDate' in value) || value['creationDate'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    return true;
+}
+export function ApiSecretSummaryFromJSON(json) {
+    return ApiSecretSummaryFromJSONTyped(json, false);
+}
+export function ApiSecretSummaryFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'type': ApiSecretTypeFromJSON(json['type']),
+        'creationDate': json['creationDate'],
+        'expirationDate': json['expirationDate'] == null ? undefined : json['expirationDate'],
+        'name': json['name'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+    };
+}
+export function ApiSecretSummaryToJSON(json) {
+    return ApiSecretSummaryToJSONTyped(json, false);
+}
+export function ApiSecretSummaryToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'type': ApiSecretTypeToJSON(value['type']),
+        'creationDate': value['creationDate'],
+        'expirationDate': value['expirationDate'],
+        'name': value['name'],
+        'comment': value['comment'],
+    };
+}

package/dist/picteus-ws-client/models/ApiSecretType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The secret type
+ * @export
+ */
+export declare const ApiSecretType: {
+    readonly Key: "key";
+    readonly Token: "token";
+};
+export type ApiSecretType = typeof ApiSecretType[keyof typeof ApiSecretType];
+export declare function instanceOfApiSecretType(value: any): boolean;
+export declare function ApiSecretTypeFromJSON(json: any): ApiSecretType;
+export declare function ApiSecretTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ApiSecretType;
+export declare function ApiSecretTypeToJSON(value?: ApiSecretType | null): any;
+export declare function ApiSecretTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): ApiSecretType;

package/dist/picteus-ws-client/models/ApiSecretType.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Picteus
+ * The Picteus API
+ *
+ * The version of the OpenAPI document: 0.4.0
+ * Contact: edouard@koppasoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The secret type
+ * @export
+ */
+export const ApiSecretType = {
+    Key: 'key',
+    Token: 'token'
+};
+export function instanceOfApiSecretType(value) {
+    for (const key in ApiSecretType) {
+        if (Object.prototype.hasOwnProperty.call(ApiSecretType, key)) {
+            if (ApiSecretType[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function ApiSecretTypeFromJSON(json) {
+    return ApiSecretTypeFromJSONTyped(json, false);
+}
+export function ApiSecretTypeFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function ApiSecretTypeToJSON(value) {
+    return value;
+}
+export function ApiSecretTypeToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/picteus-ws-client/models/Automatic1111Instruction.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/models/Automatic1111Instruction.js

@@ -4,7 +4,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/picteus-ws-client/models/Automatic1111UserComment.d.ts

@@ -2,7 +2,7 @@
  * Picteus
  * The Picteus API
  *
- * The version of the OpenAPI document: 0.3.0
+ * The version of the OpenAPI document: 0.4.0
  * Contact: edouard@koppasoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).