@crestal/nation-sdk 0.7.2 → 0.7.3
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/.openapi-generator/FILES +1 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +4 -2
- package/api.ts +94 -2117
- package/base.ts +1 -25
- package/common.ts +1 -38
- package/configuration.ts +1 -18
- package/dist/api.d.ts +46 -2116
- package/dist/api.js +97 -130
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -38
- package/dist/common.js +1 -38
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Agent.md +2 -2
- package/docs/AgentResponse.md +2 -2
- package/docs/FileUploadResponse.md +23 -0
- package/docs/LLMModelInfoWithProviderName.md +2 -2
- package/docs/UserApi.md +53 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Nation IntentKit API
|
|
3
3
|
* API for Nation IntentKit services
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.7.
|
|
5
|
+
* The version of the OpenAPI document: 0.7.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,42 +12,22 @@
|
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const COLLECTION_FORMATS: {
|
|
20
16
|
csv: string;
|
|
21
17
|
ssv: string;
|
|
22
18
|
tsv: string;
|
|
23
19
|
pipes: string;
|
|
24
20
|
};
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @export
|
|
28
|
-
* @interface RequestArgs
|
|
29
|
-
*/
|
|
30
21
|
export interface RequestArgs {
|
|
31
22
|
url: string;
|
|
32
23
|
options: RawAxiosRequestConfig;
|
|
33
24
|
}
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @export
|
|
37
|
-
* @class BaseAPI
|
|
38
|
-
*/
|
|
39
25
|
export declare class BaseAPI {
|
|
40
26
|
protected basePath: string;
|
|
41
27
|
protected axios: AxiosInstance;
|
|
42
28
|
protected configuration: Configuration | undefined;
|
|
43
29
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
30
|
}
|
|
45
|
-
/**
|
|
46
|
-
*
|
|
47
|
-
* @export
|
|
48
|
-
* @class RequiredError
|
|
49
|
-
* @extends {Error}
|
|
50
|
-
*/
|
|
51
31
|
export declare class RequiredError extends Error {
|
|
52
32
|
field: string;
|
|
53
33
|
constructor(field: string, msg?: string);
|
|
@@ -58,9 +38,5 @@ interface ServerMap {
|
|
|
58
38
|
description: string;
|
|
59
39
|
}[];
|
|
60
40
|
}
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
41
|
export declare const operationServerMap: ServerMap;
|
|
66
42
|
export {};
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Nation IntentKit API
|
|
6
6
|
* API for Nation IntentKit services
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.7.
|
|
8
|
+
* The version of the OpenAPI document: 0.7.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -31,21 +31,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
31
31
|
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
32
32
|
var axios_1 = require("axios");
|
|
33
33
|
exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @export
|
|
37
|
-
*/
|
|
38
34
|
exports.COLLECTION_FORMATS = {
|
|
39
35
|
csv: ",",
|
|
40
36
|
ssv: " ",
|
|
41
37
|
tsv: "\t",
|
|
42
38
|
pipes: "|",
|
|
43
39
|
};
|
|
44
|
-
/**
|
|
45
|
-
*
|
|
46
|
-
* @export
|
|
47
|
-
* @class BaseAPI
|
|
48
|
-
*/
|
|
49
40
|
var BaseAPI = /** @class */ (function () {
|
|
50
41
|
function BaseAPI(configuration, basePath, axios) {
|
|
51
42
|
if (basePath === void 0) { basePath = exports.BASE_PATH; }
|
|
@@ -62,12 +53,6 @@ var BaseAPI = /** @class */ (function () {
|
|
|
62
53
|
}());
|
|
63
54
|
exports.BaseAPI = BaseAPI;
|
|
64
55
|
;
|
|
65
|
-
/**
|
|
66
|
-
*
|
|
67
|
-
* @export
|
|
68
|
-
* @class RequiredError
|
|
69
|
-
* @extends {Error}
|
|
70
|
-
*/
|
|
71
56
|
var RequiredError = /** @class */ (function (_super) {
|
|
72
57
|
__extends(RequiredError, _super);
|
|
73
58
|
function RequiredError(field, msg) {
|
|
@@ -79,8 +64,4 @@ var RequiredError = /** @class */ (function (_super) {
|
|
|
79
64
|
return RequiredError;
|
|
80
65
|
}(Error));
|
|
81
66
|
exports.RequiredError = RequiredError;
|
|
82
|
-
/**
|
|
83
|
-
*
|
|
84
|
-
* @export
|
|
85
|
-
*/
|
|
86
67
|
exports.operationServerMap = {};
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Nation IntentKit API
|
|
3
3
|
* API for Nation IntentKit services
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.7.
|
|
5
|
+
* The version of the OpenAPI document: 0.7.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,54 +12,17 @@
|
|
|
12
12
|
import type { Configuration } from "./configuration";
|
|
13
13
|
import type { RequestArgs } from "./base";
|
|
14
14
|
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
16
|
/**
|
|
21
17
|
*
|
|
22
18
|
* @throws {RequiredError}
|
|
23
|
-
* @export
|
|
24
19
|
*/
|
|
25
20
|
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
*/
|
|
30
21
|
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
*/
|
|
35
22
|
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @export
|
|
39
|
-
*/
|
|
40
23
|
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @export
|
|
44
|
-
*/
|
|
45
24
|
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
*
|
|
48
|
-
* @export
|
|
49
|
-
*/
|
|
50
25
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
-
/**
|
|
52
|
-
*
|
|
53
|
-
* @export
|
|
54
|
-
*/
|
|
55
26
|
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
-
/**
|
|
57
|
-
*
|
|
58
|
-
* @export
|
|
59
|
-
*/
|
|
60
27
|
export declare const toPathString: (url: URL) => string;
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
28
|
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Nation IntentKit API
|
|
6
6
|
* API for Nation IntentKit services
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.7.
|
|
8
|
+
* The version of the OpenAPI document: 0.7.3
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,15 +62,10 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
62
62
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
63
63
|
exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
|
|
64
64
|
var base_1 = require("./base");
|
|
65
|
-
/**
|
|
66
|
-
*
|
|
67
|
-
* @export
|
|
68
|
-
*/
|
|
69
65
|
exports.DUMMY_BASE_URL = 'https://example.com';
|
|
70
66
|
/**
|
|
71
67
|
*
|
|
72
68
|
* @throws {RequiredError}
|
|
73
|
-
* @export
|
|
74
69
|
*/
|
|
75
70
|
var assertParamExists = function (functionName, paramName, paramValue) {
|
|
76
71
|
if (paramValue === null || paramValue === undefined) {
|
|
@@ -78,10 +73,6 @@ var assertParamExists = function (functionName, paramName, paramValue) {
|
|
|
78
73
|
}
|
|
79
74
|
};
|
|
80
75
|
exports.assertParamExists = assertParamExists;
|
|
81
|
-
/**
|
|
82
|
-
*
|
|
83
|
-
* @export
|
|
84
|
-
*/
|
|
85
76
|
var setApiKeyToObject = function (object, keyParamName, configuration) {
|
|
86
77
|
return __awaiter(this, void 0, void 0, function () {
|
|
87
78
|
var localVarApiKeyValue, _a;
|
|
@@ -108,20 +99,12 @@ var setApiKeyToObject = function (object, keyParamName, configuration) {
|
|
|
108
99
|
});
|
|
109
100
|
};
|
|
110
101
|
exports.setApiKeyToObject = setApiKeyToObject;
|
|
111
|
-
/**
|
|
112
|
-
*
|
|
113
|
-
* @export
|
|
114
|
-
*/
|
|
115
102
|
var setBasicAuthToObject = function (object, configuration) {
|
|
116
103
|
if (configuration && (configuration.username || configuration.password)) {
|
|
117
104
|
object["auth"] = { username: configuration.username, password: configuration.password };
|
|
118
105
|
}
|
|
119
106
|
};
|
|
120
107
|
exports.setBasicAuthToObject = setBasicAuthToObject;
|
|
121
|
-
/**
|
|
122
|
-
*
|
|
123
|
-
* @export
|
|
124
|
-
*/
|
|
125
108
|
var setBearerAuthToObject = function (object, configuration) {
|
|
126
109
|
return __awaiter(this, void 0, void 0, function () {
|
|
127
110
|
var accessToken, _a;
|
|
@@ -148,10 +131,6 @@ var setBearerAuthToObject = function (object, configuration) {
|
|
|
148
131
|
});
|
|
149
132
|
};
|
|
150
133
|
exports.setBearerAuthToObject = setBearerAuthToObject;
|
|
151
|
-
/**
|
|
152
|
-
*
|
|
153
|
-
* @export
|
|
154
|
-
*/
|
|
155
134
|
var setOAuthToObject = function (object, name, scopes, configuration) {
|
|
156
135
|
return __awaiter(this, void 0, void 0, function () {
|
|
157
136
|
var localVarAccessTokenValue, _a;
|
|
@@ -201,10 +180,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
|
|
|
201
180
|
}
|
|
202
181
|
}
|
|
203
182
|
}
|
|
204
|
-
/**
|
|
205
|
-
*
|
|
206
|
-
* @export
|
|
207
|
-
*/
|
|
208
183
|
var setSearchParams = function (url) {
|
|
209
184
|
var objects = [];
|
|
210
185
|
for (var _i = 1; _i < arguments.length; _i++) {
|
|
@@ -215,10 +190,6 @@ var setSearchParams = function (url) {
|
|
|
215
190
|
url.search = searchParams.toString();
|
|
216
191
|
};
|
|
217
192
|
exports.setSearchParams = setSearchParams;
|
|
218
|
-
/**
|
|
219
|
-
*
|
|
220
|
-
* @export
|
|
221
|
-
*/
|
|
222
193
|
var serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
223
194
|
var nonString = typeof value !== 'string';
|
|
224
195
|
var needsSerialization = nonString && configuration && configuration.isJsonMime
|
|
@@ -229,18 +200,10 @@ var serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
|
229
200
|
: (value || "");
|
|
230
201
|
};
|
|
231
202
|
exports.serializeDataIfNeeded = serializeDataIfNeeded;
|
|
232
|
-
/**
|
|
233
|
-
*
|
|
234
|
-
* @export
|
|
235
|
-
*/
|
|
236
203
|
var toPathString = function (url) {
|
|
237
204
|
return url.pathname + url.search + url.hash;
|
|
238
205
|
};
|
|
239
206
|
exports.toPathString = toPathString;
|
|
240
|
-
/**
|
|
241
|
-
*
|
|
242
|
-
* @export
|
|
243
|
-
*/
|
|
244
207
|
var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
245
208
|
return function (axios, basePath) {
|
|
246
209
|
var _a;
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Nation IntentKit API
|
|
3
3
|
* API for Nation IntentKit services
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.7.
|
|
5
|
+
* The version of the OpenAPI document: 0.7.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -23,49 +23,32 @@ export declare class Configuration {
|
|
|
23
23
|
/**
|
|
24
24
|
* parameter for apiKey security
|
|
25
25
|
* @param name security name
|
|
26
|
-
* @memberof Configuration
|
|
27
26
|
*/
|
|
28
27
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
28
|
/**
|
|
30
29
|
* parameter for basic security
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Configuration
|
|
34
30
|
*/
|
|
35
31
|
username?: string;
|
|
36
32
|
/**
|
|
37
33
|
* parameter for basic security
|
|
38
|
-
*
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof Configuration
|
|
41
34
|
*/
|
|
42
35
|
password?: string;
|
|
43
36
|
/**
|
|
44
37
|
* parameter for oauth2 security
|
|
45
38
|
* @param name security name
|
|
46
39
|
* @param scopes oauth2 scope
|
|
47
|
-
* @memberof Configuration
|
|
48
40
|
*/
|
|
49
41
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
42
|
/**
|
|
51
43
|
* override base path
|
|
52
|
-
*
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof Configuration
|
|
55
44
|
*/
|
|
56
45
|
basePath?: string;
|
|
57
46
|
/**
|
|
58
47
|
* override server index
|
|
59
|
-
*
|
|
60
|
-
* @type {number}
|
|
61
|
-
* @memberof Configuration
|
|
62
48
|
*/
|
|
63
49
|
serverIndex?: number;
|
|
64
50
|
/**
|
|
65
51
|
* base options for axios calls
|
|
66
|
-
*
|
|
67
|
-
* @type {any}
|
|
68
|
-
* @memberof Configuration
|
|
69
52
|
*/
|
|
70
53
|
baseOptions?: any;
|
|
71
54
|
/**
|
package/dist/configuration.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/Agent.md
CHANGED
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**external_website** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**ticker** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**token_address** | **string** | | [optional] [default to undefined]
|
|
13
|
-
**token_pool** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**token_address** | **string** | | [optional] [readonly] [default to undefined]
|
|
13
|
+
**token_pool** | **string** | | [optional] [readonly] [default to undefined]
|
|
14
14
|
**fee_percentage** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**example_intro** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**examples** | [**Array<AgentExample>**](AgentExample.md) | | [optional] [default to undefined]
|
package/docs/AgentResponse.md
CHANGED
|
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**external_website** | **string** | | [optional] [default to undefined]
|
|
11
11
|
**ticker** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**token_address** | **string** | | [optional] [default to undefined]
|
|
13
|
-
**token_pool** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**token_address** | **string** | | [optional] [readonly] [default to undefined]
|
|
13
|
+
**token_pool** | **string** | | [optional] [readonly] [default to undefined]
|
|
14
14
|
**fee_percentage** | **string** | | [optional] [default to undefined]
|
|
15
15
|
**example_intro** | **string** | | [optional] [default to undefined]
|
|
16
16
|
**examples** | [**Array<AgentExample>**](AgentExample.md) | | [optional] [default to undefined]
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# FileUploadResponse
|
|
2
|
+
|
|
3
|
+
Response model for file upload.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**file_url** | **string** | CDN URL of the uploaded file | [default to undefined]
|
|
10
|
+
**file_id** | **string** | Unique identifier for the uploaded file | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FileUploadResponse } from '@crestal/nation-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: FileUploadResponse = {
|
|
18
|
+
file_url,
|
|
19
|
+
file_id,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -27,8 +27,8 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**supports_presence_penalty** | **boolean** | | [optional] [default to true]
|
|
28
28
|
**api_base** | **string** | | [optional] [default to undefined]
|
|
29
29
|
**timeout** | **number** | | [optional] [default to 180]
|
|
30
|
-
**created_at** | **string** | Timestamp when this data was created | [optional] [default to 2025-09-
|
|
31
|
-
**updated_at** | **string** | Timestamp when this data was updated | [optional] [default to 2025-09-
|
|
30
|
+
**created_at** | **string** | Timestamp when this data was created | [optional] [default to 2025-09-19T05:40:39.379+00:00]
|
|
31
|
+
**updated_at** | **string** | Timestamp when this data was updated | [optional] [default to 2025-09-19T05:40:39.379+00:00]
|
|
32
32
|
**provider_name** | **string** | | [default to undefined]
|
|
33
33
|
|
|
34
34
|
## Example
|
package/docs/UserApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getUserAgentById**](#getuseragentbyid) | **GET** /user/agents/{agent_id} | Get User Agent By Id|
|
|
8
8
|
|[**getUserAgents**](#getuseragents) | **GET** /user/agents | Get User Agents|
|
|
9
|
+
|[**uploadUserFile**](#uploaduserfile) | **POST** /user/upload | Upload User File|
|
|
9
10
|
|
|
10
11
|
# **getUserAgentById**
|
|
11
12
|
> Agent getUserAgentById()
|
|
@@ -114,3 +115,55 @@ const { status, data } = await apiInstance.getUserAgents(
|
|
|
114
115
|
|
|
115
116
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
116
117
|
|
|
118
|
+
# **uploadUserFile**
|
|
119
|
+
> FileUploadResponse uploadUserFile()
|
|
120
|
+
|
|
121
|
+
Upload a file for the authenticated user. **Form Data:** * `file` - File to upload (supports images, videos, audio, and PDF files) **Returns:** * `FileUploadResponse` - Contains the CDN URL and unique identifier of the uploaded file **Raises:** * `400` - Invalid file type or file too large * `500` - Upload failed
|
|
122
|
+
|
|
123
|
+
### Example
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
import {
|
|
127
|
+
UserApi,
|
|
128
|
+
Configuration
|
|
129
|
+
} from '@crestal/nation-sdk';
|
|
130
|
+
|
|
131
|
+
const configuration = new Configuration();
|
|
132
|
+
const apiInstance = new UserApi(configuration);
|
|
133
|
+
|
|
134
|
+
let file: File; //File to upload (default to undefined)
|
|
135
|
+
|
|
136
|
+
const { status, data } = await apiInstance.uploadUserFile(
|
|
137
|
+
file
|
|
138
|
+
);
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Parameters
|
|
142
|
+
|
|
143
|
+
|Name | Type | Description | Notes|
|
|
144
|
+
|------------- | ------------- | ------------- | -------------|
|
|
145
|
+
| **file** | [**File**] | File to upload | defaults to undefined|
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
### Return type
|
|
149
|
+
|
|
150
|
+
**FileUploadResponse**
|
|
151
|
+
|
|
152
|
+
### Authorization
|
|
153
|
+
|
|
154
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
155
|
+
|
|
156
|
+
### HTTP request headers
|
|
157
|
+
|
|
158
|
+
- **Content-Type**: multipart/form-data
|
|
159
|
+
- **Accept**: application/json
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### HTTP response details
|
|
163
|
+
| Status code | Description | Response headers |
|
|
164
|
+
|-------------|-------------|------------------|
|
|
165
|
+
|**200** | Successful Response | - |
|
|
166
|
+
|**422** | Validation Error | - |
|
|
167
|
+
|
|
168
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
169
|
+
|
package/index.ts
CHANGED