@shapediver/sdk.platform-api-sdk-v1 2.12.7 → 2.12.9
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 +185 -185
- package/dist/SdPlatformSdkContext.d.ts +71 -71
- package/dist/SdPlatformSdkCreate.d.ts +7 -7
- package/dist/api/SdPlatformRequestId.d.ts +136 -136
- 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 -77
- package/dist/auth/SdPlatformAuthServiceApi.d.ts.map +1 -1
- package/dist/bundle.js +3570 -3366
- package/dist/bundle.node.js +3609 -3381
- package/dist/index.d.ts +27 -27
- package/dist/resources/SdPlatformApiClientsApi.d.ts +43 -16
- package/dist/resources/SdPlatformApiClientsApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformApiTokenApi.d.ts +43 -18
- package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBackendSystemApi.d.ts +38 -17
- package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBookmarkApi.d.ts +24 -16
- package/dist/resources/SdPlatformBookmarkApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformChargebeeApi.d.ts +43 -20
- package/dist/resources/SdPlatformChargebeeApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
- package/dist/resources/SdPlatformDomainApi.d.ts +46 -44
- package/dist/resources/SdPlatformDomainApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformHttpLogApi.d.ts +16 -15
- package/dist/resources/SdPlatformHttpLogApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformImageApi.d.ts +44 -36
- package/dist/resources/SdPlatformImageApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelApi.d.ts +78 -76
- package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelSharingApi.d.ts +65 -64
- package/dist/resources/SdPlatformModelSharingApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelTokenApi.d.ts +15 -10
- package/dist/resources/SdPlatformModelTokenApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -47
- package/dist/resources/SdPlatformNotificationApi.d.ts +65 -33
- package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformOpenIDProviderApi.d.ts +41 -41
- package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts +15 -15
- package/dist/resources/SdPlatformOrganizationApi.d.ts +95 -92
- package/dist/resources/SdPlatformOrganizationApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformPolicyApi.d.ts +43 -17
- package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformSavedStateApi.d.ts +51 -50
- package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +66 -66
- package/dist/resources/SdPlatformTagApi.d.ts +25 -15
- 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/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 +2 -2
- package/dist/ShapeDiverErrors.d.ts +0 -79
- package/dist/ShapeDiverErrors.d.ts.map +0 -1
- package/dist/ShapeDiverSDK.d.ts +0 -9
- package/dist/ShapeDiverSDK.d.ts.map +0 -1
- package/dist/ShapeDiverSDKContext.d.ts +0 -47
- package/dist/ShapeDiverSDKContext.d.ts.map +0 -1
- package/dist/ShapeDiverSDKInstance.d.ts +0 -91
- package/dist/ShapeDiverSDKInstance.d.ts.map +0 -1
- package/dist/api/RequestId.d.ts +0 -105
- package/dist/api/RequestId.d.ts.map +0 -1
- package/dist/api/ShapeDiverSDKApi.d.ts +0 -40
- package/dist/api/ShapeDiverSDKApi.d.ts.map +0 -1
- package/dist/api/ShapeDiverSDKApiErrors.d.ts +0 -7
- package/dist/api/ShapeDiverSDKApiErrors.d.ts.map +0 -1
- package/dist/api/ShapeDiverSDKConfig.d.ts +0 -7
- package/dist/api/ShapeDiverSDKConfig.d.ts.map +0 -1
- package/dist/api/ShapeDiverSDKRequestConfig.d.ts +0 -8
- package/dist/api/ShapeDiverSDKRequestConfig.d.ts.map +0 -1
- package/dist/auth/AuthServiceApi.d.ts +0 -34
- package/dist/auth/AuthServiceApi.d.ts.map +0 -1
- package/dist/auth/models/AuthRequest.d.ts +0 -13
- package/dist/auth/models/AuthRequest.d.ts.map +0 -1
- package/dist/auth/models/AuthResponse.d.ts +0 -12
- package/dist/auth/models/AuthResponse.d.ts.map +0 -1
- package/dist/common/FailedRequestError.d.ts +0 -4
- package/dist/common/FailedRequestError.d.ts.map +0 -1
- package/dist/common/Filter.d.ts +0 -52
- package/dist/common/Filter.d.ts.map +0 -1
- package/dist/common/FilterBuilder.d.ts +0 -55
- package/dist/common/FilterBuilder.d.ts.map +0 -1
- package/dist/common/Parameters.d.ts +0 -29
- package/dist/common/Parameters.d.ts.map +0 -1
- package/dist/common/QueryRequestParameters.d.ts +0 -46
- package/dist/common/QueryRequestParameters.d.ts.map +0 -1
- package/dist/common/RequestId.d.ts +0 -106
- package/dist/common/RequestId.d.ts.map +0 -1
- package/dist/common/ShapeDiverSDKContext.d.ts +0 -32
- package/dist/common/ShapeDiverSDKContext.d.ts.map +0 -1
- package/dist/config/ShapeDiverSDKConfig.d.ts +0 -7
- package/dist/config/ShapeDiverSDKConfig.d.ts.map +0 -1
- package/dist/resources/ResourcesApi.d.ts +0 -84
- package/dist/resources/ResourcesApi.d.ts.map +0 -1
- package/dist/resources/chargebee/ChargebeeApi.d.ts +0 -18
- package/dist/resources/chargebee/ChargebeeApi.d.ts.map +0 -1
- package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts +0 -45
- package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts.map +0 -1
- package/dist/resources/commons/QueryRequestParameters.d.ts +0 -46
- package/dist/resources/commons/QueryRequestParameters.d.ts.map +0 -1
- package/dist/resources/httplogs/HttpLogApi.d.ts +0 -16
- package/dist/resources/httplogs/HttpLogApi.d.ts.map +0 -1
- package/dist/resources/httplogs/models.d.ts +0 -15
- package/dist/resources/httplogs/models.d.ts.map +0 -1
- package/dist/resources/modelSharing/ModelSharingApi.d.ts +0 -50
- package/dist/resources/modelSharing/ModelSharingApi.d.ts.map +0 -1
- package/dist/resources/modelSharing/models/ModelSharing.d.ts +0 -29
- package/dist/resources/modelSharing/models/ModelSharing.d.ts.map +0 -1
- package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts +0 -15
- package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts.map +0 -1
- package/dist/resources/modelTransfers/CreateModelTransferRequest.d.ts +0 -8
- package/dist/resources/modelTransfers/CreateModelTransferRequest.d.ts.map +0 -1
- package/dist/resources/modelTransfers/ModelTransferApi.d.ts +0 -45
- package/dist/resources/modelTransfers/ModelTransferApi.d.ts.map +0 -1
- package/dist/resources/models/ModelApi.d.ts +0 -17
- package/dist/resources/models/ModelApi.d.ts.map +0 -1
- package/dist/resources/models/models/CreateModelTransferRequest.d.ts +0 -8
- package/dist/resources/models/models/CreateModelTransferRequest.d.ts.map +0 -1
- package/dist/resources/models/models/Model.d.ts +0 -166
- package/dist/resources/models/models/Model.d.ts.map +0 -1
- package/dist/resources/models/models/ModelCreate.d.ts +0 -21
- package/dist/resources/models/models/ModelCreate.d.ts.map +0 -1
- package/dist/resources/models/models/ModelPatch.d.ts +0 -25
- package/dist/resources/models/models/ModelPatch.d.ts.map +0 -1
- package/dist/resources/notifications/NotificationsApi.d.ts +0 -13
- package/dist/resources/notifications/NotificationsApi.d.ts.map +0 -1
- package/dist/resources/notifications/models/Notification.d.ts +0 -62
- package/dist/resources/notifications/models/Notification.d.ts.map +0 -1
- package/dist/resources/notifications/models/Requests.d.ts +0 -19
- package/dist/resources/notifications/models/Requests.d.ts.map +0 -1
- package/dist/resources/organizations/OrganizationsApi.d.ts +0 -73
- package/dist/resources/organizations/OrganizationsApi.d.ts.map +0 -1
- package/dist/resources/organizations/models/Organization.d.ts +0 -79
- package/dist/resources/organizations/models/Organization.d.ts.map +0 -1
- package/dist/resources/organizations/models/Requests.d.ts +0 -22
- package/dist/resources/organizations/models/Requests.d.ts.map +0 -1
- package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts +0 -50
- package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts.map +0 -1
- package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts +0 -15
- package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts.map +0 -1
- package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts +0 -6
- package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts.map +0 -1
- package/dist/resources/savedStates/SavedStatesApi.d.ts +0 -44
- package/dist/resources/savedStates/SavedStatesApi.d.ts.map +0 -1
- package/dist/resources/savedStates/models/SavedStatesModels.d.ts +0 -33
- package/dist/resources/savedStates/models/SavedStatesModels.d.ts.map +0 -1
- package/dist/resources/savedStates/models/SavedStatesRequests.d.ts +0 -29
- package/dist/resources/savedStates/models/SavedStatesRequests.d.ts.map +0 -1
- package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts +0 -15
- package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts.map +0 -1
- package/dist/resources/userModelSessions/models/UserModelSession.d.ts +0 -54
- package/dist/resources/userModelSessions/models/UserModelSession.d.ts.map +0 -1
- package/dist/resources/webhooks/WebhooksApi.d.ts +0 -51
- package/dist/resources/webhooks/WebhooksApi.d.ts.map +0 -1
- package/dist/resources/webhooks/models/Requests.d.ts +0 -17
- package/dist/resources/webhooks/models/Requests.d.ts.map +0 -1
|
@@ -1,51 +1,52 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformResponseSavedStatePublic, SdPlatformRequestSavedStateCreate, SdPlatformRequestSavedStatePatch, SdPlatformResponseSavedStateOwner } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformSavedStateQueryEmbeddableFields {
|
|
5
|
-
Model = "model",
|
|
6
|
-
Owner = "owner",
|
|
7
|
-
Image = "image"
|
|
8
|
-
}
|
|
9
|
-
export declare enum SdPlatformSavedStateGetEmbedFields {
|
|
10
|
-
Model = "model",
|
|
11
|
-
Owner = "owner"
|
|
12
|
-
}
|
|
13
|
-
export declare type SdPlatformSavedStateApiQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateQueryEmbeddableFields>;
|
|
14
|
-
/**
|
|
15
|
-
* Operations for saved states.
|
|
16
|
-
*/
|
|
17
|
-
export declare class SdPlatformSavedStateApi extends ResourcesApi {
|
|
18
|
-
protected get __resourcePath(): string;
|
|
19
|
-
/**
|
|
20
|
-
* Gets a saved state by id.
|
|
21
|
-
* @param id - saved state id.
|
|
22
|
-
* @param embed
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
*
|
|
28
|
-
* @
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
*
|
|
34
|
-
* @param
|
|
35
|
-
* @
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
*
|
|
41
|
-
* @
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
*
|
|
47
|
-
* @
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformResponseSavedStatePublic, SdPlatformRequestSavedStateCreate, SdPlatformRequestSavedStatePatch, SdPlatformResponseSavedStateOwner } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformSavedStateQueryEmbeddableFields {
|
|
5
|
+
Model = "model",
|
|
6
|
+
Owner = "owner",
|
|
7
|
+
Image = "image"
|
|
8
|
+
}
|
|
9
|
+
export declare enum SdPlatformSavedStateGetEmbedFields {
|
|
10
|
+
Model = "model",
|
|
11
|
+
Owner = "owner"
|
|
12
|
+
}
|
|
13
|
+
export declare type SdPlatformSavedStateApiQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateQueryEmbeddableFields>;
|
|
14
|
+
/**
|
|
15
|
+
* Operations for saved states.
|
|
16
|
+
*/
|
|
17
|
+
export declare class SdPlatformSavedStateApi extends ResourcesApi {
|
|
18
|
+
protected get __resourcePath(): string;
|
|
19
|
+
/**
|
|
20
|
+
* Gets a saved state by id.
|
|
21
|
+
* @param id - saved state id.
|
|
22
|
+
* @param embed the array of {@link SdPlatformSavedStateGetEmbedFields} embeddable fields.
|
|
23
|
+
* @returns - the {@link SdPlatformGetResponse} with {@see SdPlatformResponseSavedStatePublic} or one of it's derived classes as response.
|
|
24
|
+
*/
|
|
25
|
+
get<T = SdPlatformResponseSavedStatePublic>(id: string, embed?: Array<SdPlatformSavedStateGetEmbedFields>): Promise<SdPlatformGetResponse<T>>;
|
|
26
|
+
/**
|
|
27
|
+
* Create a new saved state.
|
|
28
|
+
* @param body {@link SdPlatformRequestSavedStateCreate} create saved state body.
|
|
29
|
+
* @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseSavedStateOwner} or one of it's derived classes as data.
|
|
30
|
+
*/
|
|
31
|
+
create<T = SdPlatformResponseSavedStateOwner>(body: SdPlatformRequestSavedStateCreate): Promise<SdPlatformPostResponse<T>>;
|
|
32
|
+
/**
|
|
33
|
+
* Patch a saved state.
|
|
34
|
+
* @param id
|
|
35
|
+
* @param body {@link SdPlatformRequestSavedStatePatch} saved state patch body.
|
|
36
|
+
* @returns the {@link SdPlatformPatchResponse} with {@link SdPlatformResponseSavedStateOwner} or one of it's derived classes as result.
|
|
37
|
+
*/
|
|
38
|
+
patch<T = SdPlatformResponseSavedStateOwner>(id: string, body: SdPlatformRequestSavedStatePatch): Promise<SdPlatformPatchResponse<T>>;
|
|
39
|
+
/**
|
|
40
|
+
* Delete a saved state.
|
|
41
|
+
* @param id - the id of a saved state.
|
|
42
|
+
* @returns the {@link SdPlatformDeleteResponse} response.
|
|
43
|
+
*/
|
|
44
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
45
|
+
/**
|
|
46
|
+
* Query saved states.
|
|
47
|
+
* @param params {@link SdPlatformSavedStateApiQueryParameters} query parameters.
|
|
48
|
+
* @returns the {@link SdPlatformQueryResponse} response with {@link SdPlatformResponseSavedStatePublic} or one of it's derived classes as response.
|
|
49
|
+
*/
|
|
50
|
+
query<T = SdPlatformResponseSavedStatePublic>(params?: SdPlatformSavedStateApiQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
51
|
+
}
|
|
51
52
|
//# sourceMappingURL=SdPlatformSavedStateApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformSavedStateApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformSavedStateApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,kCAAkC,EAAE,iCAAiC,EAAE,gCAAgC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAA;AAChM,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,yCAAyC;IAEjD,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAGD,oBAAY,kCAAkC;IAE1C,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAED,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAE1H;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED
|
|
1
|
+
{"version":3,"file":"SdPlatformSavedStateApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformSavedStateApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,kCAAkC,EAAE,iCAAiC,EAAE,gCAAgC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAA;AAChM,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,yCAAyC;IAEjD,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAGD,oBAAY,kCAAkC;IAE1C,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAED,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAE1H;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;QAKI;IACG,GAAG,CAAC,CAAC,GAAG,kCAAkC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKpJ;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,iCAAiC,EAAE,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAKjI;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,iCAAiC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK5I;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,kCAAkC,EAAE,MAAM,CAAC,EAAE,sCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;CAI7I"}
|
|
@@ -1,67 +1,67 @@
|
|
|
1
|
-
import { SdPlatformRequestSavedStateSharingCreateMultiple, SdPlatformResponseSavedStateSharing, SdPlatformResponseSavedStateSharingCreate, SdPlatformResponseSavedStateSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformSavedStateSharingQueryEmbeddableFields {
|
|
5
|
-
User = "user",
|
|
6
|
-
SavedState = "saved_state",
|
|
7
|
-
Provider = "provider"
|
|
8
|
-
}
|
|
9
|
-
export declare type SdPlatformSavedStateSharingQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateSharingQueryEmbeddableFields>;
|
|
10
|
-
/**
|
|
11
|
-
* Operations for saved state sharing relationships.
|
|
12
|
-
*/
|
|
13
|
-
export declare class SdPlatformSavedStateSharingApi extends ResourcesApi {
|
|
14
|
-
protected get __resourcePath(): string;
|
|
15
|
-
/**
|
|
16
|
-
* Create a saved state sharing relationship
|
|
17
|
-
* @param body
|
|
18
|
-
* @returns
|
|
19
|
-
*/
|
|
20
|
-
create(body: SdPlatformResponseSavedStateSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseSavedStateSharing>>;
|
|
21
|
-
/**
|
|
22
|
-
* Create multiple sharings.
|
|
23
|
-
* @param { SdPlatformRequestSavedStateSharingCreateMultiple
|
|
24
|
-
* @returns {
|
|
25
|
-
*/
|
|
26
|
-
createMultiple(body: SdPlatformRequestSavedStateSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseSavedStateSharing>>>;
|
|
27
|
-
/**
|
|
28
|
-
* Delete a saved state.
|
|
29
|
-
* @param saved_state_sharing_id Id of the saved state sharing relationship to delete.
|
|
30
|
-
* @returns
|
|
31
|
-
*/
|
|
32
|
-
delete(saved_state_sharing_id: string): Promise<SdPlatformDeleteResponse>;
|
|
33
|
-
/**
|
|
34
|
-
* Get saved state sharing relationships by saved state id and user id.
|
|
35
|
-
* @param saved_state_id - saved state id.
|
|
36
|
-
* @param user_id - user id.
|
|
37
|
-
* @returns
|
|
38
|
-
*/
|
|
39
|
-
getBySavedStateAndUser(saved_state_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharing>>>;
|
|
40
|
-
/**
|
|
41
|
-
* Query saved state sharing relationships.
|
|
42
|
-
* @param params
|
|
43
|
-
* @returns
|
|
44
|
-
*/
|
|
45
|
-
query(query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
|
|
46
|
-
/**
|
|
47
|
-
* Query saved state sharing relationships by saved state id.
|
|
48
|
-
* @param saved_state_id
|
|
49
|
-
* @param query
|
|
50
|
-
* @returns
|
|
51
|
-
*/
|
|
52
|
-
queryBySavedState(saved_state_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
|
|
53
|
-
/**
|
|
54
|
-
* Query saved state sharing relationships by user id.
|
|
55
|
-
* @param user_id
|
|
56
|
-
* @param query
|
|
57
|
-
* @returns
|
|
58
|
-
*/
|
|
59
|
-
queryByUser(user_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
|
|
60
|
-
/**
|
|
61
|
-
* Gets the model sharings grouped by user.
|
|
62
|
-
* @param saved_state_id
|
|
63
|
-
* @returns
|
|
64
|
-
*/
|
|
65
|
-
getGroupedByUser(saved_state_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharingGroupedByUser>>>;
|
|
66
|
-
}
|
|
1
|
+
import { SdPlatformRequestSavedStateSharingCreateMultiple, SdPlatformResponseSavedStateSharing, SdPlatformResponseSavedStateSharingCreate, SdPlatformResponseSavedStateSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformSavedStateSharingQueryEmbeddableFields {
|
|
5
|
+
User = "user",
|
|
6
|
+
SavedState = "saved_state",
|
|
7
|
+
Provider = "provider"
|
|
8
|
+
}
|
|
9
|
+
export declare type SdPlatformSavedStateSharingQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateSharingQueryEmbeddableFields>;
|
|
10
|
+
/**
|
|
11
|
+
* Operations for saved state sharing relationships.
|
|
12
|
+
*/
|
|
13
|
+
export declare class SdPlatformSavedStateSharingApi extends ResourcesApi {
|
|
14
|
+
protected get __resourcePath(): string;
|
|
15
|
+
/**
|
|
16
|
+
* Create a saved state sharing relationship
|
|
17
|
+
* @param body {@link SdPlatformResponseSavedStateSharingCreate}
|
|
18
|
+
* @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseSavedStateSharing} as response.
|
|
19
|
+
*/
|
|
20
|
+
create(body: SdPlatformResponseSavedStateSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseSavedStateSharing>>;
|
|
21
|
+
/**
|
|
22
|
+
* Create multiple sharings.
|
|
23
|
+
* @param body {@link SdPlatformRequestSavedStateSharingCreateMultiple}
|
|
24
|
+
* @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseModelSharing} as data response.
|
|
25
|
+
*/
|
|
26
|
+
createMultiple(body: SdPlatformRequestSavedStateSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseSavedStateSharing>>>;
|
|
27
|
+
/**
|
|
28
|
+
* Delete a saved state.
|
|
29
|
+
* @param saved_state_sharing_id Id of the saved state sharing relationship to delete.
|
|
30
|
+
* @returns the {@link SdPlatformDeleteResponse} as response.
|
|
31
|
+
*/
|
|
32
|
+
delete(saved_state_sharing_id: string): Promise<SdPlatformDeleteResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* Get saved state sharing relationships by saved state id and user id.
|
|
35
|
+
* @param saved_state_id - saved state id.
|
|
36
|
+
* @param user_id - user id.
|
|
37
|
+
* @returns the {@link SdPlatformGetResponse} with array of {@link SdPlatformResponseSavedStateSharing} as data.
|
|
38
|
+
*/
|
|
39
|
+
getBySavedStateAndUser(saved_state_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharing>>>;
|
|
40
|
+
/**
|
|
41
|
+
* Query saved state sharing relationships.
|
|
42
|
+
* @param params {@link SdPlatformSavedStateSharingQueryParameters}
|
|
43
|
+
* @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data.
|
|
44
|
+
*/
|
|
45
|
+
query(query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
|
|
46
|
+
/**
|
|
47
|
+
* Query saved state sharing relationships by saved state id.
|
|
48
|
+
* @param saved_state_id
|
|
49
|
+
* @param query {@link SdPlatformSavedStateSharingQueryParameters}
|
|
50
|
+
* @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data,
|
|
51
|
+
*/
|
|
52
|
+
queryBySavedState(saved_state_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
|
|
53
|
+
/**
|
|
54
|
+
* Query saved state sharing relationships by user id.
|
|
55
|
+
* @param user_id
|
|
56
|
+
* @param query {@link SdPlatformSavedStateSharingQueryParameters}
|
|
57
|
+
* @returns the {@link SdPlatformQueryResponse} with {@link SdPlatformResponseSavedStateSharing} as data,
|
|
58
|
+
*/
|
|
59
|
+
queryByUser(user_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
|
|
60
|
+
/**
|
|
61
|
+
* Gets the model sharings grouped by user.
|
|
62
|
+
* @param saved_state_id
|
|
63
|
+
* @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseSavedStateSharing} as data,
|
|
64
|
+
*/
|
|
65
|
+
getGroupedByUser(saved_state_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharingGroupedByUser>>>;
|
|
66
|
+
}
|
|
67
67
|
//# sourceMappingURL=SdPlatformSavedStateSharingApi.d.ts.map
|
|
@@ -1,16 +1,26 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformResponseTag, SdPlatformResponseTagAdmin } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformTagQueryEmbeddableFields {
|
|
5
|
-
ModelsCount = "models_count"
|
|
6
|
-
}
|
|
7
|
-
export declare type SdPlatformTagQueryParameters = SdPlatformQueryParameters<SdPlatformTagQueryEmbeddableFields>;
|
|
8
|
-
/**
|
|
9
|
-
* Operations for tags which can be attached to models.
|
|
10
|
-
*/
|
|
11
|
-
export declare class SdPlatformTagApi extends ResourcesApi {
|
|
12
|
-
protected get __resourcePath(): string;
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformResponseTag, SdPlatformResponseTagAdmin } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformTagQueryEmbeddableFields {
|
|
5
|
+
ModelsCount = "models_count"
|
|
6
|
+
}
|
|
7
|
+
export declare type SdPlatformTagQueryParameters = SdPlatformQueryParameters<SdPlatformTagQueryEmbeddableFields>;
|
|
8
|
+
/**
|
|
9
|
+
* Operations for tags which can be attached to models.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SdPlatformTagApi extends ResourcesApi {
|
|
12
|
+
protected get __resourcePath(): string;
|
|
13
|
+
/**
|
|
14
|
+
* Gets the {@link SdPlatformResponseTag} by id.
|
|
15
|
+
* @param id - the id of a tag.
|
|
16
|
+
* @returns the {@link SdPlatformGetResponse} with {@link SdPlatformResponseTag} or {@link SdPlatformResponseTagAdmin} as data.
|
|
17
|
+
*/
|
|
18
|
+
get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
19
|
+
/**
|
|
20
|
+
* Queries the {@link SdPlatformResponseTag} tags.
|
|
21
|
+
* @param query {@link SdPlatformTagQueryParameters} - query parameters for tags.
|
|
22
|
+
* @returns collection of {@link SdPlatformResponseTag} based on query parameters.
|
|
23
|
+
*/
|
|
24
|
+
query(query?: SdPlatformTagQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
25
|
+
}
|
|
16
26
|
//# sourceMappingURL=SdPlatformTagApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformTagApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformTagApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAA;AACvG,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAE/H,oBAAY,kCAAkC;IAE1C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,4BAA4B,GAAG,yBAAyB,CAAC,kCAAkC,CAAC,CAAC;AAEzG;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAE9C,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;
|
|
1
|
+
{"version":3,"file":"SdPlatformTagApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformTagApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAA;AACvG,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAE/H,oBAAY,kCAAkC;IAE1C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,4BAA4B,GAAG,yBAAyB,CAAC,kCAAkC,CAAC,CAAC;AAEzG;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,YAAY;IAE9C,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;IAK1G;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,4BAAiC,GAAG,OAAO,CAAC,uBAAuB,CAAC,qBAAqB,GAAG,0BAA0B,CAAC,CAAC;CAI/I"}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
import { SdPlatformResponseUserModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* Analytics for users.
|
|
6
|
-
*/
|
|
7
|
-
export declare class SdPlatformUserAnalyticsApi extends ResourcesApi {
|
|
8
|
-
protected get __resourcePath(): string;
|
|
9
|
-
/**
|
|
10
|
-
* Query session analytics aggregated per user.
|
|
11
|
-
* @param body
|
|
12
|
-
* @returns
|
|
13
|
-
*/
|
|
14
|
-
query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseUserModelSessionAnalyticsPerTimestamp>>;
|
|
15
|
-
}
|
|
1
|
+
import { SdPlatformResponseUserModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* Analytics for users.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SdPlatformUserAnalyticsApi extends ResourcesApi {
|
|
8
|
+
protected get __resourcePath(): string;
|
|
9
|
+
/**
|
|
10
|
+
* Query session analytics aggregated per user.
|
|
11
|
+
* @param body the query parameters.
|
|
12
|
+
* @returns collection of {@link SdPlatformResponseUserModelSessionAnalyticsPerTimestamp} based on query parameters.
|
|
13
|
+
*/
|
|
14
|
+
query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseUserModelSessionAnalyticsPerTimestamp>>;
|
|
15
|
+
}
|
|
16
16
|
//# sourceMappingURL=SdPlatformUserAnalyticsApi.d.ts.map
|
|
@@ -1,87 +1,87 @@
|
|
|
1
|
-
import { SdPlatformRequestUserPatchAdmin, SdPlatformRequestUserPasswordResetConfirm, SdPlatformRequestUserPatch, SdPlatformRequestUserRegister, SdPlatformResponseUserSelf, SdPlatformResponseUserMinimal, SdPlatformResponseUserRefreshToken } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformUserQueryEmbeddableFields {
|
|
5
|
-
BackendSystem = "backend_system",
|
|
6
|
-
ChargebeeAddons = "chargebee_addons",
|
|
7
|
-
ChargebeeCustomer = "chargebee_customer",
|
|
8
|
-
ChargebeePlan = "chargebee_plan",
|
|
9
|
-
ChargebeeSubscription = "chargebee_subscription",
|
|
10
|
-
GlobalAccessDomains = "global_accessdomains",
|
|
11
|
-
Organization = "organization"
|
|
12
|
-
}
|
|
13
|
-
export declare enum SdPlatformUserGetEmbeddableFields {
|
|
14
|
-
BackendSystem = "backend_system",
|
|
15
|
-
ChargebeeAddons = "chargebee_addons",
|
|
16
|
-
ChargebeeCustomer = "chargebee_customer",
|
|
17
|
-
ChargebeePlan = "chargebee_plan",
|
|
18
|
-
ChargebeeSubscription = "chargebee_subscription",
|
|
19
|
-
GlobalAccessDomains = "global_accessdomains",
|
|
20
|
-
Organization = "organization",
|
|
21
|
-
UsedCredits = "used_credits"
|
|
22
|
-
}
|
|
23
|
-
export declare type SdPlatformUserQueryParameters = SdPlatformQueryParameters<SdPlatformUserQueryEmbeddableFields>;
|
|
24
|
-
/**
|
|
25
|
-
* Operations for users.
|
|
26
|
-
*/
|
|
27
|
-
export declare class SdPlatformUserApi extends ResourcesApi {
|
|
28
|
-
protected get __resourcePath(): string;
|
|
29
|
-
/**
|
|
30
|
-
* Gets the specific user by id
|
|
31
|
-
* @param id - user id.
|
|
32
|
-
* @param embed
|
|
33
|
-
*/
|
|
34
|
-
get<T = SdPlatformResponseUserMinimal>(id: string, embed?: Array<SdPlatformUserGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
-
/**
|
|
36
|
-
* Register a new user. If successful a registration confirmation email will be sent.
|
|
37
|
-
* @param body
|
|
38
|
-
*/
|
|
39
|
-
register(body: SdPlatformRequestUserRegister): Promise<SdPlatformPostResponse<void>>;
|
|
40
|
-
/**
|
|
41
|
-
* Query users.
|
|
42
|
-
* @param body
|
|
43
|
-
*/
|
|
44
|
-
query<T = SdPlatformResponseUserMinimal>(body?: SdPlatformUserQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
45
|
-
/**
|
|
46
|
-
* Patch a user.
|
|
47
|
-
* @param id - the id of a user
|
|
48
|
-
* @param body
|
|
49
|
-
*/
|
|
50
|
-
patch<T = SdPlatformResponseUserSelf>(id: string, body: SdPlatformRequestUserPatch | SdPlatformRequestUserPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
|
|
51
|
-
/**
|
|
52
|
-
* Delete a user
|
|
53
|
-
* @param id
|
|
54
|
-
* @returns
|
|
55
|
-
*/
|
|
56
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
57
|
-
/**
|
|
58
|
-
* Confirm a user registration.
|
|
59
|
-
* @param token Token which was provided via registration confirmation email.
|
|
60
|
-
* @returns
|
|
61
|
-
*/
|
|
62
|
-
confirm(token: string): Promise<SdPlatformPostResponse<SdPlatformResponseUserSelf>>;
|
|
63
|
-
/**
|
|
64
|
-
* Request reset password token by email
|
|
65
|
-
* @param email
|
|
66
|
-
*/
|
|
67
|
-
passwordReset(email: string): Promise<SdPlatformPostResponse<void>>;
|
|
68
|
-
/**
|
|
69
|
-
* Change password using token
|
|
70
|
-
* @param body
|
|
71
|
-
*/
|
|
72
|
-
passwordResetConfirm(body: SdPlatformRequestUserPasswordResetConfirm): Promise<SdPlatformPostResponse<void>>;
|
|
73
|
-
/**
|
|
74
|
-
* Returns an array of data about authorized client applications and their refresh tokens.
|
|
75
|
-
* @param
|
|
76
|
-
* @returns {
|
|
77
|
-
*/
|
|
78
|
-
getUserRefreshTokens(user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
|
|
79
|
-
/**
|
|
80
|
-
* Delete refresh token.
|
|
81
|
-
* @param
|
|
82
|
-
* @param
|
|
83
|
-
* @returns {
|
|
84
|
-
*/
|
|
85
|
-
deleteRefreshToken(user_id: string, refresh_token_id: string): Promise<SdPlatformDeleteResponse>;
|
|
86
|
-
}
|
|
1
|
+
import { SdPlatformRequestUserPatchAdmin, SdPlatformRequestUserPasswordResetConfirm, SdPlatformRequestUserPatch, SdPlatformRequestUserRegister, SdPlatformResponseUserSelf, SdPlatformResponseUserMinimal, SdPlatformResponseUserRefreshToken } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformUserQueryEmbeddableFields {
|
|
5
|
+
BackendSystem = "backend_system",
|
|
6
|
+
ChargebeeAddons = "chargebee_addons",
|
|
7
|
+
ChargebeeCustomer = "chargebee_customer",
|
|
8
|
+
ChargebeePlan = "chargebee_plan",
|
|
9
|
+
ChargebeeSubscription = "chargebee_subscription",
|
|
10
|
+
GlobalAccessDomains = "global_accessdomains",
|
|
11
|
+
Organization = "organization"
|
|
12
|
+
}
|
|
13
|
+
export declare enum SdPlatformUserGetEmbeddableFields {
|
|
14
|
+
BackendSystem = "backend_system",
|
|
15
|
+
ChargebeeAddons = "chargebee_addons",
|
|
16
|
+
ChargebeeCustomer = "chargebee_customer",
|
|
17
|
+
ChargebeePlan = "chargebee_plan",
|
|
18
|
+
ChargebeeSubscription = "chargebee_subscription",
|
|
19
|
+
GlobalAccessDomains = "global_accessdomains",
|
|
20
|
+
Organization = "organization",
|
|
21
|
+
UsedCredits = "used_credits"
|
|
22
|
+
}
|
|
23
|
+
export declare type SdPlatformUserQueryParameters = SdPlatformQueryParameters<SdPlatformUserQueryEmbeddableFields>;
|
|
24
|
+
/**
|
|
25
|
+
* Operations for users.
|
|
26
|
+
*/
|
|
27
|
+
export declare class SdPlatformUserApi extends ResourcesApi {
|
|
28
|
+
protected get __resourcePath(): string;
|
|
29
|
+
/**
|
|
30
|
+
* Gets the specific user by id
|
|
31
|
+
* @param id - user id.
|
|
32
|
+
* @param embed array of {@link SdPlatformUserGetEmbeddableFields} embeddable resources.
|
|
33
|
+
*/
|
|
34
|
+
get<T = SdPlatformResponseUserMinimal>(id: string, embed?: Array<SdPlatformUserGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
+
/**
|
|
36
|
+
* Register a new user. If successful a registration confirmation email will be sent.
|
|
37
|
+
* @param body {@link SdPlatformRequestUserRegister}
|
|
38
|
+
*/
|
|
39
|
+
register(body: SdPlatformRequestUserRegister): Promise<SdPlatformPostResponse<void>>;
|
|
40
|
+
/**
|
|
41
|
+
* Query users.
|
|
42
|
+
* @param body {@link SdPlatformUserQueryParameters}
|
|
43
|
+
*/
|
|
44
|
+
query<T = SdPlatformResponseUserMinimal>(body?: SdPlatformUserQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
45
|
+
/**
|
|
46
|
+
* Patch a user.
|
|
47
|
+
* @param id - the id of a user
|
|
48
|
+
* @param body {@link SdPlatformRequestUserPatch} properties to patch
|
|
49
|
+
*/
|
|
50
|
+
patch<T = SdPlatformResponseUserSelf>(id: string, body: SdPlatformRequestUserPatch | SdPlatformRequestUserPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
|
|
51
|
+
/**
|
|
52
|
+
* Delete a user
|
|
53
|
+
* @param id
|
|
54
|
+
* @returns
|
|
55
|
+
*/
|
|
56
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
57
|
+
/**
|
|
58
|
+
* Confirm a user registration.
|
|
59
|
+
* @param token Token which was provided via registration confirmation email.
|
|
60
|
+
* @returns
|
|
61
|
+
*/
|
|
62
|
+
confirm(token: string): Promise<SdPlatformPostResponse<SdPlatformResponseUserSelf>>;
|
|
63
|
+
/**
|
|
64
|
+
* Request reset password token by email
|
|
65
|
+
* @param email
|
|
66
|
+
*/
|
|
67
|
+
passwordReset(email: string): Promise<SdPlatformPostResponse<void>>;
|
|
68
|
+
/**
|
|
69
|
+
* Change password using token
|
|
70
|
+
* @param body {@see SdPlatformRequestUserPasswordResetConfirm}
|
|
71
|
+
*/
|
|
72
|
+
passwordResetConfirm(body: SdPlatformRequestUserPasswordResetConfirm): Promise<SdPlatformPostResponse<void>>;
|
|
73
|
+
/**
|
|
74
|
+
* Returns an array of data about authorized client applications and their refresh tokens.
|
|
75
|
+
* @param user_id
|
|
76
|
+
* @returns the {@link SdPlatformGetResponse} with array of {@link SdPlatformResponseUserRefreshToken} as data
|
|
77
|
+
*/
|
|
78
|
+
getUserRefreshTokens(user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
|
|
79
|
+
/**
|
|
80
|
+
* Delete refresh token.
|
|
81
|
+
* @param user_id
|
|
82
|
+
* @param refresh_token_id
|
|
83
|
+
* @returns the {@link SdPlatformDeleteResponse} response.
|
|
84
|
+
*/
|
|
85
|
+
deleteRefreshToken(user_id: string, refresh_token_id: string): Promise<SdPlatformDeleteResponse>;
|
|
86
|
+
}
|
|
87
87
|
//# sourceMappingURL=SdPlatformUserApi.d.ts.map
|
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../api/SdPlatformSdkApi";
|
|
2
|
-
import { SdPlatformSdkContext } from "../SdPlatformSdkContext";
|
|
3
|
-
import { SdPlatformRequestWebhookChargebeeEvent, SdPlatformRequestWebhookModelMessage, SdPlatformRequestWebhookNotification, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
5
|
-
export interface SdPlatformWebhookBasicAuth {
|
|
6
|
-
username: string;
|
|
7
|
-
password: string;
|
|
8
|
-
}
|
|
9
|
-
export interface SdPlatformWebhookTokenAuth {
|
|
10
|
-
bearer_access_token?: string;
|
|
11
|
-
basic_access_token?: string;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Webhook calls.
|
|
15
|
-
*/
|
|
16
|
-
export declare class SdPlatformWebhookApi {
|
|
17
|
-
protected __context: SdPlatformSdkContext;
|
|
18
|
-
protected __commonPath: string;
|
|
19
|
-
protected __api: SdPlatformSdkApi;
|
|
20
|
-
/**
|
|
21
|
-
* @param { ShapeDiverSDKContext } __context
|
|
22
|
-
*/
|
|
23
|
-
constructor(__context: SdPlatformSdkContext);
|
|
24
|
-
protected __getPath(pathSufix?: null | string): string;
|
|
25
|
-
protected __resolveRequestConfig(options: {
|
|
26
|
-
username?: string;
|
|
27
|
-
password?: string;
|
|
28
|
-
bearer_access_token?: string;
|
|
29
|
-
basic_access_token?: string;
|
|
30
|
-
}): SdPlatformSdkRequestConfig;
|
|
31
|
-
/**
|
|
32
|
-
* Webhook which notifies the platform of chargebee events.
|
|
33
|
-
* @param auth
|
|
34
|
-
* @param body
|
|
35
|
-
* @returns
|
|
36
|
-
*/
|
|
37
|
-
chargebeeEvent(auth: SdPlatformWebhookBasicAuth, body: SdPlatformRequestWebhookChargebeeEvent): Promise<SdPlatformPostResponse<void>>;
|
|
38
|
-
/**
|
|
39
|
-
* Model message webhook call - send a message to the owner of a model.
|
|
40
|
-
* @param auth
|
|
41
|
-
* @param body
|
|
42
|
-
* @returns
|
|
43
|
-
*/
|
|
44
|
-
modelMessage(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookModelMessage): Promise<SdPlatformPostResponse<void>>;
|
|
45
|
-
/**
|
|
46
|
-
* Notification webhook call - create a notification related to a model.
|
|
47
|
-
* @param auth
|
|
48
|
-
* @param body
|
|
49
|
-
* @returns
|
|
50
|
-
*/
|
|
51
|
-
notification(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookNotification): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
|
|
52
|
-
}
|
|
1
|
+
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../api/SdPlatformSdkApi";
|
|
2
|
+
import { SdPlatformSdkContext } from "../SdPlatformSdkContext";
|
|
3
|
+
import { SdPlatformRequestWebhookChargebeeEvent, SdPlatformRequestWebhookModelMessage, SdPlatformRequestWebhookNotification, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
5
|
+
export interface SdPlatformWebhookBasicAuth {
|
|
6
|
+
username: string;
|
|
7
|
+
password: string;
|
|
8
|
+
}
|
|
9
|
+
export interface SdPlatformWebhookTokenAuth {
|
|
10
|
+
bearer_access_token?: string;
|
|
11
|
+
basic_access_token?: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Webhook calls.
|
|
15
|
+
*/
|
|
16
|
+
export declare class SdPlatformWebhookApi {
|
|
17
|
+
protected __context: SdPlatformSdkContext;
|
|
18
|
+
protected __commonPath: string;
|
|
19
|
+
protected __api: SdPlatformSdkApi;
|
|
20
|
+
/**
|
|
21
|
+
* @param { ShapeDiverSDKContext } __context
|
|
22
|
+
*/
|
|
23
|
+
constructor(__context: SdPlatformSdkContext);
|
|
24
|
+
protected __getPath(pathSufix?: null | string): string;
|
|
25
|
+
protected __resolveRequestConfig(options: {
|
|
26
|
+
username?: string;
|
|
27
|
+
password?: string;
|
|
28
|
+
bearer_access_token?: string;
|
|
29
|
+
basic_access_token?: string;
|
|
30
|
+
}): SdPlatformSdkRequestConfig;
|
|
31
|
+
/**
|
|
32
|
+
* Webhook which notifies the platform of chargebee events.
|
|
33
|
+
* @param auth {@link SdPlatformWebhookBasicAuth}
|
|
34
|
+
* @param body {@link SdPlatformRequestWebhookChargebeeEvent}
|
|
35
|
+
* @returns
|
|
36
|
+
*/
|
|
37
|
+
chargebeeEvent(auth: SdPlatformWebhookBasicAuth, body: SdPlatformRequestWebhookChargebeeEvent): Promise<SdPlatformPostResponse<void>>;
|
|
38
|
+
/**
|
|
39
|
+
* Model message webhook call - send a message to the owner of a model.
|
|
40
|
+
* @param auth {@link SdPlatformWebhookTokenAuth}
|
|
41
|
+
* @param body {@link SdPlatformRequestWebhookModelMessage}
|
|
42
|
+
* @returns
|
|
43
|
+
*/
|
|
44
|
+
modelMessage(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookModelMessage): Promise<SdPlatformPostResponse<void>>;
|
|
45
|
+
/**
|
|
46
|
+
* Notification webhook call - create a notification related to a model.
|
|
47
|
+
* @param auth {@link SdPlatformWebhookTokenAuth}
|
|
48
|
+
* @param body {@link SdPlatformRequestWebhookNotification}
|
|
49
|
+
* @returns
|
|
50
|
+
*/
|
|
51
|
+
notification(auth: SdPlatformWebhookTokenAuth, body: SdPlatformRequestWebhookNotification): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
|
|
52
|
+
}
|
|
53
53
|
//# sourceMappingURL=SdPlatformWebhookApi.d.ts.map
|