@botpress/client 0.0.9 → 0.0.11

package/dist/gen/configuration.d.ts

@@ -1,83 +1,83 @@
-/**
- * Botpress API
- * API for Botpress Cloud
- *
- * The version of the OpenAPI document: 0.2.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export interface ConfigurationParameters {
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    username?: string;
-    password?: string;
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    basePath?: string;
-    baseOptions?: any;
-    formDataCtor?: new () => any;
-}
-export declare class Configuration {
-    /**
-     * parameter for apiKey security
-     * @param name security name
-     * @memberof Configuration
-     */
-    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    username?: string;
-    /**
-     * parameter for basic security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    password?: string;
-    /**
-     * parameter for oauth2 security
-     * @param name security name
-     * @param scopes oauth2 scope
-     * @memberof Configuration
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * override base path
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    basePath?: string;
-    /**
-     * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
-     */
-    baseOptions?: any;
-    /**
-     * The FormData constructor that will be used to create multipart form data
-     * requests. You can inject this here so that execution environments that
-     * do not support the FormData class can still run the generated client.
-     *
-     * @type {new () => FormData}
-     */
-    formDataCtor?: new () => any;
-    constructor(param?: ConfigurationParameters);
-    /**
-     * Check if the given MIME is a JSON MIME.
-     * JSON MIME examples:
-     *   application/json
-     *   application/json; charset=UTF8
-     *   APPLICATION/JSON
-     *   application/vnd.company+json
-     * @param mime - MIME (Multipurpose Internet Mail Extensions)
-     * @return True if the given MIME is JSON, false otherwise.
-     */
-    isJsonMime(mime: string): boolean;
-}
+/**
+ * Botpress API
+ * API for Botpress Cloud
+ *
+ * The version of the OpenAPI document: 0.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/gen/errors.d.ts

@@ -1,144 +1,144 @@
-declare const codes: {
-    readonly HTTP_STATUS_BAD_REQUEST: 400;
-    readonly HTTP_STATUS_UNAUTHORIZED: 401;
-    readonly HTTP_STATUS_PAYMENT_REQUIRED: 402;
-    readonly HTTP_STATUS_FORBIDDEN: 403;
-    readonly HTTP_STATUS_NOT_FOUND: 404;
-    readonly HTTP_STATUS_METHOD_NOT_ALLOWED: 405;
-    readonly HTTP_STATUS_CONFLICT: 409;
-    readonly HTTP_STATUS_PAYLOAD_TOO_LARGE: 413;
-    readonly HTTP_STATUS_TOO_MANY_REQUESTS: 429;
-    readonly HTTP_STATUS_INTERNAL_SERVER_ERROR: 500;
-};
-type ErrorCode = typeof codes[keyof typeof codes];
-declare abstract class BaseApiError<Code extends ErrorCode, Type extends string, Description extends string> extends Error {
-    readonly code: Code;
-    readonly description: Description;
-    readonly type: Type;
-    readonly message: string;
-    readonly error?: Error | undefined;
-    readonly isApiError = true;
-    constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined);
-    toJSON(): {
-        code: Code;
-        type: Type;
-        message: string;
-    };
-}
-export declare const isApiError: (thrown: unknown) => thrown is ApiError;
-type UnknownType = 'Unknown';
-/**
- *  An unknown error occurred
- */
-export declare class UnknownError extends BaseApiError<500, UnknownType, 'An unknown error occurred'> {
-    constructor(message: string, error?: Error);
-}
-type InternalType = 'Internal';
-/**
- *  An internal error occurred
- */
-export declare class InternalError extends BaseApiError<500, InternalType, 'An internal error occurred'> {
-    constructor(message: string, error?: Error);
-}
-type UnauthorizedType = 'Unauthorized';
-/**
- *  The request requires to be authenticated.
- */
-export declare class UnauthorizedError extends BaseApiError<401, UnauthorizedType, 'The request requires to be authenticated.'> {
-    constructor(message: string, error?: Error);
-}
-type ForbiddenType = 'Forbidden';
-/**
- *  The requested action can\'t be peform by this resource.
- */
-export declare class ForbiddenError extends BaseApiError<403, ForbiddenType, 'The requested action can\'t be peform by this resource.'> {
-    constructor(message: string, error?: Error);
-}
-type PayloadTooLargeType = 'PayloadTooLarge';
-/**
- *  The request payload is too large.
- */
-export declare class PayloadTooLargeError extends BaseApiError<413, PayloadTooLargeType, 'The request payload is too large.'> {
-    constructor(message: string, error?: Error);
-}
-type InvalidPayloadType = 'InvalidPayload';
-/**
- *  The request payload is invalid.
- */
-export declare class InvalidPayloadError extends BaseApiError<400, InvalidPayloadType, 'The request payload is invalid.'> {
-    constructor(message: string, error?: Error);
-}
-type UnsupportedMediaTypeType = 'UnsupportedMediaType';
-/**
- *  The request is invalid because the content-type is not supported.
- */
-export declare class UnsupportedMediaTypeError extends BaseApiError<415, UnsupportedMediaTypeType, 'The request is invalid because the content-type is not supported.'> {
-    constructor(message: string, error?: Error);
-}
-type MethodNotFoundType = 'MethodNotFound';
-/**
- *  The requested method does not exist.
- */
-export declare class MethodNotFoundError extends BaseApiError<405, MethodNotFoundType, 'The requested method does not exist.'> {
-    constructor(message: string, error?: Error);
-}
-type ResourceNotFoundType = 'ResourceNotFound';
-/**
- *  The requested resource does not exist.
- */
-export declare class ResourceNotFoundError extends BaseApiError<404, ResourceNotFoundType, 'The requested resource does not exist.'> {
-    constructor(message: string, error?: Error);
-}
-type InvalidJsonSchemaType = 'InvalidJsonSchema';
-/**
- *  The provided JSON schema is invalid.
- */
-export declare class InvalidJsonSchemaError extends BaseApiError<400, InvalidJsonSchemaType, 'The provided JSON schema is invalid.'> {
-    constructor(message: string, error?: Error);
-}
-type InvalidDataFormatType = 'InvalidDataFormat';
-/**
- *  The provided data doesn\'t respect the provided JSON schema.
- */
-export declare class InvalidDataFormatError extends BaseApiError<400, InvalidDataFormatType, 'The provided data doesn\'t respect the provided JSON schema.'> {
-    constructor(message: string, error?: Error);
-}
-type InvalidIdentifierType = 'InvalidIdentifier';
-/**
- *  The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.
- */
-export declare class InvalidIdentifierError extends BaseApiError<400, InvalidIdentifierType, 'The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.'> {
-    constructor(message: string, error?: Error);
-}
-type RelationConflictType = 'RelationConflict';
-/**
- *  The resource is not related with another resource. This is usually caused when providing two resources that aren\'t linked together.
- */
-export declare class RelationConflictError extends BaseApiError<409, RelationConflictType, 'The resource is not related with another resource. This is usually caused when providing two resources that aren\'t linked together.'> {
-    constructor(message: string, error?: Error);
-}
-type ReferenceNotFoundType = 'ReferenceNotFound';
-/**
- *  The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.
- */
-export declare class ReferenceNotFoundError extends BaseApiError<400, ReferenceNotFoundType, 'The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.'> {
-    constructor(message: string, error?: Error);
-}
-type InvalidQueryType = 'InvalidQuery';
-/**
- *  The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.
- */
-export declare class InvalidQueryError extends BaseApiError<400, InvalidQueryType, 'The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.'> {
-    constructor(message: string, error?: Error);
-}
-type RuntimeType = 'Runtime';
-/**
- *  An error happened during the execution of a runtime (bot or integration).
- */
-export declare class RuntimeError extends BaseApiError<400, RuntimeType, 'An error happened during the execution of a runtime (bot or integration).'> {
-    constructor(message: string, error?: Error);
-}
-export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime';
-export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceNotFoundError | InvalidQueryError | RuntimeError;
-export declare const errorFrom: (err: unknown) => ApiError;
-export {};
+declare const codes: {
+    readonly HTTP_STATUS_BAD_REQUEST: 400;
+    readonly HTTP_STATUS_UNAUTHORIZED: 401;
+    readonly HTTP_STATUS_PAYMENT_REQUIRED: 402;
+    readonly HTTP_STATUS_FORBIDDEN: 403;
+    readonly HTTP_STATUS_NOT_FOUND: 404;
+    readonly HTTP_STATUS_METHOD_NOT_ALLOWED: 405;
+    readonly HTTP_STATUS_CONFLICT: 409;
+    readonly HTTP_STATUS_PAYLOAD_TOO_LARGE: 413;
+    readonly HTTP_STATUS_TOO_MANY_REQUESTS: 429;
+    readonly HTTP_STATUS_INTERNAL_SERVER_ERROR: 500;
+};
+type ErrorCode = typeof codes[keyof typeof codes];
+declare abstract class BaseApiError<Code extends ErrorCode, Type extends string, Description extends string> extends Error {
+    readonly code: Code;
+    readonly description: Description;
+    readonly type: Type;
+    readonly message: string;
+    readonly error?: Error | undefined;
+    readonly isApiError = true;
+    constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined);
+    toJSON(): {
+        code: Code;
+        type: Type;
+        message: string;
+    };
+}
+export declare const isApiError: (thrown: unknown) => thrown is ApiError;
+type UnknownType = 'Unknown';
+/**
+ *  An unknown error occurred
+ */
+export declare class UnknownError extends BaseApiError<500, UnknownType, 'An unknown error occurred'> {
+    constructor(message: string, error?: Error);
+}
+type InternalType = 'Internal';
+/**
+ *  An internal error occurred
+ */
+export declare class InternalError extends BaseApiError<500, InternalType, 'An internal error occurred'> {
+    constructor(message: string, error?: Error);
+}
+type UnauthorizedType = 'Unauthorized';
+/**
+ *  The request requires to be authenticated.
+ */
+export declare class UnauthorizedError extends BaseApiError<401, UnauthorizedType, 'The request requires to be authenticated.'> {
+    constructor(message: string, error?: Error);
+}
+type ForbiddenType = 'Forbidden';
+/**
+ *  The requested action can\'t be peform by this resource.
+ */
+export declare class ForbiddenError extends BaseApiError<403, ForbiddenType, 'The requested action can\'t be peform by this resource.'> {
+    constructor(message: string, error?: Error);
+}
+type PayloadTooLargeType = 'PayloadTooLarge';
+/**
+ *  The request payload is too large.
+ */
+export declare class PayloadTooLargeError extends BaseApiError<413, PayloadTooLargeType, 'The request payload is too large.'> {
+    constructor(message: string, error?: Error);
+}
+type InvalidPayloadType = 'InvalidPayload';
+/**
+ *  The request payload is invalid.
+ */
+export declare class InvalidPayloadError extends BaseApiError<400, InvalidPayloadType, 'The request payload is invalid.'> {
+    constructor(message: string, error?: Error);
+}
+type UnsupportedMediaTypeType = 'UnsupportedMediaType';
+/**
+ *  The request is invalid because the content-type is not supported.
+ */
+export declare class UnsupportedMediaTypeError extends BaseApiError<415, UnsupportedMediaTypeType, 'The request is invalid because the content-type is not supported.'> {
+    constructor(message: string, error?: Error);
+}
+type MethodNotFoundType = 'MethodNotFound';
+/**
+ *  The requested method does not exist.
+ */
+export declare class MethodNotFoundError extends BaseApiError<405, MethodNotFoundType, 'The requested method does not exist.'> {
+    constructor(message: string, error?: Error);
+}
+type ResourceNotFoundType = 'ResourceNotFound';
+/**
+ *  The requested resource does not exist.
+ */
+export declare class ResourceNotFoundError extends BaseApiError<404, ResourceNotFoundType, 'The requested resource does not exist.'> {
+    constructor(message: string, error?: Error);
+}
+type InvalidJsonSchemaType = 'InvalidJsonSchema';
+/**
+ *  The provided JSON schema is invalid.
+ */
+export declare class InvalidJsonSchemaError extends BaseApiError<400, InvalidJsonSchemaType, 'The provided JSON schema is invalid.'> {
+    constructor(message: string, error?: Error);
+}
+type InvalidDataFormatType = 'InvalidDataFormat';
+/**
+ *  The provided data doesn\'t respect the provided JSON schema.
+ */
+export declare class InvalidDataFormatError extends BaseApiError<400, InvalidDataFormatType, 'The provided data doesn\'t respect the provided JSON schema.'> {
+    constructor(message: string, error?: Error);
+}
+type InvalidIdentifierType = 'InvalidIdentifier';
+/**
+ *  The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.
+ */
+export declare class InvalidIdentifierError extends BaseApiError<400, InvalidIdentifierType, 'The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.'> {
+    constructor(message: string, error?: Error);
+}
+type RelationConflictType = 'RelationConflict';
+/**
+ *  The resource is not related with another resource. This is usually caused when providing two resources that aren\'t linked together.
+ */
+export declare class RelationConflictError extends BaseApiError<409, RelationConflictType, 'The resource is not related with another resource. This is usually caused when providing two resources that aren\'t linked together.'> {
+    constructor(message: string, error?: Error);
+}
+type ReferenceNotFoundType = 'ReferenceNotFound';
+/**
+ *  The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.
+ */
+export declare class ReferenceNotFoundError extends BaseApiError<400, ReferenceNotFoundType, 'The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.'> {
+    constructor(message: string, error?: Error);
+}
+type InvalidQueryType = 'InvalidQuery';
+/**
+ *  The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.
+ */
+export declare class InvalidQueryError extends BaseApiError<400, InvalidQueryType, 'The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.'> {
+    constructor(message: string, error?: Error);
+}
+type RuntimeType = 'Runtime';
+/**
+ *  An error happened during the execution of a runtime (bot or integration).
+ */
+export declare class RuntimeError extends BaseApiError<400, RuntimeType, 'An error happened during the execution of a runtime (bot or integration).'> {
+    constructor(message: string, error?: Error);
+}
+export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime';
+export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceNotFoundError | InvalidQueryError | RuntimeError;
+export declare const errorFrom: (err: unknown) => ApiError;
+export {};

package/dist/gen/index.d.ts

@@ -1,13 +1,13 @@
-/**
- * Botpress API
- * API for Botpress Cloud
- *
- * The version of the OpenAPI document: 0.2.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export * from "./api";
-export * from "./configuration";
+/**
+ * Botpress API
+ * API for Botpress Cloud
+ *
+ * The version of the OpenAPI document: 0.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";