@teemill/gfn-catalog 0.1.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 +21 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +45 -0
- package/dist/apis/ProductsApi.d.ts +33 -0
- package/dist/apis/ProductsApi.js +160 -0
- package/dist/apis/VariantsApi.d.ts +48 -0
- package/dist/apis/VariantsApi.js +229 -0
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +20 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +21 -0
- package/dist/models/ApiError.d.ts +37 -0
- package/dist/models/ApiError.js +53 -0
- package/dist/models/Attribute.d.ts +50 -0
- package/dist/models/Attribute.js +59 -0
- package/dist/models/AttributeThumbnail.d.ts +46 -0
- package/dist/models/AttributeThumbnail.js +60 -0
- package/dist/models/Image.d.ts +67 -0
- package/dist/models/Image.js +62 -0
- package/dist/models/Product.d.ts +56 -0
- package/dist/models/Product.js +60 -0
- package/dist/models/ProductsResponse.d.ts +32 -0
- package/dist/models/ProductsResponse.js +51 -0
- package/dist/models/Variant.d.ts +64 -0
- package/dist/models/Variant.js +65 -0
- package/dist/models/VariantProduct.d.ts +37 -0
- package/dist/models/VariantProduct.js +52 -0
- package/dist/models/VariantsResponse.d.ts +32 -0
- package/dist/models/VariantsResponse.js +51 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +27 -0
- package/dist/runtime.d.ts +187 -0
- package/dist/runtime.js +565 -0
- package/package.json +19 -0
- package/src/apis/ProductsApi.ts +103 -0
- package/src/apis/VariantsApi.ts +176 -0
- package/src/apis/index.ts +4 -0
- package/src/index.ts +5 -0
- package/src/models/ApiError.ts +74 -0
- package/src/models/Attribute.ts +98 -0
- package/src/models/AttributeThumbnail.ts +85 -0
- package/src/models/Image.ts +113 -0
- package/src/models/Product.ts +105 -0
- package/src/models/ProductsResponse.ts +72 -0
- package/src/models/Variant.ts +126 -0
- package/src/models/VariantProduct.ts +73 -0
- package/src/models/VariantsResponse.ts +72 -0
- package/src/models/index.ts +11 -0
- package/src/runtime.ts +441 -0
- package/tsconfig.json +20 -0
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* GFN Catalog API
|
|
6
|
+
* Manage Teemill GFN Products For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
* Contact: hello@teemill.com
|
|
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.VariantToJSON = exports.VariantFromJSONTyped = exports.VariantFromJSON = exports.instanceOfVariant = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var Attribute_1 = require("./Attribute");
|
|
19
|
+
var Image_1 = require("./Image");
|
|
20
|
+
var VariantProduct_1 = require("./VariantProduct");
|
|
21
|
+
/**
|
|
22
|
+
* Check if a given object implements the Variant interface.
|
|
23
|
+
*/
|
|
24
|
+
function instanceOfVariant(value) {
|
|
25
|
+
var isInstance = true;
|
|
26
|
+
isInstance = isInstance && "sku" in value;
|
|
27
|
+
isInstance = isInstance && "attributes" in value;
|
|
28
|
+
return isInstance;
|
|
29
|
+
}
|
|
30
|
+
exports.instanceOfVariant = instanceOfVariant;
|
|
31
|
+
function VariantFromJSON(json) {
|
|
32
|
+
return VariantFromJSONTyped(json, false);
|
|
33
|
+
}
|
|
34
|
+
exports.VariantFromJSON = VariantFromJSON;
|
|
35
|
+
function VariantFromJSONTyped(json, ignoreDiscriminator) {
|
|
36
|
+
if ((json === undefined) || (json === null)) {
|
|
37
|
+
return json;
|
|
38
|
+
}
|
|
39
|
+
return {
|
|
40
|
+
'id': !(0, runtime_1.exists)(json, 'id') ? undefined : json['id'],
|
|
41
|
+
'ref': !(0, runtime_1.exists)(json, 'ref') ? undefined : json['ref'],
|
|
42
|
+
'product': !(0, runtime_1.exists)(json, 'product') ? undefined : (0, VariantProduct_1.VariantProductFromJSON)(json['product']),
|
|
43
|
+
'sku': json['sku'],
|
|
44
|
+
'attributes': (json['attributes'].map(Attribute_1.AttributeFromJSON)),
|
|
45
|
+
'images': !(0, runtime_1.exists)(json, 'images') ? undefined : (json['images'].map(Image_1.ImageFromJSON)),
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
exports.VariantFromJSONTyped = VariantFromJSONTyped;
|
|
49
|
+
function VariantToJSON(value) {
|
|
50
|
+
if (value === undefined) {
|
|
51
|
+
return undefined;
|
|
52
|
+
}
|
|
53
|
+
if (value === null) {
|
|
54
|
+
return null;
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
'id': value.id,
|
|
58
|
+
'ref': value.ref,
|
|
59
|
+
'product': (0, VariantProduct_1.VariantProductToJSON)(value.product),
|
|
60
|
+
'sku': value.sku,
|
|
61
|
+
'attributes': (value.attributes.map(Attribute_1.AttributeToJSON)),
|
|
62
|
+
'images': value.images === undefined ? undefined : (value.images.map(Image_1.ImageToJSON)),
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
exports.VariantToJSON = VariantToJSON;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GFN Catalog API
|
|
3
|
+
* Manage Teemill GFN Products For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
* Contact: hello@teemill.com
|
|
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 VariantProduct
|
|
16
|
+
*/
|
|
17
|
+
export interface VariantProduct {
|
|
18
|
+
/**
|
|
19
|
+
* Unique object identifier
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof VariantProduct
|
|
22
|
+
*/
|
|
23
|
+
id?: string;
|
|
24
|
+
/**
|
|
25
|
+
* A reference to the resource location
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof VariantProduct
|
|
28
|
+
*/
|
|
29
|
+
ref?: string;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* Check if a given object implements the VariantProduct interface.
|
|
33
|
+
*/
|
|
34
|
+
export declare function instanceOfVariantProduct(value: object): boolean;
|
|
35
|
+
export declare function VariantProductFromJSON(json: any): VariantProduct;
|
|
36
|
+
export declare function VariantProductFromJSONTyped(json: any, ignoreDiscriminator: boolean): VariantProduct;
|
|
37
|
+
export declare function VariantProductToJSON(value?: VariantProduct | null): any;
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* GFN Catalog API
|
|
6
|
+
* Manage Teemill GFN Products For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
* Contact: hello@teemill.com
|
|
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.VariantProductToJSON = exports.VariantProductFromJSONTyped = exports.VariantProductFromJSON = exports.instanceOfVariantProduct = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the VariantProduct interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfVariantProduct(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfVariantProduct = instanceOfVariantProduct;
|
|
26
|
+
function VariantProductFromJSON(json) {
|
|
27
|
+
return VariantProductFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.VariantProductFromJSON = VariantProductFromJSON;
|
|
30
|
+
function VariantProductFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'id': !(0, runtime_1.exists)(json, 'id') ? undefined : json['id'],
|
|
36
|
+
'ref': !(0, runtime_1.exists)(json, 'ref') ? undefined : json['ref'],
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
exports.VariantProductFromJSONTyped = VariantProductFromJSONTyped;
|
|
40
|
+
function VariantProductToJSON(value) {
|
|
41
|
+
if (value === undefined) {
|
|
42
|
+
return undefined;
|
|
43
|
+
}
|
|
44
|
+
if (value === null) {
|
|
45
|
+
return null;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'id': value.id,
|
|
49
|
+
'ref': value.ref,
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
exports.VariantProductToJSON = VariantProductToJSON;
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GFN Catalog API
|
|
3
|
+
* Manage Teemill GFN Products For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
* Contact: hello@teemill.com
|
|
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
|
+
import type { Variant } from './Variant';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface VariantsResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface VariantsResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {Array<Variant>}
|
|
22
|
+
* @memberof VariantsResponse
|
|
23
|
+
*/
|
|
24
|
+
variants?: Array<Variant>;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Check if a given object implements the VariantsResponse interface.
|
|
28
|
+
*/
|
|
29
|
+
export declare function instanceOfVariantsResponse(value: object): boolean;
|
|
30
|
+
export declare function VariantsResponseFromJSON(json: any): VariantsResponse;
|
|
31
|
+
export declare function VariantsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VariantsResponse;
|
|
32
|
+
export declare function VariantsResponseToJSON(value?: VariantsResponse | null): any;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* GFN Catalog API
|
|
6
|
+
* Manage Teemill GFN Products For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 0.1.0
|
|
9
|
+
* Contact: hello@teemill.com
|
|
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.VariantsResponseToJSON = exports.VariantsResponseFromJSONTyped = exports.VariantsResponseFromJSON = exports.instanceOfVariantsResponse = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var Variant_1 = require("./Variant");
|
|
19
|
+
/**
|
|
20
|
+
* Check if a given object implements the VariantsResponse interface.
|
|
21
|
+
*/
|
|
22
|
+
function instanceOfVariantsResponse(value) {
|
|
23
|
+
var isInstance = true;
|
|
24
|
+
return isInstance;
|
|
25
|
+
}
|
|
26
|
+
exports.instanceOfVariantsResponse = instanceOfVariantsResponse;
|
|
27
|
+
function VariantsResponseFromJSON(json) {
|
|
28
|
+
return VariantsResponseFromJSONTyped(json, false);
|
|
29
|
+
}
|
|
30
|
+
exports.VariantsResponseFromJSON = VariantsResponseFromJSON;
|
|
31
|
+
function VariantsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
32
|
+
if ((json === undefined) || (json === null)) {
|
|
33
|
+
return json;
|
|
34
|
+
}
|
|
35
|
+
return {
|
|
36
|
+
'variants': !(0, runtime_1.exists)(json, 'variants') ? undefined : (json['variants'].map(Variant_1.VariantFromJSON)),
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
exports.VariantsResponseFromJSONTyped = VariantsResponseFromJSONTyped;
|
|
40
|
+
function VariantsResponseToJSON(value) {
|
|
41
|
+
if (value === undefined) {
|
|
42
|
+
return undefined;
|
|
43
|
+
}
|
|
44
|
+
if (value === null) {
|
|
45
|
+
return null;
|
|
46
|
+
}
|
|
47
|
+
return {
|
|
48
|
+
'variants': value.variants === undefined ? undefined : (value.variants.map(Variant_1.VariantToJSON)),
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
exports.VariantsResponseToJSON = VariantsResponseToJSON;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export * from './ApiError';
|
|
2
|
+
export * from './Attribute';
|
|
3
|
+
export * from './AttributeThumbnail';
|
|
4
|
+
export * from './Image';
|
|
5
|
+
export * from './Product';
|
|
6
|
+
export * from './ProductsResponse';
|
|
7
|
+
export * from './Variant';
|
|
8
|
+
export * from './VariantProduct';
|
|
9
|
+
export * from './VariantsResponse';
|
|
@@ -0,0 +1,27 @@
|
|
|
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("./ApiError"), exports);
|
|
20
|
+
__exportStar(require("./Attribute"), exports);
|
|
21
|
+
__exportStar(require("./AttributeThumbnail"), exports);
|
|
22
|
+
__exportStar(require("./Image"), exports);
|
|
23
|
+
__exportStar(require("./Product"), exports);
|
|
24
|
+
__exportStar(require("./ProductsResponse"), exports);
|
|
25
|
+
__exportStar(require("./Variant"), exports);
|
|
26
|
+
__exportStar(require("./VariantProduct"), exports);
|
|
27
|
+
__exportStar(require("./VariantsResponse"), exports);
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* GFN Catalog API
|
|
3
|
+
* Manage Teemill GFN Products For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 0.1.0
|
|
6
|
+
* Contact: hello@teemill.com
|
|
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 type OptionalProperties<T> = {
|
|
13
|
+
[K in keyof T]-?: undefined extends T[K] ? K : never;
|
|
14
|
+
}[keyof T];
|
|
15
|
+
export type OptionalOnly<T> = Partial<Pick<T, OptionalProperties<T>>>;
|
|
16
|
+
export declare const BASE_PATH: string;
|
|
17
|
+
export interface ConfigurationParameters {
|
|
18
|
+
basePath?: string;
|
|
19
|
+
fetchApi?: FetchAPI;
|
|
20
|
+
middleware?: Middleware[];
|
|
21
|
+
queryParamsStringify?: (params: HTTPQuery) => string;
|
|
22
|
+
username?: string;
|
|
23
|
+
password?: string;
|
|
24
|
+
apiKey?: string | ((name: string) => string);
|
|
25
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
|
|
26
|
+
headers?: HTTPHeaders;
|
|
27
|
+
credentials?: RequestCredentials;
|
|
28
|
+
}
|
|
29
|
+
export declare class Configuration {
|
|
30
|
+
private configuration;
|
|
31
|
+
constructor(configuration?: ConfigurationParameters);
|
|
32
|
+
set config(configuration: Configuration);
|
|
33
|
+
get basePath(): string;
|
|
34
|
+
get fetchApi(): FetchAPI | undefined;
|
|
35
|
+
get middleware(): Middleware[];
|
|
36
|
+
get queryParamsStringify(): (params: HTTPQuery) => string;
|
|
37
|
+
get username(): string | undefined;
|
|
38
|
+
get password(): string | undefined;
|
|
39
|
+
get apiKey(): ((name: string) => string) | undefined;
|
|
40
|
+
get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
|
|
41
|
+
get headers(): HTTPHeaders | undefined;
|
|
42
|
+
get credentials(): RequestCredentials | undefined;
|
|
43
|
+
}
|
|
44
|
+
export declare const DefaultConfig: Configuration;
|
|
45
|
+
/**
|
|
46
|
+
* This is the base class for all generated API classes.
|
|
47
|
+
*/
|
|
48
|
+
export declare class BaseAPI {
|
|
49
|
+
protected configuration: Configuration;
|
|
50
|
+
private static readonly jsonRegex;
|
|
51
|
+
private middleware;
|
|
52
|
+
constructor(configuration?: Configuration);
|
|
53
|
+
isResponseError(error: any): error is ResponseError;
|
|
54
|
+
withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
|
|
55
|
+
withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
|
|
56
|
+
withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
|
|
57
|
+
/**
|
|
58
|
+
* Check if the given MIME is a JSON MIME.
|
|
59
|
+
* JSON MIME examples:
|
|
60
|
+
* application/json
|
|
61
|
+
* application/json; charset=UTF8
|
|
62
|
+
* APPLICATION/JSON
|
|
63
|
+
* application/vnd.company+json
|
|
64
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
65
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
66
|
+
*/
|
|
67
|
+
protected isJsonMime(mime: string | null | undefined): boolean;
|
|
68
|
+
protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
|
|
69
|
+
private createFetchParams;
|
|
70
|
+
private fetchApi;
|
|
71
|
+
/**
|
|
72
|
+
* Create a shallow clone of `this` by constructing a new instance
|
|
73
|
+
* and then shallow cloning data members.
|
|
74
|
+
*/
|
|
75
|
+
private clone;
|
|
76
|
+
}
|
|
77
|
+
export declare class ResponseError extends Error {
|
|
78
|
+
response: Response;
|
|
79
|
+
name: "ResponseError";
|
|
80
|
+
constructor(response: Response, msg?: string);
|
|
81
|
+
}
|
|
82
|
+
export declare class FetchError extends Error {
|
|
83
|
+
cause: Error;
|
|
84
|
+
name: "FetchError";
|
|
85
|
+
constructor(cause: Error, msg?: string);
|
|
86
|
+
}
|
|
87
|
+
export declare class RequiredError extends Error {
|
|
88
|
+
field: string;
|
|
89
|
+
name: "RequiredError";
|
|
90
|
+
constructor(field: string, msg?: string);
|
|
91
|
+
}
|
|
92
|
+
export declare const COLLECTION_FORMATS: {
|
|
93
|
+
csv: string;
|
|
94
|
+
ssv: string;
|
|
95
|
+
tsv: string;
|
|
96
|
+
pipes: string;
|
|
97
|
+
};
|
|
98
|
+
export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
|
|
99
|
+
export type Json = any;
|
|
100
|
+
export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
|
|
101
|
+
export type HTTPHeaders = {
|
|
102
|
+
[key: string]: string;
|
|
103
|
+
};
|
|
104
|
+
export type HTTPQuery = {
|
|
105
|
+
[key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
|
|
106
|
+
};
|
|
107
|
+
export type HTTPBody = Json | FormData | URLSearchParams;
|
|
108
|
+
export type HTTPRequestInit = {
|
|
109
|
+
headers?: HTTPHeaders;
|
|
110
|
+
method: HTTPMethod;
|
|
111
|
+
credentials?: RequestCredentials;
|
|
112
|
+
body?: HTTPBody;
|
|
113
|
+
};
|
|
114
|
+
export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
|
|
115
|
+
export type InitOverrideFunction = (requestContext: {
|
|
116
|
+
init: HTTPRequestInit;
|
|
117
|
+
context: RequestOpts;
|
|
118
|
+
}) => Promise<RequestInit>;
|
|
119
|
+
export interface FetchParams {
|
|
120
|
+
url: string;
|
|
121
|
+
init: RequestInit;
|
|
122
|
+
}
|
|
123
|
+
export interface RequestOpts {
|
|
124
|
+
path: string;
|
|
125
|
+
method: HTTPMethod;
|
|
126
|
+
headers: HTTPHeaders;
|
|
127
|
+
query?: HTTPQuery;
|
|
128
|
+
body?: HTTPBody;
|
|
129
|
+
}
|
|
130
|
+
export declare function exists(json: any, key: string): boolean;
|
|
131
|
+
export declare function querystring(params: HTTPQuery, prefix?: string): string;
|
|
132
|
+
export declare function mapValues(data: any, fn: (item: any) => any): {};
|
|
133
|
+
export declare function canConsumeForm(consumes: Consume[]): boolean;
|
|
134
|
+
export interface Consume {
|
|
135
|
+
contentType: string;
|
|
136
|
+
}
|
|
137
|
+
export interface RequestContext {
|
|
138
|
+
fetch: FetchAPI;
|
|
139
|
+
url: string;
|
|
140
|
+
init: RequestInit;
|
|
141
|
+
}
|
|
142
|
+
export interface ResponseContext {
|
|
143
|
+
fetch: FetchAPI;
|
|
144
|
+
url: string;
|
|
145
|
+
init: RequestInit;
|
|
146
|
+
response: Response;
|
|
147
|
+
}
|
|
148
|
+
export interface ErrorContext {
|
|
149
|
+
fetch: FetchAPI;
|
|
150
|
+
url: string;
|
|
151
|
+
init: RequestInit;
|
|
152
|
+
error: unknown;
|
|
153
|
+
response?: Response;
|
|
154
|
+
}
|
|
155
|
+
export interface Middleware {
|
|
156
|
+
pre?(context: RequestContext): Promise<FetchParams | void>;
|
|
157
|
+
post?(context: ResponseContext): Promise<Response | void>;
|
|
158
|
+
onError?(context: ErrorContext): Promise<Response | void>;
|
|
159
|
+
}
|
|
160
|
+
export interface ApiResponse<T> {
|
|
161
|
+
raw: Response;
|
|
162
|
+
value(): Promise<T>;
|
|
163
|
+
}
|
|
164
|
+
export interface ResponseTransformer<T> {
|
|
165
|
+
(json: any): T;
|
|
166
|
+
}
|
|
167
|
+
export declare class JSONApiResponse<T> {
|
|
168
|
+
raw: Response;
|
|
169
|
+
private transformer;
|
|
170
|
+
constructor(raw: Response, transformer?: ResponseTransformer<T>);
|
|
171
|
+
value(): Promise<T>;
|
|
172
|
+
}
|
|
173
|
+
export declare class VoidApiResponse {
|
|
174
|
+
raw: Response;
|
|
175
|
+
constructor(raw: Response);
|
|
176
|
+
value(): Promise<void>;
|
|
177
|
+
}
|
|
178
|
+
export declare class BlobApiResponse {
|
|
179
|
+
raw: Response;
|
|
180
|
+
constructor(raw: Response);
|
|
181
|
+
value(): Promise<Blob>;
|
|
182
|
+
}
|
|
183
|
+
export declare class TextApiResponse {
|
|
184
|
+
raw: Response;
|
|
185
|
+
constructor(raw: Response);
|
|
186
|
+
value(): Promise<string>;
|
|
187
|
+
}
|