@equos/node-sdk 3.0.2-rc.1 → 3.0.2-rc.10

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.
Files changed (117) hide show
  1. package/dist/index.d.ts +1 -3
  2. package/dist/index.js +1 -7
  3. package/package.json +3 -4
  4. package/dist/api/apis/AgentApi.d.ts +0 -86
  5. package/dist/api/apis/AgentApi.js +0 -223
  6. package/dist/api/apis/AvatarApi.d.ts +0 -86
  7. package/dist/api/apis/AvatarApi.js +0 -223
  8. package/dist/api/apis/BrainApi.d.ts +0 -64
  9. package/dist/api/apis/BrainApi.js +0 -179
  10. package/dist/api/apis/CharacterApi.d.ts +0 -76
  11. package/dist/api/apis/CharacterApi.js +0 -213
  12. package/dist/api/apis/FaceApi.d.ts +0 -64
  13. package/dist/api/apis/FaceApi.js +0 -179
  14. package/dist/api/apis/HealthApi.d.ts +0 -26
  15. package/dist/api/apis/HealthApi.js +0 -79
  16. package/dist/api/apis/KnowledgeBaseApi.d.ts +0 -100
  17. package/dist/api/apis/KnowledgeBaseApi.js +0 -279
  18. package/dist/api/apis/LimitsApi.d.ts +0 -26
  19. package/dist/api/apis/LimitsApi.js +0 -82
  20. package/dist/api/apis/SessionPassesApi.d.ts +0 -44
  21. package/dist/api/apis/SessionPassesApi.js +0 -128
  22. package/dist/api/apis/SessionsApi.d.ts +0 -72
  23. package/dist/api/apis/SessionsApi.js +0 -187
  24. package/dist/api/apis/VoiceApi.d.ts +0 -64
  25. package/dist/api/apis/VoiceApi.js +0 -179
  26. package/dist/api/apis/index.d.ts +0 -11
  27. package/dist/api/apis/index.js +0 -29
  28. package/dist/api/index.d.ts +0 -3
  29. package/dist/api/index.js +0 -21
  30. package/dist/api/models/CreateDocumentRequest.d.ts +0 -44
  31. package/dist/api/models/CreateDocumentRequest.js +0 -58
  32. package/dist/api/models/CreateDocumentResponse.d.ts +0 -33
  33. package/dist/api/models/CreateDocumentResponse.js +0 -51
  34. package/dist/api/models/CreateEquosAgentRequest.d.ts +0 -144
  35. package/dist/api/models/CreateEquosAgentRequest.js +0 -120
  36. package/dist/api/models/CreateEquosAvatarRequest.d.ts +0 -56
  37. package/dist/api/models/CreateEquosAvatarRequest.js +0 -64
  38. package/dist/api/models/CreateEquosBrainRequest.d.ts +0 -56
  39. package/dist/api/models/CreateEquosBrainRequest.js +0 -64
  40. package/dist/api/models/CreateEquosCharacterRequest.d.ts +0 -80
  41. package/dist/api/models/CreateEquosCharacterRequest.js +0 -68
  42. package/dist/api/models/CreateEquosFaceRequest.d.ts +0 -46
  43. package/dist/api/models/CreateEquosFaceRequest.js +0 -60
  44. package/dist/api/models/CreateEquosSessionRequest.d.ts +0 -90
  45. package/dist/api/models/CreateEquosSessionRequest.js +0 -74
  46. package/dist/api/models/CreateEquosSessionRequestAgent.d.ts +0 -23
  47. package/dist/api/models/CreateEquosSessionRequestAgent.js +0 -57
  48. package/dist/api/models/CreateEquosSessionRequestAvatar.d.ts +0 -23
  49. package/dist/api/models/CreateEquosSessionRequestAvatar.js +0 -57
  50. package/dist/api/models/CreateEquosSessionResponse.d.ts +0 -45
  51. package/dist/api/models/CreateEquosSessionResponse.js +0 -55
  52. package/dist/api/models/CreateEquosVoiceRequest.d.ts +0 -56
  53. package/dist/api/models/CreateEquosVoiceRequest.js +0 -64
  54. package/dist/api/models/CreateKnowledgeBaseRequest.d.ts +0 -44
  55. package/dist/api/models/CreateKnowledgeBaseRequest.js +0 -56
  56. package/dist/api/models/CreateSessionPassRequest.d.ts +0 -76
  57. package/dist/api/models/CreateSessionPassRequest.js +0 -72
  58. package/dist/api/models/EquosAgent.d.ts +0 -180
  59. package/dist/api/models/EquosAgent.js +0 -154
  60. package/dist/api/models/EquosAvatar.d.ts +0 -92
  61. package/dist/api/models/EquosAvatar.js +0 -84
  62. package/dist/api/models/EquosBrain.d.ts +0 -74
  63. package/dist/api/models/EquosBrain.js +0 -76
  64. package/dist/api/models/EquosCharacter.d.ts +0 -132
  65. package/dist/api/models/EquosCharacter.js +0 -98
  66. package/dist/api/models/EquosDocument.d.ts +0 -74
  67. package/dist/api/models/EquosDocument.js +0 -78
  68. package/dist/api/models/EquosFace.d.ts +0 -107
  69. package/dist/api/models/EquosFace.js +0 -89
  70. package/dist/api/models/EquosKnowledgeBase.d.ts +0 -75
  71. package/dist/api/models/EquosKnowledgeBase.js +0 -77
  72. package/dist/api/models/EquosLimitResponse.d.ts +0 -68
  73. package/dist/api/models/EquosLimitResponse.js +0 -72
  74. package/dist/api/models/EquosParticipantIdentity.d.ts +0 -38
  75. package/dist/api/models/EquosParticipantIdentity.js +0 -54
  76. package/dist/api/models/EquosResourceReference.d.ts +0 -32
  77. package/dist/api/models/EquosResourceReference.js +0 -50
  78. package/dist/api/models/EquosSession.d.ts +0 -168
  79. package/dist/api/models/EquosSession.js +0 -118
  80. package/dist/api/models/EquosSessionHost.d.ts +0 -38
  81. package/dist/api/models/EquosSessionHost.js +0 -54
  82. package/dist/api/models/EquosSessionServer.d.ts +0 -32
  83. package/dist/api/models/EquosSessionServer.js +0 -50
  84. package/dist/api/models/EquosVoice.d.ts +0 -80
  85. package/dist/api/models/EquosVoice.js +0 -80
  86. package/dist/api/models/HealthResponse.d.ts +0 -38
  87. package/dist/api/models/HealthResponse.js +0 -54
  88. package/dist/api/models/ListEquosAgentsResponse.d.ts +0 -51
  89. package/dist/api/models/ListEquosAgentsResponse.js +0 -63
  90. package/dist/api/models/ListEquosAvatarsResponse.d.ts +0 -51
  91. package/dist/api/models/ListEquosAvatarsResponse.js +0 -63
  92. package/dist/api/models/ListEquosBrainsResponse.d.ts +0 -51
  93. package/dist/api/models/ListEquosBrainsResponse.js +0 -63
  94. package/dist/api/models/ListEquosCharactersResponse.d.ts +0 -51
  95. package/dist/api/models/ListEquosCharactersResponse.js +0 -63
  96. package/dist/api/models/ListEquosFacesResponse.d.ts +0 -51
  97. package/dist/api/models/ListEquosFacesResponse.js +0 -63
  98. package/dist/api/models/ListEquosKnowledgeBasesResponse.d.ts +0 -51
  99. package/dist/api/models/ListEquosKnowledgeBasesResponse.js +0 -63
  100. package/dist/api/models/ListEquosSessionsResponse.d.ts +0 -51
  101. package/dist/api/models/ListEquosSessionsResponse.js +0 -63
  102. package/dist/api/models/ListEquosVoicesResponse.d.ts +0 -51
  103. package/dist/api/models/ListEquosVoicesResponse.js +0 -63
  104. package/dist/api/models/UpdateEquosAgentRequest.d.ts +0 -156
  105. package/dist/api/models/UpdateEquosAgentRequest.js +0 -128
  106. package/dist/api/models/UpdateEquosAvatarRequest.d.ts +0 -68
  107. package/dist/api/models/UpdateEquosAvatarRequest.js +0 -72
  108. package/dist/api/models/UpdateEquosCharacterRequest.d.ts +0 -68
  109. package/dist/api/models/UpdateEquosCharacterRequest.js +0 -60
  110. package/dist/api/models/index.d.ts +0 -40
  111. package/dist/api/models/index.js +0 -58
  112. package/dist/api/runtime.d.ts +0 -184
  113. package/dist/api/runtime.js +0 -349
  114. package/dist/client.d.ts +0 -38
  115. package/dist/client.js +0 -62
  116. package/dist/options.d.ts +0 -7
  117. package/dist/options.js +0 -2
