@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,42 +1,42 @@
1
- import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestOpenIDProviderCreate, SdPlatformRequestOpenIDProviderPatch, SdPlatformResponseOpenIDProvider } from "@shapediver/api.platform-api-dto-v1";
2
- import { ResourcesApi } from "./commons/ResourcesApi";
3
- export declare enum SdPlatformOpenIDProviderEmbeddableFields {
4
- Organization = "organization"
5
- }
6
- export declare type SdPlatformOpenIDProviderQueryParameters = SdPlatformQueryParameters<SdPlatformOpenIDProviderEmbeddableFields>;
7
- /**
8
- * Operations for OpenID providers.
9
- */
10
- export declare class SdPlatformOpenIDProviderApi extends ResourcesApi {
11
- protected get __resourcePath(): string;
12
- /**
13
- * Get OpenID Provider by id.
14
- * @param id - openid provider id.
15
- * @param embed - embeddable resources.
16
- */
17
- get<T = SdPlatformResponseOpenIDProvider>(id: string, embed?: Array<SdPlatformOpenIDProviderEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
18
- /**
19
- * Query OpenID providers.
20
- * @param body
21
- */
22
- query<T = SdPlatformResponseOpenIDProvider>(body?: SdPlatformOpenIDProviderQueryParameters): Promise<SdPlatformQueryResponse<T>>;
23
- /**
24
- * Create an OpenID provider.
25
- * @param body
26
- * @returns
27
- */
28
- create(body: SdPlatformRequestOpenIDProviderCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOpenIDProvider>>;
29
- /**
30
- * Patch an OpenID provider.
31
- * @param id - id of the OpenID provider
32
- * @param body - properties to patch
33
- */
34
- patch<T = SdPlatformResponseOpenIDProvider>(id: string, body: SdPlatformRequestOpenIDProviderPatch): Promise<SdPlatformPatchResponse<T>>;
35
- /**
36
- * Delete an OpenID provider..
37
- * @param id
38
- * @returns
39
- */
40
- delete(id: string): Promise<SdPlatformDeleteResponse>;
41
- }
1
+ import { SdPlatformDeleteResponse, SdPlatformGetResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformQueryParameters, SdPlatformQueryResponse, SdPlatformRequestOpenIDProviderCreate, SdPlatformRequestOpenIDProviderPatch, SdPlatformResponseOpenIDProvider } from "@shapediver/api.platform-api-dto-v1";
2
+ import { ResourcesApi } from "./commons/ResourcesApi";
3
+ export declare enum SdPlatformOpenIDProviderEmbeddableFields {
4
+ Organization = "organization"
5
+ }
6
+ export declare type SdPlatformOpenIDProviderQueryParameters = SdPlatformQueryParameters<SdPlatformOpenIDProviderEmbeddableFields>;
7
+ /**
8
+ * Operations for OpenID providers.
9
+ */
10
+ export declare class SdPlatformOpenIDProviderApi extends ResourcesApi {
11
+ protected get __resourcePath(): string;
12
+ /**
13
+ * Get OpenID Provider by id.
14
+ * @param id - openid provider id.
15
+ * @param embed - embeddable resources.
16
+ */
17
+ get<T = SdPlatformResponseOpenIDProvider>(id: string, embed?: Array<SdPlatformOpenIDProviderEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
18
+ /**
19
+ * Query OpenID providers.
20
+ * @param body
21
+ */
22
+ query<T = SdPlatformResponseOpenIDProvider>(body?: SdPlatformOpenIDProviderQueryParameters): Promise<SdPlatformQueryResponse<T>>;
23
+ /**
24
+ * Create an OpenID provider.
25
+ * @param body
26
+ * @returns
27
+ */
28
+ create(body: SdPlatformRequestOpenIDProviderCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOpenIDProvider>>;
29
+ /**
30
+ * Patch an OpenID provider.
31
+ * @param id - id of the OpenID provider
32
+ * @param body - properties to patch
33
+ */
34
+ patch<T = SdPlatformResponseOpenIDProvider>(id: string, body: SdPlatformRequestOpenIDProviderPatch): Promise<SdPlatformPatchResponse<T>>;
35
+ /**
36
+ * Delete an OpenID provider..
37
+ * @param id
38
+ * @returns
39
+ */
40
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
41
+ }
42
42
  //# sourceMappingURL=SdPlatformOpenIDProviderApi.d.ts.map
@@ -1,16 +1,16 @@
1
- import { SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
2
- import { ResourcesApi } from "./commons/ResourcesApi";
3
- import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
4
- /**
5
- * Analytics for organizations.
6
- */
7
- export declare class SdPlatformOrganizationAnalyticsApi extends ResourcesApi {
8
- protected get __resourcePath(): string;
9
- /**
10
- * Query session analytics aggregated per user.
11
- * @param body
12
- * @returns
13
- */
14
- query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>>;
15
- }
1
+ import { SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp } from "@shapediver/api.platform-api-dto-v1";
2
+ import { ResourcesApi } from "./commons/ResourcesApi";
3
+ import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ /**
5
+ * Analytics for organizations.
6
+ */
7
+ export declare class SdPlatformOrganizationAnalyticsApi extends ResourcesApi {
8
+ protected get __resourcePath(): string;
9
+ /**
10
+ * Query session analytics aggregated per user.
11
+ * @param { SdPlatformQueryParameters<unknown> } body - the query body.
12
+ * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>> }
13
+ */
14
+ query(body?: SdPlatformQueryParameters<unknown>): Promise<SdPlatformQueryResponse<SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp>>;
15
+ }
16
16
  //# sourceMappingURL=SdPlatformOrganizationAnalyticsApi.d.ts.map
@@ -1,93 +1,93 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformResponseNotification, SdPlatformRequestOrganizationCreate, SdPlatformRequestOrganizationPatchAny, SdPlatformResponseOrganizationPublic, SdPlatformResponseOrganizationOwner, SdPlatformResponseOrganizationAdministrator, SdPlatformOrganizationMemberRole } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare enum SdPlatformOrganizationEmbeddableFields {
5
- AccessDomains = "accessdomains",
6
- BackendSystem = "backend_system",
7
- Members = "members",
8
- ChargebeeCustomer = "chargebee_customer",
9
- ChargebeeSubscription = "chargebee_subscription",
10
- ChargebeePlan = "chargebee_plan",
11
- ChargebeeAddons = "chargebee_addons",
12
- OpenIdProvider = "openid_provider"
13
- }
14
- export declare type SdPlatformOrganizationQueryParameters = SdPlatformQueryParameters<SdPlatformOrganizationEmbeddableFields>;
15
- /**
16
- * Operations for organizations.
17
- */
18
- export declare class SdPlatformOrganizationApi extends ResourcesApi {
19
- protected get __resourcePath(): string;
20
- /**
21
- * Get organization by id.
22
- * @param id - organization id.
23
- * @param embed - embeddable resources.
24
- */
25
- get<T = SdPlatformResponseOrganizationPublic>(id: string, embed?: Array<SdPlatformOrganizationEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
26
- /**
27
- * Query organizations.
28
- * @param body
29
- */
30
- query<T = SdPlatformResponseOrganizationPublic>(body?: SdPlatformOrganizationQueryParameters): Promise<SdPlatformQueryResponse<T>>;
31
- /**
32
- * Create an organization, and make the calling user owner of the organization. Will fail in case the user is member of an organization already.
33
- * @param body
34
- * @returns
35
- */
36
- create(body: SdPlatformRequestOrganizationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOrganizationOwner>>;
37
- /**
38
- * Patch an organization.
39
- * @param id - id of the organization
40
- * @param body - properties to patch
41
- */
42
- patch<T = SdPlatformResponseOrganizationAdministrator>(id: string, body: SdPlatformRequestOrganizationPatchAny): Promise<SdPlatformPatchResponse<T>>;
43
- /**
44
- * Delete an organization.
45
- * @param id
46
- * @returns
47
- */
48
- delete(id: string): Promise<SdPlatformDeleteResponse>;
49
- /**
50
- * Create organization invitation.
51
- * @param organization_id
52
- * @param receiver_id
53
- * @returns
54
- */
55
- createOrganizationInvitation(organization_id: string, receiver_id: string): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
56
- /**
57
- * Delete organization invitation.
58
- * @param organization_id
59
- * @param receiver_id
60
- * @returns
61
- */
62
- deleteOrganizationInvitation(organization_id: string, receiver_id: string): Promise<SdPlatformDeleteResponse>;
63
- /**
64
- * Get organization invitations.
65
- * @param organization_id
66
- * @returns
67
- */
68
- getOrganizationInvitations(organization_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseNotification>>>;
69
- /**
70
- * Accept organization invitation.
71
- * @param organization_id
72
- * @returns
73
- */
74
- acceptOrganizationInvitation(organization_id: string): Promise<SdPlatformPostResponse<void>>;
75
- /**
76
- * Deny organization invitation.
77
- * @param organization_id
78
- * @returns
79
- */
80
- denyOrganizationInvitation(organization_id: string): Promise<SdPlatformPostResponse<void>>;
81
- /**
82
- * Patch role of organization member.
83
- * @param email
84
- */
85
- patchMemberRole(organization_id: string, user_id: string, organization_role: SdPlatformOrganizationMemberRole): Promise<SdPlatformPatchResponse<void>>;
86
- /**
87
- * Invite user to organizatio by email.
88
- * @param organization_id
89
- * @param email
90
- */
91
- invitationByEmail(organization_id: string, email: string): Promise<SdPlatformPostResponse<void>>;
92
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformResponseNotification, SdPlatformRequestOrganizationCreate, SdPlatformRequestOrganizationPatchAny, SdPlatformResponseOrganizationPublic, SdPlatformResponseOrganizationOwner, SdPlatformResponseOrganizationAdministrator, SdPlatformOrganizationMemberRole } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ export declare enum SdPlatformOrganizationEmbeddableFields {
5
+ AccessDomains = "accessdomains",
6
+ BackendSystem = "backend_system",
7
+ Members = "members",
8
+ ChargebeeCustomer = "chargebee_customer",
9
+ ChargebeeSubscription = "chargebee_subscription",
10
+ ChargebeePlan = "chargebee_plan",
11
+ ChargebeeAddons = "chargebee_addons",
12
+ OpenIdProvider = "openid_provider"
13
+ }
14
+ export declare type SdPlatformOrganizationQueryParameters = SdPlatformQueryParameters<SdPlatformOrganizationEmbeddableFields>;
15
+ /**
16
+ * Operations for organizations.
17
+ */
18
+ export declare class SdPlatformOrganizationApi extends ResourcesApi {
19
+ protected get __resourcePath(): string;
20
+ /**
21
+ * Get organization by id.
22
+ * @param id - organization id.
23
+ * @param embed - embeddable resources.
24
+ */
25
+ get<T = SdPlatformResponseOrganizationPublic>(id: string, embed?: Array<SdPlatformOrganizationEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
26
+ /**
27
+ * Query organizations.
28
+ * @param body
29
+ */
30
+ query<T = SdPlatformResponseOrganizationPublic>(body?: SdPlatformOrganizationQueryParameters): Promise<SdPlatformQueryResponse<T>>;
31
+ /**
32
+ * Create an organization, and make the calling user owner of the organization. Will fail in case the user is member of an organization already.
33
+ * @param body
34
+ * @returns
35
+ */
36
+ create(body: SdPlatformRequestOrganizationCreate): Promise<SdPlatformPostResponse<SdPlatformResponseOrganizationOwner>>;
37
+ /**
38
+ * Patch an organization.
39
+ * @param id - id of the organization
40
+ * @param body - properties to patch
41
+ */
42
+ patch<T = SdPlatformResponseOrganizationAdministrator>(id: string, body: SdPlatformRequestOrganizationPatchAny): Promise<SdPlatformPatchResponse<T>>;
43
+ /**
44
+ * Delete an organization.
45
+ * @param id
46
+ * @returns
47
+ */
48
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
49
+ /**
50
+ * Create organization invitation.
51
+ * @param organization_id
52
+ * @param receiver_id
53
+ * @returns
54
+ */
55
+ createOrganizationInvitation(organization_id: string, receiver_id: string): Promise<SdPlatformPostResponse<SdPlatformResponseNotification>>;
56
+ /**
57
+ * Delete organization invitation.
58
+ * @param organization_id
59
+ * @param receiver_id
60
+ * @returns
61
+ */
62
+ deleteOrganizationInvitation(organization_id: string, receiver_id: string): Promise<SdPlatformDeleteResponse>;
63
+ /**
64
+ * Get organization invitations.
65
+ * @param organization_id
66
+ * @returns
67
+ */
68
+ getOrganizationInvitations(organization_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseNotification>>>;
69
+ /**
70
+ * Accept organization invitation.
71
+ * @param organization_id
72
+ * @returns
73
+ */
74
+ acceptOrganizationInvitation(organization_id: string): Promise<SdPlatformPostResponse<void>>;
75
+ /**
76
+ * Deny organization invitation.
77
+ * @param organization_id
78
+ * @returns
79
+ */
80
+ denyOrganizationInvitation(organization_id: string): Promise<SdPlatformPostResponse<void>>;
81
+ /**
82
+ * Patch role of organization member.
83
+ * @param email
84
+ */
85
+ patchMemberRole(organization_id: string, user_id: string, organization_role: SdPlatformOrganizationMemberRole): Promise<SdPlatformPatchResponse<void>>;
86
+ /**
87
+ * Invite user to organizatio by email.
88
+ * @param organization_id
89
+ * @param email
90
+ */
91
+ invitationByEmail(organization_id: string, email: string): Promise<SdPlatformPostResponse<void>>;
92
+ }
93
93
  //# sourceMappingURL=SdPlatformOrganizationApi.d.ts.map
@@ -1,18 +1,44 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformResponsePolicy } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformRequestPolicyCreate } from "@shapediver/api.platform-api-dto-v1";
4
- import { SdPlatformRequestPolicyPatch } from "@shapediver/api.platform-api-dto-v1";
5
- import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
6
- export declare type SdPlatformPolicyQueryParameters = SdPlatformQueryParameters<null>;
7
- /**
8
- * Operations for policies.
9
- */
10
- export declare class SdPlatformPolicyApi extends ResourcesApi {
11
- protected get __resourcePath(): string;
12
- query(body?: SdPlatformPolicyQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponsePolicy>>;
13
- get(id: string): Promise<SdPlatformGetResponse<SdPlatformResponsePolicy>>;
14
- create(body: SdPlatformRequestPolicyCreate): Promise<SdPlatformPostResponse<SdPlatformResponsePolicy>>;
15
- patch(id: string, body: SdPlatformRequestPolicyPatch): Promise<SdPlatformPatchResponse<SdPlatformResponsePolicy>>;
16
- delete(id: string): Promise<SdPlatformDeleteResponse>;
17
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformResponsePolicy } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformRequestPolicyCreate } from "@shapediver/api.platform-api-dto-v1";
4
+ import { SdPlatformRequestPolicyPatch } from "@shapediver/api.platform-api-dto-v1";
5
+ import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
6
+ export declare type SdPlatformPolicyQueryParameters = SdPlatformQueryParameters<null>;
7
+ /**
8
+ * Operations for policies.
9
+ */
10
+ export declare class SdPlatformPolicyApi extends ResourcesApi {
11
+ protected get __resourcePath(): string;
12
+ /**
13
+ * The platform policy api.
14
+ * @param { SdPlatformPolicyQueryParameters } body - the query body.
15
+ * @returns { Promise<SdPlatformQueryResponse<SdPlatformResponsePolicy>> }
16
+ */
17
+ query(body?: SdPlatformPolicyQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponsePolicy>>;
18
+ /**
19
+ * Get information about a policy based on its id or alias
20
+ * @param { string } id_or_alias - id or an alias.
21
+ * @returns { Promise<SdPlatformGetResponse<SdPlatformResponsePolicy>>}
22
+ */
23
+ get(id_or_alias: string): Promise<SdPlatformGetResponse<SdPlatformResponsePolicy>>;
24
+ /**
25
+ * Creates a platform policy.
26
+ * @param { SdPlatformRequestPolicyCreate } body
27
+ * @returns { Promise<SdPlatformPostResponse<SdPlatformResponsePolicy>> }
28
+ */
29
+ create(body: SdPlatformRequestPolicyCreate): Promise<SdPlatformPostResponse<SdPlatformResponsePolicy>>;
30
+ /**
31
+ * Updates a platform policy.
32
+ * @param { string } id - the policy id.
33
+ * @param { SdPlatformRequestPolicyPatch} body - the body of patch request.
34
+ * @returns { Promise<SdPlatformPatchResponse<SdPlatformResponsePolicy>> }
35
+ */
36
+ patch(id: string, body: SdPlatformRequestPolicyPatch): Promise<SdPlatformPatchResponse<SdPlatformResponsePolicy>>;
37
+ /**
38
+ * Deletes the policy
39
+ * @param { string } id - the policy id.
40
+ * @returns { Promise<SdPlatformDeleteResponse> }
41
+ */
42
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
43
+ }
18
44
  //# sourceMappingURL=SdPlatformPolicyApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformPolicyApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformPolicyApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC9E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,+BAA+B,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE9E;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAEM,KAAK,CAAC,IAAI,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;IAK7G,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;IAKzE,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;IAKtG,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;IAKjH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
1
+ {"version":3,"file":"SdPlatformPolicyApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformPolicyApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAC9E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,+BAA+B,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE9E;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;IAKpH;;;;OAIG;IACI,GAAG,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;IAKzF;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,wBAAwB,CAAC,CAAC;IAK7G;;;;;OAKG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,CAAC;IAKxH;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
@@ -1,51 +1,52 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformResponseSavedStatePublic, SdPlatformRequestSavedStateCreate, SdPlatformRequestSavedStatePatch, SdPlatformResponseSavedStateOwner } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare enum SdPlatformSavedStateQueryEmbeddableFields {
5
- Model = "model",
6
- Owner = "owner",
7
- Image = "image"
8
- }
9
- export declare enum SdPlatformSavedStateGetEmbedFields {
10
- Model = "model",
11
- Owner = "owner"
12
- }
13
- export declare type SdPlatformSavedStateApiQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateQueryEmbeddableFields>;
14
- /**
15
- * Operations for saved states.
16
- */
17
- export declare class SdPlatformSavedStateApi extends ResourcesApi {
18
- protected get __resourcePath(): string;
19
- /**
20
- * Gets a saved state by id.
21
- * @param id - saved state id.
22
- * @param embed - embeddable fields.
23
- */
24
- get<T = SdPlatformResponseSavedStatePublic>(id: string, embed?: Array<SdPlatformSavedStateGetEmbedFields>): Promise<SdPlatformGetResponse<T>>;
25
- /**
26
- * Create a new saved state.
27
- * @param body
28
- * @returns
29
- */
30
- create<T = SdPlatformResponseSavedStateOwner>(body: SdPlatformRequestSavedStateCreate): Promise<SdPlatformPostResponse<T>>;
31
- /**
32
- * Patch a saved state.
33
- * @param id
34
- * @param body
35
- * @returns
36
- */
37
- patch<T = SdPlatformResponseSavedStateOwner>(id: string, body: SdPlatformRequestSavedStatePatch): Promise<SdPlatformPatchResponse<T>>;
38
- /**
39
- * Delete a saved state.
40
- * @param id
41
- * @returns
42
- */
43
- delete(id: string): Promise<SdPlatformDeleteResponse>;
44
- /**
45
- * Query saved states.
46
- * @param params
47
- * @returns
48
- */
49
- query<T = SdPlatformResponseSavedStatePublic>(params?: SdPlatformSavedStateApiQueryParameters): Promise<SdPlatformQueryResponse<T>>;
50
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformResponseSavedStatePublic, SdPlatformRequestSavedStateCreate, SdPlatformRequestSavedStatePatch, SdPlatformResponseSavedStateOwner } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPatchResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ export declare enum SdPlatformSavedStateQueryEmbeddableFields {
5
+ Model = "model",
6
+ Owner = "owner",
7
+ Image = "image"
8
+ }
9
+ export declare enum SdPlatformSavedStateGetEmbedFields {
10
+ Model = "model",
11
+ Owner = "owner"
12
+ }
13
+ export declare type SdPlatformSavedStateApiQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateQueryEmbeddableFields>;
14
+ /**
15
+ * Operations for saved states.
16
+ */
17
+ export declare class SdPlatformSavedStateApi extends ResourcesApi {
18
+ protected get __resourcePath(): string;
19
+ /**
20
+ * Gets a saved state by id.
21
+ * @param { string } id - saved state id.
22
+ * @param { Array<SdPlatformSavedStateGetEmbedFields> } embed - embeddable fields.
23
+ * @returns { Promise<SdPlatformGetResponse<T>> }
24
+ */
25
+ get<T = SdPlatformResponseSavedStatePublic>(id: string, embed?: Array<SdPlatformSavedStateGetEmbedFields>): Promise<SdPlatformGetResponse<T>>;
26
+ /**
27
+ * Create a new saved state.
28
+ * @param { SdPlatformRequestSavedStateCreate } body - creates saved state body.
29
+ * @returns { Promise<SdPlatformPostResponse<T>>}
30
+ */
31
+ create<T = SdPlatformResponseSavedStateOwner>(body: SdPlatformRequestSavedStateCreate): Promise<SdPlatformPostResponse<T>>;
32
+ /**
33
+ * Patch a saved state.
34
+ * @param { string } id
35
+ * @param { SdPlatformRequestSavedStatePatch } body - saved state patch body.
36
+ * @returns { Promise<SdPlatformPatchResponse<T>> }
37
+ */
38
+ patch<T = SdPlatformResponseSavedStateOwner>(id: string, body: SdPlatformRequestSavedStatePatch): Promise<SdPlatformPatchResponse<T>>;
39
+ /**
40
+ * Delete a saved state.
41
+ * @param { string } id - the id of a saved state.
42
+ * @returns { Promise<SdPlatformDeleteResponse> }
43
+ */
44
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
45
+ /**
46
+ * Query saved states.
47
+ * @param { SdPlatformSavedStateApiQueryParameters | undefined } params - the query parameters.
48
+ * @returns { Promise<SdPlatformQueryResponse<T>> }
49
+ */
50
+ query<T = SdPlatformResponseSavedStatePublic>(params?: SdPlatformSavedStateApiQueryParameters): Promise<SdPlatformQueryResponse<T>>;
51
+ }
51
52
  //# sourceMappingURL=SdPlatformSavedStateApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformSavedStateApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformSavedStateApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,kCAAkC,EAAE,iCAAiC,EAAE,gCAAgC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAA;AAChM,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,yCAAyC;IAEjD,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAGD,oBAAY,kCAAkC;IAE1C,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAED,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAE1H;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;QAII;IACG,GAAG,CAAC,CAAC,GAAG,kCAAkC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKpJ;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,iCAAiC,EAAE,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAKjI;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,iCAAiC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK5I;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,kCAAkC,EAAE,MAAM,CAAC,EAAE,sCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;CAI7I"}
1
+ {"version":3,"file":"SdPlatformSavedStateApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformSavedStateApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,kCAAkC,EAAE,iCAAiC,EAAE,gCAAgC,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAA;AAChM,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,yCAAyC;IAEjD,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAGD,oBAAY,kCAAkC;IAE1C,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAED,oBAAY,sCAAsC,GAAG,yBAAyB,CAAC,yCAAyC,CAAC,CAAC;AAE1H;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,YAAY;IAErD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;QAKI;IACG,GAAG,CAAC,CAAC,GAAG,kCAAkC,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKpJ;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,iCAAiC,EAAE,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAKjI;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,iCAAiC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAK5I;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,kCAAkC,EAAE,MAAM,CAAC,EAAE,sCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;CAI7I"}
@@ -1,67 +1,67 @@
1
- import { SdPlatformRequestSavedStateSharingCreateMultiple, SdPlatformResponseSavedStateSharing, SdPlatformResponseSavedStateSharingCreate, SdPlatformResponseSavedStateSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
2
- import { ResourcesApi } from "./commons/ResourcesApi";
3
- import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare enum SdPlatformSavedStateSharingQueryEmbeddableFields {
5
- User = "user",
6
- SavedState = "saved_state",
7
- Provider = "provider"
8
- }
9
- export declare type SdPlatformSavedStateSharingQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateSharingQueryEmbeddableFields>;
10
- /**
11
- * Operations for saved state sharing relationships.
12
- */
13
- export declare class SdPlatformSavedStateSharingApi extends ResourcesApi {
14
- protected get __resourcePath(): string;
15
- /**
16
- * Create a saved state sharing relationship
17
- * @param body
18
- * @returns
19
- */
20
- create(body: SdPlatformResponseSavedStateSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseSavedStateSharing>>;
21
- /**
22
- * Create multiple sharings.
23
- * @param { SdPlatformRequestSavedStateSharingCreateMultiple } body
24
- * @returns { Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>> }
25
- */
26
- createMultiple(body: SdPlatformRequestSavedStateSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseSavedStateSharing>>>;
27
- /**
28
- * Delete a saved state.
29
- * @param saved_state_sharing_id Id of the saved state sharing relationship to delete.
30
- * @returns
31
- */
32
- delete(saved_state_sharing_id: string): Promise<SdPlatformDeleteResponse>;
33
- /**
34
- * Get saved state sharing relationships by saved state id and user id.
35
- * @param saved_state_id - saved state id.
36
- * @param user_id - user id.
37
- * @returns
38
- */
39
- getBySavedStateAndUser(saved_state_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharing>>>;
40
- /**
41
- * Query saved state sharing relationships.
42
- * @param params
43
- * @returns
44
- */
45
- query(query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
46
- /**
47
- * Query saved state sharing relationships by saved state id.
48
- * @param saved_state_id
49
- * @param query
50
- * @returns
51
- */
52
- queryBySavedState(saved_state_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
53
- /**
54
- * Query saved state sharing relationships by user id.
55
- * @param user_id
56
- * @param query
57
- * @returns
58
- */
59
- queryByUser(user_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
60
- /**
61
- * Gets the model sharings grouped by user.
62
- * @param saved_state_id
63
- * @returns
64
- */
65
- getGroupedByUser(saved_state_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharingGroupedByUser>>>;
66
- }
1
+ import { SdPlatformRequestSavedStateSharingCreateMultiple, SdPlatformResponseSavedStateSharing, SdPlatformResponseSavedStateSharingCreate, SdPlatformResponseSavedStateSharingGroupedByUser } from "@shapediver/api.platform-api-dto-v1";
2
+ import { ResourcesApi } from "./commons/ResourcesApi";
3
+ import { SdPlatformQueryParameters, SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ export declare enum SdPlatformSavedStateSharingQueryEmbeddableFields {
5
+ User = "user",
6
+ SavedState = "saved_state",
7
+ Provider = "provider"
8
+ }
9
+ export declare type SdPlatformSavedStateSharingQueryParameters = SdPlatformQueryParameters<SdPlatformSavedStateSharingQueryEmbeddableFields>;
10
+ /**
11
+ * Operations for saved state sharing relationships.
12
+ */
13
+ export declare class SdPlatformSavedStateSharingApi extends ResourcesApi {
14
+ protected get __resourcePath(): string;
15
+ /**
16
+ * Create a saved state sharing relationship
17
+ * @param body
18
+ * @returns
19
+ */
20
+ create(body: SdPlatformResponseSavedStateSharingCreate): Promise<SdPlatformPostResponse<SdPlatformResponseSavedStateSharing>>;
21
+ /**
22
+ * Create multiple sharings.
23
+ * @param { SdPlatformRequestSavedStateSharingCreateMultiple } body
24
+ * @returns { Promise<SdPlatformPostResponse<Array<SdPlatformResponseModelSharing>>> }
25
+ */
26
+ createMultiple(body: SdPlatformRequestSavedStateSharingCreateMultiple): Promise<SdPlatformPostResponse<Array<SdPlatformResponseSavedStateSharing>>>;
27
+ /**
28
+ * Delete a saved state.
29
+ * @param saved_state_sharing_id Id of the saved state sharing relationship to delete.
30
+ * @returns
31
+ */
32
+ delete(saved_state_sharing_id: string): Promise<SdPlatformDeleteResponse>;
33
+ /**
34
+ * Get saved state sharing relationships by saved state id and user id.
35
+ * @param saved_state_id - saved state id.
36
+ * @param user_id - user id.
37
+ * @returns
38
+ */
39
+ getBySavedStateAndUser(saved_state_id: string, user_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharing>>>;
40
+ /**
41
+ * Query saved state sharing relationships.
42
+ * @param params
43
+ * @returns
44
+ */
45
+ query(query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
46
+ /**
47
+ * Query saved state sharing relationships by saved state id.
48
+ * @param saved_state_id
49
+ * @param query
50
+ * @returns
51
+ */
52
+ queryBySavedState(saved_state_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
53
+ /**
54
+ * Query saved state sharing relationships by user id.
55
+ * @param user_id
56
+ * @param query
57
+ * @returns
58
+ */
59
+ queryByUser(user_id: string, query?: SdPlatformSavedStateSharingQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseSavedStateSharing>>;
60
+ /**
61
+ * Gets the model sharings grouped by user.
62
+ * @param saved_state_id
63
+ * @returns
64
+ */
65
+ getGroupedByUser(saved_state_id: string): Promise<SdPlatformGetResponse<Array<SdPlatformResponseSavedStateSharingGroupedByUser>>>;
66
+ }
67
67
  //# sourceMappingURL=SdPlatformSavedStateSharingApi.d.ts.map