docspring-ts 1.0.2 → 2.0.0
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/README.md +54 -19
- package/dist/apis/PDFApi.d.ts +120 -435
- package/dist/apis/PDFApi.js +3242 -1720
- package/dist/apis/PDFApi.js.map +1 -0
- package/dist/apis/baseapi.d.ts +18 -0
- package/dist/apis/baseapi.js +46 -0
- package/dist/apis/baseapi.js.map +1 -0
- package/dist/apis/exception.d.ts +10 -0
- package/dist/apis/exception.js +32 -0
- package/dist/apis/exception.js.map +1 -0
- package/dist/auth/auth.d.ts +36 -0
- package/dist/auth/auth.js +31 -0
- package/dist/auth/auth.js.map +1 -0
- package/dist/configuration.d.ts +18 -0
- package/dist/configuration.js +22 -0
- package/dist/configuration.js.map +1 -0
- package/dist/http/http.d.ts +68 -0
- package/dist/http/http.js +261 -0
- package/dist/http/http.js.map +1 -0
- package/dist/http/isomorphic-fetch.d.ts +6 -0
- package/dist/http/isomorphic-fetch.js +45 -0
- package/dist/http/isomorphic-fetch.js.map +1 -0
- package/dist/index.d.ts +10 -3
- package/dist/index.js +13 -5
- package/dist/index.js.map +1 -0
- package/dist/middleware.d.ts +16 -0
- package/dist/middleware.js +18 -0
- package/dist/middleware.js.map +1 -0
- package/dist/models/AddFieldsData.d.ts +19 -30
- package/dist/models/AddFieldsData.js +19 -46
- package/dist/models/AddFieldsData.js.map +1 -0
- package/dist/models/BatchGeneratePdfs201Response.d.ts +29 -0
- package/dist/models/BatchGeneratePdfs201Response.js +52 -0
- package/dist/models/BatchGeneratePdfs201Response.js.map +1 -0
- package/dist/models/CombinePdfsData.d.ts +24 -60
- package/dist/models/CombinePdfsData.js +49 -57
- package/dist/models/CombinePdfsData.js.map +1 -0
- package/dist/models/CombinedSubmission.d.ts +38 -112
- package/dist/models/CombinedSubmission.js +103 -84
- package/dist/models/CombinedSubmission.js.map +1 -0
- package/dist/models/CombinedSubmissionAction.d.ts +40 -88
- package/dist/models/CombinedSubmissionAction.js +68 -86
- package/dist/models/CombinedSubmissionAction.js.map +1 -0
- package/dist/models/CombinedSubmissionData.d.ts +23 -54
- package/dist/models/CombinedSubmissionData.js +43 -55
- package/dist/models/CombinedSubmissionData.js.map +1 -0
- package/dist/models/CopyTemplateOptions.d.ts +21 -0
- package/dist/models/CopyTemplateOptions.js +29 -0
- package/dist/models/CopyTemplateOptions.js.map +1 -0
- package/dist/models/CreateCombinedSubmissionResponse.d.ts +26 -51
- package/dist/models/CreateCombinedSubmissionResponse.js +36 -60
- package/dist/models/CreateCombinedSubmissionResponse.js.map +1 -0
- package/dist/models/CreateCustomFileData.d.ts +19 -30
- package/dist/models/CreateCustomFileData.js +19 -46
- package/dist/models/CreateCustomFileData.js.map +1 -0
- package/dist/models/CreateCustomFileResponse.d.ts +26 -50
- package/dist/models/CreateCustomFileResponse.js +36 -59
- package/dist/models/CreateCustomFileResponse.js.map +1 -0
- package/dist/models/CreateFolderData.d.ts +19 -31
- package/dist/models/CreateFolderData.js +19 -47
- package/dist/models/CreateFolderData.js.map +1 -0
- package/dist/models/CreateHtmlSubmissionData.d.ts +28 -0
- package/dist/models/CreateHtmlSubmissionData.js +71 -0
- package/dist/models/CreateHtmlSubmissionData.js.map +1 -0
- package/dist/models/CreateHtmlTemplate.d.ts +20 -0
- package/dist/models/CreateHtmlTemplate.js +23 -0
- package/dist/models/CreateHtmlTemplate.js.map +1 -0
- package/dist/models/CreatePdfSubmissionData.d.ts +28 -0
- package/dist/models/CreatePdfSubmissionData.js +65 -0
- package/dist/models/CreatePdfSubmissionData.js.map +1 -0
- package/dist/models/CreatePdfTemplate.d.ts +20 -0
- package/dist/models/CreatePdfTemplate.js +23 -0
- package/dist/models/CreatePdfTemplate.js.map +1 -0
- package/dist/models/CreateSubmissionDataRequestData.d.ts +40 -127
- package/dist/models/CreateSubmissionDataRequestData.js +62 -95
- package/dist/models/CreateSubmissionDataRequestData.js.map +1 -0
- package/dist/models/CreateSubmissionDataRequestEventRequest.d.ts +40 -0
- package/dist/models/CreateSubmissionDataRequestEventRequest.js +50 -0
- package/dist/models/CreateSubmissionDataRequestEventRequest.js.map +1 -0
- package/dist/models/CreateSubmissionDataRequestEventResponse.d.ts +27 -0
- package/dist/models/CreateSubmissionDataRequestEventResponse.js +40 -0
- package/dist/models/CreateSubmissionDataRequestEventResponse.js.map +1 -0
- package/dist/models/CreateSubmissionDataRequestResponse.d.ts +27 -0
- package/dist/models/CreateSubmissionDataRequestResponse.js +40 -0
- package/dist/models/CreateSubmissionDataRequestResponse.js.map +1 -0
- package/dist/models/CreateSubmissionDataRequestTokenResponse.d.ts +26 -51
- package/dist/models/CreateSubmissionDataRequestTokenResponse.js +36 -60
- package/dist/models/CreateSubmissionDataRequestTokenResponse.js.map +1 -0
- package/dist/models/CreateSubmissionResponse.d.ts +26 -51
- package/dist/models/CreateSubmissionResponse.js +36 -60
- package/dist/models/CreateSubmissionResponse.js.map +1 -0
- package/dist/models/CustomFile.d.ts +21 -0
- package/dist/models/CustomFile.js +29 -0
- package/dist/models/CustomFile.js.map +1 -0
- package/dist/models/ErrorResponse.d.ts +23 -43
- package/dist/models/ErrorResponse.js +29 -55
- package/dist/models/ErrorResponse.js.map +1 -0
- package/dist/models/Folder.d.ts +22 -48
- package/dist/models/Folder.js +37 -52
- package/dist/models/Folder.js.map +1 -0
- package/dist/models/JsonSchema.d.ts +28 -0
- package/dist/models/JsonSchema.js +71 -0
- package/dist/models/JsonSchema.js.map +1 -0
- package/dist/models/ListSubmissionsResponse.d.ts +22 -43
- package/dist/models/ListSubmissionsResponse.js +31 -53
- package/dist/models/ListSubmissionsResponse.js.map +1 -0
- package/dist/models/MoveFolderData.d.ts +19 -30
- package/dist/models/MoveFolderData.js +19 -46
- package/dist/models/MoveFolderData.js.map +1 -0
- package/dist/models/MoveTemplateData.d.ts +19 -30
- package/dist/models/MoveTemplateData.js +19 -46
- package/dist/models/MoveTemplateData.js.map +1 -0
- package/dist/models/MultipleErrorsResponse.d.ts +24 -0
- package/dist/models/MultipleErrorsResponse.js +33 -0
- package/dist/models/MultipleErrorsResponse.js.map +1 -0
- package/dist/models/ObjectSerializer.d.ts +57 -0
- package/dist/models/ObjectSerializer.js +459 -0
- package/dist/models/ObjectSerializer.js.map +1 -0
- package/dist/models/RenameFolderData.d.ts +19 -30
- package/dist/models/RenameFolderData.js +19 -46
- package/dist/models/RenameFolderData.js.map +1 -0
- package/dist/models/Submission.d.ts +63 -157
- package/dist/models/Submission.js +178 -104
- package/dist/models/Submission.js.map +1 -0
- package/dist/models/SubmissionAction.d.ts +40 -88
- package/dist/models/SubmissionAction.js +68 -86
- package/dist/models/SubmissionAction.js.map +1 -0
- package/dist/models/SubmissionBatch.d.ts +31 -88
- package/dist/models/SubmissionBatch.js +67 -79
- package/dist/models/SubmissionBatch.js.map +1 -0
- package/dist/models/SubmissionBatchData.d.ts +21 -49
- package/dist/models/SubmissionBatchData.js +31 -54
- package/dist/models/SubmissionBatchData.js.map +1 -0
- package/dist/models/SubmissionBatchWithSubmissions.d.ts +34 -0
- package/dist/models/SubmissionBatchWithSubmissions.js +77 -0
- package/dist/models/SubmissionBatchWithSubmissions.js.map +1 -0
- package/dist/models/SubmissionDataRequest.d.ts +60 -183
- package/dist/models/SubmissionDataRequest.js +163 -124
- package/dist/models/SubmissionDataRequest.js.map +1 -0
- package/dist/models/SubmissionDataRequestEvent.d.ts +45 -0
- package/dist/models/SubmissionDataRequestEvent.js +80 -0
- package/dist/models/SubmissionDataRequestEvent.js.map +1 -0
- package/dist/models/SubmissionDataRequestShow.d.ts +62 -0
- package/dist/models/SubmissionDataRequestShow.js +173 -0
- package/dist/models/SubmissionDataRequestShow.js.map +1 -0
- package/dist/models/SubmissionDataRequestToken.d.ts +23 -0
- package/dist/models/SubmissionDataRequestToken.js +41 -0
- package/dist/models/SubmissionDataRequestToken.js.map +1 -0
- package/dist/models/SubmissionPreview.d.ts +55 -0
- package/dist/models/SubmissionPreview.js +157 -0
- package/dist/models/SubmissionPreview.js.map +1 -0
- package/dist/models/SuccessErrorResponse.d.ts +25 -0
- package/dist/models/SuccessErrorResponse.js +34 -0
- package/dist/models/SuccessErrorResponse.js.map +1 -0
- package/dist/models/SuccessMultipleErrorsResponse.d.ts +25 -0
- package/dist/models/SuccessMultipleErrorsResponse.js +34 -0
- package/dist/models/SuccessMultipleErrorsResponse.js.map +1 -0
- package/dist/models/Template.d.ts +75 -153
- package/dist/models/Template.js +302 -111
- package/dist/models/Template.js.map +1 -0
- package/dist/models/TemplateAddFieldsResponse.d.ts +26 -0
- package/dist/models/TemplateAddFieldsResponse.js +40 -0
- package/dist/models/TemplateAddFieldsResponse.js.map +1 -0
- package/dist/models/TemplatePreview.d.ts +66 -0
- package/dist/models/TemplatePreview.js +246 -0
- package/dist/models/TemplatePreview.js.map +1 -0
- package/dist/models/UpdateHtmlTemplate.d.ts +20 -0
- package/dist/models/UpdateHtmlTemplate.js +23 -0
- package/dist/models/UpdateHtmlTemplate.js.map +1 -0
- package/dist/models/UpdateSubmissionDataRequestData.d.ts +31 -127
- package/dist/models/UpdateSubmissionDataRequestData.js +47 -93
- package/dist/models/UpdateSubmissionDataRequestData.js.map +1 -0
- package/dist/models/UploadPresignResponse.d.ts +26 -0
- package/dist/models/UploadPresignResponse.js +45 -0
- package/dist/models/UploadPresignResponse.js.map +1 -0
- package/dist/models/all.d.ts +48 -0
- package/dist/models/all.js +65 -0
- package/dist/models/all.js.map +1 -0
- package/dist/rxjsStub.d.ts +10 -0
- package/dist/rxjsStub.js +33 -0
- package/dist/rxjsStub.js.map +1 -0
- package/dist/servers.d.ts +17 -0
- package/dist/servers.js +32 -0
- package/dist/servers.js.map +1 -0
- package/dist/types/ObjectParamAPI.d.ts +269 -0
- package/dist/types/ObjectParamAPI.js +252 -0
- package/dist/types/ObjectParamAPI.js.map +1 -0
- package/dist/types/ObservableAPI.d.ts +124 -0
- package/dist/types/ObservableAPI.js +1042 -0
- package/dist/types/ObservableAPI.js.map +1 -0
- package/dist/types/PromiseAPI.d.ts +121 -0
- package/dist/types/PromiseAPI.js +316 -0
- package/dist/types/PromiseAPI.js.map +1 -0
- package/dist/util.d.ts +2 -0
- package/dist/util.js +29 -0
- package/dist/util.js.map +1 -0
- package/package.json +24 -2
- package/.openapi-generator/FILES +0 -61
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -23
- package/CHANGELOG.md +0 -7
- package/dist/apis/index.d.ts +0 -1
- package/dist/apis/index.js +0 -19
- package/dist/models/AddFieldsTemplateResponse.d.ts +0 -51
- package/dist/models/AddFieldsTemplateResponse.js +0 -62
- package/dist/models/AuthenticationError.d.ts +0 -44
- package/dist/models/AuthenticationError.js +0 -59
- package/dist/models/AuthenticationSuccessResponse.d.ts +0 -38
- package/dist/models/AuthenticationSuccessResponse.js +0 -56
- package/dist/models/CopyTemplateData.d.ts +0 -37
- package/dist/models/CopyTemplateData.js +0 -53
- package/dist/models/CreateFolderAttributes.d.ts +0 -37
- package/dist/models/CreateFolderAttributes.js +0 -53
- package/dist/models/CreateHtmlTemplateData.d.ts +0 -32
- package/dist/models/CreateHtmlTemplateData.js +0 -51
- package/dist/models/CreateSubmissionBatchResponse.d.ts +0 -65
- package/dist/models/CreateSubmissionBatchResponse.js +0 -70
- package/dist/models/CreateSubmissionBatchSubmissionsResponse.d.ts +0 -53
- package/dist/models/CreateSubmissionBatchSubmissionsResponse.js +0 -64
- package/dist/models/CreateSubmissionData.d.ts +0 -80
- package/dist/models/CreateSubmissionData.js +0 -68
- package/dist/models/CreateTemplateFromUploadData.d.ts +0 -32
- package/dist/models/CreateTemplateFromUploadData.js +0 -51
- package/dist/models/DataRequestToken.d.ts +0 -49
- package/dist/models/DataRequestToken.js +0 -59
- package/dist/models/DeleteTemplateResponse.d.ts +0 -45
- package/dist/models/DeleteTemplateResponse.js +0 -60
- package/dist/models/FullTemplate.d.ts +0 -269
- package/dist/models/FullTemplate.js +0 -173
- package/dist/models/HtmlTemplateData.d.ts +0 -144
- package/dist/models/HtmlTemplateData.js +0 -98
- package/dist/models/InvalidRequest.d.ts +0 -44
- package/dist/models/InvalidRequest.js +0 -59
- package/dist/models/PendingTemplate.d.ts +0 -136
- package/dist/models/PendingTemplate.js +0 -103
- package/dist/models/SubmissionData.d.ts +0 -62
- package/dist/models/SubmissionData.js +0 -62
- package/dist/models/SubmissionDataBatchRequest.d.ts +0 -61
- package/dist/models/SubmissionDataBatchRequest.js +0 -62
- package/dist/models/TemplateData.d.ts +0 -130
- package/dist/models/TemplateData.js +0 -88
- package/dist/models/TemplateDefaults.d.ts +0 -43
- package/dist/models/TemplateDefaults.js +0 -56
- package/dist/models/TemplateDocument.d.ts +0 -51
- package/dist/models/TemplateDocument.js +0 -63
- package/dist/models/TemplateDocumentMetadata.d.ts +0 -50
- package/dist/models/TemplateDocumentMetadata.js +0 -62
- package/dist/models/UpdateDataRequestResponse.d.ts +0 -52
- package/dist/models/UpdateDataRequestResponse.js +0 -64
- package/dist/models/UpdateTemplateData.d.ts +0 -32
- package/dist/models/UpdateTemplateData.js +0 -51
- package/dist/models/UpdateTemplateResponse.d.ts +0 -45
- package/dist/models/UpdateTemplateResponse.js +0 -60
- package/dist/models/UploadTemplateData.d.ts +0 -151
- package/dist/models/UploadTemplateData.js +0 -101
- package/dist/models/index.d.ts +0 -51
- package/dist/models/index.js +0 -69
- package/dist/runtime.d.ts +0 -182
- package/dist/runtime.js +0 -562
- package/src/apis/PDFApi.ts +0 -1665
- package/src/apis/index.ts +0 -3
- package/src/index.ts +0 -5
- package/src/models/AddFieldsData.ts +0 -66
- package/src/models/AddFieldsTemplateResponse.ts +0 -93
- package/src/models/AuthenticationError.ts +0 -84
- package/src/models/AuthenticationSuccessResponse.ts +0 -76
- package/src/models/CombinePdfsData.ts +0 -106
- package/src/models/CombinedSubmission.ts +0 -185
- package/src/models/CombinedSubmissionAction.ts +0 -144
- package/src/models/CombinedSubmissionData.ts +0 -98
- package/src/models/CopyTemplateData.ts +0 -74
- package/src/models/CreateCombinedSubmissionResponse.ts +0 -101
- package/src/models/CreateCustomFileData.ts +0 -66
- package/src/models/CreateCustomFileResponse.ts +0 -94
- package/src/models/CreateFolderAttributes.ts +0 -74
- package/src/models/CreateFolderData.ts +0 -73
- package/src/models/CreateHtmlTemplateData.ts +0 -73
- package/src/models/CreateSubmissionBatchResponse.ts +0 -124
- package/src/models/CreateSubmissionBatchSubmissionsResponse.ts +0 -101
- package/src/models/CreateSubmissionData.ts +0 -137
- package/src/models/CreateSubmissionDataRequestData.ts +0 -192
- package/src/models/CreateSubmissionDataRequestTokenResponse.ts +0 -101
- package/src/models/CreateSubmissionResponse.ts +0 -101
- package/src/models/CreateTemplateFromUploadData.ts +0 -73
- package/src/models/DataRequestToken.ts +0 -93
- package/src/models/DeleteTemplateResponse.ts +0 -85
- package/src/models/ErrorResponse.ts +0 -85
- package/src/models/Folder.ts +0 -89
- package/src/models/FullTemplate.ts +0 -427
- package/src/models/HtmlTemplateData.ts +0 -215
- package/src/models/InvalidRequest.ts +0 -85
- package/src/models/ListSubmissionsResponse.ts +0 -91
- package/src/models/MoveFolderData.ts +0 -65
- package/src/models/MoveTemplateData.ts +0 -66
- package/src/models/PendingTemplate.ts +0 -218
- package/src/models/RenameFolderData.ts +0 -66
- package/src/models/Submission.ts +0 -246
- package/src/models/SubmissionAction.ts +0 -144
- package/src/models/SubmissionBatch.ts +0 -156
- package/src/models/SubmissionBatchData.ts +0 -97
- package/src/models/SubmissionData.ts +0 -113
- package/src/models/SubmissionDataBatchRequest.ts +0 -107
- package/src/models/SubmissionDataRequest.ts +0 -271
- package/src/models/Template.ts +0 -249
- package/src/models/TemplateData.ts +0 -197
- package/src/models/TemplateDefaults.ts +0 -84
- package/src/models/TemplateDocument.ts +0 -101
- package/src/models/TemplateDocumentMetadata.ts +0 -94
- package/src/models/UpdateDataRequestResponse.ts +0 -101
- package/src/models/UpdateSubmissionDataRequestData.ts +0 -190
- package/src/models/UpdateTemplateData.ts +0 -73
- package/src/models/UpdateTemplateResponse.ts +0 -85
- package/src/models/UploadTemplateData.ts +0 -230
- package/src/models/index.ts +0 -53
- package/src/runtime.ts +0 -431
- package/tsconfig.json +0 -20
package/dist/runtime.d.ts
DELETED
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* API v1
|
|
3
|
-
* DocSpring is a service that helps you fill out and sign PDF templates.
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: v1
|
|
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 | ((name: string) => 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) | 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 exists(json: any, key: string): boolean;
|
|
126
|
-
export declare function querystring(params: HTTPQuery, prefix?: string): string;
|
|
127
|
-
export declare function mapValues(data: any, fn: (item: any) => any): {};
|
|
128
|
-
export declare function canConsumeForm(consumes: Consume[]): boolean;
|
|
129
|
-
export interface Consume {
|
|
130
|
-
contentType: string;
|
|
131
|
-
}
|
|
132
|
-
export interface RequestContext {
|
|
133
|
-
fetch: FetchAPI;
|
|
134
|
-
url: string;
|
|
135
|
-
init: RequestInit;
|
|
136
|
-
}
|
|
137
|
-
export interface ResponseContext {
|
|
138
|
-
fetch: FetchAPI;
|
|
139
|
-
url: string;
|
|
140
|
-
init: RequestInit;
|
|
141
|
-
response: Response;
|
|
142
|
-
}
|
|
143
|
-
export interface ErrorContext {
|
|
144
|
-
fetch: FetchAPI;
|
|
145
|
-
url: string;
|
|
146
|
-
init: RequestInit;
|
|
147
|
-
error: unknown;
|
|
148
|
-
response?: Response;
|
|
149
|
-
}
|
|
150
|
-
export interface Middleware {
|
|
151
|
-
pre?(context: RequestContext): Promise<FetchParams | void>;
|
|
152
|
-
post?(context: ResponseContext): Promise<Response | void>;
|
|
153
|
-
onError?(context: ErrorContext): Promise<Response | void>;
|
|
154
|
-
}
|
|
155
|
-
export interface ApiResponse<T> {
|
|
156
|
-
raw: Response;
|
|
157
|
-
value(): Promise<T>;
|
|
158
|
-
}
|
|
159
|
-
export interface ResponseTransformer<T> {
|
|
160
|
-
(json: any): T;
|
|
161
|
-
}
|
|
162
|
-
export declare class JSONApiResponse<T> {
|
|
163
|
-
raw: Response;
|
|
164
|
-
private transformer;
|
|
165
|
-
constructor(raw: Response, transformer?: ResponseTransformer<T>);
|
|
166
|
-
value(): Promise<T>;
|
|
167
|
-
}
|
|
168
|
-
export declare class VoidApiResponse {
|
|
169
|
-
raw: Response;
|
|
170
|
-
constructor(raw: Response);
|
|
171
|
-
value(): Promise<void>;
|
|
172
|
-
}
|
|
173
|
-
export declare class BlobApiResponse {
|
|
174
|
-
raw: Response;
|
|
175
|
-
constructor(raw: Response);
|
|
176
|
-
value(): Promise<Blob>;
|
|
177
|
-
}
|
|
178
|
-
export declare class TextApiResponse {
|
|
179
|
-
raw: Response;
|
|
180
|
-
constructor(raw: Response);
|
|
181
|
-
value(): Promise<string>;
|
|
182
|
-
}
|