@botpress/client 0.3.2 → 0.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bundle.cjs +7 -7
- package/dist/bundle.cjs.map +4 -4
- package/dist/config.d.ts +7 -4
- package/dist/gen/api.d.ts +43 -9
- package/dist/gen/base.d.ts +1 -1
- package/dist/gen/client.d.ts +9 -9
- package/dist/gen/common.d.ts +1 -1
- package/dist/gen/configuration.d.ts +1 -1
- package/dist/gen/errors.d.ts +23 -20
- package/dist/gen/index.d.ts +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +3 -3
- package/dist/index.mjs +1 -1
- package/package.json +3 -3
package/dist/config.d.ts
CHANGED
|
@@ -1,15 +1,18 @@
|
|
|
1
|
+
type Headers = Record<string, string | string[]>;
|
|
1
2
|
export type ClientProps = {
|
|
2
|
-
host?: string;
|
|
3
3
|
integrationId?: string;
|
|
4
4
|
workspaceId?: string;
|
|
5
5
|
botId?: string;
|
|
6
6
|
token?: string;
|
|
7
|
+
apiUrl?: string;
|
|
7
8
|
timeout?: number;
|
|
9
|
+
headers?: Headers;
|
|
8
10
|
};
|
|
9
11
|
export type ClientConfig = {
|
|
10
|
-
|
|
11
|
-
headers:
|
|
12
|
+
apiUrl: string;
|
|
13
|
+
headers: Headers;
|
|
12
14
|
withCredentials: boolean;
|
|
13
|
-
timeout
|
|
15
|
+
timeout: number;
|
|
14
16
|
};
|
|
15
17
|
export declare function getClientConfig(clientProps: ClientProps): ClientConfig;
|
|
18
|
+
export {};
|
package/dist/gen/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Botpress API
|
|
3
3
|
* API for Botpress Cloud
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.5.
|
|
5
|
+
* The version of the OpenAPI document: 0.5.4
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1616,8 +1616,8 @@ export interface GetAuditRecordsResponseRecordsInner {
|
|
|
1616
1616
|
}
|
|
1617
1617
|
export declare const GetAuditRecordsResponseRecordsInnerActionEnum: {
|
|
1618
1618
|
readonly Unknown: "UNKNOWN";
|
|
1619
|
-
readonly
|
|
1620
|
-
readonly
|
|
1619
|
+
readonly AddWorkspaceMember: "ADD_WORKSPACE_MEMBER";
|
|
1620
|
+
readonly RemoveWorkspaceMember: "REMOVE_WORKSPACE_MEMBER";
|
|
1621
1621
|
readonly UpdateWorkspaceMember: "UPDATE_WORKSPACE_MEMBER";
|
|
1622
1622
|
readonly CloseWorkspace: "CLOSE_WORKSPACE";
|
|
1623
1623
|
readonly CreateBot: "CREATE_BOT";
|
|
@@ -3199,12 +3199,6 @@ export interface UpdateConversationBody {
|
|
|
3199
3199
|
'tags': {
|
|
3200
3200
|
[key: string]: string;
|
|
3201
3201
|
};
|
|
3202
|
-
/**
|
|
3203
|
-
* Ids of the [User]s(#schema_user) participating in the conversation
|
|
3204
|
-
* @type {Array<string>}
|
|
3205
|
-
* @memberof UpdateConversationBody
|
|
3206
|
-
*/
|
|
3207
|
-
'participantIds': Array<string>;
|
|
3208
3202
|
}
|
|
3209
3203
|
/**
|
|
3210
3204
|
*
|
|
@@ -3841,6 +3835,46 @@ export declare const WorkspaceAccountTypeEnum: {
|
|
|
3841
3835
|
readonly Premium: "premium";
|
|
3842
3836
|
};
|
|
3843
3837
|
export type WorkspaceAccountTypeEnum = typeof WorkspaceAccountTypeEnum[keyof typeof WorkspaceAccountTypeEnum];
|
|
3838
|
+
/**
|
|
3839
|
+
*
|
|
3840
|
+
* @export
|
|
3841
|
+
* @interface WorkspaceMember
|
|
3842
|
+
*/
|
|
3843
|
+
export interface WorkspaceMember {
|
|
3844
|
+
/**
|
|
3845
|
+
*
|
|
3846
|
+
* @type {string}
|
|
3847
|
+
* @memberof WorkspaceMember
|
|
3848
|
+
*/
|
|
3849
|
+
'id': string;
|
|
3850
|
+
/**
|
|
3851
|
+
*
|
|
3852
|
+
* @type {string}
|
|
3853
|
+
* @memberof WorkspaceMember
|
|
3854
|
+
*/
|
|
3855
|
+
'userId'?: string;
|
|
3856
|
+
/**
|
|
3857
|
+
*
|
|
3858
|
+
* @type {string}
|
|
3859
|
+
* @memberof WorkspaceMember
|
|
3860
|
+
*/
|
|
3861
|
+
'email': string;
|
|
3862
|
+
/**
|
|
3863
|
+
*
|
|
3864
|
+
* @type {string}
|
|
3865
|
+
* @memberof WorkspaceMember
|
|
3866
|
+
*/
|
|
3867
|
+
'role': WorkspaceMemberRoleEnum;
|
|
3868
|
+
}
|
|
3869
|
+
export declare const WorkspaceMemberRoleEnum: {
|
|
3870
|
+
readonly Viewer: "viewer";
|
|
3871
|
+
readonly Billing: "billing";
|
|
3872
|
+
readonly Developer: "developer";
|
|
3873
|
+
readonly Manager: "manager";
|
|
3874
|
+
readonly Administrator: "administrator";
|
|
3875
|
+
readonly Owner: "owner";
|
|
3876
|
+
};
|
|
3877
|
+
export type WorkspaceMemberRoleEnum = typeof WorkspaceMemberRoleEnum[keyof typeof WorkspaceMemberRoleEnum];
|
|
3844
3878
|
/**
|
|
3845
3879
|
* DefaultApi - axios parameter creator
|
|
3846
3880
|
* @export
|
package/dist/gen/base.d.ts
CHANGED
package/dist/gen/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AxiosInstance } from 'axios';
|
|
2
2
|
import type { Merge, Except } from 'type-fest';
|
|
3
|
-
import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest,
|
|
3
|
+
import { Configuration, DefaultApiCreateConversationRequest, DefaultApiGetConversationRequest, DefaultApiListConversationsRequest, DefaultApiGetOrCreateConversationRequest, DefaultApiUpdateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiCreateEventRequest, DefaultApiGetEventRequest, DefaultApiListEventsRequest, DefaultApiCreateMessageRequest, DefaultApiGetOrCreateMessageRequest, DefaultApiGetMessageRequest, DefaultApiUpdateMessageRequest, DefaultApiListMessagesRequest, DefaultApiDeleteMessageRequest, DefaultApiCreateUserRequest, DefaultApiGetUserRequest, DefaultApiListUsersRequest, DefaultApiGetOrCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest, DefaultApiGetStateRequest, DefaultApiSetStateRequest, DefaultApiPatchStateRequest, DefaultApiCallActionRequest, DefaultApiConfigureIntegrationRequest, DefaultApiListPublicIntegrationsRequest, DefaultApiGetPublicIntegrationByIdRequest, DefaultApiGetPublicIntegrationRequest, DefaultApiCreateBotRequest, DefaultApiUpdateBotRequest, DefaultApiTransferBotRequest, DefaultApiListBotsRequest, DefaultApiGetBotRequest, DefaultApiDeleteBotRequest, DefaultApiGetBotLogsRequest, DefaultApiGetBotWebchatRequest, DefaultApiGetBotAnalyticsRequest, DefaultApiCreateWorkspaceRequest, DefaultApiGetWorkspaceRequest, DefaultApiUpdateWorkspaceRequest, DefaultApiListWorkspacesRequest, DefaultApiChangeWorkspacePlanRequest, DefaultApiDeleteWorkspaceRequest, DefaultApiGetAuditRecordsRequest, DefaultApiListWorkspaceMembersRequest, DefaultApiDeleteWorkspaceMemberRequest, DefaultApiCreateWorkspaceMemberRequest, DefaultApiUpdateWorkspaceMemberRequest, DefaultApiCreateIntegrationRequest, DefaultApiUpdateIntegrationRequest, DefaultApiListIntegrationsRequest, DefaultApiGetIntegrationRequest, DefaultApiGetIntegrationLogsRequest, DefaultApiGetIntegrationByNameRequest, DefaultApiDeleteIntegrationRequest, DefaultApiIntrospectRequest, DefaultApiCreateFileRequest, DefaultApiGetFileRequest, DefaultApiDownloadFileRequest, DefaultApiDeleteFileRequest, DefaultApiListFilesRequest } from '.';
|
|
4
4
|
export declare class ApiClient {
|
|
5
5
|
private _innerClient;
|
|
6
6
|
constructor(configuration?: Configuration, basePath?: string, axiosInstance?: AxiosInstance);
|
|
@@ -49,6 +49,10 @@ export declare class ApiClient {
|
|
|
49
49
|
changeWorkspacePlan: ({ id, ...changeWorkspacePlanBody }: ChangeWorkspacePlanProps) => Promise<import("./api").ChangeWorkspacePlanResponse>;
|
|
50
50
|
deleteWorkspace: (props: DeleteWorkspaceProps) => Promise<object>;
|
|
51
51
|
getAuditRecords: (props: GetAuditRecordsProps) => Promise<import("./api").GetAuditRecordsResponse>;
|
|
52
|
+
listWorkspaceMembers: (props: ListWorkspaceMembersProps) => Promise<import("./api").ListWorkspaceMembersResponse>;
|
|
53
|
+
deleteWorkspaceMember: (props: DeleteWorkspaceMemberProps) => Promise<object>;
|
|
54
|
+
createWorkspaceMember: (createWorkspaceMemberBody: CreateWorkspaceMemberProps) => Promise<import("./api").CreateWorkspaceMemberResponse>;
|
|
55
|
+
updateWorkspaceMember: ({ id, ...updateWorkspaceMemberBody }: UpdateWorkspaceMemberProps) => Promise<import("./api").UpdateWorkspaceMemberResponse>;
|
|
52
56
|
createIntegration: (createIntegrationBody: CreateIntegrationProps) => Promise<import("./api").CreateIntegrationResponse>;
|
|
53
57
|
updateIntegration: ({ id, ...updateIntegrationBody }: UpdateIntegrationProps) => Promise<import("./api").UpdateIntegrationResponse>;
|
|
54
58
|
listIntegrations: (props: ListIntegrationsProps) => Promise<import("./api").ListIntegrationsResponse>;
|
|
@@ -56,10 +60,6 @@ export declare class ApiClient {
|
|
|
56
60
|
getIntegrationLogs: (props: GetIntegrationLogsProps) => Promise<import("./api").GetIntegrationLogsResponse>;
|
|
57
61
|
getIntegrationByName: (props: GetIntegrationByNameProps) => Promise<import("./api").GetIntegrationByNameResponse>;
|
|
58
62
|
deleteIntegration: (props: DeleteIntegrationProps) => Promise<object>;
|
|
59
|
-
listWorkspaceMembers: (props: ListWorkspaceMembersProps) => Promise<import("./api").ListWorkspaceMembersResponse>;
|
|
60
|
-
deleteWorkspaceMember: (props: DeleteWorkspaceMemberProps) => Promise<object>;
|
|
61
|
-
createWorkspaceMember: (createWorkspaceMemberBody: CreateWorkspaceMemberProps) => Promise<import("./api").CreateWorkspaceMemberResponse>;
|
|
62
|
-
updateWorkspaceMember: ({ id, ...updateWorkspaceMemberBody }: UpdateWorkspaceMemberProps) => Promise<import("./api").UpdateWorkspaceMemberResponse>;
|
|
63
63
|
introspect: (introspectBody: IntrospectProps) => Promise<import("./api").IntrospectResponse>;
|
|
64
64
|
createFile: (createFileBody: CreateFileProps) => Promise<import("./api").CreateFileResponse>;
|
|
65
65
|
getFile: (props: GetFileProps) => Promise<import("./api").GetFileResponse>;
|
|
@@ -112,6 +112,10 @@ export type ListWorkspacesProps = Merge<DefaultApiListWorkspacesRequest, {}>;
|
|
|
112
112
|
export type ChangeWorkspacePlanProps = Merge<Except<DefaultApiChangeWorkspacePlanRequest, 'changeWorkspacePlanBody'>, NonNullable<DefaultApiChangeWorkspacePlanRequest['changeWorkspacePlanBody']>>;
|
|
113
113
|
export type DeleteWorkspaceProps = Merge<DefaultApiDeleteWorkspaceRequest, {}>;
|
|
114
114
|
export type GetAuditRecordsProps = Merge<DefaultApiGetAuditRecordsRequest, {}>;
|
|
115
|
+
export type ListWorkspaceMembersProps = Merge<DefaultApiListWorkspaceMembersRequest, {}>;
|
|
116
|
+
export type DeleteWorkspaceMemberProps = Merge<DefaultApiDeleteWorkspaceMemberRequest, {}>;
|
|
117
|
+
export type CreateWorkspaceMemberProps = Merge<Except<DefaultApiCreateWorkspaceMemberRequest, 'createWorkspaceMemberBody'>, NonNullable<DefaultApiCreateWorkspaceMemberRequest['createWorkspaceMemberBody']>>;
|
|
118
|
+
export type UpdateWorkspaceMemberProps = Merge<Except<DefaultApiUpdateWorkspaceMemberRequest, 'updateWorkspaceMemberBody'>, NonNullable<DefaultApiUpdateWorkspaceMemberRequest['updateWorkspaceMemberBody']>>;
|
|
115
119
|
export type CreateIntegrationProps = Merge<Except<DefaultApiCreateIntegrationRequest, 'createIntegrationBody'>, NonNullable<DefaultApiCreateIntegrationRequest['createIntegrationBody']>>;
|
|
116
120
|
export type UpdateIntegrationProps = Merge<Except<DefaultApiUpdateIntegrationRequest, 'updateIntegrationBody'>, NonNullable<DefaultApiUpdateIntegrationRequest['updateIntegrationBody']>>;
|
|
117
121
|
export type ListIntegrationsProps = Merge<DefaultApiListIntegrationsRequest, {}>;
|
|
@@ -119,10 +123,6 @@ export type GetIntegrationProps = Merge<DefaultApiGetIntegrationRequest, {}>;
|
|
|
119
123
|
export type GetIntegrationLogsProps = Merge<DefaultApiGetIntegrationLogsRequest, {}>;
|
|
120
124
|
export type GetIntegrationByNameProps = Merge<DefaultApiGetIntegrationByNameRequest, {}>;
|
|
121
125
|
export type DeleteIntegrationProps = Merge<DefaultApiDeleteIntegrationRequest, {}>;
|
|
122
|
-
export type ListWorkspaceMembersProps = Merge<DefaultApiListWorkspaceMembersRequest, {}>;
|
|
123
|
-
export type DeleteWorkspaceMemberProps = Merge<DefaultApiDeleteWorkspaceMemberRequest, {}>;
|
|
124
|
-
export type CreateWorkspaceMemberProps = Merge<Except<DefaultApiCreateWorkspaceMemberRequest, 'createWorkspaceMemberBody'>, NonNullable<DefaultApiCreateWorkspaceMemberRequest['createWorkspaceMemberBody']>>;
|
|
125
|
-
export type UpdateWorkspaceMemberProps = Merge<Except<DefaultApiUpdateWorkspaceMemberRequest, 'updateWorkspaceMemberBody'>, NonNullable<DefaultApiUpdateWorkspaceMemberRequest['updateWorkspaceMemberBody']>>;
|
|
126
126
|
export type IntrospectProps = Merge<Except<DefaultApiIntrospectRequest, 'introspectBody'>, NonNullable<DefaultApiIntrospectRequest['introspectBody']>>;
|
|
127
127
|
export type CreateFileProps = Merge<Except<DefaultApiCreateFileRequest, 'createFileBody'>, NonNullable<DefaultApiCreateFileRequest['createFileBody']>>;
|
|
128
128
|
export type GetFileProps = Merge<DefaultApiGetFileRequest, {}>;
|
package/dist/gen/common.d.ts
CHANGED
package/dist/gen/errors.d.ts
CHANGED
|
@@ -23,13 +23,16 @@ declare abstract class BaseApiError<Code extends ErrorCode, Type extends string,
|
|
|
23
23
|
readonly type: Type;
|
|
24
24
|
readonly message: string;
|
|
25
25
|
readonly error?: Error | undefined;
|
|
26
|
+
readonly id?: string | undefined;
|
|
26
27
|
readonly isApiError = true;
|
|
27
|
-
constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined);
|
|
28
|
+
constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined, id?: string | undefined);
|
|
28
29
|
toJSON(): {
|
|
30
|
+
id: string | undefined;
|
|
29
31
|
code: Code;
|
|
30
32
|
type: Type;
|
|
31
33
|
message: string;
|
|
32
34
|
};
|
|
35
|
+
static generateId(): string;
|
|
33
36
|
}
|
|
34
37
|
export declare const isApiError: (thrown: unknown) => thrown is ApiError;
|
|
35
38
|
type UnknownType = 'Unknown';
|
|
@@ -37,133 +40,133 @@ type UnknownType = 'Unknown';
|
|
|
37
40
|
* An unknown error occurred
|
|
38
41
|
*/
|
|
39
42
|
export declare class UnknownError extends BaseApiError<500, UnknownType, 'An unknown error occurred'> {
|
|
40
|
-
constructor(message: string, error?: Error);
|
|
43
|
+
constructor(message: string, error?: Error, id?: string);
|
|
41
44
|
}
|
|
42
45
|
type InternalType = 'Internal';
|
|
43
46
|
/**
|
|
44
47
|
* An internal error occurred
|
|
45
48
|
*/
|
|
46
49
|
export declare class InternalError extends BaseApiError<500, InternalType, 'An internal error occurred'> {
|
|
47
|
-
constructor(message: string, error?: Error);
|
|
50
|
+
constructor(message: string, error?: Error, id?: string);
|
|
48
51
|
}
|
|
49
52
|
type UnauthorizedType = 'Unauthorized';
|
|
50
53
|
/**
|
|
51
54
|
* The request requires to be authenticated.
|
|
52
55
|
*/
|
|
53
56
|
export declare class UnauthorizedError extends BaseApiError<401, UnauthorizedType, 'The request requires to be authenticated.'> {
|
|
54
|
-
constructor(message: string, error?: Error);
|
|
57
|
+
constructor(message: string, error?: Error, id?: string);
|
|
55
58
|
}
|
|
56
59
|
type ForbiddenType = 'Forbidden';
|
|
57
60
|
/**
|
|
58
61
|
* The requested action can\'t be peform by this resource.
|
|
59
62
|
*/
|
|
60
63
|
export declare class ForbiddenError extends BaseApiError<403, ForbiddenType, 'The requested action can\'t be peform by this resource.'> {
|
|
61
|
-
constructor(message: string, error?: Error);
|
|
64
|
+
constructor(message: string, error?: Error, id?: string);
|
|
62
65
|
}
|
|
63
66
|
type PayloadTooLargeType = 'PayloadTooLarge';
|
|
64
67
|
/**
|
|
65
68
|
* The request payload is too large.
|
|
66
69
|
*/
|
|
67
70
|
export declare class PayloadTooLargeError extends BaseApiError<413, PayloadTooLargeType, 'The request payload is too large.'> {
|
|
68
|
-
constructor(message: string, error?: Error);
|
|
71
|
+
constructor(message: string, error?: Error, id?: string);
|
|
69
72
|
}
|
|
70
73
|
type InvalidPayloadType = 'InvalidPayload';
|
|
71
74
|
/**
|
|
72
75
|
* The request payload is invalid.
|
|
73
76
|
*/
|
|
74
77
|
export declare class InvalidPayloadError extends BaseApiError<400, InvalidPayloadType, 'The request payload is invalid.'> {
|
|
75
|
-
constructor(message: string, error?: Error);
|
|
78
|
+
constructor(message: string, error?: Error, id?: string);
|
|
76
79
|
}
|
|
77
80
|
type UnsupportedMediaTypeType = 'UnsupportedMediaType';
|
|
78
81
|
/**
|
|
79
82
|
* The request is invalid because the content-type is not supported.
|
|
80
83
|
*/
|
|
81
84
|
export declare class UnsupportedMediaTypeError extends BaseApiError<415, UnsupportedMediaTypeType, 'The request is invalid because the content-type is not supported.'> {
|
|
82
|
-
constructor(message: string, error?: Error);
|
|
85
|
+
constructor(message: string, error?: Error, id?: string);
|
|
83
86
|
}
|
|
84
87
|
type MethodNotFoundType = 'MethodNotFound';
|
|
85
88
|
/**
|
|
86
89
|
* The requested method does not exist.
|
|
87
90
|
*/
|
|
88
91
|
export declare class MethodNotFoundError extends BaseApiError<405, MethodNotFoundType, 'The requested method does not exist.'> {
|
|
89
|
-
constructor(message: string, error?: Error);
|
|
92
|
+
constructor(message: string, error?: Error, id?: string);
|
|
90
93
|
}
|
|
91
94
|
type ResourceNotFoundType = 'ResourceNotFound';
|
|
92
95
|
/**
|
|
93
96
|
* The requested resource does not exist.
|
|
94
97
|
*/
|
|
95
98
|
export declare class ResourceNotFoundError extends BaseApiError<404, ResourceNotFoundType, 'The requested resource does not exist.'> {
|
|
96
|
-
constructor(message: string, error?: Error);
|
|
99
|
+
constructor(message: string, error?: Error, id?: string);
|
|
97
100
|
}
|
|
98
101
|
type InvalidJsonSchemaType = 'InvalidJsonSchema';
|
|
99
102
|
/**
|
|
100
103
|
* The provided JSON schema is invalid.
|
|
101
104
|
*/
|
|
102
105
|
export declare class InvalidJsonSchemaError extends BaseApiError<400, InvalidJsonSchemaType, 'The provided JSON schema is invalid.'> {
|
|
103
|
-
constructor(message: string, error?: Error);
|
|
106
|
+
constructor(message: string, error?: Error, id?: string);
|
|
104
107
|
}
|
|
105
108
|
type InvalidDataFormatType = 'InvalidDataFormat';
|
|
106
109
|
/**
|
|
107
110
|
* The provided data doesn\'t respect the provided JSON schema.
|
|
108
111
|
*/
|
|
109
112
|
export declare class InvalidDataFormatError extends BaseApiError<400, InvalidDataFormatType, 'The provided data doesn\'t respect the provided JSON schema.'> {
|
|
110
|
-
constructor(message: string, error?: Error);
|
|
113
|
+
constructor(message: string, error?: Error, id?: string);
|
|
111
114
|
}
|
|
112
115
|
type InvalidIdentifierType = 'InvalidIdentifier';
|
|
113
116
|
/**
|
|
114
117
|
* 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.
|
|
115
118
|
*/
|
|
116
119
|
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.'> {
|
|
117
|
-
constructor(message: string, error?: Error);
|
|
120
|
+
constructor(message: string, error?: Error, id?: string);
|
|
118
121
|
}
|
|
119
122
|
type RelationConflictType = 'RelationConflict';
|
|
120
123
|
/**
|
|
121
124
|
* The resource is not related with another resource. This is usually caused when providing two resources that aren\'t linked together.
|
|
122
125
|
*/
|
|
123
126
|
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.'> {
|
|
124
|
-
constructor(message: string, error?: Error);
|
|
127
|
+
constructor(message: string, error?: Error, id?: string);
|
|
125
128
|
}
|
|
126
129
|
type ReferenceNotFoundType = 'ReferenceNotFound';
|
|
127
130
|
/**
|
|
128
131
|
* The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.
|
|
129
132
|
*/
|
|
130
133
|
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.'> {
|
|
131
|
-
constructor(message: string, error?: Error);
|
|
134
|
+
constructor(message: string, error?: Error, id?: string);
|
|
132
135
|
}
|
|
133
136
|
type InvalidQueryType = 'InvalidQuery';
|
|
134
137
|
/**
|
|
135
138
|
* The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.
|
|
136
139
|
*/
|
|
137
140
|
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.'> {
|
|
138
|
-
constructor(message: string, error?: Error);
|
|
141
|
+
constructor(message: string, error?: Error, id?: string);
|
|
139
142
|
}
|
|
140
143
|
type RuntimeType = 'Runtime';
|
|
141
144
|
/**
|
|
142
145
|
* An error happened during the execution of a runtime (bot or integration).
|
|
143
146
|
*/
|
|
144
147
|
export declare class RuntimeError extends BaseApiError<400, RuntimeType, 'An error happened during the execution of a runtime (bot or integration).'> {
|
|
145
|
-
constructor(message: string, error?: Error);
|
|
148
|
+
constructor(message: string, error?: Error, id?: string);
|
|
146
149
|
}
|
|
147
150
|
type AlreadyExistsType = 'AlreadyExists';
|
|
148
151
|
/**
|
|
149
152
|
* The record attempted to be created already exists.
|
|
150
153
|
*/
|
|
151
154
|
export declare class AlreadyExistsError extends BaseApiError<409, AlreadyExistsType, 'The record attempted to be created already exists.'> {
|
|
152
|
-
constructor(message: string, error?: Error);
|
|
155
|
+
constructor(message: string, error?: Error, id?: string);
|
|
153
156
|
}
|
|
154
157
|
type RateLimitedType = 'RateLimited';
|
|
155
158
|
/**
|
|
156
159
|
* The request has been rate limited.
|
|
157
160
|
*/
|
|
158
161
|
export declare class RateLimitedError extends BaseApiError<429, RateLimitedType, 'The request has been rate limited.'> {
|
|
159
|
-
constructor(message: string, error?: Error);
|
|
162
|
+
constructor(message: string, error?: Error, id?: string);
|
|
160
163
|
}
|
|
161
164
|
type PaymentRequiredType = 'PaymentRequired';
|
|
162
165
|
/**
|
|
163
166
|
* A payment is required to perform this request.
|
|
164
167
|
*/
|
|
165
168
|
export declare class PaymentRequiredError extends BaseApiError<402, PaymentRequiredType, 'A payment is required to perform this request.'> {
|
|
166
|
-
constructor(message: string, error?: Error);
|
|
169
|
+
constructor(message: string, error?: Error, id?: string);
|
|
167
170
|
}
|
|
168
171
|
export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired';
|
|
169
172
|
export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError;
|
package/dist/gen/index.d.ts
CHANGED