@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,16 +1,16 @@
|
|
|
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
|
-
get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
14
|
-
query(query?: SdPlatformTagQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
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
|
+
get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
14
|
+
query(query?: SdPlatformTagQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseTag | SdPlatformResponseTagAdmin>>;
|
|
15
|
+
}
|
|
16
16
|
//# sourceMappingURL=SdPlatformTagApi.d.ts.map
|
|
@@ -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
|
|
12
|
+
* @returns
|
|
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 - 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
|
|
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 - 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
|
|
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 {string } user_id
|
|
76
|
-
* @returns { Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>> }
|
|
77
|
-
*/
|
|
78
|
-
getUserRefreshTokens(user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
|
|
79
|
-
/**
|
|
80
|
-
* Delete refresh token.
|
|
81
|
-
* @param { string } user_id
|
|
82
|
-
* @param { string } refresh_token_id
|
|
83
|
-
* @returns { Promise<SdPlatformDeleteResponse> }
|
|
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 - 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
|
|
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 - 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
|
|
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 {string } user_id
|
|
76
|
+
* @returns { Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>> }
|
|
77
|
+
*/
|
|
78
|
+
getUserRefreshTokens(user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseUserRefreshToken>>>;
|
|
79
|
+
/**
|
|
80
|
+
* Delete refresh token.
|
|
81
|
+
* @param { string } user_id
|
|
82
|
+
* @param { string } refresh_token_id
|
|
83
|
+
* @returns { Promise<SdPlatformDeleteResponse> }
|
|
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
|
|
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
|
+
}
|
|
53
53
|
//# sourceMappingURL=SdPlatformWebhookApi.d.ts.map
|
|
@@ -1,55 +1,55 @@
|
|
|
1
|
-
import { SdPlatformFilterValue } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
-
/**
|
|
3
|
-
* TODO https://shapediver.atlassian.net/browse/SS-4815
|
|
4
|
-
* document, test, expose somehow in resource API
|
|
5
|
-
*/
|
|
6
|
-
export declare enum FilterOperators {
|
|
7
|
-
Equal = "=",
|
|
8
|
-
Like = "%"
|
|
9
|
-
}
|
|
10
|
-
export declare enum LogicalOperators {
|
|
11
|
-
And = "&",
|
|
12
|
-
Or = "|"
|
|
13
|
-
}
|
|
14
|
-
export interface FilterExpression {
|
|
15
|
-
property: string;
|
|
16
|
-
value: SdPlatformFilterValue;
|
|
17
|
-
filter_operator?: FilterOperators;
|
|
18
|
-
logical_operator?: LogicalOperators;
|
|
19
|
-
join?: FilterExpression;
|
|
20
|
-
}
|
|
21
|
-
/**
|
|
22
|
-
* Interface for filter builder.
|
|
23
|
-
*/
|
|
24
|
-
export interface FilterBuilder {
|
|
25
|
-
/**
|
|
26
|
-
* Starts filter from begining. Essentially replacing all existing expressions.
|
|
27
|
-
* @param expressions
|
|
28
|
-
*/
|
|
29
|
-
start(expressions?: Array<FilterExpression>): FilterBuilder;
|
|
30
|
-
/**
|
|
31
|
-
* Adds filter expression to filter.
|
|
32
|
-
* @param expression
|
|
33
|
-
*/
|
|
34
|
-
attach(expression: FilterExpression): FilterBuilder;
|
|
35
|
-
/**
|
|
36
|
-
* Finish with filter and resolve it to final filter parameter for request.
|
|
37
|
-
*/
|
|
38
|
-
finish(): {
|
|
39
|
-
[filter_expression: string]: SdPlatformFilterValue;
|
|
40
|
-
};
|
|
41
|
-
}
|
|
42
|
-
/**
|
|
43
|
-
* Instance of filter builder.
|
|
44
|
-
*/
|
|
45
|
-
export declare class FilterBuilderInstance implements FilterBuilder {
|
|
46
|
-
private __expressions;
|
|
47
|
-
constructor(__expressions?: Array<FilterExpression>);
|
|
48
|
-
static create(expressions?: FilterExpression[]): FilterBuilder;
|
|
49
|
-
start(expressions?: FilterExpression[]): FilterBuilder;
|
|
50
|
-
attach(expression: FilterExpression): FilterBuilder;
|
|
51
|
-
finish(): {
|
|
52
|
-
[filter_expression: string]: SdPlatformFilterValue;
|
|
53
|
-
};
|
|
54
|
-
}
|
|
1
|
+
import { SdPlatformFilterValue } from "@shapediver/api.platform-api-dto-v1";
|
|
2
|
+
/**
|
|
3
|
+
* TODO https://shapediver.atlassian.net/browse/SS-4815
|
|
4
|
+
* document, test, expose somehow in resource API
|
|
5
|
+
*/
|
|
6
|
+
export declare enum FilterOperators {
|
|
7
|
+
Equal = "=",
|
|
8
|
+
Like = "%"
|
|
9
|
+
}
|
|
10
|
+
export declare enum LogicalOperators {
|
|
11
|
+
And = "&",
|
|
12
|
+
Or = "|"
|
|
13
|
+
}
|
|
14
|
+
export interface FilterExpression {
|
|
15
|
+
property: string;
|
|
16
|
+
value: SdPlatformFilterValue;
|
|
17
|
+
filter_operator?: FilterOperators;
|
|
18
|
+
logical_operator?: LogicalOperators;
|
|
19
|
+
join?: FilterExpression;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Interface for filter builder.
|
|
23
|
+
*/
|
|
24
|
+
export interface FilterBuilder {
|
|
25
|
+
/**
|
|
26
|
+
* Starts filter from begining. Essentially replacing all existing expressions.
|
|
27
|
+
* @param expressions
|
|
28
|
+
*/
|
|
29
|
+
start(expressions?: Array<FilterExpression>): FilterBuilder;
|
|
30
|
+
/**
|
|
31
|
+
* Adds filter expression to filter.
|
|
32
|
+
* @param expression
|
|
33
|
+
*/
|
|
34
|
+
attach(expression: FilterExpression): FilterBuilder;
|
|
35
|
+
/**
|
|
36
|
+
* Finish with filter and resolve it to final filter parameter for request.
|
|
37
|
+
*/
|
|
38
|
+
finish(): {
|
|
39
|
+
[filter_expression: string]: SdPlatformFilterValue;
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Instance of filter builder.
|
|
44
|
+
*/
|
|
45
|
+
export declare class FilterBuilderInstance implements FilterBuilder {
|
|
46
|
+
private __expressions;
|
|
47
|
+
constructor(__expressions?: Array<FilterExpression>);
|
|
48
|
+
static create(expressions?: FilterExpression[]): FilterBuilder;
|
|
49
|
+
start(expressions?: FilterExpression[]): FilterBuilder;
|
|
50
|
+
attach(expression: FilterExpression): FilterBuilder;
|
|
51
|
+
finish(): {
|
|
52
|
+
[filter_expression: string]: SdPlatformFilterValue;
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
55
|
//# sourceMappingURL=FilterBuilder.d.ts.map
|
|
@@ -1,43 +1,43 @@
|
|
|
1
|
-
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../../api/SdPlatformSdkApi";
|
|
2
|
-
import { SdPlatformSdkContext } from "../../SdPlatformSdkContext";
|
|
3
|
-
import { SdPlatformAuthServiceApi } from "../../auth/SdPlatformAuthServiceApi";
|
|
4
|
-
import { RequestId } from "../../api/SdPlatformRequestId";
|
|
5
|
-
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
6
|
-
/**
|
|
7
|
-
* Actions enum.
|
|
8
|
-
*/
|
|
9
|
-
export declare enum Action {
|
|
10
|
-
Post = "post",
|
|
11
|
-
Get = "get",
|
|
12
|
-
Delete = "delete",
|
|
13
|
-
Patch = "patch"
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* Base ShapeDiver Platform resource API. Implement this for new resources.
|
|
17
|
-
*/
|
|
18
|
-
export declare abstract class ResourcesApi {
|
|
19
|
-
protected __context: SdPlatformSdkContext;
|
|
20
|
-
protected __authApi: SdPlatformAuthServiceApi;
|
|
21
|
-
protected __commonPath: string;
|
|
22
|
-
protected __api: SdPlatformSdkApi;
|
|
23
|
-
constructor(__context: SdPlatformSdkContext, __authApi: SdPlatformAuthServiceApi);
|
|
24
|
-
protected abstract get __resourcePath(): string;
|
|
25
|
-
protected __getPath(pathSufix?: null | string): string;
|
|
26
|
-
protected __resolveRequestConfig(): SdPlatformSdkRequestConfig;
|
|
27
|
-
protected __refreshTokenIfExpired(): Promise<void>;
|
|
28
|
-
protected __schema<T>(requestId: RequestId): Promise<T>;
|
|
29
|
-
/**
|
|
30
|
-
* Base get request
|
|
31
|
-
* @param { string } id - the id of a resource.
|
|
32
|
-
* @param { null|Array<string> } embed - resources to embed.
|
|
33
|
-
*/
|
|
34
|
-
protected __get<T>(requestId: RequestId, id: string, embed?: Array<string>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
-
protected __query<T, TEmbeddableFields>(requestId: RequestId, body?: SdPlatformQueryParameters<TEmbeddableFields>): Promise<SdPlatformQueryResponse<T>>;
|
|
36
|
-
protected __post<T, TModel>(requestId: RequestId, body: T): Promise<SdPlatformPostResponse<TModel>>;
|
|
37
|
-
protected __patch<T, TModel>(requestId: RequestId, id: string, body: T): Promise<SdPlatformPatchResponse<TModel>>;
|
|
38
|
-
protected __delete(requestId: RequestId, id: string): Promise<SdPlatformDeleteResponse>;
|
|
39
|
-
protected __action<TResponse, TBody>(requestId: RequestId, action: Action, pathSuffix: string, body: TBody, headers?: {
|
|
40
|
-
[id: string]: string;
|
|
41
|
-
}): Promise<TResponse>;
|
|
42
|
-
}
|
|
1
|
+
import { SdPlatformSdkApi, SdPlatformSdkRequestConfig } from "../../api/SdPlatformSdkApi";
|
|
2
|
+
import { SdPlatformSdkContext } from "../../SdPlatformSdkContext";
|
|
3
|
+
import { SdPlatformAuthServiceApi } from "../../auth/SdPlatformAuthServiceApi";
|
|
4
|
+
import { RequestId } from "../../api/SdPlatformRequestId";
|
|
5
|
+
import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
|
|
6
|
+
/**
|
|
7
|
+
* Actions enum.
|
|
8
|
+
*/
|
|
9
|
+
export declare enum Action {
|
|
10
|
+
Post = "post",
|
|
11
|
+
Get = "get",
|
|
12
|
+
Delete = "delete",
|
|
13
|
+
Patch = "patch"
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Base ShapeDiver Platform resource API. Implement this for new resources.
|
|
17
|
+
*/
|
|
18
|
+
export declare abstract class ResourcesApi {
|
|
19
|
+
protected __context: SdPlatformSdkContext;
|
|
20
|
+
protected __authApi: SdPlatformAuthServiceApi;
|
|
21
|
+
protected __commonPath: string;
|
|
22
|
+
protected __api: SdPlatformSdkApi;
|
|
23
|
+
constructor(__context: SdPlatformSdkContext, __authApi: SdPlatformAuthServiceApi);
|
|
24
|
+
protected abstract get __resourcePath(): string;
|
|
25
|
+
protected __getPath(pathSufix?: null | string): string;
|
|
26
|
+
protected __resolveRequestConfig(): SdPlatformSdkRequestConfig;
|
|
27
|
+
protected __refreshTokenIfExpired(): Promise<void>;
|
|
28
|
+
protected __schema<T>(requestId: RequestId): Promise<T>;
|
|
29
|
+
/**
|
|
30
|
+
* Base get request
|
|
31
|
+
* @param { string } id - the id of a resource.
|
|
32
|
+
* @param { null|Array<string> } embed - resources to embed.
|
|
33
|
+
*/
|
|
34
|
+
protected __get<T>(requestId: RequestId, id: string, embed?: Array<string>): Promise<SdPlatformGetResponse<T>>;
|
|
35
|
+
protected __query<T, TEmbeddableFields>(requestId: RequestId, body?: SdPlatformQueryParameters<TEmbeddableFields>): Promise<SdPlatformQueryResponse<T>>;
|
|
36
|
+
protected __post<T, TModel>(requestId: RequestId, body: T): Promise<SdPlatformPostResponse<TModel>>;
|
|
37
|
+
protected __patch<T, TModel>(requestId: RequestId, id: string, body: T): Promise<SdPlatformPatchResponse<TModel>>;
|
|
38
|
+
protected __delete(requestId: RequestId, id: string): Promise<SdPlatformDeleteResponse>;
|
|
39
|
+
protected __action<TResponse, TBody>(requestId: RequestId, action: Action, pathSuffix: string, body: TBody, headers?: {
|
|
40
|
+
[id: string]: string;
|
|
41
|
+
}): Promise<TResponse>;
|
|
42
|
+
}
|
|
43
43
|
//# sourceMappingURL=ResourcesApi.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shapediver/sdk.platform-api-sdk-v1",
|
|
3
|
-
"version": "2.12.
|
|
3
|
+
"version": "2.12.8",
|
|
4
4
|
"description": "SDK to communicate with the Platform API version 1",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shapediver",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"build-prod": "bash ../../scripts/build-prod.sh"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@shapediver/api.platform-api-dto-v1": "^2.12.
|
|
42
|
+
"@shapediver/api.platform-api-dto-v1": "^2.12.8",
|
|
43
43
|
"@types/q": "^1.5.5",
|
|
44
44
|
"axios": "^0.26.1",
|
|
45
45
|
"dotenv": "^16.0.0",
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
/** TODO rename error classes to SdPlatform... */
|
|
2
|
-
/**
|
|
3
|
-
* Generic error
|
|
4
|
-
*/
|
|
5
|
-
export declare class ShapeDiverError extends Error {
|
|
6
|
-
constructor(message: string);
|
|
7
|
-
}
|
|
8
|
-
/**
|
|
9
|
-
* Request error (request could not be sent etc)
|
|
10
|
-
*/
|
|
11
|
-
export declare class ShapeDiverRequestError extends ShapeDiverError {
|
|
12
|
-
readonly desc: string;
|
|
13
|
-
constructor(message: string, desc: string);
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* Generic response error
|
|
17
|
-
*/
|
|
18
|
-
export declare abstract class ShapeDiverResponseError extends ShapeDiverError {
|
|
19
|
-
readonly http_status_code: number;
|
|
20
|
-
constructor(message: string, http_status_code: number);
|
|
21
|
-
}
|
|
22
|
-
/**
|
|
23
|
-
* Resource response error
|
|
24
|
-
*/
|
|
25
|
-
export declare class ShapeDiverResourceResponseError extends ShapeDiverResponseError {
|
|
26
|
-
readonly error: string;
|
|
27
|
-
readonly error_description: string;
|
|
28
|
-
readonly error_uri?: string | undefined;
|
|
29
|
-
readonly code?: string | number | undefined;
|
|
30
|
-
readonly fields?: {
|
|
31
|
-
[key: string]: string[];
|
|
32
|
-
} | undefined;
|
|
33
|
-
constructor(message: string, http_status_code: number, error: string, error_description: string, error_uri?: string | undefined, code?: string | number | undefined, fields?: {
|
|
34
|
-
[key: string]: string[];
|
|
35
|
-
} | undefined);
|
|
36
|
-
}
|
|
37
|
-
/**
|
|
38
|
-
* Authentication response error.
|
|
39
|
-
* Follows principles of OAuth 2.0
|
|
40
|
-
* Please see https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
|
|
41
|
-
*/
|
|
42
|
-
export declare class ShapeDiverOAuthResponseError extends ShapeDiverResponseError {
|
|
43
|
-
/**
|
|
44
|
-
* required error code
|
|
45
|
-
*
|
|
46
|
-
* * invalid_request
|
|
47
|
-
* * unauthorized_client
|
|
48
|
-
* * access_denied
|
|
49
|
-
* * unsupported_response_type
|
|
50
|
-
* * invalid_scope
|
|
51
|
-
* * server_error
|
|
52
|
-
* * temporarily_unavailable
|
|
53
|
-
*/
|
|
54
|
-
readonly error: string;
|
|
55
|
-
/** optional human-readable text providing additional information */
|
|
56
|
-
readonly error_description: string;
|
|
57
|
-
/** optional URI identifying a human-readable web page with
|
|
58
|
-
information about the error */
|
|
59
|
-
readonly error_uri?: string | undefined;
|
|
60
|
-
constructor(message: string, http_status_code: number,
|
|
61
|
-
/**
|
|
62
|
-
* required error code
|
|
63
|
-
*
|
|
64
|
-
* * invalid_request
|
|
65
|
-
* * unauthorized_client
|
|
66
|
-
* * access_denied
|
|
67
|
-
* * unsupported_response_type
|
|
68
|
-
* * invalid_scope
|
|
69
|
-
* * server_error
|
|
70
|
-
* * temporarily_unavailable
|
|
71
|
-
*/
|
|
72
|
-
error: string,
|
|
73
|
-
/** optional human-readable text providing additional information */
|
|
74
|
-
error_description: string,
|
|
75
|
-
/** optional URI identifying a human-readable web page with
|
|
76
|
-
information about the error */
|
|
77
|
-
error_uri?: string | undefined);
|
|
78
|
-
}
|
|
79
|
-
//# sourceMappingURL=ShapeDiverErrors.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ShapeDiverErrors.d.ts","sourceRoot":"","sources":["../src/ShapeDiverErrors.ts"],"names":[],"mappings":"AAAA,iDAAiD;AAEjD;;GAEG;AACH,qBAAa,eAAgB,SAAQ,KAAK;gBAEzB,OAAO,EAAE,MAAM;CAK/B;AAED;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,eAAe;aAInC,IAAI,EAAE,MAAM;gBAD5B,OAAO,EAAE,MAAM,EACC,IAAI,EAAE,MAAM;CAMnC;AAED;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,eAAe;aAI7C,gBAAgB,EAAE,MAAM;gBADxC,OAAO,EAAE,MAAM,EACC,gBAAgB,EAAE,MAAM;CAM/C;AAED;;GAEG;AACH,qBAAa,+BAAgC,SAAQ,uBAAuB;aAKpD,KAAK,EAAE,MAAM;aACb,iBAAiB,EAAE,MAAM;aACzB,SAAS,CAAC;aACV,IAAI,CAAC;aACL,MAAM,CAAC;;;gBANvB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM,EACR,KAAK,EAAE,MAAM,EACb,iBAAiB,EAAE,MAAM,EACzB,SAAS,CAAC,oBAAQ,EAClB,IAAI,CAAC,6BAAiB,EACtB,MAAM,CAAC;;iBAA6B;CAM3D;AAED;;;;GAIG;AACH,qBAAa,4BAA6B,SAAQ,uBAAuB;IAKjE;;;;;;;;;;OAUG;aACa,KAAK,EAAE,MAAM;IAC7B,oEAAoE;aACpD,iBAAiB,EAAE,MAAM;IACzC;mCAC+B;aACf,SAAS,CAAC;gBAlB1B,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM;IACxB;;;;;;;;;;OAUG;IACa,KAAK,EAAE,MAAM;IAC7B,oEAAoE;IACpD,iBAAiB,EAAE,MAAM;IACzC;mCAC+B;IACf,SAAS,CAAC,oBAAQ;CAMzC"}
|
package/dist/ShapeDiverSDK.d.ts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { ShapeDiverSDKInstance } from "./ShapeDiverSDKInstance";
|
|
2
|
-
interface ClientConfig {
|
|
3
|
-
clientId?: string;
|
|
4
|
-
clientSecret?: string;
|
|
5
|
-
baseUrl?: string;
|
|
6
|
-
}
|
|
7
|
-
export declare function create(clientId?: ClientConfig | string | null, clientSecret?: string | null, baseUrl?: string | null): ShapeDiverSDKInstance;
|
|
8
|
-
export {};
|
|
9
|
-
//# sourceMappingURL=ShapeDiverSDK.d.ts.map
|