@shapediver/sdk.platform-api-sdk-v1 2.12.7 → 2.12.9

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 (162) 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 +79 -77
  12. package/dist/auth/SdPlatformAuthServiceApi.d.ts.map +1 -1
  13. package/dist/bundle.js +3570 -3366
  14. package/dist/bundle.node.js +3609 -3381
  15. package/dist/index.d.ts +27 -27
  16. package/dist/resources/SdPlatformApiClientsApi.d.ts +43 -16
  17. package/dist/resources/SdPlatformApiClientsApi.d.ts.map +1 -1
  18. package/dist/resources/SdPlatformApiTokenApi.d.ts +43 -18
  19. package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
  20. package/dist/resources/SdPlatformBackendSystemApi.d.ts +38 -17
  21. package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
  22. package/dist/resources/SdPlatformBookmarkApi.d.ts +24 -16
  23. package/dist/resources/SdPlatformBookmarkApi.d.ts.map +1 -1
  24. package/dist/resources/SdPlatformChargebeeApi.d.ts +43 -20
  25. package/dist/resources/SdPlatformChargebeeApi.d.ts.map +1 -1
  26. package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
  27. package/dist/resources/SdPlatformDomainApi.d.ts +46 -44
  28. package/dist/resources/SdPlatformDomainApi.d.ts.map +1 -1
  29. package/dist/resources/SdPlatformHttpLogApi.d.ts +16 -15
  30. package/dist/resources/SdPlatformHttpLogApi.d.ts.map +1 -1
  31. package/dist/resources/SdPlatformImageApi.d.ts +44 -36
  32. package/dist/resources/SdPlatformImageApi.d.ts.map +1 -1
  33. package/dist/resources/SdPlatformModelApi.d.ts +78 -76
  34. package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
  35. package/dist/resources/SdPlatformModelSharingApi.d.ts +65 -64
  36. package/dist/resources/SdPlatformModelSharingApi.d.ts.map +1 -1
  37. package/dist/resources/SdPlatformModelTokenApi.d.ts +15 -10
  38. package/dist/resources/SdPlatformModelTokenApi.d.ts.map +1 -1
  39. package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -47
  40. package/dist/resources/SdPlatformNotificationApi.d.ts +65 -33
  41. package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -1
  42. package/dist/resources/SdPlatformOpenIDProviderApi.d.ts +41 -41
  43. package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts +15 -15
  44. package/dist/resources/SdPlatformOrganizationApi.d.ts +95 -92
  45. package/dist/resources/SdPlatformOrganizationApi.d.ts.map +1 -1
  46. package/dist/resources/SdPlatformPolicyApi.d.ts +43 -17
  47. package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -1
  48. package/dist/resources/SdPlatformSavedStateApi.d.ts +51 -50
  49. package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -1
  50. package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +66 -66
  51. package/dist/resources/SdPlatformTagApi.d.ts +25 -15
  52. package/dist/resources/SdPlatformTagApi.d.ts.map +1 -1
  53. package/dist/resources/SdPlatformUserAnalyticsApi.d.ts +15 -15
  54. package/dist/resources/SdPlatformUserApi.d.ts +86 -86
  55. package/dist/resources/SdPlatformWebhookApi.d.ts +52 -52
  56. package/dist/resources/commons/FilterBuilder.d.ts +54 -54
  57. package/dist/resources/commons/ResourcesApi.d.ts +42 -42
  58. package/package.json +2 -2
  59. package/dist/ShapeDiverErrors.d.ts +0 -79
  60. package/dist/ShapeDiverErrors.d.ts.map +0 -1
  61. package/dist/ShapeDiverSDK.d.ts +0 -9
  62. package/dist/ShapeDiverSDK.d.ts.map +0 -1
  63. package/dist/ShapeDiverSDKContext.d.ts +0 -47
  64. package/dist/ShapeDiverSDKContext.d.ts.map +0 -1
  65. package/dist/ShapeDiverSDKInstance.d.ts +0 -91
  66. package/dist/ShapeDiverSDKInstance.d.ts.map +0 -1
  67. package/dist/api/RequestId.d.ts +0 -105
  68. package/dist/api/RequestId.d.ts.map +0 -1
  69. package/dist/api/ShapeDiverSDKApi.d.ts +0 -40
  70. package/dist/api/ShapeDiverSDKApi.d.ts.map +0 -1
  71. package/dist/api/ShapeDiverSDKApiErrors.d.ts +0 -7
  72. package/dist/api/ShapeDiverSDKApiErrors.d.ts.map +0 -1
  73. package/dist/api/ShapeDiverSDKConfig.d.ts +0 -7
  74. package/dist/api/ShapeDiverSDKConfig.d.ts.map +0 -1
  75. package/dist/api/ShapeDiverSDKRequestConfig.d.ts +0 -8
  76. package/dist/api/ShapeDiverSDKRequestConfig.d.ts.map +0 -1
  77. package/dist/auth/AuthServiceApi.d.ts +0 -34
  78. package/dist/auth/AuthServiceApi.d.ts.map +0 -1
  79. package/dist/auth/models/AuthRequest.d.ts +0 -13
  80. package/dist/auth/models/AuthRequest.d.ts.map +0 -1
  81. package/dist/auth/models/AuthResponse.d.ts +0 -12
  82. package/dist/auth/models/AuthResponse.d.ts.map +0 -1
  83. package/dist/common/FailedRequestError.d.ts +0 -4
  84. package/dist/common/FailedRequestError.d.ts.map +0 -1
  85. package/dist/common/Filter.d.ts +0 -52
  86. package/dist/common/Filter.d.ts.map +0 -1
  87. package/dist/common/FilterBuilder.d.ts +0 -55
  88. package/dist/common/FilterBuilder.d.ts.map +0 -1
  89. package/dist/common/Parameters.d.ts +0 -29
  90. package/dist/common/Parameters.d.ts.map +0 -1
  91. package/dist/common/QueryRequestParameters.d.ts +0 -46
  92. package/dist/common/QueryRequestParameters.d.ts.map +0 -1
  93. package/dist/common/RequestId.d.ts +0 -106
  94. package/dist/common/RequestId.d.ts.map +0 -1
  95. package/dist/common/ShapeDiverSDKContext.d.ts +0 -32
  96. package/dist/common/ShapeDiverSDKContext.d.ts.map +0 -1
  97. package/dist/config/ShapeDiverSDKConfig.d.ts +0 -7
  98. package/dist/config/ShapeDiverSDKConfig.d.ts.map +0 -1
  99. package/dist/resources/ResourcesApi.d.ts +0 -84
  100. package/dist/resources/ResourcesApi.d.ts.map +0 -1
  101. package/dist/resources/chargebee/ChargebeeApi.d.ts +0 -18
  102. package/dist/resources/chargebee/ChargebeeApi.d.ts.map +0 -1
  103. package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts +0 -45
  104. package/dist/resources/chargebee/models/ChargebeeRequestsAndModels.d.ts.map +0 -1
  105. package/dist/resources/commons/QueryRequestParameters.d.ts +0 -46
  106. package/dist/resources/commons/QueryRequestParameters.d.ts.map +0 -1
  107. package/dist/resources/httplogs/HttpLogApi.d.ts +0 -16
  108. package/dist/resources/httplogs/HttpLogApi.d.ts.map +0 -1
  109. package/dist/resources/httplogs/models.d.ts +0 -15
  110. package/dist/resources/httplogs/models.d.ts.map +0 -1
  111. package/dist/resources/modelSharing/ModelSharingApi.d.ts +0 -50
  112. package/dist/resources/modelSharing/ModelSharingApi.d.ts.map +0 -1
  113. package/dist/resources/modelSharing/models/ModelSharing.d.ts +0 -29
  114. package/dist/resources/modelSharing/models/ModelSharing.d.ts.map +0 -1
  115. package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts +0 -15
  116. package/dist/resources/modelSharing/models/ModelSharingCreate.d.ts.map +0 -1
  117. package/dist/resources/modelTransfers/CreateModelTransferRequest.d.ts +0 -8
  118. package/dist/resources/modelTransfers/CreateModelTransferRequest.d.ts.map +0 -1
  119. package/dist/resources/modelTransfers/ModelTransferApi.d.ts +0 -45
  120. package/dist/resources/modelTransfers/ModelTransferApi.d.ts.map +0 -1
  121. package/dist/resources/models/ModelApi.d.ts +0 -17
  122. package/dist/resources/models/ModelApi.d.ts.map +0 -1
  123. package/dist/resources/models/models/CreateModelTransferRequest.d.ts +0 -8
  124. package/dist/resources/models/models/CreateModelTransferRequest.d.ts.map +0 -1
  125. package/dist/resources/models/models/Model.d.ts +0 -166
  126. package/dist/resources/models/models/Model.d.ts.map +0 -1
  127. package/dist/resources/models/models/ModelCreate.d.ts +0 -21
  128. package/dist/resources/models/models/ModelCreate.d.ts.map +0 -1
  129. package/dist/resources/models/models/ModelPatch.d.ts +0 -25
  130. package/dist/resources/models/models/ModelPatch.d.ts.map +0 -1
  131. package/dist/resources/notifications/NotificationsApi.d.ts +0 -13
  132. package/dist/resources/notifications/NotificationsApi.d.ts.map +0 -1
  133. package/dist/resources/notifications/models/Notification.d.ts +0 -62
  134. package/dist/resources/notifications/models/Notification.d.ts.map +0 -1
  135. package/dist/resources/notifications/models/Requests.d.ts +0 -19
  136. package/dist/resources/notifications/models/Requests.d.ts.map +0 -1
  137. package/dist/resources/organizations/OrganizationsApi.d.ts +0 -73
  138. package/dist/resources/organizations/OrganizationsApi.d.ts.map +0 -1
  139. package/dist/resources/organizations/models/Organization.d.ts +0 -79
  140. package/dist/resources/organizations/models/Organization.d.ts.map +0 -1
  141. package/dist/resources/organizations/models/Requests.d.ts +0 -22
  142. package/dist/resources/organizations/models/Requests.d.ts.map +0 -1
  143. package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts +0 -50
  144. package/dist/resources/savedStateSharing/SavedStateSharingsApi.d.ts.map +0 -1
  145. package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts +0 -15
  146. package/dist/resources/savedStateSharing/models/SavedStateSharingsModels.d.ts.map +0 -1
  147. package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts +0 -6
  148. package/dist/resources/savedStateSharing/models/SavedStatesSharingsRequests.d.ts.map +0 -1
  149. package/dist/resources/savedStates/SavedStatesApi.d.ts +0 -44
  150. package/dist/resources/savedStates/SavedStatesApi.d.ts.map +0 -1
  151. package/dist/resources/savedStates/models/SavedStatesModels.d.ts +0 -33
  152. package/dist/resources/savedStates/models/SavedStatesModels.d.ts.map +0 -1
  153. package/dist/resources/savedStates/models/SavedStatesRequests.d.ts +0 -29
  154. package/dist/resources/savedStates/models/SavedStatesRequests.d.ts.map +0 -1
  155. package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts +0 -15
  156. package/dist/resources/userModelSessions/UserModelSessionsApi.d.ts.map +0 -1
  157. package/dist/resources/userModelSessions/models/UserModelSession.d.ts +0 -54
  158. package/dist/resources/userModelSessions/models/UserModelSession.d.ts.map +0 -1
  159. package/dist/resources/webhooks/WebhooksApi.d.ts +0 -51
  160. package/dist/resources/webhooks/WebhooksApi.d.ts.map +0 -1
  161. package/dist/resources/webhooks/models/Requests.d.ts +0 -17
  162. package/dist/resources/webhooks/models/Requests.d.ts.map +0 -1
