@shapediver/sdk.platform-api-sdk-v1 1.14.16
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 -0
- package/README.md +50 -0
- package/dist/SdPlatformErrors.d.ts +78 -0
- package/dist/SdPlatformErrors.d.ts.map +1 -0
- package/dist/SdPlatformSdk.d.ts +162 -0
- package/dist/SdPlatformSdk.d.ts.map +1 -0
- package/dist/SdPlatformSdkContext.d.ts +72 -0
- package/dist/SdPlatformSdkContext.d.ts.map +1 -0
- package/dist/SdPlatformSdkCreate.d.ts +8 -0
- package/dist/SdPlatformSdkCreate.d.ts.map +1 -0
- package/dist/ShapeDiverSDK.d.ts +8 -0
- package/dist/ShapeDiverSDKInstance.d.ts +100 -0
- package/dist/api/SdPlatformRequestId.d.ts +105 -0
- package/dist/api/SdPlatformRequestId.d.ts.map +1 -0
- package/dist/api/SdPlatformSdkApi.d.ts +63 -0
- package/dist/api/SdPlatformSdkApi.d.ts.map +1 -0
- package/dist/api/SdPlatformSdkConfig.d.ts +19 -0
- package/dist/api/SdPlatformSdkConfig.d.ts.map +1 -0
- package/dist/api/SdPlatformSdkErrorMapping.d.ts +29 -0
- package/dist/api/SdPlatformSdkErrorMapping.d.ts.map +1 -0
- package/dist/api/ShapeDiverSDKApi.d.ts +65 -0
- package/dist/api/ShapeDiverSDKRequestConfig.d.ts +7 -0
- package/dist/auth/AuthServiceApi.d.ts +34 -0
- package/dist/auth/SdPlatformAuthServiceApi.d.ts +59 -0
- package/dist/auth/SdPlatformAuthServiceApi.d.ts.map +1 -0
- package/dist/auth/models/AuthRequest.d.ts +12 -0
- package/dist/auth/models/AuthResponse.d.ts +8 -0
- package/dist/auth/models/ShapeDiverAuthRequest.d.ts +12 -0
- package/dist/bundle.js +5454 -0
- package/dist/bundle.node.js +7694 -0
- package/dist/common/FailedRequestError.d.ts +3 -0
- package/dist/common/Filter.d.ts +51 -0
- package/dist/common/Parameters.d.ts +28 -0
- package/dist/common/RequestId.d.ts +101 -0
- package/dist/common/ShapeDiverSDKContext.d.ts +31 -0
- package/dist/config/ShapeDiverSDKConfig.d.ts +6 -0
- package/dist/index.d.ts +28 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/resources/ResourcesApi.d.ts +80 -0
- package/dist/resources/SdPlatformApiTokenApi.d.ts +19 -0
- package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformBackendSystemApi.d.ts +18 -0
- package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformBookmarkApi.d.ts +17 -0
- package/dist/resources/SdPlatformBookmarkApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformChargebeeApi.d.ts +21 -0
- package/dist/resources/SdPlatformChargebeeApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformDomainApi.d.ts +45 -0
- package/dist/resources/SdPlatformDomainApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformHttpLogApi.d.ts +16 -0
- package/dist/resources/SdPlatformHttpLogApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformImageApi.d.ts +37 -0
- package/dist/resources/SdPlatformImageApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformModelApi.d.ts +41 -0
- package/dist/resources/SdPlatformModelApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformModelSharingApi.d.ts +49 -0
- package/dist/resources/SdPlatformModelSharingApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformModelTokenApi.d.ts +11 -0
- package/dist/resources/SdPlatformModelTokenApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -0
- package/dist/resources/SdPlatformModelTransferApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformNotificationApi.d.ts +23 -0
- package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformOrganizationApi.d.ts +86 -0
- package/dist/resources/SdPlatformOrganizationApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformPolicyApi.d.ts +18 -0
- package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformSavedStateApi.d.ts +50 -0
- package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +50 -0
- package/dist/resources/SdPlatformSavedStateSharingApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformTagApi.d.ts +16 -0
- package/dist/resources/SdPlatformTagApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformUserAnalyticsApi.d.ts +16 -0
- package/dist/resources/SdPlatformUserAnalyticsApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformUserApi.d.ts +74 -0
- package/dist/resources/SdPlatformUserApi.d.ts.map +1 -0
- package/dist/resources/SdPlatformWebhookApi.d.ts +53 -0
- package/dist/resources/SdPlatformWebhookApi.d.ts.map +1 -0
- package/dist/resources/apiTokens/ApiTokenApi.d.ts +16 -0
- package/dist/resources/apiTokens/models/ApiToken.d.ts +37 -0
- package/dist/resources/apiTokens/models/ApiTokenCreate.d.ts +7 -0
- package/dist/resources/apiTokens/models/ApiTokenPatch.d.ts +6 -0
- package/dist/resources/apiTokens/models/JustCreatedApiToken.d.ts +5 -0
- package/dist/resources/backendSystems/BackendSystemApi.d.ts +14 -0
- package/dist/resources/backendSystems/models/BackendSystem.d.ts +25 -0
- package/dist/resources/backendSystems/models/BackendSystemCreate.d.ts +21 -0
- package/dist/resources/backendSystems/models/BackendSystemPatch.d.ts +17 -0
- package/dist/resources/bookmarks/BookmarkApi.d.ts +11 -0
- package/dist/resources/bookmarks/models/BookmarkCreate.d.ts +4 -0
- package/dist/resources/chargebee/ChargebeeApi.d.ts +17 -0
- package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts +44 -0
- package/dist/resources/common/FeaturesModel.d.ts +45 -0
- package/dist/resources/commons/FilterBuilder.d.ts +55 -0
- package/dist/resources/commons/FilterBuilder.d.ts.map +1 -0
- package/dist/resources/commons/ResourcesApi.d.ts +41 -0
- package/dist/resources/commons/ResourcesApi.d.ts.map +1 -0
- package/dist/resources/domains/DomainApi.d.ts +28 -0
- package/dist/resources/domains/models/Domain.d.ts +19 -0
- package/dist/resources/domains/models/DomainCreateRequest.d.ts +5 -0
- package/dist/resources/domains/models/DomainPatchRequest.d.ts +5 -0
- package/dist/resources/httplogs/HttpLogApi.d.ts +15 -0
- package/dist/resources/httplogs/models.d.ts +14 -0
- package/dist/resources/images/ImageApi.d.ts +33 -0
- package/dist/resources/images/models/Image.d.ts +7 -0
- package/dist/resources/images/models/ImageCreate.d.ts +9 -0
- package/dist/resources/modelSharing/ModelSharingApi.d.ts +49 -0
- package/dist/resources/modelSharing/models/ModelSharing.d.ts +28 -0
- package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts +14 -0
- package/dist/resources/modelTransfers/ModelTransferApi.d.ts +44 -0
- package/dist/resources/models/ModelApi.d.ts +16 -0
- package/dist/resources/models/models/CreateModelTransferRequest.d.ts +7 -0
- package/dist/resources/models/models/Model.d.ts +166 -0
- package/dist/resources/models/models/ModelCreate.d.ts +20 -0
- package/dist/resources/models/models/ModelPatch.d.ts +24 -0
- package/dist/resources/notifications/NotificationsApi.d.ts +14 -0
- package/dist/resources/notifications/models/Notification.d.ts +60 -0
- package/dist/resources/notifications/models/Requests.d.ts +18 -0
- package/dist/resources/organizations/OrganizationsApi.d.ts +72 -0
- package/dist/resources/organizations/models/Organization.d.ts +78 -0
- package/dist/resources/organizations/models/Requests.d.ts +21 -0
- package/dist/resources/policies/PoliciesApi.d.ts +15 -0
- package/dist/resources/policies/PolicyApi.d.ts +15 -0
- package/dist/resources/policies/models/Policy.d.ts +221 -0
- package/dist/resources/policies/models/PolicyCreate.d.ts +20 -0
- package/dist/resources/policies/models/PolicyPatch.d.ts +18 -0
- package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts +49 -0
- package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts +14 -0
- package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts +5 -0
- package/dist/resources/savedStates/SavedStatesApi.d.ts +43 -0
- package/dist/resources/savedStates/models/SavedStatesModels.d.ts +32 -0
- package/dist/resources/savedStates/models/SavedStatesRequests.d.ts +28 -0
- package/dist/resources/sdmodels/SDModelApi.d.ts +14 -0
- package/dist/resources/sdmodels/models/SDModel.d.ts +116 -0
- package/dist/resources/sdmodels/models/SDModelCreate.d.ts +20 -0
- package/dist/resources/sdmodels/models/SDModelPatch.d.ts +11 -0
- package/dist/resources/tags/TagApi.d.ts +10 -0
- package/dist/resources/tags/models/Tag.d.ts +14 -0
- package/dist/resources/tokens/TokenApi.d.ts +8 -0
- package/dist/resources/tokens/models/Token.d.ts +7 -0
- package/dist/resources/tokens/models/TokenRequest.d.ts +16 -0
- package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts +14 -0
- package/dist/resources/userModelSessions/models/UserModelSession.d.ts +53 -0
- package/dist/resources/users/UserApi.d.ts +49 -0
- package/dist/resources/users/models/PasswordResetConfirmRequest.d.ts +6 -0
- package/dist/resources/users/models/PatchUserRequest.d.ts +32 -0
- package/dist/resources/users/models/RegisterUser.d.ts +7 -0
- package/dist/resources/users/models/User.d.ts +104 -0
- package/dist/resources/users/models/UserPatchRequest.d.ts +41 -0
- package/dist/resources/webhooks/WebhooksApi.d.ts +50 -0
- package/dist/resources/webhooks/models/Requests.d.ts +16 -0
- package/package.json +59 -0
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { FilterValue } from "./Parameters";
|
|
2
|
+
declare enum FilterOperators {
|
|
3
|
+
Equal = "=",
|
|
4
|
+
Like = "%"
|
|
5
|
+
}
|
|
6
|
+
declare enum LogicalOperators {
|
|
7
|
+
And = "&",
|
|
8
|
+
Or = "|"
|
|
9
|
+
}
|
|
10
|
+
interface FilterExpression {
|
|
11
|
+
property: string;
|
|
12
|
+
value: FilterValue;
|
|
13
|
+
filter_operator?: FilterOperators;
|
|
14
|
+
logical_operator?: LogicalOperators;
|
|
15
|
+
join?: FilterExpression;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Interface for filter builder.
|
|
19
|
+
*/
|
|
20
|
+
interface FilterBuilder {
|
|
21
|
+
/**
|
|
22
|
+
* Starts filter from begining. Essentially replacing all existing expressions.
|
|
23
|
+
* @param expressions
|
|
24
|
+
*/
|
|
25
|
+
start(expressions?: Array<FilterExpression>): FilterBuilder;
|
|
26
|
+
/**
|
|
27
|
+
* Adds filter expression to filter.
|
|
28
|
+
* @param expression
|
|
29
|
+
*/
|
|
30
|
+
attach(expression: FilterExpression): FilterBuilder;
|
|
31
|
+
/**
|
|
32
|
+
* Finish with filter and resolve it to final filter parameter for request.
|
|
33
|
+
*/
|
|
34
|
+
finish(): {
|
|
35
|
+
[filter_expression: string]: FilterValue;
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Instance of filter builder.
|
|
40
|
+
*/
|
|
41
|
+
declare class FilterBuilderInstance implements FilterBuilder {
|
|
42
|
+
private __expressions;
|
|
43
|
+
constructor(__expressions?: Array<FilterExpression>);
|
|
44
|
+
static create(expressions?: FilterExpression[]): FilterBuilder;
|
|
45
|
+
start(expressions?: FilterExpression[]): FilterBuilder;
|
|
46
|
+
attach(expression: FilterExpression): FilterBuilder;
|
|
47
|
+
finish(): {
|
|
48
|
+
[filter_expression: string]: FilterValue;
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
export { FilterExpression, FilterBuilder, FilterBuilderInstance, FilterOperators, LogicalOperators };
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
interface PaginationParameters {
|
|
2
|
+
limit?: number | null;
|
|
3
|
+
strict_limit?: boolean | null;
|
|
4
|
+
/**
|
|
5
|
+
* offset is used to prefetch next set of results.
|
|
6
|
+
*/
|
|
7
|
+
offset?: string | null;
|
|
8
|
+
}
|
|
9
|
+
declare enum SortingOrder {
|
|
10
|
+
Asc = "asc",
|
|
11
|
+
Desc = "desc"
|
|
12
|
+
}
|
|
13
|
+
declare type FilterValue = string | number | boolean | null | Array<FilterValue>;
|
|
14
|
+
interface FilterParameters {
|
|
15
|
+
filters?: {
|
|
16
|
+
[filter_expression: string]: FilterValue;
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
interface SorterParameters {
|
|
20
|
+
sorters?: {
|
|
21
|
+
[column: string]: SortingOrder;
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
interface EmbedParameters<TEmeddableResource> {
|
|
25
|
+
embed?: Array<TEmeddableResource>;
|
|
26
|
+
}
|
|
27
|
+
declare type QueryParameters<TEmeddableResource> = PaginationParameters & FilterParameters & SorterParameters & EmbedParameters<TEmeddableResource>;
|
|
28
|
+
export { QueryParameters, FilterValue, SortingOrder, SorterParameters, EmbedParameters, };
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
declare enum RequestId {
|
|
2
|
+
/**
|
|
3
|
+
* Platform Authentication API
|
|
4
|
+
* Comment by Alex: Ideally this would be kept as separate as possible from the Platform Backend API
|
|
5
|
+
* - separate files
|
|
6
|
+
* - separate types
|
|
7
|
+
* - the platform SDK uses an interface defined for the authentication SDK)
|
|
8
|
+
* - the base url for the two might soon be different!!!
|
|
9
|
+
*/
|
|
10
|
+
PasswordGrant = "password_grant",
|
|
11
|
+
RefreshToken = "refresh_token",
|
|
12
|
+
Logout = "logout",
|
|
13
|
+
/** Platform Backend API */
|
|
14
|
+
UserGet = "user_get",
|
|
15
|
+
UserQuery = "user_query",
|
|
16
|
+
UserPatch = "user_patch",
|
|
17
|
+
UserDelete = "user_delete",
|
|
18
|
+
UserRegister = "user_register",
|
|
19
|
+
UserConfirm = "user_confirm",
|
|
20
|
+
PasswordReset = "password_reset",
|
|
21
|
+
PasswordResetConfirm = "password_reset_confirm",
|
|
22
|
+
PolicyGet = "policy_get",
|
|
23
|
+
PolicyQuery = "policy_query",
|
|
24
|
+
PolicyCreate = "policy_create",
|
|
25
|
+
PolicyPatch = "policy_patch",
|
|
26
|
+
PolicyDelete = "policy_delete",
|
|
27
|
+
ModelGet = "model_get",
|
|
28
|
+
ModelQuery = "model_query",
|
|
29
|
+
ModelCreate = "model_create",
|
|
30
|
+
ModelPatch = "model_patch",
|
|
31
|
+
ModelDelete = "model_delete",
|
|
32
|
+
TokenCreate = "token_create",
|
|
33
|
+
ApiTokenGet = "api_token_get",
|
|
34
|
+
ApiTokenQuery = "api_token_query",
|
|
35
|
+
ApiTokenCreate = "api_token_create",
|
|
36
|
+
ApiTokenPatch = "api_token_patch",
|
|
37
|
+
ApiTokenDelete = "api_token_delete",
|
|
38
|
+
TagGet = "tag_get",
|
|
39
|
+
TagQuery = "tag_query",
|
|
40
|
+
DomainGet = "domain_get",
|
|
41
|
+
DomainQuery = "domain_query",
|
|
42
|
+
DomainCreate = "domain_create",
|
|
43
|
+
DomainPatch = "domain_patch",
|
|
44
|
+
DomainDelete = "domain_delete",
|
|
45
|
+
BookmarkCreate = "bookmark_create",
|
|
46
|
+
BookmarkDelete = "bookmark_delete",
|
|
47
|
+
ImageGet = "image_get",
|
|
48
|
+
ImageQuery = "image_query",
|
|
49
|
+
ImageCreate = "image_create",
|
|
50
|
+
ImagesDelete = "image_delete",
|
|
51
|
+
ChargebeeHostedPage = "chargebee_hosted_page",
|
|
52
|
+
ChargebeeHostedPageUpdatePaymentMethod = "chargebee_hosted_page_update_payment_method",
|
|
53
|
+
ChargebeePortalSession = "chargebee_portal_session",
|
|
54
|
+
ChargebeeConfig = "chargebee_config",
|
|
55
|
+
QueryChargebeePlan = "query_chargebee_plan",
|
|
56
|
+
ModelSharingCreate = "model_sharing_create",
|
|
57
|
+
ModelSharingQuery = "model_sharing_query",
|
|
58
|
+
ModelSharingQueryModel = "model_sharing_query_model",
|
|
59
|
+
ModelSharingQueryUser = "model_sharing_query_user",
|
|
60
|
+
ModelSharingQueryModelAndUser = "model_sharing_query_model_user",
|
|
61
|
+
ModelSharingDelete = "model_sharing_delete",
|
|
62
|
+
HttpLogQuery = "http_log_query",
|
|
63
|
+
ChargebeeSite = "chargebee_site",
|
|
64
|
+
DecryptTicket = "decrypt_ticket",
|
|
65
|
+
SavedStateGet = "saved_state_get",
|
|
66
|
+
SavedStateQuery = "saved_state_query",
|
|
67
|
+
SavedStatePatch = "saved_state_patch",
|
|
68
|
+
SavedStateCreate = "saved_state_create",
|
|
69
|
+
BackendSystemToken = "backend_system_token",
|
|
70
|
+
SavedStateDelete = "saved_state_delete",
|
|
71
|
+
SavedStateSharingCreate = "saved_state_sharing_create",
|
|
72
|
+
SavedStateSharingDelete = "saved_state_sharing_delete",
|
|
73
|
+
SavedStateSharingGet = "saved_state_sharing_get",
|
|
74
|
+
SavedStateSharingQuery = "saved_state_sharing_query",
|
|
75
|
+
SavedStateSharingQueryBySavedState = "saved_state_sharing_query_by_saved_state",
|
|
76
|
+
SavedStateSharingQueryByUser = "saved_state_sharing_query_by_user",
|
|
77
|
+
NotificationQuery = "notification_query",
|
|
78
|
+
NotificationCreate = "notification_create",
|
|
79
|
+
NotificationPatch = "notification_patch",
|
|
80
|
+
NotificationDelete = "notification_delete",
|
|
81
|
+
WebhookChargebeeEvent = "webhook_chargebee_event",
|
|
82
|
+
WebhookModelMessage = "webhook_model_message",
|
|
83
|
+
WebhookNotification = "webhook_notification",
|
|
84
|
+
CreateModelTransferRequest = "create_model_transfer_request",
|
|
85
|
+
DeleteModelTransferRequest = "delete_model_transfer_request",
|
|
86
|
+
ListModelTransferRequests = "list_model_transfer_requests",
|
|
87
|
+
GetModelTransferRequest = "get_model_transfer_request",
|
|
88
|
+
AcceptModelTransferRequest = "accept_model_transfer_request",
|
|
89
|
+
DenyModelTransferRequest = "deny_model_transfer_request",
|
|
90
|
+
OrganizationGet = "organization_get",
|
|
91
|
+
OrganizationQuery = "organization_query",
|
|
92
|
+
OrganizationCreate = "organization_create",
|
|
93
|
+
OrganizationDelete = "organization_delete",
|
|
94
|
+
OrganizationPatch = "organization_patch",
|
|
95
|
+
OrganizationInvitationCreate = "organization_invitation_create",
|
|
96
|
+
OrganizationInvitationDelete = "organization_invitation_delete",
|
|
97
|
+
OrganizationInvitationGet = "organization_invitation_get",
|
|
98
|
+
OrganizationInvitationAccept = "organization_invitation_accept",
|
|
99
|
+
OrganizationInvitationDeny = "organization_invitation_deny"
|
|
100
|
+
}
|
|
101
|
+
export { RequestId, };
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { ShapeDiverSDKApi } from "../api/ShapeDiverSDKApi";
|
|
2
|
+
import { ShapeDiverSDKConfig } from "../config/ShapeDiverSDKConfig";
|
|
3
|
+
interface AuthorizationDetails {
|
|
4
|
+
access_token?: string;
|
|
5
|
+
expires_in?: number;
|
|
6
|
+
token_type?: string;
|
|
7
|
+
user_id?: string;
|
|
8
|
+
accessTokenExpireDate?: Date;
|
|
9
|
+
}
|
|
10
|
+
declare enum AccessTokenState {
|
|
11
|
+
NoToken = 0,
|
|
12
|
+
Expired = 1,
|
|
13
|
+
Valid = 2
|
|
14
|
+
}
|
|
15
|
+
interface AuthData {
|
|
16
|
+
readonly isAuthenticated: boolean;
|
|
17
|
+
readonly accessTokenState: AccessTokenState;
|
|
18
|
+
readonly userId: string | null;
|
|
19
|
+
}
|
|
20
|
+
declare class ShapeDiverSDKContext {
|
|
21
|
+
private __api;
|
|
22
|
+
private __config;
|
|
23
|
+
private __authorizationData;
|
|
24
|
+
constructor(__api: ShapeDiverSDKApi, __config: ShapeDiverSDKConfig);
|
|
25
|
+
get authorizationData(): AuthorizationDetails;
|
|
26
|
+
get api(): ShapeDiverSDKApi;
|
|
27
|
+
get config(): ShapeDiverSDKConfig;
|
|
28
|
+
get accessTokenState(): AccessTokenState;
|
|
29
|
+
get authData(): AuthData;
|
|
30
|
+
}
|
|
31
|
+
export { AccessTokenState, AuthorizationDetails, ShapeDiverSDKContext, AuthData, };
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare class ShapeDiverSDKConfig {
|
|
2
|
+
clientId?: string | null | undefined;
|
|
3
|
+
clientSecret?: string | null | undefined;
|
|
4
|
+
baseUrl: string | undefined | null;
|
|
5
|
+
constructor(clientId?: string | null | undefined, clientSecret?: string | null | undefined, baseUrl?: string | null);
|
|
6
|
+
}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
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/SdPlatformOrganizationApi";
|
|
17
|
+
export * from "./resources/SdPlatformPolicyApi";
|
|
18
|
+
export * from "./resources/SdPlatformSavedStateApi";
|
|
19
|
+
export * from "./resources/SdPlatformSavedStateSharingApi";
|
|
20
|
+
export * from "./resources/SdPlatformTagApi";
|
|
21
|
+
export * from "./resources/SdPlatformUserAnalyticsApi";
|
|
22
|
+
export * from "./resources/SdPlatformUserApi";
|
|
23
|
+
export * from "./resources/SdPlatformWebhookApi";
|
|
24
|
+
export * from "./SdPlatformSdkContext";
|
|
25
|
+
export * from "./SdPlatformErrors";
|
|
26
|
+
export * from './SdPlatformSdk';
|
|
27
|
+
export * from "./SdPlatformSdkCreate";
|
|
28
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { ShapeDiverSDKApi } from "../api/ShapeDiverSDKApi";
|
|
2
|
+
import { AuthorizationDetails, ShapeDiverSDKContext } from "../common/ShapeDiverSDKContext";
|
|
3
|
+
import { ShapeDiverSDKRequestConfig } from '../api/ShapeDiverSDKRequestConfig';
|
|
4
|
+
import { AuthServiceApi } from "../auth/AuthServiceApi";
|
|
5
|
+
import { FilterValue, QueryParameters } from "../common/Parameters";
|
|
6
|
+
import { FilterBuilder, FilterExpression } from "../common/Filter";
|
|
7
|
+
import { RequestId } from "../common/RequestId";
|
|
8
|
+
interface GetResponse<T> {
|
|
9
|
+
readonly success: boolean;
|
|
10
|
+
readonly data: T;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Common shapediver interface for query respones.
|
|
14
|
+
*/
|
|
15
|
+
interface QueryResponse<T> {
|
|
16
|
+
readonly success: boolean;
|
|
17
|
+
readonly data: {
|
|
18
|
+
result: Array<T>;
|
|
19
|
+
pagination: {
|
|
20
|
+
limit: number;
|
|
21
|
+
next_offset: string;
|
|
22
|
+
};
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Common ShapeDiver interface for post response.
|
|
27
|
+
*/
|
|
28
|
+
interface PostResponse<T> {
|
|
29
|
+
success: boolean;
|
|
30
|
+
message: string;
|
|
31
|
+
data: T;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Common ShapeDiver interface for patched response.
|
|
35
|
+
*/
|
|
36
|
+
interface PatchResponse<T> {
|
|
37
|
+
success: boolean;
|
|
38
|
+
patched_properties?: Array<string>;
|
|
39
|
+
data: T;
|
|
40
|
+
}
|
|
41
|
+
interface DeleteResponse {
|
|
42
|
+
success: boolean;
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Actions enum.
|
|
46
|
+
*/
|
|
47
|
+
declare enum Action {
|
|
48
|
+
Post = "post",
|
|
49
|
+
Get = "get",
|
|
50
|
+
Delete = "delete"
|
|
51
|
+
}
|
|
52
|
+
declare abstract class ResourcesApi {
|
|
53
|
+
protected __context: ShapeDiverSDKContext;
|
|
54
|
+
protected __authApi: AuthServiceApi;
|
|
55
|
+
protected __commonPath: string;
|
|
56
|
+
protected __api: ShapeDiverSDKApi;
|
|
57
|
+
protected __authorizationData: AuthorizationDetails;
|
|
58
|
+
protected __filterBuilder: FilterBuilder;
|
|
59
|
+
constructor(__context: ShapeDiverSDKContext, __authApi: AuthServiceApi);
|
|
60
|
+
protected abstract get __resourcePath(): string;
|
|
61
|
+
protected __getPath(pathSufix?: null | string): string;
|
|
62
|
+
protected __resolveRequestConfig(): ShapeDiverSDKRequestConfig;
|
|
63
|
+
protected __refreshTokenIfExpired(): Promise<void>;
|
|
64
|
+
protected __schema<T>(requestId: RequestId): Promise<T>;
|
|
65
|
+
/**
|
|
66
|
+
* Base get request
|
|
67
|
+
* @param { string } id - the id of a resource.
|
|
68
|
+
* @param { null|Array<string> } embed - resources to embed.
|
|
69
|
+
*/
|
|
70
|
+
protected __get<T>(requestId: RequestId, id: string, embed?: Array<string>): Promise<GetResponse<T>>;
|
|
71
|
+
protected __query<T, TEmbeddableFields>(requestId: RequestId, body?: QueryParameters<TEmbeddableFields>): Promise<QueryResponse<T>>;
|
|
72
|
+
protected __post<T, TModel>(requestId: RequestId, body: T): Promise<PostResponse<TModel>>;
|
|
73
|
+
protected __patch<T, TModel>(requestId: RequestId, id: string, body: T): Promise<PatchResponse<TModel>>;
|
|
74
|
+
protected __delete(requestId: RequestId, id: string): Promise<DeleteResponse>;
|
|
75
|
+
protected __action<TResponse, TBody>(requestId: RequestId, action: Action, pathSuffix: string, body: TBody): Promise<TResponse>;
|
|
76
|
+
filterBuilder(expressions: Array<FilterExpression>): {
|
|
77
|
+
[filter_expression: string]: FilterValue;
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
export { Action, ResourcesApi, GetResponse, QueryResponse, PatchResponse, PostResponse, DeleteResponse };
|
|
@@ -0,0 +1,19 @@
|
|
|
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 declare 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
|
+
get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>>;
|
|
14
|
+
query(query?: SdPlatformApiTokenQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>>;
|
|
15
|
+
create(body: SdPlatformRequestApiTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>>;
|
|
16
|
+
patch(key_id: string, body: SdPlatformRequestApiTokenPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>>;
|
|
17
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=SdPlatformApiTokenApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,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,oBAAY,iCAAiC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;IAK3E,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKlH,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKpH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKzH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { 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
|
+
export declare type SdPlatformBackendSystemQueryParameters = SdPlatformQueryParameters<string> | undefined;
|
|
5
|
+
/**
|
|
6
|
+
* Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
|
|
7
|
+
*/
|
|
8
|
+
export declare class SdPlatformBackendSystemApi extends ResourcesApi {
|
|
9
|
+
protected get __resourcePath(): string;
|
|
10
|
+
query(query?: SdPlatformBackendSystemQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
|
|
11
|
+
create(body: SdPlatformRequestBackendSystemCreate): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>>;
|
|
12
|
+
patch(id: string, body: SdPlatformRequestBackendSystemPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
|
|
13
|
+
/**
|
|
14
|
+
* Create a token for accessing a ShapeDiver Geometry Backend System
|
|
15
|
+
*/
|
|
16
|
+
token(body: SdPlatformRequestBackendSystemToken): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>>;
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=SdPlatformBackendSystemApi.d.ts.map
|
|
@@ -0,0 +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,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,oCAAoC,EAAE,oCAAoC,EAAE,MAAM,qCAAqC,CAAC;AAClR,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAEnG;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAExD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,KAAK,CAAC,KAAK,GAAE,sCAA2C,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAKjK,MAAM,CAAC,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKzH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAK3K;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;CAIjI"}
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
+
protected get __resourcePath(): string;
|
|
9
|
+
create(body: SdPlatformRequestBookmarkCreate): Promise<SdPlatformPostResponse<void>>;
|
|
10
|
+
/**
|
|
11
|
+
* Delete bookmark for a model
|
|
12
|
+
* @param id Id of the model whose bookmark shall be deleted
|
|
13
|
+
* @returns
|
|
14
|
+
*/
|
|
15
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=SdPlatformBookmarkApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformBookmarkApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBookmarkApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGtG;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAK3F;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
|
|
@@ -0,0 +1,21 @@
|
|
|
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 declare type SdPlatformChargebeePlanQueryParameters = SdPlatformQueryParameters<null>;
|
|
6
|
+
/**
|
|
7
|
+
* Actions related to Chargebee.
|
|
8
|
+
*/
|
|
9
|
+
export declare class SdPlatformChargebeeApi extends ResourcesApi {
|
|
10
|
+
protected get __resourcePath(): string;
|
|
11
|
+
hostedPage(body: SdPlatformRequestChargebeeHostedPage): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
|
|
12
|
+
hostedPageUpdatePaymentMethod(body: SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
|
|
13
|
+
portalSession(body: SdPlatformRequestChargebeePortalSession): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePortalSession>>;
|
|
14
|
+
queryChargebeePlans(body: SdPlatformChargebeePlanQueryParameters): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePlan>>;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @returns Chargebee configuration
|
|
18
|
+
*/
|
|
19
|
+
config(): Promise<SdPlatformGetResponse<SdPlatformResponseChargebeeConfig>>;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=SdPlatformChargebeeApi.d.ts.map
|
|
@@ -0,0 +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,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAEpD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,UAAU,CAAC,IAAI,EAAE,oCAAoC,GAAI,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAK/H,6BAA6B,CAAC,IAAI,EAAE,uDAAuD,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAKpK,aAAa,CAAC,IAAI,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;IAKvI,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"}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformRequestDomainCreate, SdPlatformRequestDomainPatch, SdPlatformResponseDomain, SdPlatformResponseDomainAdmin } 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 SdPlatformDomainGetEmbeddableFields {
|
|
5
|
+
Models = "models"
|
|
6
|
+
}
|
|
7
|
+
export declare enum SdPlatformDomainQueryEmbeddableFields {
|
|
8
|
+
ModelsCount = "models_count"
|
|
9
|
+
}
|
|
10
|
+
export declare type SdPlatformDomainQueryParameters = SdPlatformQueryParameters<SdPlatformDomainQueryEmbeddableFields>;
|
|
11
|
+
/**
|
|
12
|
+
* Operations for domains which can be attached or users, organizations, models.
|
|
13
|
+
*/
|
|
14
|
+
export declare class SdPlatformDomainApi extends ResourcesApi {
|
|
15
|
+
protected get __resourcePath(): string;
|
|
16
|
+
/**
|
|
17
|
+
* Get a domain by id.
|
|
18
|
+
* @param id
|
|
19
|
+
* @param embed
|
|
20
|
+
* @returns
|
|
21
|
+
*/
|
|
22
|
+
get(id: string, embed?: Array<SdPlatformDomainGetEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
|
|
23
|
+
/**
|
|
24
|
+
* Query domains.
|
|
25
|
+
* @param query
|
|
26
|
+
* @returns
|
|
27
|
+
*/
|
|
28
|
+
query(query?: SdPlatformDomainQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
|
|
29
|
+
/**
|
|
30
|
+
* Create a domain.
|
|
31
|
+
*/
|
|
32
|
+
create(body: SdPlatformRequestDomainCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
|
|
33
|
+
/**
|
|
34
|
+
* Patch a domain.
|
|
35
|
+
* @param id - the id of a domain
|
|
36
|
+
* @param body - properties to patch
|
|
37
|
+
*/
|
|
38
|
+
patch(id: string, body: SdPlatformRequestDomainPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseDomainAdmin>>;
|
|
39
|
+
/**
|
|
40
|
+
* Delete a domain.
|
|
41
|
+
* @param id - the id of a domain
|
|
42
|
+
*/
|
|
43
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
44
|
+
}
|
|
45
|
+
//# sourceMappingURL=SdPlatformDomainApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformDomainApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDomainApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAC3K,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,mCAAmC;IAE3C,MAAM,WAAW;CACpB;AAED,oBAAY,qCAAqC;IAE7C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,+BAA+B,GAAG,yBAAyB,CAAC,qCAAqC,CAAC,CAAC;AAE/G;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,mCAAmC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKxK;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKrJ;;OAEG;IACI,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKlH;;;;OAIG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,6BAA6B,CAAC,CAAC;IAK7H;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformResponseHttpLog } from "@shapediver/api.platform-api-dto-v1";
|
|
3
|
+
import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
4
|
+
export declare type SdPlatformHttpLogQueryParameters = SdPlatformQueryParameters<null>;
|
|
5
|
+
/**
|
|
6
|
+
* HTTP logs.
|
|
7
|
+
*/
|
|
8
|
+
export declare class SdPlatformHttpLogApi extends ResourcesApi {
|
|
9
|
+
protected get __resourcePath(): string;
|
|
10
|
+
/**
|
|
11
|
+
* Query HTTP logs.
|
|
12
|
+
* @param body
|
|
13
|
+
*/
|
|
14
|
+
query(body?: SdPlatformHttpLogQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseHttpLog>>;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=SdPlatformHttpLogApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformHttpLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformHttpLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,oBAAY,gCAAgC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IAElD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;OAGG;IACI,KAAK,CAAC,IAAI,GAAE,gCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;CAIzH"}
|
|
@@ -0,0 +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
|
+
}
|
|
37
|
+
//# sourceMappingURL=SdPlatformImageApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformImageApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformImageApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACzK,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGjL,oBAAY,oCAAoC;IAE5C,IAAI,SAAS;IACb,MAAM,WAAW;CACpB;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,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,oCAAoC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKvM;;;OAGG;IACI,KAAK,CAAC,IAAI,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKjL;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IAK3G;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { ResourcesApi } from "./commons/ResourcesApi";
|
|
2
|
+
import { SdPlatformRequestModelCreate, SdPlatformRequestModelPatch, SdPlatformRequestModelPatchAdmin, SdPlatformResponseModelOwner, SdPlatformResponseModelPublic, SdPlatformResponseDecryptTicketResult } 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
|
+
get<T = SdPlatformResponseModelPublic>(id: string, embed?: Array<SdPlatformModelGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
+
query<T = SdPlatformResponseModelPublic>(query?: SdPlatformModelQueryParameters): Promise<SdPlatformQueryResponse<T>>;
|
|
36
|
+
create<T = SdPlatformResponseModelOwner>(body?: SdPlatformRequestModelCreate): Promise<SdPlatformPostResponse<T>>;
|
|
37
|
+
patch<T = SdPlatformResponseModelOwner>(id: string, body: SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
|
|
38
|
+
delete(id: string): Promise<SdPlatformDeleteResponse>;
|
|
39
|
+
decryptTicket(ticket: string): Promise<SdPlatformPostResponse<SdPlatformResponseDecryptTicketResult>>;
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=SdPlatformModelApi.d.ts.map
|
|
@@ -0,0 +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,MAAM,qCAAqC,CAAA;AACrP,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;IAEM,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAK5I,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKzH,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAKrH,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,GAAG,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK9J,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAKrD,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;CAM/G"}
|