@shapediver/sdk.platform-api-sdk-v1 2.12.7 → 2.12.8
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 +77 -77
- package/dist/bundle.js +3486 -3366
- package/dist/bundle.node.js +3525 -3381
- package/dist/index.d.ts +27 -27
- package/dist/resources/SdPlatformApiClientsApi.d.ts +16 -16
- package/dist/resources/SdPlatformApiTokenApi.d.ts +44 -18
- package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBackendSystemApi.d.ts +35 -17
- package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformBookmarkApi.d.ts +21 -16
- package/dist/resources/SdPlatformBookmarkApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformChargebeeApi.d.ts +20 -20
- package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
- package/dist/resources/SdPlatformDomainApi.d.ts +44 -44
- package/dist/resources/SdPlatformHttpLogApi.d.ts +15 -15
- package/dist/resources/SdPlatformImageApi.d.ts +36 -36
- package/dist/resources/SdPlatformModelApi.d.ts +76 -76
- package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
- package/dist/resources/SdPlatformModelSharingApi.d.ts +64 -64
- package/dist/resources/SdPlatformModelTokenApi.d.ts +10 -10
- 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 +92 -92
- 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 +15 -15
- 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,37 +1,37 @@
|
|
|
1
|
-
import { SdPlatformResponseImage, SdPlatformResponseImageAdmin, SdPlatformResponseImagePublic, SdPlatformRequestImageCreate } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
-
import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformQueryParameters, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformImageQueryEmbeddableFields {
|
|
5
|
-
User = "user",
|
|
6
|
-
Models = "models"
|
|
7
|
-
}
|
|
8
|
-
export declare type SdPlatformImageQueryParameters = SdPlatformQueryParameters<SdPlatformImageQueryEmbeddableFields>;
|
|
9
|
-
/**
|
|
10
|
-
* Operations for images which can be attached to models.
|
|
11
|
-
*/
|
|
12
|
-
export declare class SdPlatformImageApi extends ResourcesApi {
|
|
13
|
-
protected get __resourcePath(): string;
|
|
14
|
-
/**
|
|
15
|
-
* Get image by id
|
|
16
|
-
* @param id
|
|
17
|
-
* @param embed
|
|
18
|
-
* @returns
|
|
19
|
-
*/
|
|
20
|
-
get(id: string, embed?: Array<SdPlatformImageQueryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
|
|
21
|
-
/**
|
|
22
|
-
* Queries images
|
|
23
|
-
* @param body
|
|
24
|
-
*/
|
|
25
|
-
query(body?: SdPlatformImageQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
|
|
26
|
-
/**
|
|
27
|
-
* Create an image
|
|
28
|
-
* @param body
|
|
29
|
-
*/
|
|
30
|
-
create(body: SdPlatformRequestImageCreate): Promise<SdPlatformPostResponse<SdPlatformResponseImage>>;
|
|
31
|
-
/**
|
|
32
|
-
* Delete image by id
|
|
33
|
-
* @param id - image id.
|
|
34
|
-
*/
|
|
35
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
36
|
-
}
|
|
1
|
+
import { SdPlatformResponseImage, SdPlatformResponseImageAdmin, SdPlatformResponseImagePublic, SdPlatformRequestImageCreate } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
3
|
+
import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformQueryParameters, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformImageQueryEmbeddableFields {
|
|
5
|
+
User = "user",
|
|
6
|
+
Models = "models"
|
|
7
|
+
}
|
|
8
|
+
export declare type SdPlatformImageQueryParameters = SdPlatformQueryParameters<SdPlatformImageQueryEmbeddableFields>;
|
|
9
|
+
/**
|
|
10
|
+
* Operations for images which can be attached to models.
|
|
11
|
+
*/
|
|
12
|
+
export declare class SdPlatformImageApi extends ResourcesApi {
|
|
13
|
+
protected get __resourcePath(): string;
|
|
14
|
+
/**
|
|
15
|
+
* Get image by id
|
|
16
|
+
* @param id
|
|
17
|
+
* @param embed
|
|
18
|
+
* @returns
|
|
19
|
+
*/
|
|
20
|
+
get(id: string, embed?: Array<SdPlatformImageQueryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
|
|
21
|
+
/**
|
|
22
|
+
* Queries images
|
|
23
|
+
* @param body
|
|
24
|
+
*/
|
|
25
|
+
query(body?: SdPlatformImageQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
|
|
26
|
+
/**
|
|
27
|
+
* Create an image
|
|
28
|
+
* @param body
|
|
29
|
+
*/
|
|
30
|
+
create(body: SdPlatformRequestImageCreate): Promise<SdPlatformPostResponse<SdPlatformResponseImage>>;
|
|
31
|
+
/**
|
|
32
|
+
* Delete image by id
|
|
33
|
+
* @param id - image id.
|
|
34
|
+
*/
|
|
35
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
36
|
+
}
|
|
37
37
|
//# sourceMappingURL=SdPlatformImageApi.d.ts.map
|
|
@@ -1,77 +1,77 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformRequestModelCreate, SdPlatformRequestModelPatch, SdPlatformRequestModelPatchAdmin, SdPlatformResponseModelOwner, SdPlatformResponseModelPublic, SdPlatformResponseDecryptTicketResult, SdPlatformResponseIFrameData } 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 SdPlatformModelQueryEmbeddableFields {
|
|
5
|
-
Accessdomains = "accessdomains",
|
|
6
|
-
GlobalAccessdomains = "global_accessdomains",
|
|
7
|
-
BackendSystem = "backend_system",
|
|
8
|
-
Tags = "tags",
|
|
9
|
-
User = "user",
|
|
10
|
-
Decoration = "decoration",
|
|
11
|
-
Bookmark = "bookmark",
|
|
12
|
-
Organization = "organization"
|
|
13
|
-
}
|
|
14
|
-
export declare enum SdPlatformModelGetEmbeddableFields {
|
|
15
|
-
Accessdomains = "accessdomains",
|
|
16
|
-
GlobalAccessdomains = "global_accessdomains",
|
|
17
|
-
BackendSystem = "backend_system",
|
|
18
|
-
BackendProperties = "backend_properties",
|
|
19
|
-
Tags = "tags",
|
|
20
|
-
User = "user",
|
|
21
|
-
Decoration = "decoration",
|
|
22
|
-
Bookmark = "bookmark",
|
|
23
|
-
Ticket = "ticket",
|
|
24
|
-
AuthorTicket = "author_ticket",
|
|
25
|
-
BackendTicket = "backend_ticket",
|
|
26
|
-
Organization = "organization"
|
|
27
|
-
}
|
|
28
|
-
export declare type SdPlatformModelQueryParameters = SdPlatformQueryParameters<SdPlatformModelQueryEmbeddableFields>;
|
|
29
|
-
/**
|
|
30
|
-
* Operations for models on the ShapeDiver Platform.
|
|
31
|
-
*/
|
|
32
|
-
export declare class SdPlatformModelApi extends ResourcesApi {
|
|
33
|
-
protected get __resourcePath(): string;
|
|
34
|
-
/**
|
|
35
|
-
* Get model by id, guid, slug, or link_sharing_slug.
|
|
36
|
-
* @param id
|
|
37
|
-
* @param embed
|
|
38
|
-
* @returns
|
|
39
|
-
*/
|
|
40
|
-
get<T = SdPlatformResponseModelPublic>(id: string, embed?: Array<SdPlatformModelGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @param query
|
|
44
|
-
* @returns
|
|
45
|
-
*/
|
|
46
|
-
query<T = SdPlatformResponseModelPublic>(query?: SdPlatformModelQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
47
|
-
/**
|
|
48
|
-
* Create a model.
|
|
49
|
-
* @param body
|
|
50
|
-
* @returns
|
|
51
|
-
*/
|
|
52
|
-
create<T = SdPlatformResponseModelOwner>(body?: SdPlatformRequestModelCreate): Promise<SdPlatformPostResponse<T>>;
|
|
53
|
-
/**
|
|
54
|
-
* Patch
|
|
55
|
-
* @param id
|
|
56
|
-
* @param
|
|
57
|
-
* @returns
|
|
58
|
-
*/
|
|
59
|
-
patch<T = SdPlatformResponseModelOwner>(id: string,
|
|
60
|
-
/**
|
|
61
|
-
*
|
|
62
|
-
* @param id
|
|
63
|
-
* @returns
|
|
64
|
-
*/
|
|
65
|
-
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
66
|
-
/**
|
|
67
|
-
*
|
|
68
|
-
* @param ticket
|
|
69
|
-
* @returns
|
|
70
|
-
*/
|
|
71
|
-
decryptTicket(ticket: string): Promise<SdPlatformPostResponse<SdPlatformResponseDecryptTicketResult>>;
|
|
72
|
-
/**
|
|
73
|
-
* Post method which is to be used to fetch data necessary for iframe embedding of a model using the ShapeDiver Viewer.
|
|
74
|
-
*/
|
|
75
|
-
iframeEmbedding(slug: string): Promise<SdPlatformPostResponse<SdPlatformResponseIFrameData>>;
|
|
76
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformRequestModelCreate, SdPlatformRequestModelPatch, SdPlatformRequestModelPatchAdmin, SdPlatformResponseModelOwner, SdPlatformResponseModelPublic, SdPlatformResponseDecryptTicketResult, SdPlatformResponseIFrameData } 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 SdPlatformModelQueryEmbeddableFields {
|
|
5
|
+
Accessdomains = "accessdomains",
|
|
6
|
+
GlobalAccessdomains = "global_accessdomains",
|
|
7
|
+
BackendSystem = "backend_system",
|
|
8
|
+
Tags = "tags",
|
|
9
|
+
User = "user",
|
|
10
|
+
Decoration = "decoration",
|
|
11
|
+
Bookmark = "bookmark",
|
|
12
|
+
Organization = "organization"
|
|
13
|
+
}
|
|
14
|
+
export declare enum SdPlatformModelGetEmbeddableFields {
|
|
15
|
+
Accessdomains = "accessdomains",
|
|
16
|
+
GlobalAccessdomains = "global_accessdomains",
|
|
17
|
+
BackendSystem = "backend_system",
|
|
18
|
+
BackendProperties = "backend_properties",
|
|
19
|
+
Tags = "tags",
|
|
20
|
+
User = "user",
|
|
21
|
+
Decoration = "decoration",
|
|
22
|
+
Bookmark = "bookmark",
|
|
23
|
+
Ticket = "ticket",
|
|
24
|
+
AuthorTicket = "author_ticket",
|
|
25
|
+
BackendTicket = "backend_ticket",
|
|
26
|
+
Organization = "organization"
|
|
27
|
+
}
|
|
28
|
+
export declare type SdPlatformModelQueryParameters = SdPlatformQueryParameters<SdPlatformModelQueryEmbeddableFields>;
|
|
29
|
+
/**
|
|
30
|
+
* Operations for models on the ShapeDiver Platform.
|
|
31
|
+
*/
|
|
32
|
+
export declare class SdPlatformModelApi extends ResourcesApi {
|
|
33
|
+
protected get __resourcePath(): string;
|
|
34
|
+
/**
|
|
35
|
+
* Get model by id, guid, slug, or link_sharing_slug.
|
|
36
|
+
* @param { string} id - the model id.
|
|
37
|
+
* @param { Array<SdPlatformModelGetEmbeddableFields> } embed - embeddable properties.
|
|
38
|
+
* @returns { Promise<SdPlatformGetResponse<T> }
|
|
39
|
+
*/
|
|
40
|
+
get<T = SdPlatformResponseModelPublic>(id: string, embed?: Array<SdPlatformModelGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
41
|
+
/**
|
|
42
|
+
* Queries the models.
|
|
43
|
+
* @param { SdPlatformModelQueryParameters } query - the query
|
|
44
|
+
* @returns { Promise<SdPlatformQueryResponse<T>> }
|
|
45
|
+
*/
|
|
46
|
+
query<T = SdPlatformResponseModelPublic>(query?: SdPlatformModelQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
47
|
+
/**
|
|
48
|
+
* Create a model.
|
|
49
|
+
* @param { SdPlatformRequestModelCreate } body - the parameters of a model.
|
|
50
|
+
* @returns { Promise<SdPlatformPostResponse<T>> }
|
|
51
|
+
*/
|
|
52
|
+
create<T = SdPlatformResponseModelOwner>(body?: SdPlatformRequestModelCreate): Promise<SdPlatformPostResponse<T>>;
|
|
53
|
+
/**
|
|
54
|
+
* Patch a model, e.g. to update its status to "done" after successful upload and model checking
|
|
55
|
+
* @param { string } id - the model id.
|
|
56
|
+
* @param { SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin} params - patch paramaters
|
|
57
|
+
* @returns { Promise<SdPlatformPatchResponse<T>> }
|
|
58
|
+
*/
|
|
59
|
+
patch<T = SdPlatformResponseModelOwner>(id: string, params: SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
|
|
60
|
+
/**
|
|
61
|
+
* Deletes a model.
|
|
62
|
+
* @param { string } id - the model id.
|
|
63
|
+
* @returns { Promise<SdPlatformDeleteResponse> }
|
|
64
|
+
*/
|
|
65
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
66
|
+
/**
|
|
67
|
+
* Decrypt a ticket, the calling user must have permission "decrypt_ticket" for the model identified by the ticket.
|
|
68
|
+
* @param { string }ticket
|
|
69
|
+
* @returns
|
|
70
|
+
*/
|
|
71
|
+
decryptTicket(ticket: string): Promise<SdPlatformPostResponse<SdPlatformResponseDecryptTicketResult>>;
|
|
72
|
+
/**
|
|
73
|
+
* Post method which is to be used to fetch data necessary for iframe embedding of a model using the ShapeDiver Viewer.
|
|
74
|
+
*/
|
|
75
|
+
iframeEmbedding(slug: string): Promise<SdPlatformPostResponse<SdPlatformResponseIFrameData>>;
|
|
76
|
+
}
|
|
77
77
|
//# sourceMappingURL=SdPlatformModelApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformModelApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,qCAAqC,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AACnR,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,oCAAoC;IAE5C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,kCAAkC;IAE1C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,iBAAiB,uBAAuB;IACxC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,iBAAiB;CAChC;AAED,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKnJ;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAK5H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,
|
|
1
|
+
{"version":3,"file":"SdPlatformModelApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,qCAAqC,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AACnR,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,oCAAoC;IAE5C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,kCAAkC;IAE1C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,iBAAiB,uBAAuB;IACxC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,iBAAiB;CAChC;AAED,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKnJ;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAK5H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKvK;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAO5G;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAStG"}
|
|
@@ -1,65 +1,65 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestModelSharingCreate, SdPlatformRequestModelSharingCreateMultiple, SdPlatformResponseModelSharing, SdPlatformResponseModelSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
export declare enum SdPlatformModelharingQueryEmbeddableFields {
|
|
4
|
-
User = "user",
|
|
5
|
-
Model = "model",
|
|
6
|
-
Provider = "provider"
|
|
7
|
-
}
|
|
8
|
-
export declare type SdPlatformModelSharingQueryParameters = SdPlatformQueryParameters<SdPlatformModelharingQueryEmbeddableFields>;
|
|
9
|
-
/**
|
|
10
|
-
* Operations for model sharing relationships.
|
|
11
|
-
*/
|
|
12
|
-
export declare class SdPlatformModelSharingApi extends ResourcesApi {
|
|
13
|
-
protected get __resourcePath(): string;
|
|
14
|
-
/**
|
|
15
|
-
* Create a model sharing relationship.
|
|
16
|
-
* @param body
|
|
17
|
-
* @returns
|
|
18
|
-
*/
|
|
19
|
-
create(body: SdPlatformRequestModelSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelSharing>>;
|
|
20
|
-
/**
|
|
21
|
-
* Create multiple sharings.
|
|
22
|
-
* @param { SdPlatformRequestModelSharingCreateMultiple } body
|
|
23
|
-
* @returns { Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>> }
|
|
24
|
-
*/
|
|
25
|
-
createMultiple(body: SdPlatformRequestModelSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>>;
|
|
26
|
-
/**
|
|
27
|
-
* Query model sharing relationships.
|
|
28
|
-
* @param query
|
|
29
|
-
* @returns
|
|
30
|
-
*/
|
|
31
|
-
query(query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
|
|
32
|
-
/**
|
|
33
|
-
* Query model sharing relationships by model id.
|
|
34
|
-
* @param model_id
|
|
35
|
-
* @param query
|
|
36
|
-
* @returns
|
|
37
|
-
*/
|
|
38
|
-
queryByModel(model_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
|
|
39
|
-
/**
|
|
40
|
-
* Query model sharing relationships by user id.
|
|
41
|
-
* @param user_id
|
|
42
|
-
* @param query
|
|
43
|
-
*/
|
|
44
|
-
queryByUser(user_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
|
|
45
|
-
/**
|
|
46
|
-
* Get model sharing relationships by model id and user id.
|
|
47
|
-
* @param model_id
|
|
48
|
-
* @param user_id
|
|
49
|
-
* @returns
|
|
50
|
-
*/
|
|
51
|
-
getByModelAndUser(model_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharing>>>;
|
|
52
|
-
/**
|
|
53
|
-
* Delete a model sharing relationship.
|
|
54
|
-
* @param model_sharing_id Id of the model sharing relationship to delete.
|
|
55
|
-
* @returns
|
|
56
|
-
*/
|
|
57
|
-
delete(model_sharing_id: string): Promise<SdPlatformDeleteResponse>;
|
|
58
|
-
/**
|
|
59
|
-
* Gets the model sharings grouped by user.
|
|
60
|
-
* @param model_id
|
|
61
|
-
* @returns
|
|
62
|
-
*/
|
|
63
|
-
getGroupedByUser(model_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharingGroupedByUser>>>;
|
|
64
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestModelSharingCreate, SdPlatformRequestModelSharingCreateMultiple, SdPlatformResponseModelSharing, SdPlatformResponseModelSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
export declare enum SdPlatformModelharingQueryEmbeddableFields {
|
|
4
|
+
User = "user",
|
|
5
|
+
Model = "model",
|
|
6
|
+
Provider = "provider"
|
|
7
|
+
}
|
|
8
|
+
export declare type SdPlatformModelSharingQueryParameters = SdPlatformQueryParameters<SdPlatformModelharingQueryEmbeddableFields>;
|
|
9
|
+
/**
|
|
10
|
+
* Operations for model sharing relationships.
|
|
11
|
+
*/
|
|
12
|
+
export declare class SdPlatformModelSharingApi extends ResourcesApi {
|
|
13
|
+
protected get __resourcePath(): string;
|
|
14
|
+
/**
|
|
15
|
+
* Create a model sharing relationship.
|
|
16
|
+
* @param body
|
|
17
|
+
* @returns
|
|
18
|
+
*/
|
|
19
|
+
create(body: SdPlatformRequestModelSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelSharing>>;
|
|
20
|
+
/**
|
|
21
|
+
* Create multiple sharings.
|
|
22
|
+
* @param { SdPlatformRequestModelSharingCreateMultiple } body
|
|
23
|
+
* @returns { Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>> }
|
|
24
|
+
*/
|
|
25
|
+
createMultiple(body: SdPlatformRequestModelSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>>;
|
|
26
|
+
/**
|
|
27
|
+
* Query model sharing relationships.
|
|
28
|
+
* @param query
|
|
29
|
+
* @returns
|
|
30
|
+
*/
|
|
31
|
+
query(query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
|
|
32
|
+
/**
|
|
33
|
+
* Query model sharing relationships by model id.
|
|
34
|
+
* @param model_id
|
|
35
|
+
* @param query
|
|
36
|
+
* @returns
|
|
37
|
+
*/
|
|
38
|
+
queryByModel(model_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
|
|
39
|
+
/**
|
|
40
|
+
* Query model sharing relationships by user id.
|
|
41
|
+
* @param user_id
|
|
42
|
+
* @param query
|
|
43
|
+
*/
|
|
44
|
+
queryByUser(user_id: string, query?: SdPlatformModelSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseModelSharing>>;
|
|
45
|
+
/**
|
|
46
|
+
* Get model sharing relationships by model id and user id.
|
|
47
|
+
* @param model_id
|
|
48
|
+
* @param user_id
|
|
49
|
+
* @returns
|
|
50
|
+
*/
|
|
51
|
+
getByModelAndUser(model_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharing>>>;
|
|
52
|
+
/**
|
|
53
|
+
* Delete a model sharing relationship.
|
|
54
|
+
* @param model_sharing_id Id of the model sharing relationship to delete.
|
|
55
|
+
* @returns
|
|
56
|
+
*/
|
|
57
|
+
delete(model_sharing_id: string): Promise<SdPlatformDeleteResponse>;
|
|
58
|
+
/**
|
|
59
|
+
* Gets the model sharings grouped by user.
|
|
60
|
+
* @param model_id
|
|
61
|
+
* @returns
|
|
62
|
+
*/
|
|
63
|
+
getGroupedByUser(model_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseModelSharingGroupedByUser>>>;
|
|
64
|
+
}
|
|
65
65
|
//# sourceMappingURL=SdPlatformModelSharingApi.d.ts.map
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformResponseModelToken, SdPlatformRequestModelTokenCreate } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* Operations for creating tokens for models on Geometry Backend Systems
|
|
6
|
-
*/
|
|
7
|
-
export declare class SdPlatformModelTokenApi extends ResourcesApi {
|
|
8
|
-
protected get __resourcePath(): string;
|
|
9
|
-
create(body: SdPlatformRequestModelTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelToken>>;
|
|
10
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformResponseModelToken, SdPlatformRequestModelTokenCreate } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* Operations for creating tokens for models on Geometry Backend Systems
|
|
6
|
+
*/
|
|
7
|
+
export declare class SdPlatformModelTokenApi extends ResourcesApi {
|
|
8
|
+
protected get __resourcePath(): string;
|
|
9
|
+
create(body: SdPlatformRequestModelTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseModelToken>>;
|
|
10
|
+
}
|
|
11
11
|
//# sourceMappingURL=SdPlatformModelTokenApi.d.ts.map
|
|
@@ -1,48 +1,48 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformRequestModelTransferCreate, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
/**
|
|
5
|
-
* Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
|
|
6
|
-
*/
|
|
7
|
-
export declare class SdPlatformModelTransferApi extends ResourcesApi {
|
|
8
|
-
protected get __resourcePath(): string;
|
|
9
|
-
/**
|
|
10
|
-
* Get all model transfer requests for models currently owned by the authenticated user.
|
|
11
|
-
* @returns
|
|
12
|
-
*/
|
|
13
|
-
getModelTransferRequests(): Promise<SdPlatformGetResponse<Array<SdPlatformResponseNotification>>>;
|
|
14
|
-
/**
|
|
15
|
-
* Creates a model transfer request. The calling user must have permission "update_owner" for the model.
|
|
16
|
-
* In case the receiving user immediately accepts the transfer request, no notification will be returned.
|
|
17
|
-
* @param model_id
|
|
18
|
-
* @param body
|
|
19
|
-
* @returns
|
|
20
|
-
*/
|
|
21
|
-
createModelTransferRequest(model_id: string, body: SdPlatformRequestModelTransferCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification | undefined>>;
|
|
22
|
-
/**
|
|
23
|
-
* Deletes a model transfer request by model id. The calling user must have permission "update_owner" for the model.
|
|
24
|
-
* @param model_id
|
|
25
|
-
* @returns
|
|
26
|
-
*/
|
|
27
|
-
deleteModelTransferRequest(model_id: string): Promise<SdPlatformDeleteResponse>;
|
|
28
|
-
/**
|
|
29
|
-
* Get a model transfer request by model id. The calling user must have permission "update_owner" for the model.
|
|
30
|
-
* The receiving user can see the model transfer request when querying notifications in general.
|
|
31
|
-
* @param model_id
|
|
32
|
-
* @returns
|
|
33
|
-
*/
|
|
34
|
-
getModelTransferRequest(model_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseNotification>>;
|
|
35
|
-
/**
|
|
36
|
-
* Accept a model transfer request. This must be called by the receiving user.
|
|
37
|
-
* @param model_id
|
|
38
|
-
* @returns
|
|
39
|
-
*/
|
|
40
|
-
acceptModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
|
|
41
|
-
/**
|
|
42
|
-
* Deny the model transfer request. This must be called by the receiving user.
|
|
43
|
-
* @param model_id
|
|
44
|
-
* @returns
|
|
45
|
-
*/
|
|
46
|
-
denyModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
|
|
47
|
-
}
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformRequestModelTransferCreate, SdPlatformResponseNotification } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformGetResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
/**
|
|
5
|
+
* Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SdPlatformModelTransferApi extends ResourcesApi {
|
|
8
|
+
protected get __resourcePath(): string;
|
|
9
|
+
/**
|
|
10
|
+
* Get all model transfer requests for models currently owned by the authenticated user.
|
|
11
|
+
* @returns
|
|
12
|
+
*/
|
|
13
|
+
getModelTransferRequests(): Promise<SdPlatformGetResponse<Array<SdPlatformResponseNotification>>>;
|
|
14
|
+
/**
|
|
15
|
+
* Creates a model transfer request. The calling user must have permission "update_owner" for the model.
|
|
16
|
+
* In case the receiving user immediately accepts the transfer request, no notification will be returned.
|
|
17
|
+
* @param model_id
|
|
18
|
+
* @param body
|
|
19
|
+
* @returns
|
|
20
|
+
*/
|
|
21
|
+
createModelTransferRequest(model_id: string, body: SdPlatformRequestModelTransferCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification | undefined>>;
|
|
22
|
+
/**
|
|
23
|
+
* Deletes a model transfer request by model id. The calling user must have permission "update_owner" for the model.
|
|
24
|
+
* @param model_id
|
|
25
|
+
* @returns
|
|
26
|
+
*/
|
|
27
|
+
deleteModelTransferRequest(model_id: string): Promise<SdPlatformDeleteResponse>;
|
|
28
|
+
/**
|
|
29
|
+
* Get a model transfer request by model id. The calling user must have permission "update_owner" for the model.
|
|
30
|
+
* The receiving user can see the model transfer request when querying notifications in general.
|
|
31
|
+
* @param model_id
|
|
32
|
+
* @returns
|
|
33
|
+
*/
|
|
34
|
+
getModelTransferRequest(model_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseNotification>>;
|
|
35
|
+
/**
|
|
36
|
+
* Accept a model transfer request. This must be called by the receiving user.
|
|
37
|
+
* @param model_id
|
|
38
|
+
* @returns
|
|
39
|
+
*/
|
|
40
|
+
acceptModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
|
|
41
|
+
/**
|
|
42
|
+
* Deny the model transfer request. This must be called by the receiving user.
|
|
43
|
+
* @param model_id
|
|
44
|
+
* @returns
|
|
45
|
+
*/
|
|
46
|
+
denyModelTransferRequest(model_id: string): Promise<SdPlatformPostResponse<void>>;
|
|
47
|
+
}
|
|
48
48
|
//# sourceMappingURL=SdPlatformModelTransferApi.d.ts.map
|
|
@@ -1,34 +1,66 @@
|
|
|
1
|
-
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
-
import { SdPlatformGetResponse, SdPlatformRequestNotificationCreate, SdPlatformRequestNotificationPatch, SdPlatformResponseNotification, SdPlatformResponseNotificationSummary } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
-
import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
-
export declare enum SdPlatformNotificationEmbeddableFields {
|
|
5
|
-
Receiver = "receiver",
|
|
6
|
-
User = "user",
|
|
7
|
-
Model = "model",
|
|
8
|
-
SavedState = "saved_state",
|
|
9
|
-
Document = "document",
|
|
10
|
-
Organization = "organization"
|
|
11
|
-
}
|
|
12
|
-
export declare enum SdPlatformNotificationSummaryEmbeddableFields {
|
|
13
|
-
Total = "total",
|
|
14
|
-
Unread = "unread"
|
|
15
|
-
}
|
|
16
|
-
export declare type SdPlatformNotificationQueryParameters = SdPlatformQueryParameters<SdPlatformNotificationEmbeddableFields>;
|
|
17
|
-
/**
|
|
18
|
-
* Operations for querying, reading/unreading, creating notifications.
|
|
19
|
-
*/
|
|
20
|
-
export declare class SdPlatformNotificationApi extends ResourcesApi {
|
|
21
|
-
protected get __resourcePath(): string;
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
* @
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformGetResponse, SdPlatformRequestNotificationCreate, SdPlatformRequestNotificationPatch, SdPlatformResponseNotification, SdPlatformResponseNotificationSummary } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare enum SdPlatformNotificationEmbeddableFields {
|
|
5
|
+
Receiver = "receiver",
|
|
6
|
+
User = "user",
|
|
7
|
+
Model = "model",
|
|
8
|
+
SavedState = "saved_state",
|
|
9
|
+
Document = "document",
|
|
10
|
+
Organization = "organization"
|
|
11
|
+
}
|
|
12
|
+
export declare enum SdPlatformNotificationSummaryEmbeddableFields {
|
|
13
|
+
Total = "total",
|
|
14
|
+
Unread = "unread"
|
|
15
|
+
}
|
|
16
|
+
export declare type SdPlatformNotificationQueryParameters = SdPlatformQueryParameters<SdPlatformNotificationEmbeddableFields>;
|
|
17
|
+
/**
|
|
18
|
+
* Operations for querying, reading/unreading, creating notifications.
|
|
19
|
+
*/
|
|
20
|
+
export declare class SdPlatformNotificationApi extends ResourcesApi {
|
|
21
|
+
protected get __resourcePath(): string;
|
|
22
|
+
/**
|
|
23
|
+
* Query the notifications.
|
|
24
|
+
* @param { SdPlatformNotificationQueryParameters } body - the notifications query body.
|
|
25
|
+
* @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseNotification>> }
|
|
26
|
+
*/
|
|
27
|
+
query(body?: SdPlatformNotificationQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseNotification>>;
|
|
28
|
+
/**
|
|
29
|
+
* Creates the notification.
|
|
30
|
+
* @param { SdPlatformRequestNotificationCreate } body
|
|
31
|
+
* @returns { Promise<SdPlatformPostResponse<SdPlatformResponseNotification>> }
|
|
32
|
+
*/
|
|
33
|
+
create(body: SdPlatformRequestNotificationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
|
|
34
|
+
/**
|
|
35
|
+
* Updates the notification-
|
|
36
|
+
* @param { string } id - the id of a notification.
|
|
37
|
+
* @param { SdPlatformRequestNotificationPatch } body - the body of a notification.
|
|
38
|
+
* @returns { Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>> }
|
|
39
|
+
*/
|
|
40
|
+
patch(id: string, body: SdPlatformRequestNotificationPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseNotification>>;
|
|
41
|
+
/**
|
|
42
|
+
* Deletes the notification.
|
|
43
|
+
* @param { string } id - the id of a notification.
|
|
44
|
+
* @returns { Promise<SdPlatformDeleteResponse> }
|
|
45
|
+
*/
|
|
46
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
47
|
+
/**
|
|
48
|
+
* Gets the summary of notifications.
|
|
49
|
+
* Gives information about total number of notifications and unread number of notifications.
|
|
50
|
+
* @param { Array<SdPlatformNotificationSummaryEmbeddableFields> } embed - the embed properties.
|
|
51
|
+
* @returns { Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>> }
|
|
52
|
+
*/
|
|
53
|
+
summary(embed: Array<SdPlatformNotificationSummaryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseNotificationSummary>>;
|
|
54
|
+
/**
|
|
55
|
+
* Gets the notification by id.
|
|
56
|
+
* @param { string } id - the id of notification.
|
|
57
|
+
* @returns { Promise<SdPlatformGetResponse<T>> }
|
|
58
|
+
*/
|
|
59
|
+
get<T = SdPlatformResponseNotification>(id: string): Promise<SdPlatformGetResponse<T>>;
|
|
60
|
+
/**
|
|
61
|
+
* Marks all notifications of signed in user as read.
|
|
62
|
+
* @returns { Promise<SdPlatformPostResponse<void>> }
|
|
63
|
+
*/
|
|
64
|
+
markAllAsRead(): Promise<SdPlatformPostResponse<void>>;
|
|
65
|
+
}
|
|
34
66
|
//# sourceMappingURL=SdPlatformNotificationApi.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SdPlatformNotificationApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformNotificationApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACH,qBAAqB,EACrB,mCAAmC,EACnC,kCAAkC,EAClC,8BAA8B,EAC9B,qCAAqC,EACxC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL,oBAAY,sCAAsC;IAE9C,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,6CAA6C;IAErD,KAAK,UAAU;IACf,MAAM,WAAW;CACpB;AAGD,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;
|
|
1
|
+
{"version":3,"file":"SdPlatformNotificationApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformNotificationApi.ts"],"names":[],"mappings":"AAEA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EACH,qBAAqB,EACrB,mCAAmC,EACnC,kCAAkC,EAClC,8BAA8B,EAC9B,qCAAqC,EACxC,MAAM,qCAAqC,CAAA;AAC5C,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL,oBAAY,sCAAsC;IAE9C,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,6CAA6C;IAErD,KAAK,UAAU;IACf,MAAM,WAAW;CACpB;AAGD,oBAAY,qCAAqC,GAAG,yBAAyB,CAAC,sCAAsC,CAAC,CAAA;AAErH;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,YAAY;IAEvD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,qCAA0C,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,8BAA8B,CAAC,CAAC;IAKzH;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kCAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,8BAA8B,CAAC,CAAC;IAKpI;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,6CAA6C,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,qCAAqC,CAAC,CAAC;IAKlJ;;;;OAIG;IACI,GAAG,CAAC,CAAC,GAAG,8BAA8B,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK7F;;;OAGG;IACI,aAAa,IAAI,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAIhE"}
|