@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
package/LICENSE
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright 2021 ShapeDiver GmbH
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
<p style="text-align: center">
|
|
2
|
+
<a href="https://www.shapediver.com/">
|
|
3
|
+
<img
|
|
4
|
+
alt="ShapeDiver"
|
|
5
|
+
src="https://sduse1-assets.shapediver.com/production/assets/img/apple-icon.png"
|
|
6
|
+
/>
|
|
7
|
+
</a>
|
|
8
|
+
</p>
|
|
9
|
+
|
|
10
|
+
# ShapeDiver Platform SDK
|
|
11
|
+
[ShapeDiver](https://www.shapediver.com/) is a cloud platform that provides the right tools and scalable infrastructure to help you transform your Grasshopper files into online applications. It allows you to share the power of Grasshopper and Parametric Design with partners, clients and other key stakeholders wherever they are.
|
|
12
|
+
|
|
13
|
+
The **ShapeDiver Platform SDK** allows to access the functionality of the [ShapeDiver Platform](https://www.shapediver.com/app/) (or white labelled instances of it) by means of the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation).
|
|
14
|
+
The SDK exposes all TypeScript-types describing request and response objects.
|
|
15
|
+
|
|
16
|
+
The authentication system is based on **JWT tokens**, which the SDK allows you to request from the **ShapeDiver Platform** using the OAuth 2.0 functionality integrated with the [ShapeDiver Platform API](https://app.shapediver.com/api/documentation).
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
* Add npm package:
|
|
21
|
+
```sh
|
|
22
|
+
npm i @shapediver/sdk.platform-api-sdk-v1
|
|
23
|
+
```
|
|
24
|
+
* Import constructor function:
|
|
25
|
+
```javascript
|
|
26
|
+
import { create } from '@shapediver/sdk.platform-api-sdk-v1';
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
* Create and authorize client:
|
|
30
|
+
```javascript
|
|
31
|
+
const client = create({clientId: "CLIENT_ID", baseUrl: "SHAPEDIVER_PLATFORM_API_ENDPOINT"});
|
|
32
|
+
await client.authorization.passwordGrant("USERNAME", "PASSWORD");
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Versioning
|
|
36
|
+
We take care to provide backwards compatibility for older versions of the SDK and the API, but might introduce breaking changes in case of major version upgrades.
|
|
37
|
+
New features of the SDK might be limited to newer versions of the API. We recommend always using the newest SDK version out there.
|
|
38
|
+
|
|
39
|
+
## Support
|
|
40
|
+
|
|
41
|
+
* [Plaform Backend documentation](https://help.shapediver.com/doc/Platform-Backend.1863876635.html)
|
|
42
|
+
* [ShapeDiver Help Center](https://help.shapediver.com)
|
|
43
|
+
* [Forum](https://forum.shapediver.com)
|
|
44
|
+
|
|
45
|
+
If you have further questions, [reach out to us](https://www.shapediver.com/?open_contact=true).
|
|
46
|
+
|
|
47
|
+
Find out more about ShapeDiver [right here](https://www.shapediver.com/)!
|
|
48
|
+
|
|
49
|
+
## Licensing
|
|
50
|
+
The ShapeDiver Platform SDK is released under the [MIT License](LICENSE).
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generic error
|
|
3
|
+
*/
|
|
4
|
+
export declare class SdPlatformError extends Error {
|
|
5
|
+
constructor(message: string);
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Request error (request could not be sent etc)
|
|
9
|
+
*/
|
|
10
|
+
export declare class SdPlatformRequestError extends SdPlatformError {
|
|
11
|
+
readonly desc: string;
|
|
12
|
+
constructor(message: string, desc: string);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Generic response error
|
|
16
|
+
*/
|
|
17
|
+
export declare abstract class SdPlatformResponseError extends SdPlatformError {
|
|
18
|
+
readonly http_status_code: number;
|
|
19
|
+
constructor(message: string, http_status_code: number);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Resource response error
|
|
23
|
+
*/
|
|
24
|
+
export declare class SdPlatformResourceResponseError extends SdPlatformResponseError {
|
|
25
|
+
readonly error: string;
|
|
26
|
+
readonly error_description: string;
|
|
27
|
+
readonly error_uri?: string | undefined;
|
|
28
|
+
readonly code?: string | number | undefined;
|
|
29
|
+
readonly fields?: {
|
|
30
|
+
[key: string]: string[];
|
|
31
|
+
} | undefined;
|
|
32
|
+
constructor(message: string, http_status_code: number, error: string, error_description: string, error_uri?: string | undefined, code?: string | number | undefined, fields?: {
|
|
33
|
+
[key: string]: string[];
|
|
34
|
+
} | undefined);
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Authentication response error.
|
|
38
|
+
* Follows principles of OAuth 2.0
|
|
39
|
+
* Please see https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1
|
|
40
|
+
*/
|
|
41
|
+
export declare class SdPlatformOAuthResponseError extends SdPlatformResponseError {
|
|
42
|
+
/**
|
|
43
|
+
* required error code
|
|
44
|
+
*
|
|
45
|
+
* * invalid_request
|
|
46
|
+
* * unauthorized_client
|
|
47
|
+
* * access_denied
|
|
48
|
+
* * unsupported_response_type
|
|
49
|
+
* * invalid_scope
|
|
50
|
+
* * server_error
|
|
51
|
+
* * temporarily_unavailable
|
|
52
|
+
*/
|
|
53
|
+
readonly error: string;
|
|
54
|
+
/** optional human-readable text providing additional information */
|
|
55
|
+
readonly error_description: string;
|
|
56
|
+
/** optional URI identifying a human-readable web page with
|
|
57
|
+
information about the error */
|
|
58
|
+
readonly error_uri?: string | undefined;
|
|
59
|
+
constructor(message: string, http_status_code: number,
|
|
60
|
+
/**
|
|
61
|
+
* required error code
|
|
62
|
+
*
|
|
63
|
+
* * invalid_request
|
|
64
|
+
* * unauthorized_client
|
|
65
|
+
* * access_denied
|
|
66
|
+
* * unsupported_response_type
|
|
67
|
+
* * invalid_scope
|
|
68
|
+
* * server_error
|
|
69
|
+
* * temporarily_unavailable
|
|
70
|
+
*/
|
|
71
|
+
error: string,
|
|
72
|
+
/** optional human-readable text providing additional information */
|
|
73
|
+
error_description: string,
|
|
74
|
+
/** optional URI identifying a human-readable web page with
|
|
75
|
+
information about the error */
|
|
76
|
+
error_uri?: string | undefined);
|
|
77
|
+
}
|
|
78
|
+
//# sourceMappingURL=SdPlatformErrors.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformErrors.d.ts","sourceRoot":"","sources":["../src/SdPlatformErrors.ts"],"names":[],"mappings":"AACA;;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"}
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import { SdPlatformRequestFinishedEvent, SdPlatformRequestStartEvent } from "./api/SdPlatformSdkApi";
|
|
2
|
+
import { SdPlatformSdkConfig } from "./api/SdPlatformSdkConfig";
|
|
3
|
+
import { SdPlatformAuthServiceApi } from './auth/SdPlatformAuthServiceApi';
|
|
4
|
+
import { SdPlatformApiTokenApi } from "./resources/SdPlatformApiTokenApi";
|
|
5
|
+
import { SdPlatformBackendSystemApi } from "./resources/SdPlatformBackendSystemApi";
|
|
6
|
+
import { SdPlatformBookmarkApi } from "./resources/SdPlatformBookmarkApi";
|
|
7
|
+
import { SdPlatformChargebeeApi } from "./resources/SdPlatformChargebeeApi";
|
|
8
|
+
import { SdPlatformDomainApi } from "./resources/SdPlatformDomainApi";
|
|
9
|
+
import { SdPlatformHttpLogApi } from './resources/SdPlatformHttpLogApi';
|
|
10
|
+
import { SdPlatformImageApi } from "./resources/SdPlatformImageApi";
|
|
11
|
+
import { SdPlatformModelApi } from "./resources/SdPlatformModelApi";
|
|
12
|
+
import { SdPlatformModelSharingApi } from "./resources/SdPlatformModelSharingApi";
|
|
13
|
+
import { SdPlatformModelTokenApi } from "./resources/SdPlatformModelTokenApi";
|
|
14
|
+
import { SdPlatformModelTransferApi } from './resources/SdPlatformModelTransferApi';
|
|
15
|
+
import { SdPlatformNotificationApi } from "./resources/SdPlatformNotificationApi";
|
|
16
|
+
import { SdPlatformOrganizationApi } from "./resources/SdPlatformOrganizationApi";
|
|
17
|
+
import { SdPlatformPolicyApi } from "./resources/SdPlatformPolicyApi";
|
|
18
|
+
import { SdPlatformSavedStateApi } from './resources/SdPlatformSavedStateApi';
|
|
19
|
+
import { SdPlatformSavedStateSharingApi } from "./resources/SdPlatformSavedStateSharingApi";
|
|
20
|
+
import { SdPlatformTagApi } from "./resources/SdPlatformTagApi";
|
|
21
|
+
import { SdPlatformUserAnalyticsApi } from "./resources/SdPlatformUserAnalyticsApi";
|
|
22
|
+
import { SdPlatformUserApi } from "./resources/SdPlatformUserApi";
|
|
23
|
+
import { SdPlatformWebhookApi } from './resources/SdPlatformWebhookApi';
|
|
24
|
+
export declare class SdPlatformSdk {
|
|
25
|
+
private __config;
|
|
26
|
+
private __api;
|
|
27
|
+
private __authorization;
|
|
28
|
+
private __api_tokens;
|
|
29
|
+
private __backendSystem;
|
|
30
|
+
private __bookmarks;
|
|
31
|
+
private __chargebee;
|
|
32
|
+
private __domains;
|
|
33
|
+
private __http_logs;
|
|
34
|
+
private __images;
|
|
35
|
+
private __model_sharing;
|
|
36
|
+
private __models;
|
|
37
|
+
private __modelTokens;
|
|
38
|
+
private __modelTransfers;
|
|
39
|
+
private __notifications;
|
|
40
|
+
private __organizations;
|
|
41
|
+
private __policies;
|
|
42
|
+
private __savedStates;
|
|
43
|
+
private __savedStateSharing;
|
|
44
|
+
private __tags;
|
|
45
|
+
private __userAnalytics;
|
|
46
|
+
private __users;
|
|
47
|
+
private __webhooks;
|
|
48
|
+
/**
|
|
49
|
+
* ShapeDiverSDK constructor
|
|
50
|
+
* @param clientId - the client id
|
|
51
|
+
* @param clientSecret - the client secret
|
|
52
|
+
* @param baseUrl - the base url
|
|
53
|
+
*/
|
|
54
|
+
constructor(clientId?: string | null, clientSecret?: string | null, baseUrl?: string | null);
|
|
55
|
+
/**
|
|
56
|
+
* Configuration for this instance of the Platform SDK.
|
|
57
|
+
*/
|
|
58
|
+
get config(): SdPlatformSdkConfig;
|
|
59
|
+
/**
|
|
60
|
+
* Authentication service for ShapeDiver Platform.
|
|
61
|
+
*/
|
|
62
|
+
get authorization(): SdPlatformAuthServiceApi;
|
|
63
|
+
/**
|
|
64
|
+
* CRUD operations for Platform API tokens.
|
|
65
|
+
* Platform API tokens can be limited in scope and lifetime.
|
|
66
|
+
* Use Platform API tokens for applications making use of the Platform API.
|
|
67
|
+
* Limit their scope as much as possible.
|
|
68
|
+
*/
|
|
69
|
+
get apiTokens(): SdPlatformApiTokenApi;
|
|
70
|
+
/**
|
|
71
|
+
* Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
|
|
72
|
+
*/
|
|
73
|
+
get backendSystem(): SdPlatformBackendSystemApi;
|
|
74
|
+
/**
|
|
75
|
+
* Operations for creating and deleting bookmarks
|
|
76
|
+
*/
|
|
77
|
+
get bookmarks(): SdPlatformBookmarkApi;
|
|
78
|
+
/**
|
|
79
|
+
* Actions related to Chargebee subscription management.
|
|
80
|
+
*/
|
|
81
|
+
get chargebee(): SdPlatformChargebeeApi;
|
|
82
|
+
/**
|
|
83
|
+
* Operations for domains which can be attached to users, organizations, models.
|
|
84
|
+
*/
|
|
85
|
+
get domains(): SdPlatformDomainApi;
|
|
86
|
+
/**
|
|
87
|
+
* HTTP logs.
|
|
88
|
+
*/
|
|
89
|
+
get httpLogs(): SdPlatformHttpLogApi;
|
|
90
|
+
/**
|
|
91
|
+
* Operations for images which can be attached to models
|
|
92
|
+
*/
|
|
93
|
+
get images(): SdPlatformImageApi;
|
|
94
|
+
/**
|
|
95
|
+
* Operations for model sharing relationships.
|
|
96
|
+
*/
|
|
97
|
+
get modelSharing(): SdPlatformModelSharingApi;
|
|
98
|
+
/**
|
|
99
|
+
* Operations for models on the ShapeDiver Platform.
|
|
100
|
+
*/
|
|
101
|
+
get models(): SdPlatformModelApi;
|
|
102
|
+
/**
|
|
103
|
+
* Operations for creating tokens for models on Geometry Backend Systems
|
|
104
|
+
*/
|
|
105
|
+
get modelTokens(): SdPlatformModelTokenApi;
|
|
106
|
+
/**
|
|
107
|
+
* Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
|
|
108
|
+
*/
|
|
109
|
+
get modelTransfers(): SdPlatformModelTransferApi;
|
|
110
|
+
/**
|
|
111
|
+
* Operations for querying, reading/unreading, creating notifications.
|
|
112
|
+
*/
|
|
113
|
+
get notifications(): SdPlatformNotificationApi;
|
|
114
|
+
/**
|
|
115
|
+
* Operations for organizations.
|
|
116
|
+
*/
|
|
117
|
+
get organizations(): SdPlatformOrganizationApi;
|
|
118
|
+
/**
|
|
119
|
+
* Operations for policies.
|
|
120
|
+
*/
|
|
121
|
+
get policies(): SdPlatformPolicyApi;
|
|
122
|
+
/**
|
|
123
|
+
* Operations for saved states.
|
|
124
|
+
*/
|
|
125
|
+
get savedStates(): SdPlatformSavedStateApi;
|
|
126
|
+
/**
|
|
127
|
+
* Operations for saved state sharing relationships.
|
|
128
|
+
*/
|
|
129
|
+
get savedStateSharing(): SdPlatformSavedStateSharingApi;
|
|
130
|
+
/**
|
|
131
|
+
* Operations for tags which can be attached to models.
|
|
132
|
+
*/
|
|
133
|
+
get tags(): SdPlatformTagApi;
|
|
134
|
+
/**
|
|
135
|
+
* Analytics for users.
|
|
136
|
+
*/
|
|
137
|
+
get userAnalytics(): SdPlatformUserAnalyticsApi;
|
|
138
|
+
/**
|
|
139
|
+
* Operations for users.
|
|
140
|
+
*/
|
|
141
|
+
get users(): SdPlatformUserApi;
|
|
142
|
+
/**
|
|
143
|
+
* Webhook calls.
|
|
144
|
+
*/
|
|
145
|
+
get webhooks(): SdPlatformWebhookApi;
|
|
146
|
+
/**
|
|
147
|
+
* Register callbacks for request start events.
|
|
148
|
+
* onRequestStart is fired before each request. This does not modify request, it is used only as notification that request is starting.
|
|
149
|
+
* NOTE: requestParams is as shallow copy.
|
|
150
|
+
* @param cb
|
|
151
|
+
*/
|
|
152
|
+
onRequestStart(cb: (event: SdPlatformRequestStartEvent) => void): void;
|
|
153
|
+
/**
|
|
154
|
+
* Register callbacks for request finished events.
|
|
155
|
+
* onRequestFinished is fired after request has been resolved.
|
|
156
|
+
* NOTE: response is passed as shallow copy.
|
|
157
|
+
* NOTE: requestParams is as shallow copy.
|
|
158
|
+
* @param cb
|
|
159
|
+
*/
|
|
160
|
+
onRequestFinished(cb: (event: SdPlatformRequestFinishedEvent) => void): void;
|
|
161
|
+
}
|
|
162
|
+
//# sourceMappingURL=SdPlatformSdk.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformSdk.d.ts","sourceRoot":"","sources":["../src/SdPlatformSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,2BAA2B,EAAoB,MAAM,wBAAwB,CAAC;AACvH,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAE3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAG,MAAM,uCAAuC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAClF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAC5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE,qBAAa,aAAa;IAEtB,OAAO,CAAC,QAAQ,CAAsB;IACtC,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,eAAe,CAA2B;IAElD,OAAO,CAAC,YAAY,CAAwB;IAC5C,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,WAAW,CAAwB;IAC3C,OAAO,CAAC,WAAW,CAAyB;IAC5C,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,WAAW,CAAuB;IAC1C,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,UAAU,CAAsB;IACxC,OAAO,CAAC,aAAa,CAA0B;IAC/C,OAAO,CAAC,mBAAmB,CAAiC;IAC5D,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,UAAU,CAAuB;IAEzC;;;;;OAKG;gBACS,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IA+B3F;;OAEG;IACH,IAAW,MAAM,IAAI,mBAAmB,CAGvC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,wBAAwB,CAGnD;IAED;;;;;OAKG;IACH,IAAW,SAAS,IAAI,qBAAqB,CAG5C;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,0BAA0B,CAGrD;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,qBAAqB,CAG5C;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,sBAAsB,CAG7C;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,mBAAmB,CAGxC;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,oBAAoB,CAG1C;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,kBAAkB,CAGtC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,yBAAyB,CAGnD;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,kBAAkB,CAGtC;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,uBAAuB,CAGhD;IAED;;OAEG;IACH,IAAW,cAAc,IAAI,0BAA0B,CAGtD;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,yBAAyB,CAGpD;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,yBAAyB,CAGpD;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,mBAAmB,CAGzC;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,uBAAuB,CAGhD;IAED;;OAEG;IACH,IAAW,iBAAiB,IAAI,8BAA8B,CAG7D;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,gBAAgB,CAGlC;IAED;;OAEG;IACH,IAAW,aAAa,IAAI,0BAA0B,CAGrD;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,iBAAiB,CAGpC;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,oBAAoB,CAG1C;IAED;;;;;OAKG;IACI,cAAc,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,2BAA2B,KAAK,IAAI,GAAG,IAAI;IAK7E;;;;;;OAMG;IACI,iBAAiB,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,8BAA8B,KAAK,IAAI,GAAG,IAAI;CAItF"}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { SdPlatformSdkApi } from "./api/SdPlatformSdkApi";
|
|
2
|
+
import { SdPlatformSdkConfig } from "./api/SdPlatformSdkConfig";
|
|
3
|
+
/**
|
|
4
|
+
* Access token details
|
|
5
|
+
*/
|
|
6
|
+
export interface SdPlatformAccessTokenDetails {
|
|
7
|
+
access_token?: string;
|
|
8
|
+
refresh_token?: string;
|
|
9
|
+
expires_in?: number;
|
|
10
|
+
token_type?: string;
|
|
11
|
+
user_id?: string;
|
|
12
|
+
expirationDate?: Date;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Status of the access token
|
|
16
|
+
*/
|
|
17
|
+
export declare enum SdPlatformAccessTokenState {
|
|
18
|
+
/** no access token has been set */
|
|
19
|
+
NoToken = 0,
|
|
20
|
+
/** the access token has expired */
|
|
21
|
+
Expired = 1,
|
|
22
|
+
/** the access token has been set and is not expired yet */
|
|
23
|
+
Valid = 2
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Status of authentication.
|
|
27
|
+
*/
|
|
28
|
+
export interface SdPlatformAuthenticationStatus {
|
|
29
|
+
/** true if an access token is present, not considering its state */
|
|
30
|
+
readonly isAuthenticated: boolean;
|
|
31
|
+
/** status of access token */
|
|
32
|
+
readonly accessTokenState: SdPlatformAccessTokenState;
|
|
33
|
+
/** id of authenticated user (ShapeDiver Platform user id) */
|
|
34
|
+
readonly userId: string | null;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Contextual information shared between the authentication API
|
|
38
|
+
* and the ShapeDiver Platform resource APIs.
|
|
39
|
+
*/
|
|
40
|
+
export declare class SdPlatformSdkContext {
|
|
41
|
+
private __api;
|
|
42
|
+
private __config;
|
|
43
|
+
private __accessTokenDetails;
|
|
44
|
+
constructor(__api: SdPlatformSdkApi, __config: SdPlatformSdkConfig);
|
|
45
|
+
private cloneTokenDetails;
|
|
46
|
+
/**
|
|
47
|
+
* Get details of the access token
|
|
48
|
+
*/
|
|
49
|
+
get accessTokenDetails(): SdPlatformAccessTokenDetails;
|
|
50
|
+
/**
|
|
51
|
+
* Set details of the access token
|
|
52
|
+
* @param details
|
|
53
|
+
*/
|
|
54
|
+
setAccessTokenDetails(details: SdPlatformAccessTokenDetails): void;
|
|
55
|
+
/**
|
|
56
|
+
* Base API.
|
|
57
|
+
*/
|
|
58
|
+
get api(): SdPlatformSdkApi;
|
|
59
|
+
/**
|
|
60
|
+
* SDK Configuration.
|
|
61
|
+
*/
|
|
62
|
+
get config(): SdPlatformSdkConfig;
|
|
63
|
+
/**
|
|
64
|
+
* Status of the access token.
|
|
65
|
+
*/
|
|
66
|
+
get accessTokenState(): SdPlatformAccessTokenState;
|
|
67
|
+
/**
|
|
68
|
+
* Status of authentication.
|
|
69
|
+
*/
|
|
70
|
+
get authData(): SdPlatformAuthenticationStatus;
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=SdPlatformSdkContext.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformSdkContext.d.ts","sourceRoot":"","sources":["../src/SdPlatformSdkContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAEzC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,oBAAY,0BAA0B;IAElC,mCAAmC;IACnC,OAAO,IAAA;IACP,mCAAmC;IACnC,OAAO,IAAA;IACP,2DAA2D;IAC3D,KAAK,IAAA;CACR;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAE3C,oEAAoE;IACpE,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,6BAA6B;IAC7B,QAAQ,CAAC,gBAAgB,EAAE,0BAA0B,CAAC;IACtD,6DAA6D;IAC7D,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED;;;GAGG;AACH,qBAAa,oBAAoB;IAIjB,OAAO,CAAC,KAAK;IAAoB,OAAO,CAAC,QAAQ;IAF7D,OAAO,CAAC,oBAAoB,CAAoC;gBAE5C,KAAK,EAAE,gBAAgB,EAAU,QAAQ,EAAE,mBAAmB;IAKlF,OAAO,CAAC,iBAAiB;IAYzB;;OAEG;IACH,IAAW,kBAAkB,IAAI,4BAA4B,CAG5D;IAED;;;OAGG;IACI,qBAAqB,CAAC,OAAO,EAAE,4BAA4B;IAIlE;;OAEG;IACH,IAAW,GAAG,IAAI,gBAAgB,CAGjC;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,mBAAmB,CAGvC;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,0BAA0B,CAexD;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,8BAA8B,CAOpD;CACJ"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { SdPlatformSdk } from "./SdPlatformSdk";
|
|
2
|
+
export interface SdPlatformClientConfig {
|
|
3
|
+
clientId?: string;
|
|
4
|
+
clientSecret?: string;
|
|
5
|
+
baseUrl?: string;
|
|
6
|
+
}
|
|
7
|
+
export declare function create(clientId?: SdPlatformClientConfig | string | null, clientSecret?: string | null, baseUrl?: string | null): SdPlatformSdk;
|
|
8
|
+
//# sourceMappingURL=SdPlatformSdkCreate.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformSdkCreate.d.ts","sourceRoot":"","sources":["../src/SdPlatformSdkCreate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,MAAM,WAAW,sBAAsB;IAEnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,wBAAgB,MAAM,CAAC,QAAQ,CAAC,EAAE,sBAAsB,GAAG,MAAM,GAAG,IAAI,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,aAAa,CAmB9I"}
|
|
@@ -0,0 +1,8 @@
|
|
|
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 {};
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { BeforeRequest, RequestFinishedEvent, RequestStartEvent } from "./api/ShapeDiverSDKApi";
|
|
2
|
+
import { ShapeDiverSDKConfig } from "./config/ShapeDiverSDKConfig";
|
|
3
|
+
import { ModelApi } from "./resources/models/ModelApi";
|
|
4
|
+
import { AuthServiceApi } from './auth/AuthServiceApi';
|
|
5
|
+
import { PolicyApi } from "./resources/policies/PolicyApi";
|
|
6
|
+
import { UserApi } from "./resources/users/UserApi";
|
|
7
|
+
import { TokenApi } from "./resources/tokens/TokenApi";
|
|
8
|
+
import { ApiTokenApi } from "./resources/apiTokens/ApiTokenApi";
|
|
9
|
+
import { TagApi } from "./resources/tags/TagApi";
|
|
10
|
+
import { DomainApi } from "./resources/domains/DomainApi";
|
|
11
|
+
import { BookmarkApi } from "./resources/bookmarks/BookmarkApi";
|
|
12
|
+
import { ImageApi } from "./resources/images/ImageApi";
|
|
13
|
+
import { ChargebeeApi } from "./resources/chargebee/ChargebeeApi";
|
|
14
|
+
import { ModelSharingApi } from "./resources/modelSharing/ModelSharingApi";
|
|
15
|
+
import { HttpLogApi } from './resources/httplogs/HttpLogApi';
|
|
16
|
+
import { BackendSystemApi } from "./resources/backendSystems/BackendSystemApi";
|
|
17
|
+
import { SavedStatesApi } from './resources/savedStates/SavedStatesApi';
|
|
18
|
+
import { SavedStateSharingsApi } from "./resources/savedStateSharing/SavedStateSharingsApi";
|
|
19
|
+
import { NotificationApi } from "./resources/notifications/NotificationsApi";
|
|
20
|
+
import { WebhookApi } from './resources/webhooks/WebhooksApi';
|
|
21
|
+
import { UserModelSessionsApi } from "./resources/userModelSessions/UserModelSessionsApi";
|
|
22
|
+
import { OrganizationsApi } from "./resources/organizations/OrganizationsApi";
|
|
23
|
+
import { ModelTransferApi } from './resources/modelTransfers/ModelTransferApi';
|
|
24
|
+
export declare class ShapeDiverSDKInstance {
|
|
25
|
+
private __config;
|
|
26
|
+
private __api;
|
|
27
|
+
private __authorization;
|
|
28
|
+
private __models;
|
|
29
|
+
private __policies;
|
|
30
|
+
private __users;
|
|
31
|
+
private __tokens;
|
|
32
|
+
private __api_tokens;
|
|
33
|
+
private __tags;
|
|
34
|
+
private __domains;
|
|
35
|
+
private __bookmarks;
|
|
36
|
+
private __images;
|
|
37
|
+
private __chargebee;
|
|
38
|
+
private __model_sharing;
|
|
39
|
+
private __http_logs;
|
|
40
|
+
private __backendSystem;
|
|
41
|
+
private __savedStates;
|
|
42
|
+
private __savedStateSharings;
|
|
43
|
+
private __notifications;
|
|
44
|
+
private __webhooks;
|
|
45
|
+
private __userModelSessions;
|
|
46
|
+
private __organizations;
|
|
47
|
+
private __modelTransfers;
|
|
48
|
+
/**
|
|
49
|
+
* ShapeDiverSDK constructor
|
|
50
|
+
* @param clientId - the client id
|
|
51
|
+
* @param clientSecret - the client secret
|
|
52
|
+
* @param baseUrl - the base url
|
|
53
|
+
*/
|
|
54
|
+
constructor(clientId?: string | null, clientSecret?: string | null, baseUrl?: string | null);
|
|
55
|
+
get config(): ShapeDiverSDKConfig;
|
|
56
|
+
get authorization(): AuthServiceApi;
|
|
57
|
+
get models(): ModelApi;
|
|
58
|
+
get policies(): PolicyApi;
|
|
59
|
+
get users(): UserApi;
|
|
60
|
+
get tokens(): TokenApi;
|
|
61
|
+
get apiTokens(): ApiTokenApi;
|
|
62
|
+
get tags(): TagApi;
|
|
63
|
+
get domains(): DomainApi;
|
|
64
|
+
get bookmarks(): BookmarkApi;
|
|
65
|
+
get images(): ImageApi;
|
|
66
|
+
get chargebee(): ChargebeeApi;
|
|
67
|
+
get modelSharing(): ModelSharingApi;
|
|
68
|
+
/**
|
|
69
|
+
* TODO: do be deprecated
|
|
70
|
+
*/
|
|
71
|
+
get http_logs(): HttpLogApi;
|
|
72
|
+
get httpLogs(): HttpLogApi;
|
|
73
|
+
get backendSystem(): BackendSystemApi;
|
|
74
|
+
get savedStates(): SavedStatesApi;
|
|
75
|
+
get savedStatesSharings(): SavedStateSharingsApi;
|
|
76
|
+
get notifications(): NotificationApi;
|
|
77
|
+
get webhooks(): WebhookApi;
|
|
78
|
+
get userModelSessions(): UserModelSessionsApi;
|
|
79
|
+
get organizations(): OrganizationsApi;
|
|
80
|
+
get modelTransfers(): ModelTransferApi;
|
|
81
|
+
/**
|
|
82
|
+
* beforeRequestPipe modifies request that is to be used.
|
|
83
|
+
* Use it to attach any custom data to requests if necessary. Such as custom header etc...
|
|
84
|
+
* @param cb
|
|
85
|
+
*/
|
|
86
|
+
beforeRequestPipe(cb: (request: BeforeRequest) => BeforeRequest): void;
|
|
87
|
+
/**
|
|
88
|
+
* onRequestStart is fired before each request. This does not modify request, it is used only as notification that request is starting.
|
|
89
|
+
* NOTE: requestParams is as shallow copy.
|
|
90
|
+
* @param cb
|
|
91
|
+
*/
|
|
92
|
+
onRequestStart(cb: (event: RequestStartEvent) => void): void;
|
|
93
|
+
/**
|
|
94
|
+
* onRequestFinished is fired after request has been resolved.
|
|
95
|
+
* NOTE: response is passed as shallow copy.
|
|
96
|
+
* NOTE: requestParams is as shallow copy.
|
|
97
|
+
* @param cb
|
|
98
|
+
*/
|
|
99
|
+
onRequestFinished(cb: (event: RequestFinishedEvent) => void): void;
|
|
100
|
+
}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Identifier for type of request to the ShapeDiver Platform Backend.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum RequestId {
|
|
5
|
+
/**
|
|
6
|
+
* Platform Authentication API
|
|
7
|
+
*/
|
|
8
|
+
PasswordGrant = "password_grant",
|
|
9
|
+
RefreshToken = "refresh_token",
|
|
10
|
+
Logout = "logout",
|
|
11
|
+
/**
|
|
12
|
+
* Platform Backend API
|
|
13
|
+
*/
|
|
14
|
+
ApiTokenGet = "api_token_get",
|
|
15
|
+
ApiTokenQuery = "api_token_query",
|
|
16
|
+
ApiTokenCreate = "api_token_create",
|
|
17
|
+
ApiTokenPatch = "api_token_patch",
|
|
18
|
+
ApiTokenDelete = "api_token_delete",
|
|
19
|
+
BackendSystemQuery = "backend_system_query",
|
|
20
|
+
BackendSystemCreate = "backend_system_create",
|
|
21
|
+
BackendSystemPatch = "backend_system_patch",
|
|
22
|
+
BackendSystemToken = "backend_system_token",
|
|
23
|
+
BookmarkCreate = "bookmark_create",
|
|
24
|
+
BookmarkDelete = "bookmark_delete",
|
|
25
|
+
ImageGet = "image_get",
|
|
26
|
+
ImageQuery = "image_query",
|
|
27
|
+
ImageCreate = "image_create",
|
|
28
|
+
ImagesDelete = "image_delete",
|
|
29
|
+
PolicyGet = "policy_get",
|
|
30
|
+
PolicyQuery = "policy_query",
|
|
31
|
+
PolicyCreate = "policy_create",
|
|
32
|
+
PolicyPatch = "policy_patch",
|
|
33
|
+
PolicyDelete = "policy_delete",
|
|
34
|
+
TagGet = "tag_get",
|
|
35
|
+
TagQuery = "tag_query",
|
|
36
|
+
TokenCreate = "token_create",
|
|
37
|
+
UserGet = "user_get",
|
|
38
|
+
UserQuery = "user_query",
|
|
39
|
+
UserPatch = "user_patch",
|
|
40
|
+
UserDelete = "user_delete",
|
|
41
|
+
UserRegister = "user_register",
|
|
42
|
+
UserConfirm = "user_confirm",
|
|
43
|
+
PasswordReset = "password_reset",
|
|
44
|
+
PasswordResetConfirm = "password_reset_confirm",
|
|
45
|
+
ModelGet = "model_get",
|
|
46
|
+
ModelQuery = "model_query",
|
|
47
|
+
ModelCreate = "model_create",
|
|
48
|
+
ModelPatch = "model_patch",
|
|
49
|
+
ModelDelete = "model_delete",
|
|
50
|
+
DecryptTicket = "decrypt_ticket",
|
|
51
|
+
SavedStateGet = "saved_state_get",
|
|
52
|
+
SavedStateQuery = "saved_state_query",
|
|
53
|
+
SavedStatePatch = "saved_state_patch",
|
|
54
|
+
SavedStateCreate = "saved_state_create",
|
|
55
|
+
SavedStateDelete = "saved_state_delete",
|
|
56
|
+
DomainGet = "domain_get",
|
|
57
|
+
DomainQuery = "domain_query",
|
|
58
|
+
DomainCreate = "domain_create",
|
|
59
|
+
DomainPatch = "domain_patch",
|
|
60
|
+
DomainDelete = "domain_delete",
|
|
61
|
+
OrganizationGet = "organization_get",
|
|
62
|
+
OrganizationQuery = "organization_query",
|
|
63
|
+
OrganizationCreate = "organization_create",
|
|
64
|
+
OrganizationDelete = "organization_delete",
|
|
65
|
+
OrganizationPatch = "organization_patch",
|
|
66
|
+
OrganizationInvitationCreate = "organization_invitation_create",
|
|
67
|
+
OrganizationInvitationDelete = "organization_invitation_delete",
|
|
68
|
+
OrganizationInvitationsGet = "organization_invitation_get",
|
|
69
|
+
OrganizationInvitationAccept = "organization_invitation_accept",
|
|
70
|
+
OrganizationInvitationDeny = "organization_invitation_deny",
|
|
71
|
+
OrganizationPatchMemberRole = "organization_patch_member_role",
|
|
72
|
+
NotificationQuery = "notification_query",
|
|
73
|
+
NotificationCreate = "notification_create",
|
|
74
|
+
NotificationPatch = "notification_patch",
|
|
75
|
+
NotificationDelete = "notification_delete",
|
|
76
|
+
UserModelSessionsQuery = "user_model_sessions_query",
|
|
77
|
+
ChargebeeHostedPage = "chargebee_hosted_page",
|
|
78
|
+
ChargebeeHostedPageUpdatePaymentMethod = "chargebee_hosted_page_update_payment_method",
|
|
79
|
+
ChargebeePortalSession = "chargebee_portal_session",
|
|
80
|
+
ChargebeeConfig = "chargebee_config",
|
|
81
|
+
ChargebeeQueryPlan = "chargebee_query_plan",
|
|
82
|
+
HttpLogQuery = "http_log_query",
|
|
83
|
+
ModelSharingCreate = "model_sharing_create",
|
|
84
|
+
ModelSharingQuery = "model_sharing_query",
|
|
85
|
+
ModelSharingQueryByModel = "model_sharing_query_by_model",
|
|
86
|
+
ModelSharingQueryByUser = "model_sharing_query_by_user",
|
|
87
|
+
ModelSharingGetByModelAndUser = "model_sharing_get_by_model_and_user",
|
|
88
|
+
ModelSharingDelete = "model_sharing_delete",
|
|
89
|
+
SavedStateSharingCreate = "saved_state_sharing_create",
|
|
90
|
+
SavedStateSharingQuery = "saved_state_sharing_query",
|
|
91
|
+
SavedStateSharingQueryBySavedState = "saved_state_sharing_query_by_saved_state",
|
|
92
|
+
SavedStateSharingQueryByUser = "saved_state_sharing_query_by_user",
|
|
93
|
+
SavedStateSharingGetBySavedStateAndUser = "saved_state_sharing_get_by_saved_state_and_user",
|
|
94
|
+
SavedStateSharingDelete = "saved_state_sharing_delete",
|
|
95
|
+
WebhookChargebeeEvent = "webhook_chargebee_event",
|
|
96
|
+
WebhookModelMessage = "webhook_model_message",
|
|
97
|
+
WebhookNotification = "webhook_notification",
|
|
98
|
+
ModelTransferRequestCreate = "model_transfer_request_create",
|
|
99
|
+
ModelTransferRequestDelete = "model_transfer_request_delete",
|
|
100
|
+
ModelTransferRequestList = "model_transfer_request_list",
|
|
101
|
+
ModelTransferRequestGet = "model_transfer_request_get",
|
|
102
|
+
ModelTransferRequestAccept = "model_transfer_request_accept",
|
|
103
|
+
ModelTransferRequestDeny = "model_transfer_request_deny"
|
|
104
|
+
}
|
|
105
|
+
//# sourceMappingURL=SdPlatformRequestId.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"SdPlatformRequestId.d.ts","sourceRoot":"","sources":["../../src/api/SdPlatformRequestId.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,SAAS;IAEjB;;OAEG;IACH,aAAa,mBAAmB;IAChC,YAAY,kBAAkB;IAC9B,MAAM,WAAW;IAEjB;;OAEG;IACH,WAAW,kBAAkB;IAC7B,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IACnC,aAAa,oBAAoB;IACjC,cAAc,qBAAqB;IAEnC,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,kBAAkB,yBAAyB;IAC3C,kBAAkB,yBAAyB;IAE3C,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;IAElC,QAAQ,cAAc;IACtB,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,YAAY,iBAAiB;IAE7B,SAAS,eAAe;IACxB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAE9B,MAAM,YAAY;IAClB,QAAQ,cAAc;IAEtB,WAAW,iBAAiB;IAE5B,OAAO,aAAa;IACpB,SAAS,eAAe;IACxB,SAAS,eAAe;IACxB,UAAU,gBAAgB;IAC1B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAE5B,aAAa,mBAAmB;IAChC,oBAAoB,2BAA2B;IAE/C,QAAQ,cAAc;IACtB,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,UAAU,gBAAgB;IAC1B,WAAW,iBAAiB;IAC5B,aAAa,mBAAmB;IAEhC,aAAa,oBAAoB;IACjC,eAAe,sBAAsB;IACrC,eAAe,sBAAsB;IACrC,gBAAgB,uBAAuB;IACvC,gBAAgB,uBAAuB;IAEvC,SAAS,eAAe;IACxB,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAC9B,WAAW,iBAAiB;IAC5B,YAAY,kBAAkB;IAE9B,eAAe,qBAAqB;IACpC,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,kBAAkB,wBAAwB;IAC1C,iBAAiB,uBAAuB;IACxC,4BAA4B,mCAAmC;IAC/D,4BAA4B,mCAAmC;IAC/D,0BAA0B,gCAAgC;IAC1D,4BAA4B,mCAAmC;IAC/D,0BAA0B,iCAAiC;IAC3D,2BAA2B,mCAAmC;IAE9D,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAC1C,iBAAiB,uBAAuB;IACxC,kBAAkB,wBAAwB;IAE1C,sBAAsB,8BAA8B;IAEpD,mBAAmB,0BAA0B;IAC7C,sCAAsC,gDAAgD;IACtF,sBAAsB,6BAA6B;IACnD,eAAe,qBAAqB;IACpC,kBAAkB,yBAAyB;IAE3C,YAAY,mBAAmB;IAE/B,kBAAkB,yBAAyB;IAC3C,iBAAiB,wBAAwB;IACzC,wBAAwB,iCAAiC;IACzD,uBAAuB,gCAAgC;IACvD,6BAA6B,wCAAwC;IACrE,kBAAkB,yBAAyB;IAE3C,uBAAuB,+BAA+B;IACtD,sBAAsB,8BAA8B;IACpD,kCAAkC,6CAA6C;IAC/E,4BAA4B,sCAAsC;IAClE,uCAAuC,oDAAoD;IAC3F,uBAAuB,+BAA+B;IAEtD,qBAAqB,4BAA4B;IACjD,mBAAmB,0BAA0B;IAC7C,mBAAmB,yBAAyB;IAE5C,0BAA0B,kCAAkC;IAC5D,0BAA0B,kCAAkC;IAC5D,wBAAwB,gCAAgC;IACxD,uBAAuB,+BAA+B;IACtD,0BAA0B,kCAAkC;IAC5D,wBAAwB,gCAAgC;CAE3D"}
|