package/dist/index.d.ts CHANGED
@@ -1,28 +1,28 @@
1
- export * from "@shapediver/api.platform-api-dto-v1";
2
- export * from "./api/SdPlatformRequestId";
3
- export * from "./auth/SdPlatformAuthServiceApi";
4
- export * from "./resources/SdPlatformApiTokenApi";
5
- export * from "./resources/SdPlatformBackendSystemApi";
6
- export * from "./resources/SdPlatformBookmarkApi";
7
- export * from "./resources/SdPlatformChargebeeApi";
8
- export * from "./resources/SdPlatformDomainApi";
9
- export * from "./resources/SdPlatformHttpLogApi";
10
- export * from "./resources/SdPlatformImageApi";
11
- export * from "./resources/SdPlatformModelApi";
12
- export * from "./resources/SdPlatformModelSharingApi";
13
- export * from "./resources/SdPlatformModelTokenApi";
14
- export * from "./resources/SdPlatformModelTransferApi";
15
- export * from "./resources/SdPlatformNotificationApi";
16
- export * from "./resources/SdPlatformOrganizationApi";
17
- export * from "./resources/SdPlatformPolicyApi";
18
- export * from "./resources/SdPlatformSavedStateApi";
19
- export * from "./resources/SdPlatformSavedStateSharingApi";
20
- export * from "./resources/SdPlatformTagApi";
21
- export * from "./resources/SdPlatformUserAnalyticsApi";
22
- export * from "./resources/SdPlatformUserApi";
23
- export * from "./resources/SdPlatformWebhookApi";
24
- export * from "./SdPlatformSdkContext";
25
- export * from "./SdPlatformErrors";
26
- export * from './SdPlatformSdk';
27
- export * from "./SdPlatformSdkCreate";
1
+ export * from "@shapediver/api.platform-api-dto-v1";
2
+ export * from "./api/SdPlatformRequestId";
3
+ export * from "./auth/SdPlatformAuthServiceApi";
4
+ export * from "./resources/SdPlatformApiTokenApi";
5
+ export * from "./resources/SdPlatformBackendSystemApi";
6
+ export * from "./resources/SdPlatformBookmarkApi";
7
+ export * from "./resources/SdPlatformChargebeeApi";
8
+ export * from "./resources/SdPlatformDomainApi";
9
+ export * from "./resources/SdPlatformHttpLogApi";
10
+ export * from "./resources/SdPlatformImageApi";
11
+ export * from "./resources/SdPlatformModelApi";
12
+ export * from "./resources/SdPlatformModelSharingApi";
13
+ export * from "./resources/SdPlatformModelTokenApi";
14
+ export * from "./resources/SdPlatformModelTransferApi";
15
+ export * from "./resources/SdPlatformNotificationApi";
16
+ export * from "./resources/SdPlatformOrganizationApi";
17
+ export * from "./resources/SdPlatformPolicyApi";
18
+ export * from "./resources/SdPlatformSavedStateApi";
19
+ export * from "./resources/SdPlatformSavedStateSharingApi";
20
+ export * from "./resources/SdPlatformTagApi";
21
+ export * from "./resources/SdPlatformUserAnalyticsApi";
22
+ export * from "./resources/SdPlatformUserApi";
23
+ export * from "./resources/SdPlatformWebhookApi";
24
+ export * from "./SdPlatformSdkContext";
25
+ export * from "./SdPlatformErrors";
26
+ export * from './SdPlatformSdk';
27
+ export * from "./SdPlatformSdkCreate";
28
28
  //# sourceMappingURL=index.d.ts.map
