@shapediver/sdk.platform-api-sdk-v1 2.14.1 → 2.14.4

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 (66) 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 +197 -191
  5. package/dist/SdPlatformSdk.d.ts.map +1 -1
  6. package/dist/SdPlatformSdkContext.d.ts +71 -71
  7. package/dist/SdPlatformSdkCreate.d.ts +7 -7
  8. package/dist/api/SdPlatformRequestId.d.ts +139 -138
  9. package/dist/api/SdPlatformRequestId.d.ts.map +1 -1
  10. package/dist/api/SdPlatformSdkApi.d.ts +66 -66
  11. package/dist/api/SdPlatformSdkConfig.d.ts +18 -18
  12. package/dist/api/SdPlatformSdkErrorMapping.d.ts +6 -6
  13. package/dist/auth/SdPlatformAuthServiceApi.d.ts +79 -79
  14. package/dist/bundle.js +3978 -3931
  15. package/dist/bundle.node.js +4103 -4033
  16. package/dist/index.d.ts +28 -27
  17. package/dist/index.d.ts.map +1 -1
  18. package/dist/resources/SdPlatformApiClientsApi.d.ts +43 -43
  19. package/dist/resources/SdPlatformApiClientsApi.d.ts.map +1 -1
  20. package/dist/resources/SdPlatformApiTokenApi.d.ts +43 -43
  21. package/dist/resources/SdPlatformApiTokenApi.d.ts.map +1 -1
  22. package/dist/resources/SdPlatformBackendSystemApi.d.ts +43 -43
  23. package/dist/resources/SdPlatformBackendSystemApi.d.ts.map +1 -1
  24. package/dist/resources/SdPlatformBookmarkApi.d.ts +24 -24
  25. package/dist/resources/SdPlatformChargebeeApi.d.ts +43 -43
  26. package/dist/resources/SdPlatformChargebeeApi.d.ts.map +1 -1
  27. package/dist/resources/SdPlatformDocumentApi.d.ts +83 -83
  28. package/dist/resources/SdPlatformDocumentApi.d.ts.map +1 -1
  29. package/dist/resources/SdPlatformDomainApi.d.ts +46 -46
  30. package/dist/resources/SdPlatformDomainApi.d.ts.map +1 -1
  31. package/dist/resources/SdPlatformHttpLogApi.d.ts +16 -16
  32. package/dist/resources/SdPlatformHttpLogApi.d.ts.map +1 -1
  33. package/dist/resources/SdPlatformImageApi.d.ts +44 -44
  34. package/dist/resources/SdPlatformImageApi.d.ts.map +1 -1
  35. package/dist/resources/SdPlatformJobLogApi.d.ts +16 -16
  36. package/dist/resources/SdPlatformJobLogApi.d.ts.map +1 -1
  37. package/dist/resources/SdPlatformModelApi.d.ts +78 -78
  38. package/dist/resources/SdPlatformModelApi.d.ts.map +1 -1
  39. package/dist/resources/SdPlatformModelSharingApi.d.ts +65 -65
  40. package/dist/resources/SdPlatformModelSharingApi.d.ts.map +1 -1
  41. package/dist/resources/SdPlatformModelTokenApi.d.ts +15 -15
  42. package/dist/resources/SdPlatformModelTransferApi.d.ts +47 -47
  43. package/dist/resources/SdPlatformNotificationApi.d.ts +65 -65
  44. package/dist/resources/SdPlatformNotificationApi.d.ts.map +1 -1
  45. package/dist/resources/SdPlatformOpenIDProviderApi.d.ts +41 -41
  46. package/dist/resources/SdPlatformOpenIDProviderApi.d.ts.map +1 -1
  47. package/dist/resources/SdPlatformOrganizationAnalyticsApi.d.ts +15 -15
  48. package/dist/resources/SdPlatformOrganizationApi.d.ts +95 -95
  49. package/dist/resources/SdPlatformOrganizationApi.d.ts.map +1 -1
  50. package/dist/resources/SdPlatformPolicyApi.d.ts +43 -43
  51. package/dist/resources/SdPlatformPolicyApi.d.ts.map +1 -1
  52. package/dist/resources/SdPlatformSavedStateApi.d.ts +51 -51
  53. package/dist/resources/SdPlatformSavedStateApi.d.ts.map +1 -1
  54. package/dist/resources/SdPlatformSavedStateSharingApi.d.ts +66 -66
  55. package/dist/resources/SdPlatformSavedStateSharingApi.d.ts.map +1 -1
  56. package/dist/resources/SdPlatformStargateApi.d.ts +13 -0
  57. package/dist/resources/SdPlatformStargateApi.d.ts.map +1 -0
  58. package/dist/resources/SdPlatformTagApi.d.ts +25 -25
  59. package/dist/resources/SdPlatformTagApi.d.ts.map +1 -1
  60. package/dist/resources/SdPlatformUserAnalyticsApi.d.ts +15 -15
  61. package/dist/resources/SdPlatformUserApi.d.ts +86 -86
  62. package/dist/resources/SdPlatformUserApi.d.ts.map +1 -1
  63. package/dist/resources/SdPlatformWebhookApi.d.ts +52 -52
  64. package/dist/resources/commons/FilterBuilder.d.ts +54 -54
  65. package/dist/resources/commons/ResourcesApi.d.ts +42 -42
  66. package/package.json +14 -12
