@cirrobio/api-client 0.4.3 → 0.9.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/.openapi-generator/FILES +1 -0
- package/README.md +1 -1
- package/package.json +4 -2
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +1 -5
- package/dist/apis/AuditApi.d.ts +0 -60
- package/dist/apis/AuditApi.js +0 -194
- package/dist/apis/BillingApi.d.ts +0 -71
- package/dist/apis/BillingApi.js +0 -304
- package/dist/apis/ComputeEnvironmentApi.d.ts +0 -124
- package/dist/apis/ComputeEnvironmentApi.js +0 -532
- package/dist/apis/DashboardsApi.d.ts +0 -88
- package/dist/apis/DashboardsApi.js +0 -374
- package/dist/apis/DatasetsApi.d.ts +0 -162
- package/dist/apis/DatasetsApi.js +0 -670
- package/dist/apis/ExecutionApi.d.ts +0 -110
- package/dist/apis/ExecutionApi.js +0 -442
- package/dist/apis/FileApi.d.ts +0 -60
- package/dist/apis/FileApi.js +0 -260
- package/dist/apis/GovernanceApi.d.ts +0 -253
- package/dist/apis/GovernanceApi.js +0 -1094
- package/dist/apis/MetadataApi.d.ts +0 -85
- package/dist/apis/MetadataApi.js +0 -371
- package/dist/apis/MetricsApi.d.ts +0 -41
- package/dist/apis/MetricsApi.js +0 -187
- package/dist/apis/NotebooksApi.d.ts +0 -101
- package/dist/apis/NotebooksApi.js +0 -423
- package/dist/apis/ProcessesApi.d.ts +0 -138
- package/dist/apis/ProcessesApi.js +0 -589
- package/dist/apis/ProjectRequestsApi.d.ts +0 -31
- package/dist/apis/ProjectRequestsApi.js +0 -137
- package/dist/apis/ProjectsApi.d.ts +0 -225
- package/dist/apis/ProjectsApi.js +0 -973
- package/dist/apis/ReferencesApi.d.ts +0 -91
- package/dist/apis/ReferencesApi.js +0 -405
- package/dist/apis/SharingApi.d.ts +0 -145
- package/dist/apis/SharingApi.js +0 -601
- package/dist/apis/SystemApi.d.ts +0 -36
- package/dist/apis/SystemApi.js +0 -182
- package/dist/apis/ToolsApi.d.ts +0 -31
- package/dist/apis/ToolsApi.js +0 -137
- package/dist/apis/UsersApi.d.ts +0 -86
- package/dist/apis/UsersApi.js +0 -367
- package/dist/apis/index.d.ts +0 -19
- package/dist/apis/index.js +0 -37
- package/dist/index.d.ts +0 -3
- package/dist/index.js +0 -21
- package/dist/models/AWSCredentials.d.ts +0 -55
- package/dist/models/AWSCredentials.js +0 -62
- package/dist/models/Agent.d.ts +0 -52
- package/dist/models/Agent.js +0 -58
- package/dist/models/AgentDetail.d.ts +0 -91
- package/dist/models/AgentDetail.js +0 -77
- package/dist/models/AgentInput.d.ts +0 -67
- package/dist/models/AgentInput.js +0 -62
- package/dist/models/AgentRegistration.d.ts +0 -55
- package/dist/models/AgentRegistration.js +0 -62
- package/dist/models/AgentStatus.d.ts +0 -23
- package/dist/models/AgentStatus.js +0 -38
- package/dist/models/AllowedDataType.d.ts +0 -44
- package/dist/models/AllowedDataType.js +0 -57
- package/dist/models/ApproveAccessRequest.d.ts +0 -32
- package/dist/models/ApproveAccessRequest.js +0 -51
- package/dist/models/ApproveProjectAccessRequest.d.ts +0 -32
- package/dist/models/ApproveProjectAccessRequest.js +0 -51
- package/dist/models/Artifact.d.ts +0 -38
- package/dist/models/Artifact.js +0 -54
- package/dist/models/ArtifactType.d.ts +0 -34
- package/dist/models/ArtifactType.js +0 -49
- package/dist/models/AuditEvent.d.ts +0 -89
- package/dist/models/AuditEvent.js +0 -68
- package/dist/models/AuthInfo.d.ts +0 -55
- package/dist/models/AuthInfo.js +0 -62
- package/dist/models/BillingAccount.d.ts +0 -88
- package/dist/models/BillingAccount.js +0 -80
- package/dist/models/BillingAccountRequest.d.ts +0 -70
- package/dist/models/BillingAccountRequest.js +0 -71
- package/dist/models/BillingMethod.d.ts +0 -24
- package/dist/models/BillingMethod.js +0 -39
- package/dist/models/BudgetPeriod.d.ts +0 -24
- package/dist/models/BudgetPeriod.js +0 -39
- package/dist/models/ClassificationInput.d.ts +0 -43
- package/dist/models/ClassificationInput.js +0 -56
- package/dist/models/CloudAccount.d.ts +0 -50
- package/dist/models/CloudAccount.js +0 -58
- package/dist/models/CloudAccountType.d.ts +0 -23
- package/dist/models/CloudAccountType.js +0 -38
- package/dist/models/ColumnDefinition.d.ts +0 -43
- package/dist/models/ColumnDefinition.js +0 -54
- package/dist/models/ComputeEnvironmentConfiguration.d.ts +0 -77
- package/dist/models/ComputeEnvironmentConfiguration.js +0 -69
- package/dist/models/ComputeEnvironmentConfigurationInput.d.ts +0 -45
- package/dist/models/ComputeEnvironmentConfigurationInput.js +0 -55
- package/dist/models/Contact.d.ts +0 -49
- package/dist/models/Contact.js +0 -59
- package/dist/models/ContactInput.d.ts +0 -55
- package/dist/models/ContactInput.js +0 -62
- package/dist/models/CreateNotebookInstanceRequest.d.ts +0 -61
- package/dist/models/CreateNotebookInstanceRequest.js +0 -64
- package/dist/models/CreateProjectAccessRequest.d.ts +0 -38
- package/dist/models/CreateProjectAccessRequest.js +0 -54
- package/dist/models/CreateReferenceRequest.d.ts +0 -49
- package/dist/models/CreateReferenceRequest.js +0 -59
- package/dist/models/CreateResponse.d.ts +0 -37
- package/dist/models/CreateResponse.js +0 -53
- package/dist/models/CustomPipelineSettings.d.ts +0 -75
- package/dist/models/CustomPipelineSettings.js +0 -67
- package/dist/models/CustomProcessInput.d.ts +0 -131
- package/dist/models/CustomProcessInput.js +0 -93
- package/dist/models/CustomerType.d.ts +0 -24
- package/dist/models/CustomerType.js +0 -39
- package/dist/models/Dashboard.d.ts +0 -83
- package/dist/models/Dashboard.js +0 -74
- package/dist/models/DashboardRequest.d.ts +0 -59
- package/dist/models/DashboardRequest.js +0 -62
- package/dist/models/DataFile.d.ts +0 -39
- package/dist/models/DataFile.js +0 -53
- package/dist/models/Dataset.d.ts +0 -93
- package/dist/models/Dataset.js +0 -82
- package/dist/models/DatasetAssetsManifest.d.ts +0 -65
- package/dist/models/DatasetAssetsManifest.js +0 -64
- package/dist/models/DatasetCondition.d.ts +0 -38
- package/dist/models/DatasetCondition.js +0 -54
- package/dist/models/DatasetConditionField.d.ts +0 -25
- package/dist/models/DatasetConditionField.js +0 -40
- package/dist/models/DatasetDetail.d.ts +0 -146
- package/dist/models/DatasetDetail.js +0 -107
- package/dist/models/DatasetViz.d.ts +0 -55
- package/dist/models/DatasetViz.js +0 -58
- package/dist/models/EnvironmentType.d.ts +0 -25
- package/dist/models/EnvironmentType.js +0 -40
- package/dist/models/ErrorMessage.d.ts +0 -31
- package/dist/models/ErrorMessage.js +0 -50
- package/dist/models/Executor.d.ts +0 -25
- package/dist/models/Executor.js +0 -40
- package/dist/models/FeatureFlags.d.ts +0 -43
- package/dist/models/FeatureFlags.js +0 -56
- package/dist/models/FileEntry.d.ts +0 -45
- package/dist/models/FileEntry.js +0 -54
- package/dist/models/FileMappingRule.d.ts +0 -56
- package/dist/models/FileMappingRule.js +0 -61
- package/dist/models/FileNamePattern.d.ts +0 -43
- package/dist/models/FileNamePattern.js +0 -56
- package/dist/models/FileRequirements.d.ts +0 -44
- package/dist/models/FileRequirements.js +0 -57
- package/dist/models/FormSchema.d.ts +0 -41
- package/dist/models/FormSchema.js +0 -52
- package/dist/models/FulfillmentResponse.d.ts +0 -37
- package/dist/models/FulfillmentResponse.js +0 -53
- package/dist/models/GenerateSftpCredentialsRequest.d.ts +0 -31
- package/dist/models/GenerateSftpCredentialsRequest.js +0 -50
- package/dist/models/GetExecutionLogsResponse.d.ts +0 -32
- package/dist/models/GetExecutionLogsResponse.js +0 -51
- package/dist/models/GovernanceAccessType.d.ts +0 -25
- package/dist/models/GovernanceAccessType.js +0 -40
- package/dist/models/GovernanceClassification.d.ts +0 -67
- package/dist/models/GovernanceClassification.js +0 -68
- package/dist/models/GovernanceContact.d.ts +0 -79
- package/dist/models/GovernanceContact.js +0 -74
- package/dist/models/GovernanceExpiry.d.ts +0 -44
- package/dist/models/GovernanceExpiry.js +0 -55
- package/dist/models/GovernanceExpiryType.d.ts +0 -25
- package/dist/models/GovernanceExpiryType.js +0 -40
- package/dist/models/GovernanceFile.d.ts +0 -50
- package/dist/models/GovernanceFile.js +0 -57
- package/dist/models/GovernanceFileAccessRequest.d.ts +0 -50
- package/dist/models/GovernanceFileAccessRequest.js +0 -58
- package/dist/models/GovernanceFileInput.d.ts +0 -50
- package/dist/models/GovernanceFileInput.js +0 -60
- package/dist/models/GovernanceFileType.d.ts +0 -23
- package/dist/models/GovernanceFileType.js +0 -38
- package/dist/models/GovernanceRequirement.d.ts +0 -146
- package/dist/models/GovernanceRequirement.js +0 -102
- package/dist/models/GovernanceRequirementFile.d.ts +0 -50
- package/dist/models/GovernanceRequirementFile.js +0 -57
- package/dist/models/GovernanceScope.d.ts +0 -23
- package/dist/models/GovernanceScope.js +0 -38
- package/dist/models/GovernanceTrainingVerification.d.ts +0 -23
- package/dist/models/GovernanceTrainingVerification.js +0 -38
- package/dist/models/GovernanceType.d.ts +0 -24
- package/dist/models/GovernanceType.js +0 -39
- package/dist/models/ImportDataRequest.d.ts +0 -50
- package/dist/models/ImportDataRequest.js +0 -59
- package/dist/models/InviteUserRequest.d.ts +0 -43
- package/dist/models/InviteUserRequest.js +0 -56
- package/dist/models/InviteUserResponse.d.ts +0 -31
- package/dist/models/InviteUserResponse.js +0 -50
- package/dist/models/LogEntry.d.ts +0 -37
- package/dist/models/LogEntry.js +0 -53
- package/dist/models/LoginProvider.d.ts +0 -49
- package/dist/models/LoginProvider.js +0 -59
- package/dist/models/MetricRecord.d.ts +0 -45
- package/dist/models/MetricRecord.js +0 -55
- package/dist/models/MoveDatasetInput.d.ts +0 -43
- package/dist/models/MoveDatasetInput.js +0 -56
- package/dist/models/MoveDatasetResponse.d.ts +0 -43
- package/dist/models/MoveDatasetResponse.js +0 -56
- package/dist/models/NamedItem.d.ts +0 -37
- package/dist/models/NamedItem.js +0 -53
- package/dist/models/NotebookInstance.d.ts +0 -98
- package/dist/models/NotebookInstance.js +0 -84
- package/dist/models/NotebookInstanceStatusResponse.d.ts +0 -37
- package/dist/models/NotebookInstanceStatusResponse.js +0 -53
- package/dist/models/OpenNotebookInstanceResponse.d.ts +0 -37
- package/dist/models/OpenNotebookInstanceResponse.js +0 -53
- package/dist/models/PaginatedResponseDatasetListDto.d.ts +0 -38
- package/dist/models/PaginatedResponseDatasetListDto.js +0 -54
- package/dist/models/PaginatedResponseSampleDto.d.ts +0 -38
- package/dist/models/PaginatedResponseSampleDto.js +0 -54
- package/dist/models/PaginatedResponseUserDto.d.ts +0 -38
- package/dist/models/PaginatedResponseUserDto.js +0 -54
- package/dist/models/PipelineCode.d.ts +0 -50
- package/dist/models/PipelineCode.js +0 -60
- package/dist/models/PipelineCost.d.ts +0 -43
- package/dist/models/PipelineCost.js +0 -54
- package/dist/models/PortalErrorResponse.d.ts +0 -50
- package/dist/models/PortalErrorResponse.js +0 -60
- package/dist/models/Process.d.ts +0 -140
- package/dist/models/Process.js +0 -99
- package/dist/models/ProcessDetail.d.ts +0 -161
- package/dist/models/ProcessDetail.js +0 -108
- package/dist/models/Project.d.ts +0 -75
- package/dist/models/Project.js +0 -73
- package/dist/models/ProjectAccessRequest.d.ts +0 -81
- package/dist/models/ProjectAccessRequest.js +0 -76
- package/dist/models/ProjectAccessType.d.ts +0 -26
- package/dist/models/ProjectAccessType.js +0 -41
- package/dist/models/ProjectCreateOptions.d.ts +0 -56
- package/dist/models/ProjectCreateOptions.js +0 -63
- package/dist/models/ProjectDetail.d.ts +0 -120
- package/dist/models/ProjectDetail.js +0 -97
- package/dist/models/ProjectFileAccessRequest.d.ts +0 -44
- package/dist/models/ProjectFileAccessRequest.js +0 -56
- package/dist/models/ProjectInput.d.ts +0 -77
- package/dist/models/ProjectInput.js +0 -73
- package/dist/models/ProjectMetrics.d.ts +0 -44
- package/dist/models/ProjectMetrics.js +0 -56
- package/dist/models/ProjectRequest.d.ts +0 -61
- package/dist/models/ProjectRequest.js +0 -65
- package/dist/models/ProjectRequirement.d.ts +0 -163
- package/dist/models/ProjectRequirement.js +0 -107
- package/dist/models/ProjectRole.d.ts +0 -26
- package/dist/models/ProjectRole.js +0 -41
- package/dist/models/ProjectSettings.d.ts +0 -140
- package/dist/models/ProjectSettings.js +0 -89
- package/dist/models/ProjectUser.d.ts +0 -62
- package/dist/models/ProjectUser.js +0 -66
- package/dist/models/Reference.d.ts +0 -68
- package/dist/models/Reference.js +0 -69
- package/dist/models/ReferenceType.d.ts +0 -51
- package/dist/models/ReferenceType.js +0 -59
- package/dist/models/RepositoryType.d.ts +0 -25
- package/dist/models/RepositoryType.js +0 -40
- package/dist/models/RequestStatus.d.ts +0 -24
- package/dist/models/RequestStatus.js +0 -39
- package/dist/models/RequirementFulfillmentInput.d.ts +0 -37
- package/dist/models/RequirementFulfillmentInput.js +0 -52
- package/dist/models/RequirementInput.d.ts +0 -108
- package/dist/models/RequirementInput.js +0 -85
- package/dist/models/ResourcesInfo.d.ts +0 -49
- package/dist/models/ResourcesInfo.js +0 -59
- package/dist/models/RunAnalysisRequest.d.ts +0 -81
- package/dist/models/RunAnalysisRequest.js +0 -71
- package/dist/models/Sample.d.ts +0 -70
- package/dist/models/Sample.js +0 -65
- package/dist/models/SampleRequest.d.ts +0 -39
- package/dist/models/SampleRequest.js +0 -53
- package/dist/models/ServiceConnection.d.ts +0 -37
- package/dist/models/ServiceConnection.js +0 -53
- package/dist/models/SetUserProjectRoleRequest.d.ts +0 -44
- package/dist/models/SetUserProjectRoleRequest.js +0 -57
- package/dist/models/SftpCredentials.d.ts +0 -49
- package/dist/models/SftpCredentials.js +0 -59
- package/dist/models/Share.d.ts +0 -93
- package/dist/models/Share.js +0 -82
- package/dist/models/ShareDetail.d.ts +0 -112
- package/dist/models/ShareDetail.js +0 -92
- package/dist/models/ShareInput.d.ts +0 -68
- package/dist/models/ShareInput.js +0 -67
- package/dist/models/ShareType.d.ts +0 -24
- package/dist/models/ShareType.js +0 -39
- package/dist/models/Status.d.ts +0 -31
- package/dist/models/Status.js +0 -46
- package/dist/models/StopExecutionResponse.d.ts +0 -37
- package/dist/models/StopExecutionResponse.js +0 -52
- package/dist/models/SyncStatus.d.ts +0 -23
- package/dist/models/SyncStatus.js +0 -38
- package/dist/models/SystemInfoResponse.d.ts +0 -100
- package/dist/models/SystemInfoResponse.js +0 -86
- package/dist/models/Table.d.ts +0 -62
- package/dist/models/Table.js +0 -62
- package/dist/models/Tag.d.ts +0 -44
- package/dist/models/Tag.js +0 -55
- package/dist/models/Task.d.ts +0 -79
- package/dist/models/Task.js +0 -70
- package/dist/models/TenantInfo.d.ts +0 -87
- package/dist/models/TenantInfo.js +0 -79
- package/dist/models/UpdateDatasetRequest.d.ts +0 -50
- package/dist/models/UpdateDatasetRequest.js +0 -60
- package/dist/models/UpdateUserRequest.d.ts +0 -74
- package/dist/models/UpdateUserRequest.js +0 -67
- package/dist/models/UploadDatasetCreateResponse.d.ts +0 -49
- package/dist/models/UploadDatasetCreateResponse.js +0 -59
- package/dist/models/UploadDatasetRequest.d.ts +0 -56
- package/dist/models/UploadDatasetRequest.js +0 -62
- package/dist/models/User.d.ts +0 -49
- package/dist/models/User.js +0 -59
- package/dist/models/UserDetail.d.ts +0 -99
- package/dist/models/UserDetail.js +0 -85
- package/dist/models/UserProjectAssignment.d.ts +0 -50
- package/dist/models/UserProjectAssignment.js +0 -60
- package/dist/models/UserSettings.d.ts +0 -32
- package/dist/models/UserSettings.js +0 -57
- package/dist/models/ValidateFileRequirementsRequest.d.ts +0 -37
- package/dist/models/ValidateFileRequirementsRequest.js +0 -53
- package/dist/models/index.d.ts +0 -132
- package/dist/models/index.js +0 -150
- package/dist/runtime.d.ts +0 -182
- package/dist/runtime.js +0 -562
package/dist/runtime.d.ts
DELETED
|
@@ -1,182 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Cirro Data
|
|
3
|
-
* Cirro Data Platform service API
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: latest
|
|
6
|
-
* Contact: support@cirro.bio
|
|
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
|
-
}
|