@@ -1,72 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Equos.ai API
6
- * API documentation for Equos.ai live platform.
7
- *
8
- * The version of the OpenAPI document: 3.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfUpdateEquosAvatarRequest = instanceOfUpdateEquosAvatarRequest;
17
- exports.UpdateEquosAvatarRequestFromJSON = UpdateEquosAvatarRequestFromJSON;
18
- exports.UpdateEquosAvatarRequestFromJSONTyped = UpdateEquosAvatarRequestFromJSONTyped;
19
- exports.UpdateEquosAvatarRequestToJSON = UpdateEquosAvatarRequestToJSON;
20
- exports.UpdateEquosAvatarRequestToJSONTyped = UpdateEquosAvatarRequestToJSONTyped;
21
- /**
22
- * Check if a given object implements the UpdateEquosAvatarRequest interface.
23
- */
24
- function instanceOfUpdateEquosAvatarRequest(value) {
25
- if (!('identity' in value) || value['identity'] === undefined)
26
- return false;
27
- if (!('name' in value) || value['name'] === undefined)
28
- return false;
29
- if (!('refImage' in value) || value['refImage'] === undefined)
30
- return false;
31
- if (!('agentId' in value) || value['agentId'] === undefined)
32
- return false;
33
- if (!('id' in value) || value['id'] === undefined)
34
- return false;
35
- if (!('organizationId' in value) || value['organizationId'] === undefined)
36
- return false;
37
- return true;
38
- }
39
- function UpdateEquosAvatarRequestFromJSON(json) {
40
- return UpdateEquosAvatarRequestFromJSONTyped(json, false);
41
- }
42
- function UpdateEquosAvatarRequestFromJSONTyped(json, ignoreDiscriminator) {
43
- if (json == null) {
44
- return json;
45
- }
46
- return {
47
- 'identity': json['identity'],
48
- 'name': json['name'],
49
- 'refImage': json['refImage'],
50
- 'agentId': json['agentId'],
51
- 'client': json['client'] == null ? undefined : json['client'],
52
- 'id': json['id'],
53
- 'organizationId': json['organizationId'],
54
- };
55
- }
56
- function UpdateEquosAvatarRequestToJSON(json) {
57
- return UpdateEquosAvatarRequestToJSONTyped(json, false);
58
- }
59
- function UpdateEquosAvatarRequestToJSONTyped(value, ignoreDiscriminator = false) {
60
- if (value == null) {
61
- return value;
62
- }
63
- return {
64
- 'identity': value['identity'],
65
- 'name': value['name'],
66
- 'refImage': value['refImage'],
67
- 'agentId': value['agentId'],
68
- 'client': value['client'],
69
- 'id': value['id'],
70
- 'organizationId': value['organizationId'],
71
- };
72
- }
@@ -1,68 +0,0 @@
1
- /**
2
- * Equos.ai API
3
- * API documentation for Equos.ai live platform.
4
- *
5
- * The version of the OpenAPI document: 3.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface UpdateEquosCharacterRequest
16
- */
17
- export interface UpdateEquosCharacterRequest {
18
- /**
19
- *
20
- * @type {string}
21
- * @memberof UpdateEquosCharacterRequest
22
- */
23
- name?: string;
24
- /**
25
- *
26
- * @type {object}
27
- * @memberof UpdateEquosCharacterRequest
28
- */
29
- faceId?: object | null;
30
- /**
31
- *
32
- * @type {object}
33
- * @memberof UpdateEquosCharacterRequest
34
- */
35
- voiceId?: object | null;
36
- /**
37
- *
38
- * @type {object}
39
- * @memberof UpdateEquosCharacterRequest
40
- */
41
- brainId?: object | null;
42
- /**
43
- *
44
- * @type {object}
45
- * @memberof UpdateEquosCharacterRequest
46
- */
47
- knowledgeBaseId?: object | null;
48
- /**
49
- *
50
- * @type {boolean}
51
- * @memberof UpdateEquosCharacterRequest
52
- */
53
- search?: boolean;
54
- /**
55
- *
56
- * @type {object}
57
- * @memberof UpdateEquosCharacterRequest
58
- */
59
- elevenlabsAgentId?: object | null;
60
- }
61
- /**
62
- * Check if a given object implements the UpdateEquosCharacterRequest interface.
63
- */
64
- export declare function instanceOfUpdateEquosCharacterRequest(value: object): value is UpdateEquosCharacterRequest;
65
- export declare function UpdateEquosCharacterRequestFromJSON(json: any): UpdateEquosCharacterRequest;
66
- export declare function UpdateEquosCharacterRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateEquosCharacterRequest;
67
- export declare function UpdateEquosCharacterRequestToJSON(json: any): UpdateEquosCharacterRequest;
68
- export declare function UpdateEquosCharacterRequestToJSONTyped(value?: UpdateEquosCharacterRequest | null, ignoreDiscriminator?: boolean): any;
@@ -1,60 +0,0 @@
1
- "use strict";
2
- /* tslint:disable */
3
- /* eslint-disable */
4
- /**
5
- * Equos.ai API
6
- * API documentation for Equos.ai live platform.
7
- *
8
- * The version of the OpenAPI document: 3.0
9
- *
10
- *
11
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
- * https://openapi-generator.tech
13
- * Do not edit the class manually.
14
- */
15
- Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.instanceOfUpdateEquosCharacterRequest = instanceOfUpdateEquosCharacterRequest;
17
- exports.UpdateEquosCharacterRequestFromJSON = UpdateEquosCharacterRequestFromJSON;
18
- exports.UpdateEquosCharacterRequestFromJSONTyped = UpdateEquosCharacterRequestFromJSONTyped;
19
- exports.UpdateEquosCharacterRequestToJSON = UpdateEquosCharacterRequestToJSON;
20
- exports.UpdateEquosCharacterRequestToJSONTyped = UpdateEquosCharacterRequestToJSONTyped;
21
- /**
22
- * Check if a given object implements the UpdateEquosCharacterRequest interface.
23
- */
24
- function instanceOfUpdateEquosCharacterRequest(value) {
25
- return true;
26
- }
27
- function UpdateEquosCharacterRequestFromJSON(json) {
28
- return UpdateEquosCharacterRequestFromJSONTyped(json, false);
29
- }
30
- function UpdateEquosCharacterRequestFromJSONTyped(json, ignoreDiscriminator) {
31
- if (json == null) {
32
- return json;
33
- }
34
- return {
35
- 'name': json['name'] == null ? undefined : json['name'],
36
- 'faceId': json['faceId'] == null ? undefined : json['faceId'],
37
- 'voiceId': json['voiceId'] == null ? undefined : json['voiceId'],
38
- 'brainId': json['brainId'] == null ? undefined : json['brainId'],
39
- 'knowledgeBaseId': json['knowledgeBaseId'] == null ? undefined : json['knowledgeBaseId'],
40
- 'search': json['search'] == null ? undefined : json['search'],
41
- 'elevenlabsAgentId': json['elevenlabsAgentId'] == null ? undefined : json['elevenlabsAgentId'],
42
- };
43
- }
44
- function UpdateEquosCharacterRequestToJSON(json) {
45
- return UpdateEquosCharacterRequestToJSONTyped(json, false);
46
- }
47
- function UpdateEquosCharacterRequestToJSONTyped(value, ignoreDiscriminator = false) {
48
- if (value == null) {
49
- return value;
50
- }
51
- return {
52
- 'name': value['name'],
53
- 'faceId': value['faceId'],
54
- 'voiceId': value['voiceId'],
55
- 'brainId': value['brainId'],
56
- 'knowledgeBaseId': value['knowledgeBaseId'],
57
- 'search': value['search'],
58
- 'elevenlabsAgentId': value['elevenlabsAgentId'],
59
- };
60
- }
@@ -1,40 +0,0 @@
1
- export * from './CreateDocumentRequest';
2
- export * from './CreateDocumentResponse';
3
- export * from './CreateEquosAgentRequest';
4
- export * from './CreateEquosAvatarRequest';
5
- export * from './CreateEquosBrainRequest';
6
- export * from './CreateEquosCharacterRequest';
7
- export * from './CreateEquosFaceRequest';
8
- export * from './CreateEquosSessionRequest';
9
- export * from './CreateEquosSessionRequestAgent';
10
- export * from './CreateEquosSessionRequestAvatar';
11
- export * from './CreateEquosSessionResponse';
12
- export * from './CreateEquosVoiceRequest';
13
- export * from './CreateKnowledgeBaseRequest';
14
- export * from './CreateSessionPassRequest';
15
- export * from './EquosAgent';
16
- export * from './EquosAvatar';
17
- export * from './EquosBrain';
18
- export * from './EquosCharacter';
19
- export * from './EquosDocument';
20
- export * from './EquosFace';
21
- export * from './EquosKnowledgeBase';
22
- export * from './EquosLimitResponse';
23
- export * from './EquosParticipantIdentity';
24
- export * from './EquosResourceReference';
25
- export * from './EquosSession';
26
- export * from './EquosSessionHost';
27
- export * from './EquosSessionServer';
28
- export * from './EquosVoice';
29
- export * from './HealthResponse';
30
- export * from './ListEquosAgentsResponse';
31
- export * from './ListEquosAvatarsResponse';
32
- export * from './ListEquosBrainsResponse';
33
- export * from './ListEquosCharactersResponse';
34
- export * from './ListEquosFacesResponse';
35
- export * from './ListEquosKnowledgeBasesResponse';
36
- export * from './ListEquosSessionsResponse';
37
- export * from './ListEquosVoicesResponse';
38
- export * from './UpdateEquosAgentRequest';
39
- export * from './UpdateEquosAvatarRequest';
40
- export * from './UpdateEquosCharacterRequest';
@@ -1,58 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- /* tslint:disable */
18
- /* eslint-disable */
19
- __exportStar(require("./CreateDocumentRequest"), exports);
20
- __exportStar(require("./CreateDocumentResponse"), exports);
21
- __exportStar(require("./CreateEquosAgentRequest"), exports);
22
- __exportStar(require("./CreateEquosAvatarRequest"), exports);
23
- __exportStar(require("./CreateEquosBrainRequest"), exports);
24
- __exportStar(require("./CreateEquosCharacterRequest"), exports);
25
- __exportStar(require("./CreateEquosFaceRequest"), exports);
26
- __exportStar(require("./CreateEquosSessionRequest"), exports);
27
- __exportStar(require("./CreateEquosSessionRequestAgent"), exports);
28
- __exportStar(require("./CreateEquosSessionRequestAvatar"), exports);
29
- __exportStar(require("./CreateEquosSessionResponse"), exports);
30
- __exportStar(require("./CreateEquosVoiceRequest"), exports);
31
- __exportStar(require("./CreateKnowledgeBaseRequest"), exports);
32
- __exportStar(require("./CreateSessionPassRequest"), exports);
33
- __exportStar(require("./EquosAgent"), exports);
34
- __exportStar(require("./EquosAvatar"), exports);
35
- __exportStar(require("./EquosBrain"), exports);
36
- __exportStar(require("./EquosCharacter"), exports);
37
- __exportStar(require("./EquosDocument"), exports);
38
- __exportStar(require("./EquosFace"), exports);
39
- __exportStar(require("./EquosKnowledgeBase"), exports);
40
- __exportStar(require("./EquosLimitResponse"), exports);
41
- __exportStar(require("./EquosParticipantIdentity"), exports);
42
- __exportStar(require("./EquosResourceReference"), exports);
43
- __exportStar(require("./EquosSession"), exports);
44
- __exportStar(require("./EquosSessionHost"), exports);
45
- __exportStar(require("./EquosSessionServer"), exports);
46
- __exportStar(require("./EquosVoice"), exports);
47
- __exportStar(require("./HealthResponse"), exports);
48
- __exportStar(require("./ListEquosAgentsResponse"), exports);
49
- __exportStar(require("./ListEquosAvatarsResponse"), exports);
50
- __exportStar(require("./ListEquosBrainsResponse"), exports);
51
- __exportStar(require("./ListEquosCharactersResponse"), exports);
52
- __exportStar(require("./ListEquosFacesResponse"), exports);
53
- __exportStar(require("./ListEquosKnowledgeBasesResponse"), exports);
54
- __exportStar(require("./ListEquosSessionsResponse"), exports);
55
- __exportStar(require("./ListEquosVoicesResponse"), exports);
56
- __exportStar(require("./UpdateEquosAgentRequest"), exports);
57
- __exportStar(require("./UpdateEquosAvatarRequest"), exports);
58
- __exportStar(require("./UpdateEquosCharacterRequest"), exports);
@@ -1,184 +0,0 @@
1
- /**
2
- * Equos.ai API
3
- * API documentation for Equos.ai live platform.
4
- *
5
- * The version of the OpenAPI document: 3.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- export declare const BASE_PATH: string;
13
- export interface ConfigurationParameters {
14
- basePath?: string;
15
- fetchApi?: FetchAPI;
16
- middleware?: Middleware[];
17
- queryParamsStringify?: (params: HTTPQuery) => string;
18
- username?: string;
19
- password?: string;
20
- apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
21
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
22
- headers?: HTTPHeaders;
23
- credentials?: RequestCredentials;
24
- }
25
- export declare class Configuration {
26
- private configuration;
27
- constructor(configuration?: ConfigurationParameters);
28
- set config(configuration: Configuration);
29
- get basePath(): string;
30
- get fetchApi(): FetchAPI | undefined;
31
- get middleware(): Middleware[];
32
- get queryParamsStringify(): (params: HTTPQuery) => string;
33
- get username(): string | undefined;
34
- get password(): string | undefined;
35
- get apiKey(): ((name: string) => string | Promise<string>) | undefined;
36
- get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
37
- get headers(): HTTPHeaders | undefined;
38
- get credentials(): RequestCredentials | undefined;
39
- }
40
- export declare const DefaultConfig: Configuration;
41
- /**
42
- * This is the base class for all generated API classes.
43
- */
44
- export declare class BaseAPI {
45
- protected configuration: Configuration;
46
- private static readonly jsonRegex;
47
- private middleware;
48
- constructor(configuration?: Configuration);
49
- withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
50
- withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
51
- withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
52
- /**
53
- * Check if the given MIME is a JSON MIME.
54
- * JSON MIME examples:
55
- * application/json
56
- * application/json; charset=UTF8
57
- * APPLICATION/JSON
58
- * application/vnd.company+json
59
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
60
- * @return True if the given MIME is JSON, false otherwise.
61
- */
62
- protected isJsonMime(mime: string | null | undefined): boolean;
63
- protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
64
- private createFetchParams;
65
- private fetchApi;
66
- /**
67
- * Create a shallow clone of `this` by constructing a new instance
68
- * and then shallow cloning data members.
69
- */
70
- private clone;
71
- }
72
- export declare class ResponseError extends Error {
73
- response: Response;
74
- name: "ResponseError";
75
- constructor(response: Response, msg?: string);
76
- }
77
- export declare class FetchError extends Error {
78
- cause: Error;
79
- name: "FetchError";
80
- constructor(cause: Error, msg?: string);
81
- }
82
- export declare class RequiredError extends Error {
83
- field: string;
84
- name: "RequiredError";
85
- constructor(field: string, msg?: string);
86
- }
87
- export declare const COLLECTION_FORMATS: {
88
- csv: string;
89
- ssv: string;
90
- tsv: string;
91
- pipes: string;
92
- };
93
- export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
94
- export type Json = any;
95
- export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
96
- export type HTTPHeaders = {
97
- [key: string]: string;
98
- };
99
- export type HTTPQuery = {
100
- [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
101
- };
102
- export type HTTPBody = Json | FormData | URLSearchParams;
103
- export type HTTPRequestInit = {
104
- headers?: HTTPHeaders;
105
- method: HTTPMethod;
106
- credentials?: RequestCredentials;
107
- body?: HTTPBody;
108
- };
109
- export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
110
- export type InitOverrideFunction = (requestContext: {
111
- init: HTTPRequestInit;
112
- context: RequestOpts;
113
- }) => Promise<RequestInit>;
114
- export interface FetchParams {
115
- url: string;
116
- init: RequestInit;
117
- }
118
- export interface RequestOpts {
119
- path: string;
120
- method: HTTPMethod;
121
- headers: HTTPHeaders;
122
- query?: HTTPQuery;
123
- body?: HTTPBody;
124
- }
125
- export declare function querystring(params: HTTPQuery, prefix?: string): string;
126
- export declare function exists(json: any, key: string): boolean;
127
- export declare function mapValues(data: any, fn: (item: any) => any): {
128
- [key: string]: any;
129
- };
130
- export declare function canConsumeForm(consumes: Consume[]): boolean;
131
- export interface Consume {
132
- contentType: string;
133
- }
134
- export interface RequestContext {
135
- fetch: FetchAPI;
136
- url: string;
137
- init: RequestInit;
138
- }
139
- export interface ResponseContext {
140
- fetch: FetchAPI;
141
- url: string;
142
- init: RequestInit;
143
- response: Response;
144
- }
145
- export interface ErrorContext {
146
- fetch: FetchAPI;
147
- url: string;
148
- init: RequestInit;
149
- error: unknown;
150
- response?: Response;
151
- }
152
- export interface Middleware {
153
- pre?(context: RequestContext): Promise<FetchParams | void>;
154
- post?(context: ResponseContext): Promise<Response | void>;
155
- onError?(context: ErrorContext): Promise<Response | void>;
156
- }
157
- export interface ApiResponse<T> {
158
- raw: Response;
159
- value(): Promise<T>;
160
- }
161
- export interface ResponseTransformer<T> {
162
- (json: any): T;
163
- }
164
- export declare class JSONApiResponse<T> {
165
- raw: Response;
166
- private transformer;
167
- constructor(raw: Response, transformer?: ResponseTransformer<T>);
168
- value(): Promise<T>;
169
- }
170
- export declare class VoidApiResponse {
171
- raw: Response;
172
- constructor(raw: Response);
173
- value(): Promise<void>;
174
- }
175
- export declare class BlobApiResponse {
176
- raw: Response;
177
- constructor(raw: Response);
178
- value(): Promise<Blob>;
179
- }
180
- export declare class TextApiResponse {
181
- raw: Response;
182
- constructor(raw: Response);
183
- value(): Promise<string>;
184
- }