@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.
Files changed (152) hide show
  1. package/LICENSE +7 -7
  2. package/README.md +61 -61
  3. package/dist/SdPlatformErrors.d.ts +134 -134
  4. package/dist/SdPlatformSdk.d.ts +185 -185
  5. package/dist/SdPlatformSdkContext.d.ts +71 -71
  6. package/dist/SdPlatformSdkCreate.d.ts +7 -7
  7. package/dist/api/SdPlatformRequestId.d.ts +136 -136
  8. package/dist/api/SdPlatformSdkApi.d.ts +66 -66
  9. package/dist/api/SdPlatformSdkConfig.d.ts +18 -18
  10. package/dist/api/SdPlatformSdkErrorMapping.d.ts +6 -6
  11. package/dist/auth/SdPlatformAuthServiceApi.d.ts +77 -77
  12. package/dist/bundle.js +3486 -3366
  13. package/dist/bundle.node.js +3525 -3381
  14. package/dist/index.d.ts +27 -27
  15. package/dist/resources/SdPlatformApiClientsApi.d.ts +16 -16
  16. package/dist/resources/SdPlatformApiTokenApi.d.ts +44 -18
  17. package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
  18. package/dist/resources/SdPlatformBackendSystemApi.d.ts +35 -17
  19. package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
  20. package/dist/resources/SdPlatformBookmarkApi.d.ts +21 -16
  21. package/dist/resources/SdPlatformBookmarkApi.d.ts.map +1 -1
  22. package/dist/resources/SdPlatformChargebeeApi.d.ts +20 -20
  23. package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
  24. package/dist/resources/SdPlatformDomainApi.d.ts +44 -44
  25. package/dist/resources/SdPlatformHttpLogApi.d.ts +15 -15
  26. package/dist/resources/SdPlatformImageApi.d.ts +36 -36
  27. package/dist/resources/SdPlatformModelApi.d.ts +76 -76
  28. package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
  29. package/dist/resources/SdPlatformModelSharingApi.d.ts +64 -64
  30. package/dist/resources/SdPlatformModelTokenApi.d.ts +10 -10
  31. package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -47
  32. package/dist/resources/SdPlatformNotificationApi.d.ts +65 -33
  33. package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -1
  34. package/dist/resources/SdPlatformOpenIDProviderApi.d.ts +41 -41
  35. package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts +15 -15
  36. package/dist/resources/SdPlatformOrganizationApi.d.ts +92 -92
  37. package/dist/resources/SdPlatformPolicyApi.d.ts +43 -17
  38. package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -1
  39. package/dist/resources/SdPlatformSavedStateApi.d.ts +51 -50
  40. package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -1
  41. package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +66 -66
  42. package/dist/resources/SdPlatformTagApi.d.ts +15 -15
  43. package/dist/resources/SdPlatformUserAnalyticsApi.d.ts +15 -15
  44. package/dist/resources/SdPlatformUserApi.d.ts +86 -86
  45. package/dist/resources/SdPlatformWebhookApi.d.ts +52 -52
  46. package/dist/resources/commons/FilterBuilder.d.ts +54 -54
  47. package/dist/resources/commons/ResourcesApi.d.ts +42 -42
  48. package/package.json +2 -2
  49. package/dist/ShapeDiverErrors.d.ts +0 -79
  50. package/dist/ShapeDiverErrors.d.ts.map +0 -1
  51. package/dist/ShapeDiverSDK.d.ts +0 -9
  52. package/dist/ShapeDiverSDK.d.ts.map +0 -1
  53. package/dist/ShapeDiverSDKContext.d.ts +0 -47
  54. package/dist/ShapeDiverSDKContext.d.ts.map +0 -1
  55. package/dist/ShapeDiverSDKInstance.d.ts +0 -91
  56. package/dist/ShapeDiverSDKInstance.d.ts.map +0 -1
  57. package/dist/api/RequestId.d.ts +0 -105
  58. package/dist/api/RequestId.d.ts.map +0 -1
  59. package/dist/api/ShapeDiverSDKApi.d.ts +0 -40
  60. package/dist/api/ShapeDiverSDKApi.d.ts.map +0 -1
  61. package/dist/api/ShapeDiverSDKApiErrors.d.ts +0 -7
  62. package/dist/api/ShapeDiverSDKApiErrors.d.ts.map +0 -1
  63. package/dist/api/ShapeDiverSDKConfig.d.ts +0 -7
  64. package/dist/api/ShapeDiverSDKConfig.d.ts.map +0 -1
  65. package/dist/api/ShapeDiverSDKRequestConfig.d.ts +0 -8
  66. package/dist/api/ShapeDiverSDKRequestConfig.d.ts.map +0 -1
  67. package/dist/auth/AuthServiceApi.d.ts +0 -34
  68. package/dist/auth/AuthServiceApi.d.ts.map +0 -1
  69. package/dist/auth/models/AuthRequest.d.ts +0 -13
  70. package/dist/auth/models/AuthRequest.d.ts.map +0 -1
  71. package/dist/auth/models/AuthResponse.d.ts +0 -12
  72. package/dist/auth/models/AuthResponse.d.ts.map +0 -1
  73. package/dist/common/FailedRequestError.d.ts +0 -4
  74. package/dist/common/FailedRequestError.d.ts.map +0 -1
  75. package/dist/common/Filter.d.ts +0 -52
  76. package/dist/common/Filter.d.ts.map +0 -1
  77. package/dist/common/FilterBuilder.d.ts +0 -55
  78. package/dist/common/FilterBuilder.d.ts.map +0 -1
  79. package/dist/common/Parameters.d.ts +0 -29
  80. package/dist/common/Parameters.d.ts.map +0 -1
  81. package/dist/common/QueryRequestParameters.d.ts +0 -46
  82. package/dist/common/QueryRequestParameters.d.ts.map +0 -1
  83. package/dist/common/RequestId.d.ts +0 -106
  84. package/dist/common/RequestId.d.ts.map +0 -1
  85. package/dist/common/ShapeDiverSDKContext.d.ts +0 -32
  86. package/dist/common/ShapeDiverSDKContext.d.ts.map +0 -1
  87. package/dist/config/ShapeDiverSDKConfig.d.ts +0 -7
  88. package/dist/config/ShapeDiverSDKConfig.d.ts.map +0 -1
  89. package/dist/resources/ResourcesApi.d.ts +0 -84
  90. package/dist/resources/ResourcesApi.d.ts.map +0 -1
  91. package/dist/resources/chargebee/ChargebeeApi.d.ts +0 -18
  92. package/dist/resources/chargebee/ChargebeeApi.d.ts.map +0 -1
  93. package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts +0 -45
  94. package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts.map +0 -1
  95. package/dist/resources/commons/QueryRequestParameters.d.ts +0 -46
  96. package/dist/resources/commons/QueryRequestParameters.d.ts.map +0 -1
  97. package/dist/resources/httplogs/HttpLogApi.d.ts +0 -16
  98. package/dist/resources/httplogs/HttpLogApi.d.ts.map +0 -1
  99. package/dist/resources/httplogs/models.d.ts +0 -15
  100. package/dist/resources/httplogs/models.d.ts.map +0 -1
  101. package/dist/resources/modelSharing/ModelSharingApi.d.ts +0 -50
  102. package/dist/resources/modelSharing/ModelSharingApi.d.ts.map +0 -1
  103. package/dist/resources/modelSharing/models/ModelSharing.d.ts +0 -29
  104. package/dist/resources/modelSharing/models/ModelSharing.d.ts.map +0 -1
  105. package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts +0 -15
  106. package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts.map +0 -1
  107. package/dist/resources/modelTransfers/CreateModelTransferRequest.d.ts +0 -8
  108. package/dist/resources/modelTransfers/CreateModelTransferRequest.d.ts.map +0 -1
  109. package/dist/resources/modelTransfers/ModelTransferApi.d.ts +0 -45
  110. package/dist/resources/modelTransfers/ModelTransferApi.d.ts.map +0 -1
  111. package/dist/resources/models/ModelApi.d.ts +0 -17
  112. package/dist/resources/models/ModelApi.d.ts.map +0 -1
  113. package/dist/resources/models/models/CreateModelTransferRequest.d.ts +0 -8
  114. package/dist/resources/models/models/CreateModelTransferRequest.d.ts.map +0 -1
  115. package/dist/resources/models/models/Model.d.ts +0 -166
  116. package/dist/resources/models/models/Model.d.ts.map +0 -1
  117. package/dist/resources/models/models/ModelCreate.d.ts +0 -21
  118. package/dist/resources/models/models/ModelCreate.d.ts.map +0 -1
  119. package/dist/resources/models/models/ModelPatch.d.ts +0 -25
  120. package/dist/resources/models/models/ModelPatch.d.ts.map +0 -1
  121. package/dist/resources/notifications/NotificationsApi.d.ts +0 -13
  122. package/dist/resources/notifications/NotificationsApi.d.ts.map +0 -1
  123. package/dist/resources/notifications/models/Notification.d.ts +0 -62
  124. package/dist/resources/notifications/models/Notification.d.ts.map +0 -1
  125. package/dist/resources/notifications/models/Requests.d.ts +0 -19
  126. package/dist/resources/notifications/models/Requests.d.ts.map +0 -1
  127. package/dist/resources/organizations/OrganizationsApi.d.ts +0 -73
  128. package/dist/resources/organizations/OrganizationsApi.d.ts.map +0 -1
  129. package/dist/resources/organizations/models/Organization.d.ts +0 -79
  130. package/dist/resources/organizations/models/Organization.d.ts.map +0 -1
  131. package/dist/resources/organizations/models/Requests.d.ts +0 -22
  132. package/dist/resources/organizations/models/Requests.d.ts.map +0 -1
  133. package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts +0 -50
  134. package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts.map +0 -1
  135. package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts +0 -15
  136. package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts.map +0 -1
  137. package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts +0 -6
  138. package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts.map +0 -1
  139. package/dist/resources/savedStates/SavedStatesApi.d.ts +0 -44
  140. package/dist/resources/savedStates/SavedStatesApi.d.ts.map +0 -1
  141. package/dist/resources/savedStates/models/SavedStatesModels.d.ts +0 -33
  142. package/dist/resources/savedStates/models/SavedStatesModels.d.ts.map +0 -1
  143. package/dist/resources/savedStates/models/SavedStatesRequests.d.ts +0 -29
  144. package/dist/resources/savedStates/models/SavedStatesRequests.d.ts.map +0 -1
  145. package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts +0 -15
  146. package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts.map +0 -1
  147. package/dist/resources/userModelSessions/models/UserModelSession.d.ts +0 -54
  148. package/dist/resources/userModelSessions/models/UserModelSession.d.ts.map +0 -1
  149. package/dist/resources/webhooks/WebhooksApi.d.ts +0 -51
  150. package/dist/resources/webhooks/WebhooksApi.d.ts.map +0 -1
  151. package/dist/resources/webhooks/models/Requests.d.ts +0 -17
  152. package/dist/resources/webhooks/models/Requests.d.ts.map +0 -1