@@ -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 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
- }
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 type SdPlatformDocumentQueryParameters = SdPlatformQueryParameters<string>;
6
+ export 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
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformDocumentApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDocumentApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,+BAA+B,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACtR,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AAEtF,oBAAY,iCAAiC,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAClF,oBAAY,oCAAoC,GAAG;IAC/C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAA;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKpH;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAOzH;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;MAIE;IACK,IAAI,CAAC,gBAAgB,CAAC,EAAE,oCAAoC,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAK3I;;;;OAIG;IACI,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAKlF;;;;OAIG;IACI,IAAI,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAK9E;;;;MAIE;IACK,cAAc,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM;IAK1D;;;;OAIG;IACI,UAAU,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM;IAKtD;;;;OAIG;IACI,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAInH"}
1
+ {"version":3,"file":"SdPlatformDocumentApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDocumentApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,+BAA+B,EAAE,0BAA0B,EAAE,8BAA8B,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACtR,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAC;AAEtF,MAAM,MAAM,iCAAiC,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;AAClF,MAAM,MAAM,oCAAoC,GAAG;IAC/C;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B,CAAA;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IAEnD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKpH;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,iCAAsC,GAAG,OAAO,CAAC,uBAAuB,CAAC,0BAA0B,CAAC,CAAC;IAOzH;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;MAIE;IACK,IAAI,CAAC,gBAAgB,CAAC,EAAE,oCAAoC,GAAG,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAK3I;;;;OAIG;IACI,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAKlF;;;;OAIG;IACI,IAAI,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAK9E;;;;MAIE;IACK,cAAc,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM;IAK1D;;;;OAIG;IACI,UAAU,CAAC,mBAAmB,EAAE,MAAM,GAAG,MAAM;IAKtD;;;;OAIG;IACI,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,+BAA+B,GAAG,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;CAInH"}
@@ -1,47 +1,47 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformRequestDomainCreate, SdPlatformRequestDomainPatch, SdPlatformResponseDomain, SdPlatformResponseDomainAdmin } 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 SdPlatformDomainGetEmbeddableFields {
5
- Models = "models"
6
- }
7
- export declare enum SdPlatformDomainQueryEmbeddableFields {
8
- ModelsCount = "models_count"
9
- }
10
- export declare type SdPlatformDomainQueryParameters = SdPlatformQueryParameters<SdPlatformDomainQueryEmbeddableFields>;
11
- /**
12
- * Operations for domains which can be attached or users, organizations, models.
13
- */
14
- export declare class SdPlatformDomainApi extends ResourcesApi {
15
- protected get __resourcePath(): string;
16
- /**
17
- * Get a domain by id.
18
- * @param id
19
- * @param embed - array of {@link SdPlatformDomainGetEmbeddableFields}
20
- * @returns - {@link SdPlatformGetResponse} with {@link SdPlatformResponseDomain} as result.
21
- */
22
- get(id: string, embed?: Array<SdPlatformDomainGetEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
23
- /**
24
- * Query domains.
25
- * @param query
26
- * @returns
27
- */
28
- query(query?: SdPlatformDomainQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
29
- /**
30
- * Create a new domain.
31
- * @param body - {@link SdPlatformRequestDomainCreate} as request body.
32
- * @returns - new domain.
33
- */
34
- create(body: SdPlatformRequestDomainCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
35
- /**
36
- * Patch a domain.
37
- * @param id - the id of a domain
38
- * @param body - {@link SdPlatformRequestDomainPatch} as properties to patch.
39
- */
40
- patch(id: string, body: SdPlatformRequestDomainPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseDomainAdmin>>;
41
- /**
42
- * Delete a domain.
43
- * @param id - the id of a domain
44
- */
45
- delete(id: string): Promise<SdPlatformDeleteResponse>;
46
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformRequestDomainCreate, SdPlatformRequestDomainPatch, SdPlatformResponseDomain, SdPlatformResponseDomainAdmin } 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 SdPlatformDomainGetEmbeddableFields {
5
+ Models = "models"
6
+ }
7
+ export declare enum SdPlatformDomainQueryEmbeddableFields {
8
+ ModelsCount = "models_count"
9
+ }
10
+ export type SdPlatformDomainQueryParameters = SdPlatformQueryParameters<SdPlatformDomainQueryEmbeddableFields>;
11
+ /**
12
+ * Operations for domains which can be attached or users, organizations, models.
13
+ */
14
+ export declare class SdPlatformDomainApi extends ResourcesApi {
15
+ protected get __resourcePath(): string;
16
+ /**
17
+ * Get a domain by id.
18
+ * @param id
19
+ * @param embed - array of {@link SdPlatformDomainGetEmbeddableFields}
20
+ * @returns - {@link SdPlatformGetResponse} with {@link SdPlatformResponseDomain} as result.
21
+ */
22
+ get(id: string, embed?: Array<SdPlatformDomainGetEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
23
+ /**
24
+ * Query domains.
25
+ * @param query
26
+ * @returns
27
+ */
28
+ query(query?: SdPlatformDomainQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseDomain | SdPlatformResponseDomainAdmin>>;
29
+ /**
30
+ * Create a new domain.
31
+ * @param body - {@link SdPlatformRequestDomainCreate} as request body.
32
+ * @returns - new domain.
33
+ */
34
+ create(body: SdPlatformRequestDomainCreate): Promise<SdPlatformPostResponse<SdPlatformResponseDomainAdmin>>;
35
+ /**
36
+ * Patch a domain.
37
+ * @param id - the id of a domain
38
+ * @param body - {@link SdPlatformRequestDomainPatch} as properties to patch.
39
+ */
40
+ patch(id: string, body: SdPlatformRequestDomainPatch): Promise<SdPlatformPatchResponse<SdPlatformResponseDomainAdmin>>;
41
+ /**
42
+ * Delete a domain.
43
+ * @param id - the id of a domain
44
+ */
45
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
46
+ }
47
47
  //# sourceMappingURL=SdPlatformDomainApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformDomainApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDomainApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAC3K,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,mCAAmC;IAE3C,MAAM,WAAW;CACpB;AAED,oBAAY,qCAAqC;IAE7C,WAAW,iBAAiB;CAC/B;AAED,oBAAY,+BAA+B,GAAG,yBAAyB,CAAC,qCAAqC,CAAC,CAAC;AAE/G;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,mCAAmC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKxK;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKrJ;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKlH;;;;OAIG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,6BAA6B,CAAC,CAAC;IAK7H;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
1
+ {"version":3,"file":"SdPlatformDomainApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformDomainApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAC,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AAC3K,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAG1M,oBAAY,mCAAmC;IAE3C,MAAM,WAAW;CACpB;AAED,oBAAY,qCAAqC;IAE7C,WAAW,iBAAiB;CAC/B;AAED,MAAM,MAAM,+BAA+B,GAAG,yBAAyB,CAAC,qCAAqC,CAAC,CAAC;AAE/G;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IAEjD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,mCAAmC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKxK;;;;OAIG;IACI,KAAK,CAAC,KAAK,GAAE,+BAAoC,GAAG,OAAO,CAAC,uBAAuB,CAAC,wBAAwB,GAAG,6BAA6B,CAAC,CAAC;IAKrJ;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,6BAA6B,GAAG,OAAO,CAAC,sBAAsB,CAAC,6BAA6B,CAAC,CAAC;IAKlH;;;;OAIG;IACI,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC,6BAA6B,CAAC,CAAC;IAK7H;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
@@ -1,17 +1,17 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformResponseHttpLog } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare type SdPlatformHttpLogQueryParameters = SdPlatformQueryParameters<null>;
5
- /**
6
- * HTTP logs.
7
- */
8
- export declare class SdPlatformHttpLogApi extends ResourcesApi {
9
- protected get __resourcePath(): string;
10
- /**
11
- * Query HTTP logs.
12
- * @param body - the body of a request.
13
- * @returns - http logs.
14
- */
15
- query(body?: SdPlatformHttpLogQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseHttpLog>>;
16
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformResponseHttpLog } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ export type SdPlatformHttpLogQueryParameters = SdPlatformQueryParameters<null>;
5
+ /**
6
+ * HTTP logs.
7
+ */
8
+ export declare class SdPlatformHttpLogApi extends ResourcesApi {
9
+ protected get __resourcePath(): string;
10
+ /**
11
+ * Query HTTP logs.
12
+ * @param body - the body of a request.
13
+ * @returns - http logs.
14
+ */
15
+ query(body?: SdPlatformHttpLogQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseHttpLog>>;
16
+ }
17
17
  //# sourceMappingURL=SdPlatformHttpLogApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformHttpLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformHttpLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,oBAAY,gCAAgC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IAElD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,gCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;CAIzH"}
1
+ {"version":3,"file":"SdPlatformHttpLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformHttpLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,MAAM,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,YAAY;IAElD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,GAAE,gCAAqC,GAAG,OAAO,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,CAAC;CAIzH"}
@@ -1,45 +1,45 @@
1
- import { SdPlatformResponseImage, SdPlatformResponseImageAdmin, SdPlatformResponseImagePublic, SdPlatformRequestImageCreate } from "@shapediver/api.platform-api-dto-v1";
2
- import { ResourcesApi } from "./commons/ResourcesApi";
3
- import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformQueryParameters, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
- /**
5
- * Platform image emedabble fields.
6
- */
7
- export declare enum SdPlatformImageQueryEmbeddableFields {
8
- User = "user",
9
- Models = "models"
10
- }
11
- /**
12
- * Platform query image parameters.
13
- */
14
- export declare type SdPlatformImageQueryParameters = SdPlatformQueryParameters<SdPlatformImageQueryEmbeddableFields>;
15
- /**
16
- * Operations for images which can be attached to models.
17
- */
18
- export declare class SdPlatformImageApi extends ResourcesApi {
19
- protected get __resourcePath(): string;
20
- /**
21
- * Get image by id
22
- * @param id - the id of an image.
23
- * @param embed - array of {@link SdPlatformImageQueryEmbeddableFields} fields to embed.
24
- * @returns image
25
- */
26
- get(id: string, embed?: Array<SdPlatformImageQueryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
27
- /**
28
- * Queries images
29
- * @param body - {@link SdPlatformImageQueryParameters} as body.
30
- *
31
- * @remarks body is optional.
32
- */
33
- query(body?: SdPlatformImageQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
34
- /**
35
- * Create an image
36
- * @param body {@link SdPlatformRequestImageCreate}
37
- */
38
- create(body: SdPlatformRequestImageCreate): Promise<SdPlatformPostResponse<SdPlatformResponseImage>>;
39
- /**
40
- * Delete image by id
41
- * @param id - image id.
42
- */
43
- delete(id: string): Promise<SdPlatformDeleteResponse>;
44
- }
1
+ import { SdPlatformResponseImage, SdPlatformResponseImageAdmin, SdPlatformResponseImagePublic, SdPlatformRequestImageCreate } from "@shapediver/api.platform-api-dto-v1";
2
+ import { ResourcesApi } from "./commons/ResourcesApi";
3
+ import { SdPlatformGetResponse, SdPlatformQueryResponse, SdPlatformQueryParameters, SdPlatformPostResponse, SdPlatformDeleteResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ /**
5
+ * Platform image emedabble fields.
6
+ */
7
+ export declare enum SdPlatformImageQueryEmbeddableFields {
8
+ User = "user",
9
+ Models = "models"
10
+ }
11
+ /**
12
+ * Platform query image parameters.
13
+ */
14
+ export type SdPlatformImageQueryParameters = SdPlatformQueryParameters<SdPlatformImageQueryEmbeddableFields>;
15
+ /**
16
+ * Operations for images which can be attached to models.
17
+ */
18
+ export declare class SdPlatformImageApi extends ResourcesApi {
19
+ protected get __resourcePath(): string;
20
+ /**
21
+ * Get image by id
22
+ * @param id - the id of an image.
23
+ * @param embed - array of {@link SdPlatformImageQueryEmbeddableFields} fields to embed.
24
+ * @returns image
25
+ */
26
+ get(id: string, embed?: Array<SdPlatformImageQueryEmbeddableFields>): Promise<SdPlatformGetResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
27
+ /**
28
+ * Queries images
29
+ * @param body - {@link SdPlatformImageQueryParameters} as body.
30
+ *
31
+ * @remarks body is optional.
32
+ */
33
+ query(body?: SdPlatformImageQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformResponseImageAdmin | SdPlatformResponseImage | SdPlatformResponseImagePublic>>;
34
+ /**
35
+ * Create an image
36
+ * @param body {@link SdPlatformRequestImageCreate}
37
+ */
38
+ create(body: SdPlatformRequestImageCreate): Promise<SdPlatformPostResponse<SdPlatformResponseImage>>;
39
+ /**
40
+ * Delete image by id
41
+ * @param id - image id.
42
+ */
43
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
44
+ }
45
45
  //# sourceMappingURL=SdPlatformImageApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformImageApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformImageApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACzK,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEjL;;GAEG;AACH,oBAAY,oCAAoC;IAE5C,IAAI,SAAS;IACb,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,oCAAoC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKvM;;;;;OAKG;IACI,KAAK,CAAC,IAAI,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKjL;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IAK3G;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
1
+ {"version":3,"file":"SdPlatformImageApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformImageApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAC;AACzK,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAEjL;;GAEG;AACH,oBAAY,oCAAoC;IAE5C,IAAI,SAAS;IACb,MAAM,WAAW;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,oCAAoC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKvM;;;;;OAKG;IACI,KAAK,CAAC,IAAI,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,4BAA4B,GAAG,uBAAuB,GAAG,6BAA6B,CAAC,CAAC;IAKjL;;;OAGG;IACI,MAAM,CAAC,IAAI,EAAE,4BAA4B,GAAG,OAAO,CAAC,sBAAsB,CAAC,uBAAuB,CAAC,CAAC;IAK3G;;;OAGG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAI/D"}
@@ -1,17 +1,17 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformJobLogResponse } from "@shapediver/api.platform-api-dto-v1";
3
- import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
4
- export declare type SdPlatformJobLogQueryParameters = SdPlatformQueryParameters<null>;
5
- /**
6
- * The job logs api.
7
- */
8
- export declare class SdPlatformJobLogApi extends ResourcesApi {
9
- protected get __resourcePath(): string;
10
- /**
11
- * Query HTTP logs.
12
- * @param body - the body of a request.
13
- * @returns - job logs.
14
- */
15
- query(body?: SdPlatformJobLogQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformJobLogResponse>>;
16
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformJobLogResponse } from "@shapediver/api.platform-api-dto-v1";
3
+ import { SdPlatformQueryParameters, SdPlatformQueryResponse } from "@shapediver/api.platform-api-dto-v1";
4
+ export type SdPlatformJobLogQueryParameters = SdPlatformQueryParameters<null>;
5
+ /**
6
+ * The job logs api.
7
+ */
8
+ export declare class SdPlatformJobLogApi extends ResourcesApi {
9
+ protected get __resourcePath(): string;
10
+ /**
11
+ * Query HTTP logs.
12
+ * @param body - the body of a request.
13
+ * @returns - job logs.
14
+ */
15
+ query(body?: SdPlatformJobLogQueryParameters): Promise<SdPlatformQueryResponse<SdPlatformJobLogResponse>>;
16
+ }
17
17
  //# sourceMappingURL=SdPlatformJobLogApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformJobLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformJobLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,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;CAIvH"}
1
+ {"version":3,"file":"SdPlatformJobLogApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformJobLogApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAG,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAA;AAExG,MAAM,MAAM,+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;CAIvH"}
@@ -1,79 +1,79 @@
1
- import { ResourcesApi } from "./commons/ResourcesApi";
2
- import { SdPlatformRequestModelCreate, SdPlatformRequestModelPatch, SdPlatformRequestModelPatchAdmin, SdPlatformResponseModelOwner, SdPlatformResponseModelPublic, SdPlatformResponseDecryptTicketResult, SdPlatformResponseIFrameData } 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 SdPlatformModelQueryEmbeddableFields {
5
- Accessdomains = "accessdomains",
6
- GlobalAccessdomains = "global_accessdomains",
7
- BackendSystem = "backend_system",
8
- Tags = "tags",
9
- User = "user",
10
- Decoration = "decoration",
11
- Bookmark = "bookmark",
12
- Organization = "organization"
13
- }
14
- export declare enum SdPlatformModelGetEmbeddableFields {
15
- Accessdomains = "accessdomains",
16
- GlobalAccessdomains = "global_accessdomains",
17
- BackendSystem = "backend_system",
18
- BackendProperties = "backend_properties",
19
- Tags = "tags",
20
- User = "user",
21
- Decoration = "decoration",
22
- Bookmark = "bookmark",
23
- Ticket = "ticket",
24
- AuthorTicket = "author_ticket",
25
- BackendTicket = "backend_ticket",
26
- Organization = "organization"
27
- }
28
- export declare type SdPlatformModelQueryParameters = SdPlatformQueryParameters<SdPlatformModelQueryEmbeddableFields>;
29
- /**
30
- * Operations for models on the ShapeDiver Platform.
31
- */
32
- export declare class SdPlatformModelApi extends ResourcesApi {
33
- protected get __resourcePath(): string;
34
- /**
35
- * Get model by id, guid, slug, or link_sharing_slug.
36
- * @param id - the model id.
37
- * @param embed array of {@link SdPlatformModelGetEmbeddableFields} embeddable properties.
38
- * @returns get response with a model.
39
- */
40
- get<T = SdPlatformResponseModelPublic>(id: string, embed?: Array<SdPlatformModelGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
41
- /**
42
- * Queries the models.
43
- * @param query {@link SdPlatformModelQueryParameters}
44
- * @returns the {@link SdPlatformQueryResponse} response with one of {@link SdPlatformResponseModelPublic} as result.
45
- */
46
- query<T = SdPlatformResponseModelPublic>(query?: SdPlatformModelQueryParameters): Promise<SdPlatformQueryResponse<T>>;
47
- /**
48
- * Create a model.
49
- * @param body {@link SdPlatformRequestModelCreate} the parameters of a model.
50
- * @returns the {@link SdPlatformPostResponse} response with {@link SdPlatformResponseModelOwner} as result.
51
- */
52
- create<T = SdPlatformResponseModelOwner>(body?: SdPlatformRequestModelCreate): Promise<SdPlatformPostResponse<T>>;
53
- /**
54
- * Patch a model, e.g. to update its status to "done" after successful upload and model checking
55
- * @param id - the model id.
56
- * @param params {@link SdPlatformRequestModelPatch} or {@link SdPlatformRequestModelPatchAdmin} as patch paramaters
57
- * @returns { Promise<SdPlatformPatchResponse<T>> }
58
- */
59
- patch<T = SdPlatformResponseModelOwner>(id: string, params: SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
60
- /**
61
- * Deletes a model.
62
- * @param id - the model id.
63
- * @returns the {@link SdPlatformDeleteResponse} response.
64
- */
65
- delete(id: string): Promise<SdPlatformDeleteResponse>;
66
- /**
67
- * Decrypt a ticket, the calling user must have permission "decrypt_ticket" for the model identified by the ticket.
68
- * @param ticket
69
- * @returns decrypted ticket result {@link SdPlatformResponseDecryptTicketResult}
70
- */
71
- decryptTicket(ticket: string): Promise<SdPlatformPostResponse<SdPlatformResponseDecryptTicketResult>>;
72
- /**
73
- * Post method which is to be used to fetch data necessary for iframe embedding of a model using the ShapeDiver Viewer.
74
- * @param slug - the model slug.
75
- * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseIFrameData} as data.
76
- */
77
- iframeEmbedding(slug: string): Promise<SdPlatformPostResponse<SdPlatformResponseIFrameData>>;
78
- }
1
+ import { ResourcesApi } from "./commons/ResourcesApi";
2
+ import { SdPlatformRequestModelCreate, SdPlatformRequestModelPatch, SdPlatformRequestModelPatchAdmin, SdPlatformResponseModelOwner, SdPlatformResponseModelPublic, SdPlatformResponseDecryptTicketResult, SdPlatformResponseIFrameData } 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 SdPlatformModelQueryEmbeddableFields {
5
+ Accessdomains = "accessdomains",
6
+ GlobalAccessdomains = "global_accessdomains",
7
+ BackendSystem = "backend_system",
8
+ Tags = "tags",
9
+ User = "user",
10
+ Decoration = "decoration",
11
+ Bookmark = "bookmark",
12
+ Organization = "organization"
13
+ }
14
+ export declare enum SdPlatformModelGetEmbeddableFields {
15
+ Accessdomains = "accessdomains",
16
+ GlobalAccessdomains = "global_accessdomains",
17
+ BackendSystem = "backend_system",
18
+ BackendProperties = "backend_properties",
19
+ Tags = "tags",
20
+ User = "user",
21
+ Decoration = "decoration",
22
+ Bookmark = "bookmark",
23
+ Ticket = "ticket",
24
+ AuthorTicket = "author_ticket",
25
+ BackendTicket = "backend_ticket",
26
+ Organization = "organization"
27
+ }
28
+ export type SdPlatformModelQueryParameters = SdPlatformQueryParameters<SdPlatformModelQueryEmbeddableFields>;
29
+ /**
30
+ * Operations for models on the ShapeDiver Platform.
31
+ */
32
+ export declare class SdPlatformModelApi extends ResourcesApi {
33
+ protected get __resourcePath(): string;
34
+ /**
35
+ * Get model by id, guid, slug, or link_sharing_slug.
36
+ * @param id - the model id.
37
+ * @param embed array of {@link SdPlatformModelGetEmbeddableFields} embeddable properties.
38
+ * @returns get response with a model.
39
+ */
40
+ get<T = SdPlatformResponseModelPublic>(id: string, embed?: Array<SdPlatformModelGetEmbeddableFields>): Promise<SdPlatformGetResponse<T>>;
41
+ /**
42
+ * Queries the models.
43
+ * @param query {@link SdPlatformModelQueryParameters}
44
+ * @returns the {@link SdPlatformQueryResponse} response with one of {@link SdPlatformResponseModelPublic} as result.
45
+ */
46
+ query<T = SdPlatformResponseModelPublic>(query?: SdPlatformModelQueryParameters): Promise<SdPlatformQueryResponse<T>>;
47
+ /**
48
+ * Create a model.
49
+ * @param body {@link SdPlatformRequestModelCreate} the parameters of a model.
50
+ * @returns the {@link SdPlatformPostResponse} response with {@link SdPlatformResponseModelOwner} as result.
51
+ */
52
+ create<T = SdPlatformResponseModelOwner>(body?: SdPlatformRequestModelCreate): Promise<SdPlatformPostResponse<T>>;
53
+ /**
54
+ * Patch a model, e.g. to update its status to "done" after successful upload and model checking
55
+ * @param id - the model id.
56
+ * @param params {@link SdPlatformRequestModelPatch} or {@link SdPlatformRequestModelPatchAdmin} as patch paramaters
57
+ * @returns { Promise<SdPlatformPatchResponse<T>> }
58
+ */
59
+ patch<T = SdPlatformResponseModelOwner>(id: string, params: SdPlatformRequestModelPatch | SdPlatformRequestModelPatchAdmin): Promise<SdPlatformPatchResponse<T>>;
60
+ /**
61
+ * Deletes a model.
62
+ * @param id - the model id.
63
+ * @returns the {@link SdPlatformDeleteResponse} response.
64
+ */
65
+ delete(id: string): Promise<SdPlatformDeleteResponse>;
66
+ /**
67
+ * Decrypt a ticket, the calling user must have permission "decrypt_ticket" for the model identified by the ticket.
68
+ * @param ticket
69
+ * @returns decrypted ticket result {@link SdPlatformResponseDecryptTicketResult}
70
+ */
71
+ decryptTicket(ticket: string): Promise<SdPlatformPostResponse<SdPlatformResponseDecryptTicketResult>>;
72
+ /**
73
+ * Post method which is to be used to fetch data necessary for iframe embedding of a model using the ShapeDiver Viewer.
74
+ * @param slug - the model slug.
75
+ * @returns the {@link SdPlatformPostResponse} with {@link SdPlatformResponseIFrameData} as data.
76
+ */
77
+ iframeEmbedding(slug: string): Promise<SdPlatformPostResponse<SdPlatformResponseIFrameData>>;
78
+ }
79
79
  //# sourceMappingURL=SdPlatformModelApi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformModelApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,qCAAqC,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AACnR,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,oCAAoC;IAE5C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,kCAAkC;IAE1C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,iBAAiB,uBAAuB;IACxC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,iBAAiB;CAChC;AAED,oBAAY,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKnJ;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAK5H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKvK;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAO5G;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAStG"}
1
+ {"version":3,"file":"SdPlatformModelApi.d.ts","sourceRoot":"","sources":["../../src/resources/SdPlatformModelApi.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,gCAAgC,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,qCAAqC,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AACnR,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAA;AAE1M,oBAAY,oCAAoC;IAE5C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,YAAY,iBAAiB;CAChC;AAED,oBAAY,kCAAkC;IAE1C,aAAa,kBAAkB;IAC/B,mBAAmB,yBAAyB;IAC5C,aAAa,mBAAmB;IAChC,iBAAiB,uBAAuB;IACxC,IAAI,SAAS;IACb,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,YAAY,iBAAiB;CAChC;AAED,MAAM,MAAM,8BAA8B,GAAG,yBAAyB,CAAC,oCAAoC,CAAC,CAAC;AAE7G;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;IAEhD,SAAS,KAAK,cAAc,IAAI,MAAM,CAGrC;IAED;;;;;OAKG;IACI,GAAG,CAAC,CAAC,GAAG,6BAA6B,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAE,KAAK,CAAC,kCAAkC,CAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAKnJ;;;;OAIG;IACI,KAAK,CAAC,CAAC,GAAG,6BAA6B,EAAE,KAAK,GAAE,8BAAmC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKhI;;;;OAIG;IACI,MAAM,CAAC,CAAC,GAAG,4BAA4B,EAAE,IAAI,GAAE,4BAAiC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAK5H;;;;;OAKG;IACI,KAAK,CAAC,CAAC,GAAG,4BAA4B,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,GAAG,gCAAgC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAKvK;;;;OAIG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAK5D;;;;OAIG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,qCAAqC,CAAC,CAAC;IAO5G;;;;OAIG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,4BAA4B,CAAC,CAAC;CAStG"}