@shapediver/sdk.platform-api-sdk-v1 2.14.1 → 2.14.4
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 +7 -7
- package/README.md +61 -61
- package/dist/SdPlatformErrors.d.ts +134 -134
- package/dist/SdPlatformSdk.d.ts +197 -191
- package/dist/SdPlatformSdk.d.ts.map +1 -1
- package/dist/SdPlatformSdkContext.d.ts +71 -71
- package/dist/SdPlatformSdkCreate.d.ts +7 -7
- package/dist/api/SdPlatformRequestId.d.ts +139 -138
- package/dist/api/SdPlatformRequestId.d.ts.map +1 -1
- package/dist/api/SdPlatformSdkApi.d.ts +66 -66
- package/dist/api/SdPlatformSdkConfig.d.ts +18 -18
- package/dist/api/SdPlatformSdkErrorMapping.d.ts +6 -6
- package/dist/auth/SdPlatformAuthServiceApi.d.ts +79 -79
- package/dist/bundle.js +3978 -3931
- package/dist/bundle.node.js +4103 -4033
- package/dist/index.d.ts +28 -27
- package/dist/index.d.ts.map +1 -1
- package/dist/resources/SdPlatformApiClientsApi.d.ts +43 -43
- package/dist/resources/SdPlatformApiClientsApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformApiTokenApi.d.ts +43 -43
- package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBackendSystemApi.d.ts +43 -43
- package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBookmarkApi.d.ts +24 -24
- package/dist/resources/SdPlatformChargebeeApi.d.ts +43 -43
- package/dist/resources/SdPlatformChargebeeApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
- package/dist/resources/SdPlatformDocumentApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformDomainApi.d.ts +46 -46
- package/dist/resources/SdPlatformDomainApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformHttpLogApi.d.ts +16 -16
- package/dist/resources/SdPlatformHttpLogApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformImageApi.d.ts +44 -44
- package/dist/resources/SdPlatformImageApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformJobLogApi.d.ts +16 -16
- package/dist/resources/SdPlatformJobLogApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelApi.d.ts +78 -78
- package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelSharingApi.d.ts +65 -65
- package/dist/resources/SdPlatformModelSharingApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelTokenApi.d.ts +15 -15
- package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -47
- package/dist/resources/SdPlatformNotificationApi.d.ts +65 -65
- package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformOpenIDProviderApi.d.ts +41 -41
- package/dist/resources/SdPlatformOpenIDProviderApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts +15 -15
- package/dist/resources/SdPlatformOrganizationApi.d.ts +95 -95
- package/dist/resources/SdPlatformOrganizationApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformPolicyApi.d.ts +43 -43
- package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformSavedStateApi.d.ts +51 -51
- package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +66 -66
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformStargateApi.d.ts +13 -0
- package/dist/resources/SdPlatformStargateApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformTagApi.d.ts +25 -25
- package/dist/resources/SdPlatformTagApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformUserAnalyticsApi.d.ts +15 -15
- package/dist/resources/SdPlatformUserApi.d.ts +86 -86
- package/dist/resources/SdPlatformUserApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformWebhookApi.d.ts +52 -52
- package/dist/resources/commons/FilterBuilder.d.ts +54 -54
- package/dist/resources/commons/ResourcesApi.d.ts +42 -42
- package/package.json +14 -12
package/dist/index.d.ts
CHANGED
|
@@ -1,28 +1,29 @@
|
|
|
1
|
-
export * from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
export * from "./api/SdPlatformRequestId";
|
|
3
|
-
export * from "./auth/SdPlatformAuthServiceApi";
|
|
4
|
-
export * from "./resources/SdPlatformApiTokenApi";
|
|
5
|
-
export * from "./resources/SdPlatformBackendSystemApi";
|
|
6
|
-
export * from "./resources/SdPlatformBookmarkApi";
|
|
7
|
-
export * from "./resources/SdPlatformChargebeeApi";
|
|
8
|
-
export * from "./resources/SdPlatformDomainApi";
|
|
9
|
-
export * from "./resources/SdPlatformHttpLogApi";
|
|
10
|
-
export * from "./resources/SdPlatformImageApi";
|
|
11
|
-
export * from "./resources/SdPlatformModelApi";
|
|
12
|
-
export * from "./resources/SdPlatformModelSharingApi";
|
|
13
|
-
export * from "./resources/SdPlatformModelTokenApi";
|
|
14
|
-
export * from "./resources/SdPlatformModelTransferApi";
|
|
15
|
-
export * from "./resources/SdPlatformNotificationApi";
|
|
16
|
-
export * from "./resources/
|
|
17
|
-
export * from "./resources/
|
|
18
|
-
export * from "./resources/
|
|
19
|
-
export * from "./resources/
|
|
20
|
-
export * from "./resources/
|
|
21
|
-
export * from "./resources/
|
|
22
|
-
export * from "./resources/
|
|
23
|
-
export * from "./resources/
|
|
24
|
-
export * from "./
|
|
25
|
-
export * from "./
|
|
26
|
-
export * from
|
|
27
|
-
export * from
|
|
1
|
+
export * from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
export * from "./api/SdPlatformRequestId";
|
|
3
|
+
export * from "./auth/SdPlatformAuthServiceApi";
|
|
4
|
+
export * from "./resources/SdPlatformApiTokenApi";
|
|
5
|
+
export * from "./resources/SdPlatformBackendSystemApi";
|
|
6
|
+
export * from "./resources/SdPlatformBookmarkApi";
|
|
7
|
+
export * from "./resources/SdPlatformChargebeeApi";
|
|
8
|
+
export * from "./resources/SdPlatformDomainApi";
|
|
9
|
+
export * from "./resources/SdPlatformHttpLogApi";
|
|
10
|
+
export * from "./resources/SdPlatformImageApi";
|
|
11
|
+
export * from "./resources/SdPlatformModelApi";
|
|
12
|
+
export * from "./resources/SdPlatformModelSharingApi";
|
|
13
|
+
export * from "./resources/SdPlatformModelTokenApi";
|
|
14
|
+
export * from "./resources/SdPlatformModelTransferApi";
|
|
15
|
+
export * from "./resources/SdPlatformNotificationApi";
|
|
16
|
+
export * from "./resources/SdPlatformOpenIDProviderApi";
|
|
17
|
+
export * from "./resources/SdPlatformOrganizationApi";
|
|
18
|
+
export * from "./resources/SdPlatformPolicyApi";
|
|
19
|
+
export * from "./resources/SdPlatformSavedStateApi";
|
|
20
|
+
export * from "./resources/SdPlatformSavedStateSharingApi";
|
|
21
|
+
export * from "./resources/SdPlatformTagApi";
|
|
22
|
+
export * from "./resources/SdPlatformUserAnalyticsApi";
|
|
23
|
+
export * from "./resources/SdPlatformUserApi";
|
|
24
|
+
export * from "./resources/SdPlatformWebhookApi";
|
|
25
|
+
export * from "./SdPlatformSdkContext";
|
|
26
|
+
export * from "./SdPlatformErrors";
|
|
27
|
+
export * from './SdPlatformSdk';
|
|
28
|
+
export * from "./SdPlatformSdkCreate";
|
|
28
29
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AAEpD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,iCAAiC,CAAA;AAE/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,uCAAuC,CAAA;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAA;AACtD,cAAc,uCAAuC,CAAA;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAA;AACnD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAA;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAA;AAEhD,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAC;AAEpD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,iCAAiC,CAAA;AAE/C,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,oCAAoC,CAAC;AACnD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAA;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAA;AAC9C,cAAc,uCAAuC,CAAA;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAA;AACtD,cAAc,uCAAuC,CAAA;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,qCAAqC,CAAA;AACnD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAA;AACtD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAA;AAEhD,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC"}
|
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformResponseApiClient, SdPlatformRequestApiClientCreate, SdPlatformRequestApiClientPatch } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* The embeddable fields for query parameter.
|
|
6
|
-
*/
|
|
7
|
-
export declare enum SdPlatformApiClientsQueryEmbeddableFields {
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* The query parameters for platform api clients.
|
|
11
|
-
*/
|
|
12
|
-
export
|
|
13
|
-
/**
|
|
14
|
-
* API client operations (API clients of the platform backend).
|
|
15
|
-
*/
|
|
16
|
-
export declare class SdPlatformApiClientsApi extends ResourcesApi {
|
|
17
|
-
protected get __resourcePath(): string;
|
|
18
|
-
/**
|
|
19
|
-
* Query the api clients.
|
|
20
|
-
* @param query - {@link SdPlatformApiClientsQueryParameters} optional query parameters
|
|
21
|
-
* @returns query result
|
|
22
|
-
*/
|
|
23
|
-
query(query?: SdPlatformApiClientsQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiClient>>;
|
|
24
|
-
/**
|
|
25
|
-
* Create a new api client.
|
|
26
|
-
* @param body - {@link SdPlatformRequestApiClientCreate} body or parameters for create request.
|
|
27
|
-
* @returns returns created api client response.
|
|
28
|
-
*/
|
|
29
|
-
create(body: SdPlatformRequestApiClientCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiClient>>;
|
|
30
|
-
/**
|
|
31
|
-
* Patch an api client
|
|
32
|
-
* @param id
|
|
33
|
-
* @param body - {@link SdPlatformRequestApiClientPatch} body or patch parameters.
|
|
34
|
-
* @returns patch response.
|
|
35
|
-
*/
|
|
36
|
-
patch(id: string, body: SdPlatformRequestApiClientPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiClient>>;
|
|
37
|
-
/**
|
|
38
|
-
* Delete an api client.
|
|
39
|
-
* @param id
|
|
40
|
-
* @returns delete response.
|
|
41
|
-
*/
|
|
42
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
43
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformResponseApiClient, SdPlatformRequestApiClientCreate, SdPlatformRequestApiClientPatch } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* The embeddable fields for query parameter.
|
|
6
|
+
*/
|
|
7
|
+
export declare enum SdPlatformApiClientsQueryEmbeddableFields {
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* The query parameters for platform api clients.
|
|
11
|
+
*/
|
|
12
|
+
export type SdPlatformApiClientsQueryParameters = SdPlatformQueryParameters<SdPlatformApiClientsQueryEmbeddableFields>;
|
|
13
|
+
/**
|
|
14
|
+
* API client operations (API clients of the platform backend).
|
|
15
|
+
*/
|
|
16
|
+
export declare class SdPlatformApiClientsApi extends ResourcesApi {
|
|
17
|
+
protected get __resourcePath(): string;
|
|
18
|
+
/**
|
|
19
|
+
* Query the api clients.
|
|
20
|
+
* @param query - {@link SdPlatformApiClientsQueryParameters} optional query parameters
|
|
21
|
+
* @returns query result
|
|
22
|
+
*/
|
|
23
|
+
query(query?: SdPlatformApiClientsQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiClient>>;
|
|
24
|
+
/**
|
|
25
|
+
* Create a new api client.
|
|
26
|
+
* @param body - {@link SdPlatformRequestApiClientCreate} body or parameters for create request.
|
|
27
|
+
* @returns returns created api client response.
|
|
28
|
+
*/
|
|
29
|
+
create(body: SdPlatformRequestApiClientCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiClient>>;
|
|
30
|
+
/**
|
|
31
|
+
* Patch an api client
|
|
32
|
+
* @param id
|
|
33
|
+
* @param body - {@link SdPlatformRequestApiClientPatch} body or patch parameters.
|
|
34
|
+
* @returns patch response.
|
|
35
|
+
*/
|
|
36
|
+
patch(id: string, body: SdPlatformRequestApiClientPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiClient>>;
|
|
37
|
+
/**
|
|
38
|
+
* Delete an api client.
|
|
39
|
+
* @param id
|
|
40
|
+
* @returns delete response.
|
|
41
|
+
*/
|
|
42
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
43
|
+
}
|
|
44
44
|
//# sourceMappingURL=SdPlatformApiClientsApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformApiClientsApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiClientsApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AACpJ,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL;;GAEG;AACH,oBAAY,yCAAyC;CACnD;AAGF;;GAEG;AACH,
|
|
1
|
+
{"version":3,"file":"SdPlatformApiClientsApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiClientsApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AACpJ,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL;;GAEG;AACH,oBAAY,yCAAyC;CACnD;AAGF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAEvH;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,mCAAwC,GAAG,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAK5H;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;IAKnH;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAI,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAK/H;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAM/D"}
|
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformRequestApiTokenCreate, SdPlatformRequestApiTokenPatch, SdPlatformResponseApiToken, SdPlatformResponseApiTokenWithSecret } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export
|
|
5
|
-
/**
|
|
6
|
-
* CRUD operations for Platform API tokens.
|
|
7
|
-
* Platform API tokens can be limited in scope and lifetime.
|
|
8
|
-
* Use Platform API tokens for applications making use of the Platform API.
|
|
9
|
-
* Limit their scope as much as possible.
|
|
10
|
-
*/
|
|
11
|
-
export declare class SdPlatformApiTokenApi extends ResourcesApi {
|
|
12
|
-
protected get __resourcePath(): string;
|
|
13
|
-
/**
|
|
14
|
-
* Get the token.
|
|
15
|
-
* @param key_id
|
|
16
|
-
* @returns api token response.
|
|
17
|
-
*/
|
|
18
|
-
get(key_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>>;
|
|
19
|
-
/**
|
|
20
|
-
* Query the API tokens.
|
|
21
|
-
* @param query - {@link SdPlatformApiTokenQueryParameters} optional query parameters.
|
|
22
|
-
* @returns query response with @see {@link SdPlatformResponseApiToken} as result.
|
|
23
|
-
*/
|
|
24
|
-
query(query?: SdPlatformApiTokenQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>>;
|
|
25
|
-
/**
|
|
26
|
-
* Create a token.
|
|
27
|
-
* @param body - {@link SdPlatformRequestApiTokenCreate} body or create token parameters.
|
|
28
|
-
* @returns @see {@link SdPlatformResponseApiTokenWithSecret} as result.
|
|
29
|
-
*/
|
|
30
|
-
create(body: SdPlatformRequestApiTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>>;
|
|
31
|
-
/**
|
|
32
|
-
* Update and API token.
|
|
33
|
-
* @param key_id
|
|
34
|
-
* @param @see {@link SdPlatformRequestApiTokenPatch} patch body with parameters.
|
|
35
|
-
* @returns patch response with @see {@link SdPlatformResponseApiToken}
|
|
36
|
-
*/
|
|
37
|
-
patch(key_id: string, body: SdPlatformRequestApiTokenPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>>;
|
|
38
|
-
/**
|
|
39
|
-
* Delete an API token.
|
|
40
|
-
* @param key_id
|
|
41
|
-
*/
|
|
42
|
-
delete(key_id: string): Promise<SdPlatformDeleteResponse>;
|
|
43
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformRequestApiTokenCreate, SdPlatformRequestApiTokenPatch, SdPlatformResponseApiToken, SdPlatformResponseApiTokenWithSecret } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export type SdPlatformApiTokenQueryParameters = SdPlatformQueryParameters<null>;
|
|
5
|
+
/**
|
|
6
|
+
* CRUD operations for Platform API tokens.
|
|
7
|
+
* Platform API tokens can be limited in scope and lifetime.
|
|
8
|
+
* Use Platform API tokens for applications making use of the Platform API.
|
|
9
|
+
* Limit their scope as much as possible.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SdPlatformApiTokenApi extends ResourcesApi {
|
|
12
|
+
protected get __resourcePath(): string;
|
|
13
|
+
/**
|
|
14
|
+
* Get the token.
|
|
15
|
+
* @param key_id
|
|
16
|
+
* @returns api token response.
|
|
17
|
+
*/
|
|
18
|
+
get(key_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>>;
|
|
19
|
+
/**
|
|
20
|
+
* Query the API tokens.
|
|
21
|
+
* @param query - {@link SdPlatformApiTokenQueryParameters} optional query parameters.
|
|
22
|
+
* @returns query response with @see {@link SdPlatformResponseApiToken} as result.
|
|
23
|
+
*/
|
|
24
|
+
query(query?: SdPlatformApiTokenQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>>;
|
|
25
|
+
/**
|
|
26
|
+
* Create a token.
|
|
27
|
+
* @param body - {@link SdPlatformRequestApiTokenCreate} body or create token parameters.
|
|
28
|
+
* @returns @see {@link SdPlatformResponseApiTokenWithSecret} as result.
|
|
29
|
+
*/
|
|
30
|
+
create(body: SdPlatformRequestApiTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>>;
|
|
31
|
+
/**
|
|
32
|
+
* Update and API token.
|
|
33
|
+
* @param key_id
|
|
34
|
+
* @param @see {@link SdPlatformRequestApiTokenPatch} patch body with parameters.
|
|
35
|
+
* @returns patch response with @see {@link SdPlatformResponseApiToken}
|
|
36
|
+
*/
|
|
37
|
+
patch(key_id: string, body: SdPlatformRequestApiTokenPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>>;
|
|
38
|
+
/**
|
|
39
|
+
* Delete an API token.
|
|
40
|
+
* @param key_id
|
|
41
|
+
*/
|
|
42
|
+
delete(key_id: string): Promise<SdPlatformDeleteResponse>;
|
|
43
|
+
}
|
|
44
44
|
//# sourceMappingURL=SdPlatformApiTokenApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC/K,OAAO,EAAC,yBAAyB,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,oCAAoC,EAAC,MAAM,qCAAqC,CAAC;AAEjN,
|
|
1
|
+
{"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC/K,OAAO,EAAC,yBAAyB,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,oCAAoC,EAAC,MAAM,qCAAqC,CAAC;AAEjN,MAAM,MAAM,iCAAiC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;IAKtF;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKzH;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAK3H;;;;;OAKG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKhI;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAInE"}
|
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformDeleteResponse, SdPlatformRequestBackendSystemCreate, SdPlatformRequestBackendSystemPatch, SdPlatformRequestBackendSystemToken, SdPlatformResponseBackendSystem, SdPlatformResponseBackendSystemAdmin, SdPlatformResponseBackendSystemToken } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* The query parameters for fetching the @see {@link SdPlatformResponseBackendSystem}
|
|
6
|
-
*/
|
|
7
|
-
export
|
|
8
|
-
/**
|
|
9
|
-
* Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
|
|
10
|
-
*/
|
|
11
|
-
export declare class SdPlatformBackendSystemApi extends ResourcesApi {
|
|
12
|
-
protected get __resourcePath(): string;
|
|
13
|
-
/**
|
|
14
|
-
* Query the backend systems.
|
|
15
|
-
* @param query - {@link SdPlatformBackendSystemQueryParameters} query parameters.
|
|
16
|
-
* @returns - {@link SdPlatformQueryResponse} response with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
|
|
17
|
-
*/
|
|
18
|
-
query(query?: SdPlatformBackendSystemQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
|
|
19
|
-
/**
|
|
20
|
-
* Create the backend system.
|
|
21
|
-
* @param body - {@link SdPlatformRequestBackendSystemCreate} body parameters.
|
|
22
|
-
* @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemAdmin} as result.
|
|
23
|
-
*/
|
|
24
|
-
create(body: SdPlatformRequestBackendSystemCreate): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>>;
|
|
25
|
-
/**
|
|
26
|
-
* Updates the backend system.
|
|
27
|
-
* @param id - the backend system id.
|
|
28
|
-
* @param body - {@link SdPlatformRequestBackendSystemPatch} update parameters.
|
|
29
|
-
* @returns - {@link SdPlatformPatchResponse} with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
|
|
30
|
-
*/
|
|
31
|
-
patch(id: string, body: SdPlatformRequestBackendSystemPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
|
|
32
|
-
/**
|
|
33
|
-
* Get a token for interacting with a geometry backend system.
|
|
34
|
-
* @param body - {@link SdPlatformRequestBackendSystemToken} body
|
|
35
|
-
* @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemToken} as result.
|
|
36
|
-
*/
|
|
37
|
-
token(body: SdPlatformRequestBackendSystemToken): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>>;
|
|
38
|
-
/**
|
|
39
|
-
* Delete a backend system.
|
|
40
|
-
* @param id - the id of a backend system
|
|
41
|
-
*/
|
|
42
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
43
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformDeleteResponse, SdPlatformRequestBackendSystemCreate, SdPlatformRequestBackendSystemPatch, SdPlatformRequestBackendSystemToken, SdPlatformResponseBackendSystem, SdPlatformResponseBackendSystemAdmin, SdPlatformResponseBackendSystemToken } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* The query parameters for fetching the @see {@link SdPlatformResponseBackendSystem}
|
|
6
|
+
*/
|
|
7
|
+
export type SdPlatformBackendSystemQueryParameters = SdPlatformQueryParameters<string> | undefined;
|
|
8
|
+
/**
|
|
9
|
+
* Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SdPlatformBackendSystemApi extends ResourcesApi {
|
|
12
|
+
protected get __resourcePath(): string;
|
|
13
|
+
/**
|
|
14
|
+
* Query the backend systems.
|
|
15
|
+
* @param query - {@link SdPlatformBackendSystemQueryParameters} query parameters.
|
|
16
|
+
* @returns - {@link SdPlatformQueryResponse} response with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
|
|
17
|
+
*/
|
|
18
|
+
query(query?: SdPlatformBackendSystemQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
|
|
19
|
+
/**
|
|
20
|
+
* Create the backend system.
|
|
21
|
+
* @param body - {@link SdPlatformRequestBackendSystemCreate} body parameters.
|
|
22
|
+
* @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemAdmin} as result.
|
|
23
|
+
*/
|
|
24
|
+
create(body: SdPlatformRequestBackendSystemCreate): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>>;
|
|
25
|
+
/**
|
|
26
|
+
* Updates the backend system.
|
|
27
|
+
* @param id - the backend system id.
|
|
28
|
+
* @param body - {@link SdPlatformRequestBackendSystemPatch} update parameters.
|
|
29
|
+
* @returns - {@link SdPlatformPatchResponse} with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
|
|
30
|
+
*/
|
|
31
|
+
patch(id: string, body: SdPlatformRequestBackendSystemPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
|
|
32
|
+
/**
|
|
33
|
+
* Get a token for interacting with a geometry backend system.
|
|
34
|
+
* @param body - {@link SdPlatformRequestBackendSystemToken} body
|
|
35
|
+
* @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemToken} as result.
|
|
36
|
+
*/
|
|
37
|
+
token(body: SdPlatformRequestBackendSystemToken): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>>;
|
|
38
|
+
/**
|
|
39
|
+
* Delete a backend system.
|
|
40
|
+
* @param id - the id of a backend system
|
|
41
|
+
*/
|
|
42
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
43
|
+
}
|
|
44
44
|
//# sourceMappingURL=SdPlatformBackendSystemApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformBackendSystemApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBackendSystemApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACH,wBAAwB,EACxB,oCAAoC,EACpC,mCAAmC,EACnC,mCAAmC,EACnC,+BAA+B,EAC/B,oCAAoC,EACpC,oCAAoC,EACvC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ;;GAEG;AACH,
|
|
1
|
+
{"version":3,"file":"SdPlatformBackendSystemApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBackendSystemApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACH,wBAAwB,EACxB,oCAAoC,EACpC,mCAAmC,EACnC,mCAAmC,EACnC,+BAA+B,EAC/B,oCAAoC,EACpC,oCAAoC,EACvC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ;;GAEG;AACH,MAAM,MAAM,sCAAsC,GAAG,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAEnG;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAExD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,sCAA2C,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAKxK;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKhI;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAK3K;;;;OAIG;IACI,KAAK,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAI9H;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformRequestBookmarkCreate } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* Operations for creating and deleting bookmarks
|
|
6
|
-
*/
|
|
7
|
-
export declare class SdPlatformBookmarkApi extends ResourcesApi {
|
|
8
|
-
/**
|
|
9
|
-
* The resource path.
|
|
10
|
-
*/
|
|
11
|
-
protected get __resourcePath(): string;
|
|
12
|
-
/**
|
|
13
|
-
* Create a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
|
|
14
|
-
* @param body - {@link SdPlatformRequestBookmarkCreate} creae parameters.
|
|
15
|
-
* @returns - {@link SdPlatformPostResponse} with 'success' property being true,
|
|
16
|
-
*/
|
|
17
|
-
create(body: SdPlatformRequestBookmarkCreate): Promise<SdPlatformPostResponse<void>>;
|
|
18
|
-
/**
|
|
19
|
-
* Delete a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
|
|
20
|
-
* @param id - id of the model whose bookmark shall be deleted
|
|
21
|
-
* @returns - {@link SdPlatformDeleteResponse}
|
|
22
|
-
*/
|
|
23
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
24
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformRequestBookmarkCreate } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* Operations for creating and deleting bookmarks
|
|
6
|
+
*/
|
|
7
|
+
export declare class SdPlatformBookmarkApi extends ResourcesApi {
|
|
8
|
+
/**
|
|
9
|
+
* The resource path.
|
|
10
|
+
*/
|
|
11
|
+
protected get __resourcePath(): string;
|
|
12
|
+
/**
|
|
13
|
+
* Create a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
|
|
14
|
+
* @param body - {@link SdPlatformRequestBookmarkCreate} creae parameters.
|
|
15
|
+
* @returns - {@link SdPlatformPostResponse} with 'success' property being true,
|
|
16
|
+
*/
|
|
17
|
+
create(body: SdPlatformRequestBookmarkCreate): Promise<SdPlatformPostResponse<void>>;
|
|
18
|
+
/**
|
|
19
|
+
* Delete a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
|
|
20
|
+
* @param id - id of the model whose bookmark shall be deleted
|
|
21
|
+
* @returns - {@link SdPlatformDeleteResponse}
|
|
22
|
+
*/
|
|
23
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
24
|
+
}
|
|
25
25
|
//# sourceMappingURL=SdPlatformBookmarkApi.d.ts.map
|
|
@@ -1,44 +1,44 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformRequestChargebeeHostedPage, SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod, SdPlatformRequestChargebeePortalSession, SdPlatformResponseChargebeeConfig } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformResponseChargebeeHostedPage, SdPlatformResponseChargebeePortalSession, SdPlatformResponseChargebeePlan } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
5
|
-
export
|
|
6
|
-
/**
|
|
7
|
-
* Actions related to Chargebee.
|
|
8
|
-
*/
|
|
9
|
-
export declare class SdPlatformChargebeeApi extends ResourcesApi {
|
|
10
|
-
protected get __resourcePath(): string;
|
|
11
|
-
/**
|
|
12
|
-
* Get data required to integrate a chargebee with website.
|
|
13
|
-
* @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2} for more.
|
|
14
|
-
* @param body - the parameters of a request.
|
|
15
|
-
* @returns
|
|
16
|
-
*/
|
|
17
|
-
hostedPage(body: SdPlatformRequestChargebeeHostedPage): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
|
|
18
|
-
/**
|
|
19
|
-
* Get data required to integrade hosted page payment method with website.
|
|
20
|
-
* @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#update_payment_method}
|
|
21
|
-
* @param body - the parameters of a request.
|
|
22
|
-
* @returns
|
|
23
|
-
*/
|
|
24
|
-
hostedPageUpdatePaymentMethod(body: SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
|
|
25
|
-
/**
|
|
26
|
-
* Gets all the required data for opening a chargebee portal session.
|
|
27
|
-
* @see - {@link https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2} for more.
|
|
28
|
-
* @param body - {@link @SdPlatformRequestChargebeePortalSession} body
|
|
29
|
-
* @returns - post response with {@link SdPlatformResponseChargebeePortalSession} data
|
|
30
|
-
*/
|
|
31
|
-
portalSession(body: SdPlatformRequestChargebeePortalSession): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePortalSession>>;
|
|
32
|
-
/**
|
|
33
|
-
* Queries the chargebee plans.
|
|
34
|
-
* @param body - {@link SdPlatformChargebeePlanQueryParameters } body
|
|
35
|
-
* @returns - post response with {@link SdPlatformResponseChargebeePlan} data
|
|
36
|
-
*/
|
|
37
|
-
queryChargebeePlans(body: SdPlatformChargebeePlanQueryParameters): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePlan>>;
|
|
38
|
-
/**
|
|
39
|
-
*
|
|
40
|
-
* @returns Chargebee configuration
|
|
41
|
-
*/
|
|
42
|
-
config(): Promise<SdPlatformGetResponse<SdPlatformResponseChargebeeConfig>>;
|
|
43
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformRequestChargebeeHostedPage, SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod, SdPlatformRequestChargebeePortalSession, SdPlatformResponseChargebeeConfig } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformResponseChargebeeHostedPage, SdPlatformResponseChargebeePortalSession, SdPlatformResponseChargebeePlan } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
5
|
+
export type SdPlatformChargebeePlanQueryParameters = SdPlatformQueryParameters<null>;
|
|
6
|
+
/**
|
|
7
|
+
* Actions related to Chargebee.
|
|
8
|
+
*/
|
|
9
|
+
export declare class SdPlatformChargebeeApi extends ResourcesApi {
|
|
10
|
+
protected get __resourcePath(): string;
|
|
11
|
+
/**
|
|
12
|
+
* Get data required to integrate a chargebee with website.
|
|
13
|
+
* @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2} for more.
|
|
14
|
+
* @param body - the parameters of a request.
|
|
15
|
+
* @returns
|
|
16
|
+
*/
|
|
17
|
+
hostedPage(body: SdPlatformRequestChargebeeHostedPage): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
|
|
18
|
+
/**
|
|
19
|
+
* Get data required to integrade hosted page payment method with website.
|
|
20
|
+
* @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#update_payment_method}
|
|
21
|
+
* @param body - the parameters of a request.
|
|
22
|
+
* @returns
|
|
23
|
+
*/
|
|
24
|
+
hostedPageUpdatePaymentMethod(body: SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
|
|
25
|
+
/**
|
|
26
|
+
* Gets all the required data for opening a chargebee portal session.
|
|
27
|
+
* @see - {@link https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2} for more.
|
|
28
|
+
* @param body - {@link @SdPlatformRequestChargebeePortalSession} body
|
|
29
|
+
* @returns - post response with {@link SdPlatformResponseChargebeePortalSession} data
|
|
30
|
+
*/
|
|
31
|
+
portalSession(body: SdPlatformRequestChargebeePortalSession): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePortalSession>>;
|
|
32
|
+
/**
|
|
33
|
+
* Queries the chargebee plans.
|
|
34
|
+
* @param body - {@link SdPlatformChargebeePlanQueryParameters } body
|
|
35
|
+
* @returns - post response with {@link SdPlatformResponseChargebeePlan} data
|
|
36
|
+
*/
|
|
37
|
+
queryChargebeePlans(body: SdPlatformChargebeePlanQueryParameters): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePlan>>;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @returns Chargebee configuration
|
|
41
|
+
*/
|
|
42
|
+
config(): Promise<SdPlatformGetResponse<SdPlatformResponseChargebeeConfig>>;
|
|
43
|
+
}
|
|
44
44
|
//# sourceMappingURL=SdPlatformChargebeeApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformChargebeeApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformChargebeeApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oCAAoC,EAAE,uDAAuD,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAChO,OAAO,EAAE,qCAAqC,EAAE,wCAAwC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACvK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE9H,
|
|
1
|
+
{"version":3,"file":"SdPlatformChargebeeApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformChargebeeApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oCAAoC,EAAE,uDAAuD,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAChO,OAAO,EAAE,qCAAqC,EAAE,wCAAwC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACvK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE9H,MAAM,MAAM,sCAAsC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAEpD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,UAAU,CAAC,IAAI,EAAE,oCAAoC,GAAI,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAKtI;;;;;OAKG;IACI,6BAA6B,CAAC,IAAI,EAAE,uDAAuD,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAK3K;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;IAK9I;;;;OAIG;IACI,mBAAmB,CAAC,IAAI,EAAE,sCAAsC,GAAG,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;IAK1I;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,qBAAqB,CAAC,iCAAiC,CAAC,CAAC;CAIrF"}
|