@@ -1,186 +1,186 @@
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 { SdPlatformDocumentApi } from "./resources/SdPlatformDocumentApi";
9
- import { SdPlatformDomainApi } from "./resources/SdPlatformDomainApi";
10
- import { SdPlatformHttpLogApi } from './resources/SdPlatformHttpLogApi';
11
- import { SdPlatformImageApi } from "./resources/SdPlatformImageApi";
12
- import { SdPlatformModelApi } from "./resources/SdPlatformModelApi";
13
- import { SdPlatformModelSharingApi } from "./resources/SdPlatformModelSharingApi";
14
- import { SdPlatformModelTokenApi } from "./resources/SdPlatformModelTokenApi";
15
- import { SdPlatformModelTransferApi } from './resources/SdPlatformModelTransferApi';
16
- import { SdPlatformNotificationApi } from "./resources/SdPlatformNotificationApi";
17
- import { SdPlatformOrganizationApi } from "./resources/SdPlatformOrganizationApi";
18
- import { SdPlatformPolicyApi } from "./resources/SdPlatformPolicyApi";
19
- import { SdPlatformSavedStateApi } from './resources/SdPlatformSavedStateApi';
20
- import { SdPlatformSavedStateSharingApi } from "./resources/SdPlatformSavedStateSharingApi";
21
- import { SdPlatformTagApi } from "./resources/SdPlatformTagApi";
22
- import { SdPlatformUserAnalyticsApi } from "./resources/SdPlatformUserAnalyticsApi";
23
- import { SdPlatformUserApi } from "./resources/SdPlatformUserApi";
24
- import { SdPlatformWebhookApi } from './resources/SdPlatformWebhookApi';
25
- import { SdPlatformOrganizationAnalyticsApi } from "./resources/SdPlatformOrganizationAnalyticsApi";
26
- import { SdPlatformOpenIDProviderApi } from './resources/SdPlatformOpenIDProviderApi';
27
- import { SdPlatformApiClientsApi } from "./resources/SdPlatformApiClientsApi";
28
- export declare class SdPlatformSdk {
29
- private __config;
30
- private __api;
31
- private __authorization;
32
- private __apiClients;
33
- private __api_tokens;
34
- private __backendSystem;
35
- private __bookmarks;
36
- private __chargebee;
37
- private __documents;
38
- private __domains;
39
- private __http_logs;
40
- private __images;
41
- private __model_sharing;
42
- private __models;
43
- private __modelTokens;
44
- private __modelTransfers;
45
- private __notifications;
46
- private __openidProviders;
47
- private __organizations;
48
- private __policies;
49
- private __savedStates;
50
- private __savedStateSharing;
51
- private __tags;
52
- private __userAnalytics;
53
- private __organizationAnalytics;
54
- private __users;
55
- private __webhooks;
56
- /**
57
- * ShapeDiverSDK constructor
58
- * @param clientId - the client id
59
- * @param clientSecret - the client secret
60
- * @param baseUrl - the base url
61
- */
62
- constructor(clientId?: string | null, clientSecret?: string | null, baseUrl?: string | null);
63
- /**
64
- * Configuration for this instance of the Platform SDK.
65
- */
66
- get config(): SdPlatformSdkConfig;
67
- /**
68
- * Authentication service for ShapeDiver Platform.
69
- */
70
- get authorization(): SdPlatformAuthServiceApi;
71
- /**
72
- * CRUD operations for Platform API clients.
73
- */
74
- get apiClients(): SdPlatformApiClientsApi;
75
- /**
76
- * CRUD operations for Platform API tokens.
77
- * Platform API tokens can be limited in scope and lifetime.
78
- * Use Platform API tokens for applications making use of the Platform API.
79
- * Limit their scope as much as possible.
80
- */
81
- get apiTokens(): SdPlatformApiTokenApi;
82
- /**
83
- * Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
84
- */
85
- get backendSystem(): SdPlatformBackendSystemApi;
86
- /**
87
- * Operations for creating and deleting bookmarks
88
- */
89
- get bookmarks(): SdPlatformBookmarkApi;
90
- /**
91
- * Actions related to Chargebee subscription management.
92
- */
93
- get chargebee(): SdPlatformChargebeeApi;
94
- /**
95
- * The documents api actions.
96
- */
97
- get documents(): SdPlatformDocumentApi;
98
- /**
99
- * Operations for domains which can be attached to users, organizations, models.
100
- */
101
- get domains(): SdPlatformDomainApi;
102
- /**
103
- * HTTP logs.
104
- */
105
- get httpLogs(): SdPlatformHttpLogApi;
106
- /**
107
- * Operations for images which can be attached to models
108
- */
109
- get images(): SdPlatformImageApi;
110
- /**
111
- * Operations for model sharing relationships.
112
- */
113
- get modelSharing(): SdPlatformModelSharingApi;
114
- /**
115
- * Operations for models on the ShapeDiver Platform.
116
- */
117
- get models(): SdPlatformModelApi;
118
- /**
119
- * Operations for creating tokens for models on Geometry Backend Systems
120
- */
121
- get modelTokens(): SdPlatformModelTokenApi;
122
- /**
123
- * Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
124
- */
125
- get modelTransfers(): SdPlatformModelTransferApi;
126
- /**
127
- * Operations for querying, reading/unreading, creating notifications.
128
- */
129
- get notifications(): SdPlatformNotificationApi;
130
- /**
131
- * Gets the openid providers.
132
- */
133
- get openidProviders(): SdPlatformOpenIDProviderApi;
134
- /**
135
- * Operations for organizations.
136
- */
137
- get organizations(): SdPlatformOrganizationApi;
138
- /**
139
- * Operations for policies.
140
- */
141
- get policies(): SdPlatformPolicyApi;
142
- /**
143
- * Operations for saved states.
144
- */
145
- get savedStates(): SdPlatformSavedStateApi;
146
- /**
147
- * Operations for saved state sharing relationships.
148
- */
149
- get savedStateSharing(): SdPlatformSavedStateSharingApi;
150
- /**
151
- * Operations for tags which can be attached to models.
152
- */
153
- get tags(): SdPlatformTagApi;
154
- /**
155
- * Analytics for users.
156
- */
157
- get userAnalytics(): SdPlatformUserAnalyticsApi;
158
- /**
159
- * Analytics for organizations.
160
- */
161
- get organizationAnalytics(): SdPlatformOrganizationAnalyticsApi;
162
- /**
163
- * Operations for users.
164
- */
165
- get users(): SdPlatformUserApi;
166
- /**
167
- * Webhook calls.
168
- */
169
- get webhooks(): SdPlatformWebhookApi;
170
- /**
171
- * Register callbacks for request start events.
172
- * onRequestStart is fired before each request. This does not modify request, it is used only as notification that request is starting.
173
- * NOTE: requestParams is as shallow copy.
174
- * @param cb
175
- */
176
- onRequestStart(cb: (event: SdPlatformRequestStartEvent) => void): void;
177
- /**
178
- * Register callbacks for request finished events.
179
- * onRequestFinished is fired after request has been resolved.
180
- * NOTE: response is passed as shallow copy.
181
- * NOTE: requestParams is as shallow copy.
182
- * @param cb
183
- */
184
- onRequestFinished(cb: (event: SdPlatformRequestFinishedEvent) => void): void;
185
- }
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 { SdPlatformDocumentApi } from "./resources/SdPlatformDocumentApi";
9
+ import { SdPlatformDomainApi } from "./resources/SdPlatformDomainApi";
10
+ import { SdPlatformHttpLogApi } from './resources/SdPlatformHttpLogApi';
11
+ import { SdPlatformImageApi } from "./resources/SdPlatformImageApi";
12
+ import { SdPlatformModelApi } from "./resources/SdPlatformModelApi";
13
+ import { SdPlatformModelSharingApi } from "./resources/SdPlatformModelSharingApi";
14
+ import { SdPlatformModelTokenApi } from "./resources/SdPlatformModelTokenApi";
15
+ import { SdPlatformModelTransferApi } from './resources/SdPlatformModelTransferApi';
16
+ import { SdPlatformNotificationApi } from "./resources/SdPlatformNotificationApi";
17
+ import { SdPlatformOrganizationApi } from "./resources/SdPlatformOrganizationApi";
18
+ import { SdPlatformPolicyApi } from "./resources/SdPlatformPolicyApi";
19
+ import { SdPlatformSavedStateApi } from './resources/SdPlatformSavedStateApi';
20
+ import { SdPlatformSavedStateSharingApi } from "./resources/SdPlatformSavedStateSharingApi";
21
+ import { SdPlatformTagApi } from "./resources/SdPlatformTagApi";
22
+ import { SdPlatformUserAnalyticsApi } from "./resources/SdPlatformUserAnalyticsApi";
23
+ import { SdPlatformUserApi } from "./resources/SdPlatformUserApi";
24
+ import { SdPlatformWebhookApi } from './resources/SdPlatformWebhookApi';
25
+ import { SdPlatformOrganizationAnalyticsApi } from "./resources/SdPlatformOrganizationAnalyticsApi";
26
+ import { SdPlatformOpenIDProviderApi } from './resources/SdPlatformOpenIDProviderApi';
27
+ import { SdPlatformApiClientsApi } from "./resources/SdPlatformApiClientsApi";
28
+ export declare class SdPlatformSdk {
29
+ private __config;
30
+ private __api;
31
+ private __authorization;
32
+ private __apiClients;
33
+ private __api_tokens;
34
+ private __backendSystem;
35
+ private __bookmarks;
36
+ private __chargebee;
37
+ private __documents;
38
+ private __domains;
39
+ private __http_logs;
40
+ private __images;
41
+ private __model_sharing;
42
+ private __models;
43
+ private __modelTokens;
44
+ private __modelTransfers;
45
+ private __notifications;
46
+ private __openidProviders;
47
+ private __organizations;
48
+ private __policies;
49
+ private __savedStates;
50
+ private __savedStateSharing;
51
+ private __tags;
52
+ private __userAnalytics;
53
+ private __organizationAnalytics;
54
+ private __users;
55
+ private __webhooks;
56
+ /**
57
+ * ShapeDiverSDK constructor
58
+ * @param clientId - the client id
59
+ * @param clientSecret - the client secret
60
+ * @param baseUrl - the base url
61
+ */
62
+ constructor(clientId?: string | null, clientSecret?: string | null, baseUrl?: string | null);
63
+ /**
64
+ * Configuration for this instance of the Platform SDK.
65
+ */
66
+ get config(): SdPlatformSdkConfig;
67
+ /**
68
+ * Authentication service for ShapeDiver Platform.
69
+ */
70
+ get authorization(): SdPlatformAuthServiceApi;
71
+ /**
72
+ * CRUD operations for Platform API clients.
73
+ */
74
+ get apiClients(): SdPlatformApiClientsApi;
75
+ /**
76
+ * CRUD operations for Platform API tokens.
77
+ * Platform API tokens can be limited in scope and lifetime.
78
+ * Use Platform API tokens for applications making use of the Platform API.
79
+ * Limit their scope as much as possible.
80
+ */
81
+ get apiTokens(): SdPlatformApiTokenApi;
82
+ /**
83
+ * Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
84
+ */
85
+ get backendSystem(): SdPlatformBackendSystemApi;
86
+ /**
87
+ * Operations for creating and deleting bookmarks
88
+ */
89
+ get bookmarks(): SdPlatformBookmarkApi;
90
+ /**
91
+ * Actions related to Chargebee subscription management.
92
+ */
93
+ get chargebee(): SdPlatformChargebeeApi;
94
+ /**
95
+ * The documents api actions.
96
+ */
97
+ get documents(): SdPlatformDocumentApi;
98
+ /**
99
+ * Operations for domains which can be attached to users, organizations, models.
100
+ */
101
+ get domains(): SdPlatformDomainApi;
102
+ /**
103
+ * HTTP logs.
104
+ */
105
+ get httpLogs(): SdPlatformHttpLogApi;
106
+ /**
107
+ * Operations for images which can be attached to models
108
+ */
109
+ get images(): SdPlatformImageApi;
110
+ /**
111
+ * Operations for model sharing relationships.
112
+ */
113
+ get modelSharing(): SdPlatformModelSharingApi;
114
+ /**
115
+ * Operations for models on the ShapeDiver Platform.
116
+ */
117
+ get models(): SdPlatformModelApi;
118
+ /**
119
+ * Operations for creating tokens for models on Geometry Backend Systems
120
+ */
121
+ get modelTokens(): SdPlatformModelTokenApi;
122
+ /**
123
+ * Operations for creating, revoking, accepting, denying, model ownership transfer notifications.
124
+ */
125
+ get modelTransfers(): SdPlatformModelTransferApi;
126
+ /**
127
+ * Operations for querying, reading/unreading, creating notifications.
128
+ */
129
+ get notifications(): SdPlatformNotificationApi;
130
+ /**
131
+ * Gets the openid providers.
132
+ */
133
+ get openidProviders(): SdPlatformOpenIDProviderApi;
134
+ /**
135
+ * Operations for organizations.
136
+ */
137
+ get organizations(): SdPlatformOrganizationApi;
138
+ /**
139
+ * Operations for policies.
140
+ */
141
+ get policies(): SdPlatformPolicyApi;
142
+ /**
143
+ * Operations for saved states.
144
+ */
145
+ get savedStates(): SdPlatformSavedStateApi;
146
+ /**
147
+ * Operations for saved state sharing relationships.
148
+ */
149
+ get savedStateSharing(): SdPlatformSavedStateSharingApi;
150
+ /**
151
+ * Operations for tags which can be attached to models.
152
+ */
153
+ get tags(): SdPlatformTagApi;
154
+ /**
155
+ * Analytics for users.
156
+ */
157
+ get userAnalytics(): SdPlatformUserAnalyticsApi;
158
+ /**
159
+ * Analytics for organizations.
160
+ */
161
+ get organizationAnalytics(): SdPlatformOrganizationAnalyticsApi;
162
+ /**
163
+ * Operations for users.
164
+ */
165
+ get users(): SdPlatformUserApi;
166
+ /**
167
+ * Webhook calls.
168
+ */
169
+ get webhooks(): SdPlatformWebhookApi;
170
+ /**
171
+ * Register callbacks for request start events.
172
+ * onRequestStart is fired before each request. This does not modify request, it is used only as notification that request is starting.
173
+ * NOTE: requestParams is as shallow copy.
174
+ * @param cb
175
+ */
176
+ onRequestStart(cb: (event: SdPlatformRequestStartEvent) => void): void;
177
+ /**
178
+ * Register callbacks for request finished events.
179
+ * onRequestFinished is fired after request has been resolved.
180
+ * NOTE: response is passed as shallow copy.
181
+ * NOTE: requestParams is as shallow copy.
182
+ * @param cb
183
+ */
184
+ onRequestFinished(cb: (event: SdPlatformRequestFinishedEvent) => void): void;
185
+ }
186
186
  //# sourceMappingURL=SdPlatformSdk.d.ts.map
@@ -1,72 +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
- }
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
72
  //# sourceMappingURL=SdPlatformSdkContext.d.ts.map
@@ -1,8 +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;
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
8
  //# sourceMappingURL=SdPlatformSdkCreate.d.ts.map