@@ -1,17 +1,44 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformResponseApiClient, SdPlatformRequestApiClientCreate, SdPlatformRequestApiClientPatch } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare enum SdPlatformApiClientsQueryEmbeddableFields {
5
- }
6
- export declare type SdPlatformApiClientsQueryParameters = SdPlatformQueryParameters<SdPlatformApiClientsQueryEmbeddableFields>;
7
- /**
8
- * Operations for models on the ShapeDiver Platform.
9
- */
10
- export declare class SdPlatformApiClientsApi extends ResourcesApi {
11
- protected get __resourcePath(): string;
12
- query(query?: SdPlatformApiClientsQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiClient>>;
13
- create(body: SdPlatformRequestApiClientCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiClient>>;
14
- patch(id: string, body: SdPlatformRequestApiClientPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiClient>>;
15
- delete(id: string): Promise<SdPlatformDeleteResponse>;
16
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformResponseApiClient, SdPlatformRequestApiClientCreate, SdPlatformRequestApiClientPatch } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ /**
5
+ * The embeddable fields for query parameter.
6
+ */
7
+ export declare enum SdPlatformApiClientsQueryEmbeddableFields {
8
+ }
9
+ /**
10
+ * The query parameters for platform api clients.
11
+ */
12
+ export declare type SdPlatformApiClientsQueryParameters = SdPlatformQueryParameters<SdPlatformApiClientsQueryEmbeddableFields>;
13
+ /**
14
+ * API client operations (API clients of the platform backend).
15
+ */
16
+ export declare class SdPlatformApiClientsApi extends ResourcesApi {
17
+ protected get __resourcePath(): string;
18
+ /**
19
+ * Query the api clients.
20
+ * @param query - {@link SdPlatformApiClientsQueryParameters} optional query parameters
21
+ * @returns query result
22
+ */
23
+ query(query?: SdPlatformApiClientsQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiClient>>;
24
+ /**
25
+ * Create a new api client.
26
+ * @param body - {@link SdPlatformRequestApiClientCreate} body or parameters for create request.
27
+ * @returns returns created api client response.
28
+ */
29
+ create(body: SdPlatformRequestApiClientCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiClient>>;
30
+ /**
31
+ * Patch an api client
32
+ * @param id
33
+ * @param body - {@link SdPlatformRequestApiClientPatch} body or patch parameters.
34
+ * @returns patch response.
35
+ */
36
+ patch(id: string, body: SdPlatformRequestApiClientPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiClient>>;
37
+ /**
38
+ * Delete an api client.
39
+ * @param id
40
+ * @returns delete response.
41
+ */
42
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
43
+ }
17
44
  //# sourceMappingURL=SdPlatformApiClientsApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformApiClientsApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiClientsApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAmM,2BAA2B,EAAE,gCAAgC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AACrV,OAAO,EAAE,yBAAyB,EAAyB,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,yCAAyC;CACnD;AAGF,oBAAY,mCAAmC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAEvH;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAIM,KAAK,CAAC,KAAK,GAAE,mCAAwC,GAAG,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAKrH,MAAM,CAAC,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;IAK5G,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAI,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAKxH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAM/D"}
1
+ {"version":3,"file":"SdPlatformApiClientsApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiClientsApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AACpJ,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEnL;;GAEG;AACH,oBAAY,yCAAyC;CACnD;AAGF;;GAEG;AACH,oBAAY,mCAAmC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAEvH;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,mCAAwC,GAAG,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAK5H;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,sBAAsB,CAAC,2BAA2B,CAAC,CAAC;IAKnH;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAI,OAAO,CAAC,uBAAuB,CAAC,2BAA2B,CAAC,CAAC;IAK/H;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAM/D"}
@@ -1,19 +1,44 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformRequestApiTokenCreate, SdPlatformRequestApiTokenPatch, SdPlatformResponseApiToken, SdPlatformResponseApiTokenWithSecret } from "@shapediver/api.platform-api-dto-v1";
4
- export declare type SdPlatformApiTokenQueryParameters = SdPlatformQueryParameters<null>;
5
- /**
6
- * CRUD operations for Platform API tokens.
7
- * Platform API tokens can be limited in scope and lifetime.
8
- * Use Platform API tokens for applications making use of the Platform API.
9
- * Limit their scope as much as possible.
10
- */
11
- export declare class SdPlatformApiTokenApi extends ResourcesApi {
12
- protected get __resourcePath(): string;
13
- get(key_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>>;
14
- query(query?: SdPlatformApiTokenQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>>;
15
- create(body: SdPlatformRequestApiTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>>;
16
- patch(key_id: string, body: SdPlatformRequestApiTokenPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>>;
17
- delete(key_id: string): Promise<SdPlatformDeleteResponse>;
18
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformRequestApiTokenCreate, SdPlatformRequestApiTokenPatch, SdPlatformResponseApiToken, SdPlatformResponseApiTokenWithSecret } from "@shapediver/api.platform-api-dto-v1";
4
+ export declare type SdPlatformApiTokenQueryParameters = SdPlatformQueryParameters<null>;
5
+ /**
6
+ * CRUD operations for Platform API tokens.
7
+ * Platform API tokens can be limited in scope and lifetime.
8
+ * Use Platform API tokens for applications making use of the Platform API.
9
+ * Limit their scope as much as possible.
10
+ */
11
+ export declare class SdPlatformApiTokenApi extends ResourcesApi {
12
+ protected get __resourcePath(): string;
13
+ /**
14
+ * Get the token.
15
+ * @param key_id
16
+ * @returns api token response.
17
+ */
18
+ get(key_id: string): Promise<SdPlatformGetResponse<SdPlatformResponseApiToken>>;
19
+ /**
20
+ * Query the API tokens.
21
+ * @param query - {@link SdPlatformApiTokenQueryParameters} optional query parameters.
22
+ * @returns query response with @see {@link SdPlatformResponseApiToken} as result.
23
+ */
24
+ query(query?: SdPlatformApiTokenQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseApiToken>>;
25
+ /**
26
+ * Create a token.
27
+ * @param body - {@link SdPlatformRequestApiTokenCreate} body or create token parameters.
28
+ * @returns @see {@link SdPlatformResponseApiTokenWithSecret} as result.
29
+ */
30
+ create(body: SdPlatformRequestApiTokenCreate): Promise<SdPlatformPostResponse<SdPlatformResponseApiTokenWithSecret>>;
31
+ /**
32
+ * Update and API token.
33
+ * @param key_id
34
+ * @param @see {@link SdPlatformRequestApiTokenPatch} patch body with parameters.
35
+ * @returns patch response with @see {@link SdPlatformResponseApiToken}
36
+ */
37
+ patch(key_id: string, body: SdPlatformRequestApiTokenPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseApiToken>>;
38
+ /**
39
+ * Delete an API token.
40
+ * @param key_id
41
+ */
42
+ delete(key_id: string): Promise<SdPlatformDeleteResponse>;
43
+ }
19
44
  //# sourceMappingURL=SdPlatformApiTokenApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC/K,OAAO,EAAC,yBAAyB,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,oCAAoC,EAAC,MAAM,qCAAqC,CAAC;AAEjN,oBAAY,iCAAiC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;IAK/E,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKlH,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKpH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKzH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAInE"}
1
+ {"version":3,"file":"SdPlatformApiTokenApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformApiTokenApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC/K,OAAO,EAAC,yBAAyB,EAAE,+BAA+B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,oCAAoC,EAAC,MAAM,qCAAqC,CAAC;AAEjN,oBAAY,iCAAiC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;GAKG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;IAKtF;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKzH;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAK3H;;;;;OAKG;IACI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAKhI;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAInE"}
@@ -1,18 +1,39 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformRequestBackendSystemCreate, SdPlatformRequestBackendSystemPatch, SdPlatformRequestBackendSystemToken, SdPlatformResponseBackendSystem, SdPlatformResponseBackendSystemAdmin, SdPlatformResponseBackendSystemToken } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare type SdPlatformBackendSystemQueryParameters = SdPlatformQueryParameters<string> | undefined;
5
- /**
6
- * Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
7
- */
8
- export declare class SdPlatformBackendSystemApi extends ResourcesApi {
9
- protected get __resourcePath(): string;
10
- query(query?: SdPlatformBackendSystemQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
11
- create(body: SdPlatformRequestBackendSystemCreate): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>>;
12
- patch(id: string, body: SdPlatformRequestBackendSystemPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
13
- /**
14
- * Create a token for accessing a ShapeDiver Geometry Backend System
15
- */
16
- token(body: SdPlatformRequestBackendSystemToken): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>>;
17
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformRequestBackendSystemCreate, SdPlatformRequestBackendSystemPatch, SdPlatformRequestBackendSystemToken, SdPlatformResponseBackendSystem, SdPlatformResponseBackendSystemAdmin, SdPlatformResponseBackendSystemToken } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ /**
5
+ * The query parameters for fetching the @see {@link SdPlatformResponseBackendSystem}
6
+ */
7
+ export declare type SdPlatformBackendSystemQueryParameters = SdPlatformQueryParameters<string> | undefined;
8
+ /**
9
+ * Operations for ShapeDiver Geometry Backend Systems known by the Platform Backend.
10
+ */
11
+ export declare class SdPlatformBackendSystemApi extends ResourcesApi {
12
+ protected get __resourcePath(): string;
13
+ /**
14
+ * Query the backend systems.
15
+ * @param query - {@link SdPlatformBackendSystemQueryParameters} query parameters.
16
+ * @returns - {@link SdPlatformQueryResponse} response with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
17
+ */
18
+ query(query?: SdPlatformBackendSystemQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
19
+ /**
20
+ * Create the backend system.
21
+ * @param body - {@link SdPlatformRequestBackendSystemCreate} body parameters.
22
+ * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemAdmin} as result.
23
+ */
24
+ create(body: SdPlatformRequestBackendSystemCreate): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemAdmin>>;
25
+ /**
26
+ * Updates the backend system.
27
+ * @param id - the backend system id.
28
+ * @param body - {@link SdPlatformRequestBackendSystemPatch} update parameters.
29
+ * @returns - {@link SdPlatformPatchResponse} with {@link SdPlatformResponseBackendSystem} or {@link SdPlatformResponseBackendSystemAdmin} as result.
30
+ */
31
+ patch(id: string, body: SdPlatformRequestBackendSystemPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseBackendSystem | SdPlatformResponseBackendSystemAdmin>>;
32
+ /**
33
+ * Get a token for interacting with a geometry backend system.
34
+ * @param body - {@link SdPlatformRequestBackendSystemToken} body
35
+ * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseBackendSystemToken} as result.
36
+ */
37
+ token(body: SdPlatformRequestBackendSystemToken): Promise<SdPlatformPostResponse<SdPlatformResponseBackendSystemToken>>;
38
+ }
18
39
  //# sourceMappingURL=SdPlatformBackendSystemApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformBackendSystemApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBackendSystemApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,oCAAoC,EAAE,oCAAoC,EAAE,MAAM,qCAAqC,CAAC;AAClR,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAEnG;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAExD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,KAAK,CAAC,KAAK,GAAE,sCAA2C,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAKjK,MAAM,CAAC,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKzH,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAK3K;;OAEG;IACI,KAAK,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;CAIjI"}
1
+ {"version":3,"file":"SdPlatformBackendSystemApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBackendSystemApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,oCAAoC,EAAE,mCAAmC,EAAE,mCAAmC,EAAE,+BAA+B,EAAE,oCAAoC,EAAE,oCAAoC,EAAE,MAAM,qCAAqC,CAAC;AAClR,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAGzJ;;GAEG;AACH,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;AAEnG;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,YAAY;IAExD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,sCAA2C,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAKxK;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAKhI;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,+BAA+B,GAAC,oCAAoC,CAAC,CAAC;IAK3K;;;;OAIG;IACI,KAAK,CAAC,IAAI,EAAE,mCAAmC,GAAG,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;CAIjI"}
@@ -1,17 +1,25 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformRequestBookmarkCreate } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
- /**
5
- * Operations for creating and deleting bookmarks
6
- */
7
- export declare class SdPlatformBookmarkApi extends ResourcesApi {
8
- protected get __resourcePath(): string;
9
- create(body: SdPlatformRequestBookmarkCreate): Promise<SdPlatformPostResponse<void>>;
10
- /**
11
- * Delete bookmark for a model
12
- * @param id Id of the model whose bookmark shall be deleted
13
- * @returns
14
- */
15
- delete(id: string): Promise<SdPlatformDeleteResponse>;
16
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformRequestBookmarkCreate } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ /**
5
+ * Operations for creating and deleting bookmarks
6
+ */
7
+ export declare class SdPlatformBookmarkApi extends ResourcesApi {
8
+ /**
9
+ * The resource path.
10
+ */
11
+ protected get __resourcePath(): string;
12
+ /**
13
+ * Create a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
14
+ * @param body - {@link SdPlatformRequestBookmarkCreate} creae parameters.
15
+ * @returns - {@link SdPlatformPostResponse} with 'success' property being true,
16
+ */
17
+ create(body: SdPlatformRequestBookmarkCreate): Promise<SdPlatformPostResponse<void>>;
18
+ /**
19
+ * Delete a bookmark for the model for the user identified by @see SdPlatformAuthServiceApi
20
+ * @param id - id of the model whose bookmark shall be deleted
21
+ * @returns - {@link SdPlatformDeleteResponse}
22
+ */
23
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
24
+ }
17
25
  //# sourceMappingURL=SdPlatformBookmarkApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformBookmarkApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBookmarkApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGtG;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAK3F;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
1
+ {"version":3,"file":"SdPlatformBookmarkApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformBookmarkApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAGtG;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD;;OAEG;IACH,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;IAK3F;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
@@ -1,21 +1,44 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformRequestChargebeeHostedPage, SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod, SdPlatformRequestChargebeePortalSession, SdPlatformResponseChargebeeConfig } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformResponseChargebeeHostedPage, SdPlatformResponseChargebeePortalSession, SdPlatformResponseChargebeePlan } from "@shapediver/api.platform-api-dto-v1";
4
- import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
5
- export declare type SdPlatformChargebeePlanQueryParameters = SdPlatformQueryParameters<null>;
6
- /**
7
- * Actions related to Chargebee.
8
- */
9
- export declare class SdPlatformChargebeeApi extends ResourcesApi {
10
- protected get __resourcePath(): string;
11
- hostedPage(body: SdPlatformRequestChargebeeHostedPage): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
12
- hostedPageUpdatePaymentMethod(body: SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
13
- portalSession(body: SdPlatformRequestChargebeePortalSession): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePortalSession>>;
14
- queryChargebeePlans(body: SdPlatformChargebeePlanQueryParameters): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePlan>>;
15
- /**
16
- *
17
- * @returns Chargebee configuration
18
- */
19
- config(): Promise<SdPlatformGetResponse<SdPlatformResponseChargebeeConfig>>;
20
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformRequestChargebeeHostedPage, SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod, SdPlatformRequestChargebeePortalSession, SdPlatformResponseChargebeeConfig } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformResponseChargebeeHostedPage, SdPlatformResponseChargebeePortalSession, SdPlatformResponseChargebeePlan } from "@shapediver/api.platform-api-dto-v1";
4
+ import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
5
+ export declare type SdPlatformChargebeePlanQueryParameters = SdPlatformQueryParameters<null>;
6
+ /**
7
+ * Actions related to Chargebee.
8
+ */
9
+ export declare class SdPlatformChargebeeApi extends ResourcesApi {
10
+ protected get __resourcePath(): string;
11
+ /**
12
+ * Get data required to integrate a chargebee with website.
13
+ * @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2} for more.
14
+ * @param body - the parameters of a request.
15
+ * @returns
16
+ */
17
+ hostedPage(body: SdPlatformRequestChargebeeHostedPage): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
18
+ /**
19
+ * Get data required to integrade hosted page payment method with website.
20
+ * @see {@link https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=2#update_payment_method}
21
+ * @param body - the parameters of a request.
22
+ * @returns
23
+ */
24
+ hostedPageUpdatePaymentMethod(body: SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeeHostedPage>>;
25
+ /**
26
+ * Gets all the required data for opening a chargebee portal session.
27
+ * @see - {@link https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=2} for more.
28
+ * @param body - {@link @SdPlatformRequestChargebeePortalSession} body
29
+ * @returns - post response with {@link SdPlatformResponseChargebeePortalSession} data
30
+ */
31
+ portalSession(body: SdPlatformRequestChargebeePortalSession): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePortalSession>>;
32
+ /**
33
+ * Queries the chargebee plans.
34
+ * @param body - {@link SdPlatformChargebeePlanQueryParameters } body
35
+ * @returns - post response with {@link SdPlatformResponseChargebeePlan} data
36
+ */
37
+ queryChargebeePlans(body: SdPlatformChargebeePlanQueryParameters): Promise<SdPlatformPostResponse<SdPlatformResponseChargebeePlan>>;
38
+ /**
39
+ *
40
+ * @returns Chargebee configuration
41
+ */
42
+ config(): Promise<SdPlatformGetResponse<SdPlatformResponseChargebeeConfig>>;
43
+ }
21
44
  //# sourceMappingURL=SdPlatformChargebeeApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformChargebeeApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformChargebeeApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oCAAoC,EAAE,uDAAuD,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAChO,OAAO,EAAE,qCAAqC,EAAE,wCAAwC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACvK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE9H,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAEpD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,UAAU,CAAC,IAAI,EAAE,oCAAoC,GAAI,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAK/H,6BAA6B,CAAC,IAAI,EAAE,uDAAuD,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAKpK,aAAa,CAAC,IAAI,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;IAKvI,mBAAmB,CAAC,IAAI,EAAE,sCAAsC,GAAG,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;IAK1I;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,qBAAqB,CAAC,iCAAiC,CAAC,CAAC;CAIrF"}
1
+ {"version":3,"file":"SdPlatformChargebeeApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformChargebeeApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,oCAAoC,EAAE,uDAAuD,EAAE,uCAAuC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAChO,OAAO,EAAE,qCAAqC,EAAE,wCAAwC,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AACvK,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAA;AAE9H,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,YAAY;IAEpD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,UAAU,CAAC,IAAI,EAAE,oCAAoC,GAAI,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAKtI;;;;;OAKG;IACI,6BAA6B,CAAC,IAAI,EAAE,uDAAuD,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAK3K;;;;;OAKG;IACI,aAAa,CAAC,IAAI,EAAE,uCAAuC,GAAG,OAAO,CAAC,sBAAsB,CAAC,wCAAwC,CAAC,CAAC;IAK9I;;;;OAIG;IACI,mBAAmB,CAAC,IAAI,EAAE,sCAAsC,GAAG,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;IAK1I;;;OAGG;IACI,MAAM,IAAI,OAAO,CAAC,qBAAqB,CAAC,iCAAiC,CAAC,CAAC;CAIrF"}
@@ -1,84 +1,84 @@
1
- import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestDocumentAccept, SdPlatformResponseDocument, SdPlatformResponseDocumentUser, SdPlatformResponseDomainAdmin } from "@shapediver/api.platform-api-dto-v1";
2
- import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
3
- import { ResourcesApi } from "./commons/ResourcesApi";
4
- import { SdPlatformRequestDocumentCreate } from "@shapediver/api.platform-api-dto-v1";
5
- export declare type SdPlatformDocumentQueryParameters = SdPlatformQueryParameters<string>;
6
- export declare type SdPlatformDocumentGetQueryParameters = {
7
- /**
8
- * Type of document, can be a comma separated list.
9
- * For example: 'customer_terms,user_terms,privacy_policy_supplement'
10
- */
11
- type?: string;
12
- /**
13
- * Filter documents which are active (valid_from in the past) or inactive (valid_from in the future), if defined.
14
- */
15
- active?: boolean;
16
- /**
17
- * Filter documents which require acceptance or do not require acceptance, if defined.
18
- */
19
- requires_acceptance?: boolean;
20
- /**
21
- * Filter documents which are relevant to users which are account owners, or users which are not account owners, if defined.
22
- */
23
- account_owner?: boolean;
24
- };
25
- /**
26
- * Actions related to Documents.
27
- */
28
- export declare class SdPlatformDocumentApi extends ResourcesApi {
29
- protected get __resourcePath(): string;
30
- /**
31
- * Create a document.
32
- * @param { SdPlatformRequestDocumentCreate } body
33
- * @returns { Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>> }
34
- */
35
- create(body: SdPlatformRequestDocumentCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
36
- /**
37
- * Query documents.
38
- * @param { SdPlatformDocumentQueryParameters } query
39
- * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseDocument>> }
40
- */
41
- query(query?: SdPlatformDocumentQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDocument>>;
42
- /**
43
- * Delete a document.
44
- * @param { string } id - the id of a document.
45
- */
46
- delete(id: string): Promise<SdPlatformDeleteResponse>;
47
- /**
48
- * Get a list of documents which are relevant to the requesting user.
49
- * @param { SdPlatformDocumentGetQueryParameters | undefined | null } query_parameters
50
- * @returns { Promise<SdPlatformGetResponse<Array<SdPlatformResponseDocumentUser>>> }
51
- */
52
- list(query_parameters?: SdPlatformDocumentGetQueryParameters): Promise<SdPlatformGetResponse<Array<SdPlatformResponseDocumentUser>>>;
53
- /**
54
- * Download a document.
55
- * @param { string } document_id_or_type
56
- * @returns : Promise<SdPlatformGetResponse<void>>
57
- */
58
- download(document_id_or_type: string): Promise<SdPlatformGetResponse<void>>;
59
- /**
60
- * View a document.
61
- * @param { string } document_id_or_type
62
- * @returns : Promise<SdPlatformGetResponse<void>>
63
- */
64
- view(document_id_or_type: string): Promise<SdPlatformGetResponse<void>>;
65
- /**
66
- * Get a download document url.
67
- * @param { string } document_id_or_type
68
- * @returns { string }
69
- */
70
- getDownloadUrl(document_id_or_type: string): string;
71
- /**
72
- * Get a view document url.
73
- * @param { string } document_id_or_type
74
- * @returns { string }
75
- */
76
- getViewUrl(document_id_or_type: string): string;
77
- /**
78
- * Accept a document
79
- * @param { string } document_id
80
- * @param { SdPlatformRequestDocumentAccept } body
81
- */
82
- accept(document_id: string, body: SdPlatformRequestDocumentAccept): Promise<SdPlatformPostResponse<void>>;
83
- }
1
+ import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestDocumentAccept, SdPlatformResponseDocument, SdPlatformResponseDocumentUser, SdPlatformResponseDomainAdmin } from "@shapediver/api.platform-api-dto-v1";
2
+ import { SdPlatformPostResponse } from "@shapediver/api.platform-api-dto-v1";
3
+ import { ResourcesApi } from "./commons/ResourcesApi";
4
+ import { SdPlatformRequestDocumentCreate } from "@shapediver/api.platform-api-dto-v1";
5
+ export declare type SdPlatformDocumentQueryParameters = SdPlatformQueryParameters<string>;
6
+ export declare type SdPlatformDocumentGetQueryParameters = {
7
+ /**
8
+ * Type of document, can be a comma separated list.
9
+ * For example: 'customer_terms,user_terms,privacy_policy_supplement'
10
+ */
11
+ type?: string;
12
+ /**
13
+ * Filter documents which are active (valid_from in the past) or inactive (valid_from in the future), if defined.
14
+ */
15
+ active?: boolean;
16
+ /**
17
+ * Filter documents which require acceptance or do not require acceptance, if defined.
18
+ */
19
+ requires_acceptance?: boolean;
20
+ /**
21
+ * Filter documents which are relevant to users which are account owners, or users which are not account owners, if defined.
22
+ */
23
+ account_owner?: boolean;
24
+ };
25
+ /**
26
+ * Actions related to Documents.
27
+ */
28
+ export declare class SdPlatformDocumentApi extends ResourcesApi {
29
+ protected get __resourcePath(): string;
30
+ /**
31
+ * Create a document.
32
+ * @param body - {@link SdPlatformRequestDocumentCreate } body
33
+ * @returns - {@link SdPlatformPostResponse} with {@link SdPlatformResponseDomainAdmin} data
34
+ */
35
+ create(body: SdPlatformRequestDocumentCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
36
+ /**
37
+ * Query documents.
38
+ * @param query - {@link SdPlatformDocumentQueryParameters} query parameters.
39
+ * @returns - the {@link SdPlatformQueryResponse} query response with array of {@link SdPlatformResponseDocument} as data.
40
+ */
41
+ query(query?: SdPlatformDocumentQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDocument>>;
42
+ /**
43
+ * Delete a document.
44
+ * @param { string } id - the id of a document.
45
+ */
46
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
47
+ /**
48
+ * Get a list of documents which are relevant to the requesting user.
49
+ * @param query_parameters - optional, {@link SdPlatformDocumentGetQueryParameters}
50
+ * @returns { Promise<SdPlatformGetResponse<Array<SdPlatformResponseDocumentUser>>> }
51
+ */
52
+ list(query_parameters?: SdPlatformDocumentGetQueryParameters): Promise<SdPlatformGetResponse<Array<SdPlatformResponseDocumentUser>>>;
53
+ /**
54
+ * Download a document.
55
+ * @param { string } document_id_or_type
56
+ * @returns : Promise<SdPlatformGetResponse<void>>
57
+ */
58
+ download(document_id_or_type: string): Promise<SdPlatformGetResponse<void>>;
59
+ /**
60
+ * View a document.
61
+ * @param { string } document_id_or_type
62
+ * @returns : Promise<SdPlatformGetResponse<void>>
63
+ */
64
+ view(document_id_or_type: string): Promise<SdPlatformGetResponse<void>>;
65
+ /**
66
+ * Get a download document url.
67
+ * @param { string } document_id_or_type
68
+ * @returns { string }
69
+ */
70
+ getDownloadUrl(document_id_or_type: string): string;
71
+ /**
72
+ * Get a view document url.
73
+ * @param { string } document_id_or_type
74
+ * @returns { string }
75
+ */
76
+ getViewUrl(document_id_or_type: string): string;
77
+ /**
78
+ * Accept a document
79
+ * @param { string } document_id
80
+ * @param { SdPlatformRequestDocumentAccept } body
81
+ */
82
+ accept(document_id: string, body: SdPlatformRequestDocumentAccept): Promise<SdPlatformPostResponse<void>>;
83
+ }
84
84
  //# sourceMappingURL=SdPlatformDocumentApi.d.ts.map