@api7/portal-sdk 0.0.1
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/LICENSE +201 -0
- package/README.md +53 -0
- package/dist/api_product.d.ts +26 -0
- package/dist/api_product.d.ts.map +1 -0
- package/dist/application.d.ts +55 -0
- package/dist/application.d.ts.map +1 -0
- package/dist/credential.d.ts +18 -0
- package/dist/credential.d.ts.map +1 -0
- package/dist/developer.d.ts +27 -0
- package/dist/developer.d.ts.map +1 -0
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/index.d.ts +9 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/types.gen.d.ts +89 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +15 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.d.ts +13 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +19 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.d.ts +44 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.d.ts +79 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +20 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/index.d.ts +3 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/sdk.gen.d.ts +124 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/transformers.gen.d.ts +16 -0
- package/dist/generated/transformers.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.d.ts +2095 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/index.cjs +7 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1025 -0
- package/dist/miscellaneous.d.ts +34 -0
- package/dist/miscellaneous.d.ts.map +1 -0
- package/dist/subscription.d.ts +27 -0
- package/dist/subscription.d.ts.map +1 -0
- package/dist/utils.d.ts +35 -0
- package/dist/utils.d.ts.map +1 -0
- package/package.json +43 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { DeveloperPortalLabelResourceType, AllLabels, ListDcrProvidersData, ListDcrProvidersResponses } from './generated/index.js';
|
|
2
|
+
import { Client } from './generated/client/types.gen.js';
|
|
3
|
+
export declare class DCRProviderAPI {
|
|
4
|
+
private readonly client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* List all DCR providers.
|
|
8
|
+
* @returns The list of DCR providers.
|
|
9
|
+
* @throws {APIError} If the API request fails or network error occurs.
|
|
10
|
+
*/
|
|
11
|
+
list(query?: ListDcrProvidersData['query']): Promise<ListDcrProvidersResponses['200']>;
|
|
12
|
+
}
|
|
13
|
+
export declare class SystemSettingAPI {
|
|
14
|
+
private readonly client;
|
|
15
|
+
constructor(client: Client);
|
|
16
|
+
/**
|
|
17
|
+
* Get public access settings.
|
|
18
|
+
* @returns Whether the developer portal is publicly accessible.
|
|
19
|
+
* @throws {APIError} If the API request fails or network error occurs.
|
|
20
|
+
*/
|
|
21
|
+
getPublicAccess(): Promise<boolean>;
|
|
22
|
+
}
|
|
23
|
+
export declare class MiscellaneousAPI {
|
|
24
|
+
private readonly client;
|
|
25
|
+
constructor(client: Client);
|
|
26
|
+
/**
|
|
27
|
+
* Get list of labels for a given resource type.
|
|
28
|
+
* @param type The resource type.
|
|
29
|
+
* @returns The list of labels.
|
|
30
|
+
* @throws {APIError} If the API request fails or network error occurs.
|
|
31
|
+
*/
|
|
32
|
+
listLabels(type: DeveloperPortalLabelResourceType): Promise<AllLabels>;
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=miscellaneous.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"miscellaneous.d.ts","sourceRoot":"","sources":["../src/miscellaneous.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,gCAAgC,EAChC,SAAS,EACT,oBAAoB,EACpB,yBAAyB,EAC1B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAGzD,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAE3C;;;;OAIG;IACU,IAAI,CACf,KAAK,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,GACpC,OAAO,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;CAK7C;AAED,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAE3C;;;;OAIG;IACU,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;CAKjD;AAED,qBAAa,gBAAgB;IACf,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAE3C;;;;;OAKG;IACU,UAAU,CACrB,IAAI,EAAE,gCAAgC,GACrC,OAAO,CAAC,SAAS,CAAC;CAKtB"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { CreateSubscriptionReq, ListSubscriptionsData, ListSubscriptionsResponses } from './generated/index.js';
|
|
2
|
+
import { Client } from './generated/client/types.gen.js';
|
|
3
|
+
export declare class SubscriptionAPI {
|
|
4
|
+
private readonly client;
|
|
5
|
+
constructor(client: Client);
|
|
6
|
+
/**
|
|
7
|
+
* List all subscriptions.
|
|
8
|
+
* @param query Optional query parameters.
|
|
9
|
+
* @returns The list of subscriptions.
|
|
10
|
+
* @throws {APIError} If the API request fails or network error occurs.
|
|
11
|
+
*/
|
|
12
|
+
list(query?: ListSubscriptionsData['query']): Promise<ListSubscriptionsResponses['200']>;
|
|
13
|
+
/**
|
|
14
|
+
* Bulk subscribe to products
|
|
15
|
+
* @returns The created subscription.
|
|
16
|
+
* @throws {APIError} If the API request fails or network error occurs.
|
|
17
|
+
*/
|
|
18
|
+
bulkSubscribe(data: CreateSubscriptionReq): Promise<void>;
|
|
19
|
+
/**
|
|
20
|
+
* Unsubscribe from a subscription by ID.
|
|
21
|
+
* @param id The subscription ID.
|
|
22
|
+
* @returns The result of the unsubscription.
|
|
23
|
+
* @throws {APIError} If the API request fails or network error occurs.
|
|
24
|
+
*/
|
|
25
|
+
unsubscribe(id: string): Promise<void>;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=subscription.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../src/subscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,qBAAqB,EAGrB,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAGzD,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAE3C;;;;;OAKG;IACU,IAAI,CACf,KAAK,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,GACrC,OAAO,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC;IAM7C;;;;OAIG;IACU,aAAa,CAAC,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItE;;;;;OAKG;IACU,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAQpD"}
|
package/dist/utils.d.ts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { AxiosError, AxiosResponse } from 'axios';
|
|
2
|
+
export declare const attachDeveloperIdHeader: (id: string, headers?: Record<string, string>) => {
|
|
3
|
+
'X-Portal-Developer-ID': string;
|
|
4
|
+
};
|
|
5
|
+
type ResponseNormal<TData> = AxiosResponse<TData> & {
|
|
6
|
+
error: undefined;
|
|
7
|
+
};
|
|
8
|
+
type ResponseAbnormal<TError> = AxiosError<TError> & {
|
|
9
|
+
data: undefined;
|
|
10
|
+
error: TError;
|
|
11
|
+
};
|
|
12
|
+
type Response<TData, TError> = ResponseNormal<TData> | ResponseAbnormal<TError>;
|
|
13
|
+
export declare class APIError extends Error {
|
|
14
|
+
#private;
|
|
15
|
+
message: string;
|
|
16
|
+
status: number;
|
|
17
|
+
method: string;
|
|
18
|
+
url: string;
|
|
19
|
+
constructor(message: string, status: number, method: string, url: string, raw: AxiosError);
|
|
20
|
+
static fromAxiosError: <TError>(error: ResponseAbnormal<TError>) => APIError;
|
|
21
|
+
/**
|
|
22
|
+
* Check if the given error is an instance of APIError.
|
|
23
|
+
* @param error The error to check.
|
|
24
|
+
* @returns True if the error is an instance of APIError, false otherwise.
|
|
25
|
+
*/
|
|
26
|
+
static isAPIError: (error: unknown) => error is APIError;
|
|
27
|
+
/**
|
|
28
|
+
* Get the original raw Axios error.
|
|
29
|
+
* @returns {AxiosError} The original Axios error.
|
|
30
|
+
*/
|
|
31
|
+
rawError(): AxiosError;
|
|
32
|
+
}
|
|
33
|
+
export declare const transformResponse: <TData, TError>(resp: Response<TData, TError>) => TData;
|
|
34
|
+
export {};
|
|
35
|
+
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAElD,eAAO,MAAM,uBAAuB,GAClC,IAAI,MAAM,EACV,UAAU,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;;CAIhC,CAAC;AAEH,KAAK,cAAc,CAAC,KAAK,IAAI,aAAa,CAAC,KAAK,CAAC,GAAG;IAAE,KAAK,EAAE,SAAS,CAAA;CAAE,CAAC;AACzE,KAAK,gBAAgB,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,GAAG;IACnD,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AACF,KAAK,QAAQ,CAAC,KAAK,EAAE,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAEhF,qBAAa,QAAS,SAAQ,KAAK;;IAIf,OAAO,EAAE,MAAM;IACxB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,MAAM;IACd,GAAG,EAAE,MAAM;gBAHF,OAAO,EAAE,MAAM,EACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EAClB,GAAG,EAAE,UAAU;IAOjB,MAAM,CAAC,cAAc,GAAI,MAAM,EAAE,OAAO,gBAAgB,CAAC,MAAM,CAAC,cAiB9D;IAEF;;;;OAIG;IACH,MAAM,CAAC,UAAU,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,QAAQ,CAC3B;IAE5B;;;OAGG;IACI,QAAQ,IAAI,UAAU;CAG9B;AAED,eAAO,MAAM,iBAAiB,GAAI,KAAK,EAAE,MAAM,EAC7C,MAAM,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,KAIT,KACrB,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@api7/portal-sdk",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"license": "Apache-2.0",
|
|
5
|
+
"repository": {
|
|
6
|
+
"url": "https://github.com/api7/portal-sdk-typescript"
|
|
7
|
+
},
|
|
8
|
+
"type": "module",
|
|
9
|
+
"main": "./dist/index.js",
|
|
10
|
+
"module": "./dist/index.js",
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
"./package.json": "./package.json",
|
|
14
|
+
".": {
|
|
15
|
+
"types": "./dist/index.d.ts",
|
|
16
|
+
"import": "./dist/index.js",
|
|
17
|
+
"require": "./dist/index.cjs",
|
|
18
|
+
"default": "./dist/index.js"
|
|
19
|
+
}
|
|
20
|
+
},
|
|
21
|
+
"files": [
|
|
22
|
+
"dist",
|
|
23
|
+
"!**/*.tsbuildinfo"
|
|
24
|
+
],
|
|
25
|
+
"devDependencies": {
|
|
26
|
+
"@hey-api/openapi-ts": "0.89.2"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"axios": "^1.13.2"
|
|
30
|
+
},
|
|
31
|
+
"nx": {
|
|
32
|
+
"name": "portal-sdk",
|
|
33
|
+
"targets": {
|
|
34
|
+
"openapi-ts": {
|
|
35
|
+
"executor": "nx:run-commands",
|
|
36
|
+
"options": {
|
|
37
|
+
"command": "openapi-ts",
|
|
38
|
+
"cwd": "packages/portal-sdk"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|