@shapediver/api.platform-api-dto-v1 2.12.9 → 2.12.11

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 (69) hide show
  1. package/dist/commons/SdPlatformApiTokenScopes.d.ts +127 -1
  2. package/dist/commons/SdPlatformApiTokenScopes.d.ts.map +1 -1
  3. package/dist/commons/SdPlatformApiTokenScopes.js +127 -1
  4. package/dist/commons/SdPlatformApiTokenScopes.js.map +1 -1
  5. package/dist/commons/SdPlatformChargebee.d.ts +24 -0
  6. package/dist/commons/SdPlatformChargebee.d.ts.map +1 -1
  7. package/dist/commons/SdPlatformModelCommons.d.ts +9 -0
  8. package/dist/commons/SdPlatformModelCommons.d.ts.map +1 -1
  9. package/dist/commons/SdPlatformModelCommons.js +9 -0
  10. package/dist/commons/SdPlatformModelCommons.js.map +1 -1
  11. package/dist/commons/SdPlatformModelTokenScopes.d.ts +12 -0
  12. package/dist/commons/SdPlatformModelTokenScopes.d.ts.map +1 -1
  13. package/dist/commons/SdPlatformModelTokenScopes.js +12 -0
  14. package/dist/commons/SdPlatformModelTokenScopes.js.map +1 -1
  15. package/dist/commons/SdPlatformNotificationCommons.d.ts +7 -3
  16. package/dist/commons/SdPlatformNotificationCommons.d.ts.map +1 -1
  17. package/dist/commons/SdPlatformNotificationCommons.js +6 -2
  18. package/dist/commons/SdPlatformNotificationCommons.js.map +1 -1
  19. package/dist/commons/SdPlatformPolicyCommons.d.ts +44 -1
  20. package/dist/commons/SdPlatformPolicyCommons.d.ts.map +1 -1
  21. package/dist/commons/SdPlatformPolicyCommons.js +1 -0
  22. package/dist/commons/SdPlatformPolicyCommons.js.map +1 -1
  23. package/dist/commons/SdPlatformUsedCredits.d.ts +3 -0
  24. package/dist/commons/SdPlatformUsedCredits.d.ts.map +1 -1
  25. package/dist/commons/SdPlatformVisibility.d.ts +42 -2
  26. package/dist/commons/SdPlatformVisibility.d.ts.map +1 -1
  27. package/dist/commons/SdPlatformVisibility.js +42 -2
  28. package/dist/commons/SdPlatformVisibility.js.map +1 -1
  29. package/dist/request/SdPlatformAuthRequest.d.ts +24 -0
  30. package/dist/request/SdPlatformAuthRequest.d.ts.map +1 -1
  31. package/dist/request/SdPlatformAuthRequest.js.map +1 -1
  32. package/dist/request/SdPlatformBaseRequestTypes.d.ts +23 -3
  33. package/dist/request/SdPlatformBaseRequestTypes.d.ts.map +1 -1
  34. package/dist/request/SdPlatformBaseRequestTypes.js +6 -0
  35. package/dist/request/SdPlatformBaseRequestTypes.js.map +1 -1
  36. package/dist/request/SdPlatformRequestApiClients.d.ts +48 -0
  37. package/dist/request/SdPlatformRequestApiClients.d.ts.map +1 -1
  38. package/dist/request/SdPlatformRequestModel.d.ts +39 -0
  39. package/dist/request/SdPlatformRequestModel.d.ts.map +1 -1
  40. package/dist/request/SdPlatformRequestModelToken.d.ts +12 -1
  41. package/dist/request/SdPlatformRequestModelToken.d.ts.map +1 -1
  42. package/dist/request/SdPlatformRequestOrganization.d.ts +61 -1
  43. package/dist/request/SdPlatformRequestOrganization.d.ts.map +1 -1
  44. package/dist/request/SdPlatformRequestSavedState.d.ts +45 -0
  45. package/dist/request/SdPlatformRequestSavedState.d.ts.map +1 -1
  46. package/dist/request/SdPlatformRequestUser.d.ts +120 -0
  47. package/dist/request/SdPlatformRequestUser.d.ts.map +1 -1
  48. package/dist/response/SdPlatformAuthResponse.d.ts +4 -1
  49. package/dist/response/SdPlatformAuthResponse.d.ts.map +1 -1
  50. package/dist/response/SdPlatformBaseResponseTypes.d.ts +67 -7
  51. package/dist/response/SdPlatformBaseResponseTypes.d.ts.map +1 -1
  52. package/dist/response/SdPlatformResponseChargebee.d.ts +81 -0
  53. package/dist/response/SdPlatformResponseChargebee.d.ts.map +1 -1
  54. package/dist/response/SdPlatformResponseChargebee.js +20 -1
  55. package/dist/response/SdPlatformResponseChargebee.js.map +1 -1
  56. package/dist/response/SdPlatformResponseFeatures.d.ts +3 -3
  57. package/dist/response/SdPlatformResponseModel.d.ts +3 -0
  58. package/dist/response/SdPlatformResponseModel.d.ts.map +1 -1
  59. package/dist/response/SdPlatformResponseNotification.d.ts +2 -0
  60. package/dist/response/SdPlatformResponseNotification.d.ts.map +1 -1
  61. package/dist/response/SdPlatformResponseOrganization.d.ts +69 -0
  62. package/dist/response/SdPlatformResponseOrganization.d.ts.map +1 -1
  63. package/dist/response/SdPlatformResponseSavedState.d.ts +51 -0
  64. package/dist/response/SdPlatformResponseSavedState.d.ts.map +1 -1
  65. package/dist/response/SdPlatformResponseTag.d.ts +18 -0
  66. package/dist/response/SdPlatformResponseTag.d.ts.map +1 -1
  67. package/dist/response/SdPlatformResponseUser.d.ts +168 -0
  68. package/dist/response/SdPlatformResponseUser.d.ts.map +1 -1
  69. package/package.json +1 -1
@@ -3,30 +3,78 @@ import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibilit
3
3
  * DTO for creating an organization
4
4
  */
5
5
  export interface SdPlatformRequestOrganizationCreate {
6
+ /**
7
+ * Name of the organization, minimum 5 characters.
8
+ */
6
9
  name: string;
7
10
  /**
8
- * avatar image base64 encoded, maximum 1MB
11
+ * Avatar image base64 encoded, maximum 1MB
9
12
  */
10
13
  avatar?: string;
14
+ /**
15
+ * Visibility of the organization.
16
+ */
11
17
  visibility?: SdPlatformOrganizationVisibility;
18
+ /**
19
+ * Should sharing be allowed for organization members?
20
+ */
12
21
  allow_sharing?: boolean;
22
+ /**
23
+ * Should private link sharing be allowed for organization members?
24
+ */
13
25
  allow_link_sharing?: boolean;
26
+ /**
27
+ * Should organization members be allowed to expose their email address?
28
+ */
14
29
  allow_expose_email?: boolean;
30
+ /**
31
+ * Website of organization.
32
+ */
15
33
  website?: string;
34
+ /**
35
+ * Description of organization
36
+ */
16
37
  description?: string;
17
38
  }
18
39
  /**
19
40
  * DTO for patching an organization - organization administrator access level
20
41
  */
21
42
  export interface SdPlatformRequestOrganizationPatchAdministrator {
43
+ /**
44
+ * Visibility of the organization.
45
+ */
22
46
  visibility?: SdPlatformOrganizationVisibility;
47
+ /**
48
+ * Should sharing be allowed for organization members?
49
+ */
23
50
  allow_sharing?: boolean;
51
+ /**
52
+ * Should private link sharing be allowed for organization members?
53
+ */
24
54
  allow_link_sharing?: boolean;
55
+ /**
56
+ * Should organization members be allowed to expose their email address?
57
+ */
25
58
  allow_expose_email?: boolean;
59
+ /**
60
+ * Website of organization.
61
+ */
26
62
  website?: string;
63
+ /**
64
+ * Description of organization
65
+ */
27
66
  description?: string;
67
+ /**
68
+ * List of host names (optionally including port) to set as allowed domains for embedding.
69
+ */
28
70
  accessdomains?: Array<string>;
71
+ /**
72
+ * Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the organization?
73
+ */
29
74
  force_require_token?: boolean;
75
+ /**
76
+ * Should credit consumption be limited once the monthly quota has been reached?
77
+ */
30
78
  limit_credit_consumption?: boolean;
31
79
  /**
32
80
  * updates the default backend system for the organization based on the given backend system alias,
@@ -37,18 +85,30 @@ export interface SdPlatformRequestOrganizationPatchAdministrator {
37
85
  * DTO for patching an organization - organization owner access level
38
86
  */
39
87
  export interface SdPlatformRequestOrganizationPatchOwner extends SdPlatformRequestOrganizationPatchAdministrator {
88
+ /**
89
+ * Name of the organization.
90
+ */
40
91
  name?: string;
41
92
  /**
42
93
  * avatar image base64 encoded, maximum 1MB
43
94
  */
44
95
  avatar?: string;
96
+ /**
97
+ * URL-compatible short name of the organization, minimum 5 characters. Used for links to the organizations's profile on the ShapeDiver Platform.
98
+ */
45
99
  slug?: string;
46
100
  }
47
101
  /**
48
102
  * DTO for patching an organization - admin access level
49
103
  */
50
104
  export interface SdPlatformRequestOrganizationPatchAdmin extends SdPlatformRequestOrganizationPatchOwner {
105
+ /**
106
+ * Id of the geometry backend system of the organization.
107
+ */
51
108
  backend_system_id?: string;
109
+ /**
110
+ * Chargebee customer id of the organization.
111
+ */
52
112
  chargebee_customer_id?: string;
53
113
  }
54
114
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformRequestOrganization.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestOrganization.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAEhD,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,gCAAgC,CAAC;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,+CAA+C;IAE5D,UAAU,CAAC,EAAE,gCAAgC,CAAC;IAC9C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,+CAA+C;IAE5G,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,uCAAuC;IAEpG,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,qCAAqC,GAAG,uCAAuC,GACrF,uCAAuC,GACvC,+CAA+C,CAAC"}
1
+ {"version":3,"file":"SdPlatformRequestOrganization.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestOrganization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AAGnF;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAEhD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,gCAAgC,CAAC;IAC9C;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,+CAA+C;IAE5D;;OAEG;IACH,UAAU,CAAC,EAAE,gCAAgC,CAAC;IAC9C;;UAEM;IACN,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,+CAA+C;IAE5G;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,uCAAwC,SAAQ,uCAAuC;IAEpG;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,oBAAY,qCAAqC,GAAG,uCAAuC,GACrF,uCAAuC,GACvC,+CAA+C,CAAC"}
@@ -3,34 +3,79 @@ import { SdPlatformSavedStateVisibility } from "../commons/SdPlatformVisibility"
3
3
  * The saved state settings.
4
4
  */
5
5
  export interface SdPlatformRequestSavedStateSettings {
6
+ /**
7
+ * The version of settings.
8
+ */
6
9
  version: string;
10
+ /**
11
+ * The Viewer Settings.
12
+ */
7
13
  viewer_settings: any;
8
14
  }
9
15
  /**
10
16
  * DTO for creating a saved state
11
17
  */
12
18
  export interface SdPlatformRequestSavedStateCreate {
19
+ /**
20
+ * Name of the saved state.
21
+ */
13
22
  name: string;
23
+ /**
24
+ * Description of the saved state.
25
+ */
14
26
  description: string;
27
+ /**
28
+ * Id of the model of the saved state.
29
+ */
15
30
  model_id: string;
31
+ /**
32
+ * Id of the image of the saved state.
33
+ */
16
34
  image_id?: string;
35
+ /**
36
+ * The parameter values of the model for this saved state. Map from parameter id to parameter string value.
37
+ */
17
38
  parameters: {
18
39
  [id: string]: string;
19
40
  };
41
+ /**
42
+ * Nominal visibility of the saved state.
43
+ */
20
44
  visibility: SdPlatformSavedStateVisibility;
45
+ /**
46
+ * Settings of the saved state, used to store viewer settings like camera position etc.
47
+ */
21
48
  settings?: SdPlatformRequestSavedStateSettings;
22
49
  }
23
50
  /**
24
51
  * DTO for patching a saved state
25
52
  */
26
53
  export interface SdPlatformRequestSavedStatePatch {
54
+ /**
55
+ * Name of the saved state.
56
+ */
27
57
  name?: string;
58
+ /**
59
+ * Description of the saved state.
60
+ */
28
61
  description?: string;
62
+ /**
63
+ * Id of the image of the saved state.
64
+ */
29
65
  image_id?: string;
66
+ /**
67
+ * The parameter values of the model for this saved state. Map from parameter id to parameter string value.
68
+ */
30
69
  parameters?: {
31
70
  [id: string]: string;
32
71
  };
72
+ /**
73
+ * Nominal visibility of the saved state.
74
+ */
33
75
  visibility?: SdPlatformSavedStateVisibility;
76
+ /**
77
+ * Settings of the saved state, used to store viewer settings like camera position etc.
78
+ */
34
79
  settings?: SdPlatformRequestSavedStateSettings;
35
80
  }
36
81
  //# sourceMappingURL=SdPlatformRequestSavedState.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformRequestSavedState.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestSavedState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAEhD,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,GAAG,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAE9C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACrC,UAAU,EAAE,8BAA8B,CAAC;IAC3C,QAAQ,CAAC,EAAE,mCAAmC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAE7C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACtC,UAAU,CAAC,EAAE,8BAA8B,CAAC;IAC5C,QAAQ,CAAC,EAAE,mCAAmC,CAAC;CAClD"}
1
+ {"version":3,"file":"SdPlatformRequestSavedState.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestSavedState.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAEhD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,eAAe,EAAE,GAAG,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAE9C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,UAAU,EAAE,8BAA8B,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,mCAAmC,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAE7C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,8BAA8B,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,mCAAmC,CAAC;CAClD"}
@@ -4,53 +4,155 @@ import { SdPlatformUserVisibility } from "../commons/SdPlatformVisibility";
4
4
  * DTO for confirming a password reset request
5
5
  */
6
6
  export interface SdPlatformRequestUserPasswordResetConfirm {
7
+ /**
8
+ * The token.
9
+ */
7
10
  token: string;
11
+ /**
12
+ * The password.
13
+ */
8
14
  password?: string;
15
+ /**
16
+ * The password confirmation.
17
+ */
9
18
  password_confirmation?: string;
10
19
  }
11
20
  /**
12
21
  * DTO for registering a new user
13
22
  */
14
23
  export interface SdPlatformRequestUserRegister {
24
+ /**
25
+ * The email.
26
+ */
15
27
  email: string;
28
+ /**
29
+ * The password.
30
+ */
16
31
  password: string;
32
+ /**
33
+ * The password confirmation.
34
+ */
17
35
  password_confirmation: string;
36
+ /**
37
+ * The captcha token.
38
+ */
18
39
  captcha_token: string;
19
40
  }
20
41
  /**
21
42
  * DTO for patching a user
22
43
  */
23
44
  export interface SdPlatformRequestUserPatch {
45
+ /**
46
+ * Username, minimum 5 characters.
47
+ */
24
48
  username?: string;
25
49
  /**
26
50
  * avatar image base64 encoded, maximum 1MB
27
51
  */
28
52
  avatar?: string;
53
+ /**
54
+ * Location of the user.
55
+ */
29
56
  location?: string;
57
+ /**
58
+ * Website of the user.
59
+ */
30
60
  website?: string;
61
+ /**
62
+ * Facebook id of the user.
63
+ */
31
64
  facebook_id?: string;
65
+ /**
66
+ * Instagram id of the user
67
+ */
32
68
  instagram_id?: string;
69
+ /**
70
+ * McNeel id of the user
71
+ */
33
72
  mcneel_id?: string;
73
+ /**
74
+ * LinkedIn id of the user.
75
+ */
34
76
  linkedin_id?: string;
77
+ /**
78
+ * Twitter id of the user.
79
+ */
35
80
  twitter_id?: string;
81
+ /**
82
+ * Bio of the user.
83
+ */
36
84
  bio?: string;
85
+ /**
86
+ * Accessdomains of the user.
87
+ */
37
88
  global_accessdomains?: Array<string>;
89
+ /**
90
+ * Is the user subscribed to the newsletter?
91
+ */
38
92
  newsletter_subscribed?: boolean;
93
+ /**
94
+ * First name of the user.
95
+ */
39
96
  first_name?: string;
97
+ /**
98
+ * Last name of the user
99
+ */
40
100
  last_name?: string;
101
+ /**
102
+ * Country of the user.
103
+ */
41
104
  country?: string;
105
+ /**
106
+ * Company name.
107
+ */
42
108
  company_name?: string;
109
+ /**
110
+ * Primary reason of the user to use ShapeDiver (registration field).
111
+ */
43
112
  using_reason?: string;
113
+ /**
114
+ * User knows ShapeDiver from (registration field).
115
+ */
44
116
  know_source?: string;
117
+ /**
118
+ * Grasshopper know-how of the user (registration field).
119
+ */
45
120
  grasshopper_knowhow?: string;
121
+ /**
122
+ * Industry of the user (registration field).
123
+ */
46
124
  industry?: string;
125
+ /**
126
+ * Should the email address be exposed on the public profile page? Might be influenced by {@link SdPlatformResponseOrganizationMember.expose_email}
127
+ */
47
128
  expose_email?: boolean;
129
+ /**
130
+ * The old password.
131
+ */
48
132
  old_password?: string;
133
+ /**
134
+ * The new password.
135
+ */
49
136
  new_password?: string;
137
+ /**
138
+ * The new password confirmation.
139
+ */
50
140
  new_password_confirmation?: string;
141
+ /**
142
+ * Visibility of the user (may be limited by the visibility of the user's organization).
143
+ */
51
144
  visibility?: SdPlatformUserVisibility;
145
+ /**
146
+ * Should sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_sharing}
147
+ */
52
148
  allow_sharing?: boolean;
149
+ /**
150
+ * Should private link sharing of models be allowed? Might be influenced by {@link SdPlatformResponseOrganizationMember.allow_link_sharing }
151
+ */
53
152
  allow_link_sharing?: boolean;
153
+ /**
154
+ * URL-compatible short name of the user. Used for links to the user's profile on the [ShapeDiver Platform](https://shapediver.com/app/users/{slug}).
155
+ */
54
156
  slug?: string;
55
157
  /**
56
158
  * updates the default backend system for the user, requires permission "update_default_backend_system"
@@ -61,13 +163,31 @@ export interface SdPlatformRequestUserPatch {
61
163
  * requires that the user has access to the backend system
62
164
  */
63
165
  backend_system_alias?: string;
166
+ /**
167
+ * Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the user? Might be influenced by {@link SdPlatformResponseOrganizationMember.force_require_token}
168
+ */
64
169
  force_require_token?: boolean;
170
+ /**
171
+ * Mailing settings of the user.
172
+ */
65
173
  mailing?: {
66
174
  [id: string]: boolean;
67
175
  };
176
+ /**
177
+ * Should credit consumption be limited once the monthly quota has been reached?
178
+ */
68
179
  limit_credit_consumption?: boolean;
180
+ /**
181
+ * Should model transfer requests be accepted without confirmation?
182
+ */
69
183
  transfers_accept_any?: boolean;
184
+ /**
185
+ * When accepting model transfer requests, should existing sharing relationships be removed?
186
+ */
70
187
  transfers_clear_sharing?: boolean;
188
+ /**
189
+ * When accepting model transfer requests, should policies requested by the providing user be shared back?
190
+ */
71
191
  transfers_accept_shareback?: boolean;
72
192
  }
73
193
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformRequestUser.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,yCAAyC;IAEtD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAE1C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAEvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACtC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,OAAO,CAAC,EAAE;QAAE,CAAC,EAAE,EAAC,MAAM,GAAI,OAAO,CAAA;KAAE,CAAC;IACpC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,0BAA0B;IAE/E,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,+BAA+B;IAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,oCAAoC;IACpC,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,gCAAgC,CAAC;CACxD"}
1
+ {"version":3,"file":"SdPlatformRequestUser.d.ts","sourceRoot":"","sources":["../../src/request/SdPlatformRequestUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,yCAAyC;IAEtD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAE1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrC;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,wBAAwB,CAAC;IACnC;;IAEA;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,EAAE,EAAC,MAAM,GAAI,OAAO,CAAA;KAAE,CAAC;IACpC;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,0BAA0B;IAE/E,0CAA0C;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,+BAA+B;IAC/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,oCAAoC;IACpC,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,gCAAgC,CAAC;CACxD"}
@@ -1,5 +1,8 @@
1
1
  /**
2
- * ShapeDiver Platform Authentication API response (OAuth 2.0)
2
+ * Response for
3
+ * password credentials grant request
4
+ * refresh token grant request
5
+ * [see](https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/)
3
6
  */
4
7
  export interface SdPlatformAuthResponse {
5
8
  access_token?: string;
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformAuthResponse.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformAuthResponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IAEnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mCAAmC;IAEhD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAEzC,OAAO,EAAE,OAAO,CAAC;CACpB"}
1
+ {"version":3,"file":"SdPlatformAuthResponse.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformAuthResponse.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IAEnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sBAAsB;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mCAAmC;IAEhD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAEzC,OAAO,EAAE,OAAO,CAAC;CACpB"}
@@ -2,20 +2,50 @@
2
2
  * Common ShapeDiver Platform GET response.
3
3
  */
4
4
  export interface SdPlatformGetResponse<T> {
5
+ /**
6
+ * This property is always true unless a exception is thrown.
7
+ */
5
8
  readonly success: boolean;
9
+ /**
10
+ * Version of the Platform Backend API.
11
+ */
6
12
  readonly version: string;
13
+ /**
14
+ * Data resulting from the get request.
15
+ */
7
16
  readonly data: T;
8
17
  }
9
18
  /**
10
19
  * Common ShapeDiver Platform query response.
11
20
  */
12
21
  export interface SdPlatformQueryResponse<T> {
22
+ /**
23
+ * This property is always true unless a exception is thrown.
24
+ */
13
25
  readonly success: boolean;
26
+ /**
27
+ * Version of the Platform Backend API.
28
+ */
14
29
  readonly version: string;
30
+ /**
31
+ * Data resulting from the query request.
32
+ */
15
33
  readonly data: {
34
+ /**
35
+ * The resulting items.
36
+ */
16
37
  result: Array<T>;
38
+ /**
39
+ * Data for requesting the next page of items.
40
+ */
17
41
  pagination: {
42
+ /**
43
+ * Limit which was used for the query.
44
+ */
18
45
  limit: number;
46
+ /**
47
+ * Offset to use for requesting the next page, null in case there are no more items.
48
+ */
19
49
  next_offset: string;
20
50
  };
21
51
  };
@@ -24,25 +54,55 @@ export interface SdPlatformQueryResponse<T> {
24
54
  * Common ShapeDiver Platform POST response.
25
55
  */
26
56
  export interface SdPlatformPostResponse<T> {
27
- success: boolean;
57
+ /**
58
+ * This property is always true unless a exception is thrown.
59
+ */
60
+ readonly success: boolean;
61
+ /**
62
+ * Version of the Platform Backend API.
63
+ */
28
64
  readonly version: string;
29
- message: string;
30
- data: T;
65
+ /**
66
+ * Error message (short):
67
+ */
68
+ readonly message: string;
69
+ /**
70
+ * Data resulting from the post request.
71
+ */
72
+ readonly data: T;
31
73
  }
32
74
  /**
33
75
  * Common ShapeDiver Platform PATCH response.
34
76
  */
35
77
  export interface SdPlatformPatchResponse<T> {
36
- success: boolean;
78
+ /**
79
+ * This property is always true unless a exception is thrown.
80
+ */
81
+ readonly success: boolean;
82
+ /**
83
+ * Version of the Platform Backend API.
84
+ */
37
85
  readonly version: string;
38
- patched_properties?: Array<string>;
39
- data: T;
86
+ /**
87
+ * Properties which were patched.
88
+ */
89
+ readonly patched_properties?: Array<string>;
90
+ /**
91
+ * Data resulting from the patch request.
92
+ */
93
+ readonly data: T;
40
94
  }
41
95
  /**
42
96
  * Common ShapeDiver Platform DELETE response.
43
97
  */
44
98
  export interface SdPlatformDeleteResponse {
99
+ /**
100
+ * This property is always true unless a exception is thrown.
101
+ */
102
+ readonly success: boolean;
103
+ /**
104
+ * Version of the Platform Backend API.
105
+ */
45
106
  readonly version: string;
46
- success: boolean;
47
107
  }
48
108
  //# sourceMappingURL=SdPlatformBaseResponseTypes.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformBaseResponseTypes.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformBaseResponseTypes.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IAEpC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;CACpB;AAEA;;GAEG;AACJ,MAAM,WAAW,uBAAuB,CAAC,CAAC;IAEtC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE;QACX,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,UAAU,EACV;YACI,KAAK,EAAE,MAAM,CAAC;YACd,WAAW,EAAE,MAAM,CAAC;SACvB,CAAA;KACJ,CAAA;CACJ;AAEA;;GAEG;AACJ,MAAM,WAAW,sBAAsB,CAAC,CAAC;IAErC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,CAAC,CAAC;CACX;AAEA;;GAEG;AACJ,MAAM,WAAW,uBAAuB,CAAC,CAAC;IAEtC,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,EAAE,CAAC,CAAC;CACX;AAEA;;GAEG;AACJ,MAAM,WAAW,wBAAwB;IAErC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;CACpB"}
1
+ {"version":3,"file":"SdPlatformBaseResponseTypes.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformBaseResponseTypes.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IAEpC;;MAEE;IACF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE;QACX;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB;;WAEG;QACH,UAAU,EACV;YACI;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YACd;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;SACvB,CAAA;KACJ,CAAA;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IAErC;;MAEE;IACF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IAErC;;MAEE;IACF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC5B"}
@@ -6,28 +6,109 @@ export declare enum SdPlatformResponseChargebeeCurrencyCode {
6
6
  EUR = "EUR",
7
7
  GBP = "GBP"
8
8
  }
9
+ export declare enum SdPlatformResponseChargebeePeriodUnit {
10
+ /**
11
+ * Charge based on day(s).
12
+ */
13
+ Day = "day",
14
+ /**
15
+ * Charge based on week(s).
16
+ */
17
+ Week = "week",
18
+ /**
19
+ * Charge based on month(s).
20
+ */
21
+ Month = "month",
22
+ /**
23
+ * Charge based on year(s).
24
+ */
25
+ Year = "year"
26
+ }
27
+ /**
28
+ * The [Chargebee Plan](https://apidocs.chargebee.com/docs/api/plans?prod_cat_ver=1#plan_attributes)
29
+ */
9
30
  export interface SdPlatformResponseChargebeePlan {
31
+ /**
32
+ * A unique ID for your system to identify the plan.
33
+ */
10
34
  readonly id: string;
35
+ /**
36
+ * The display name used in web interface for identifying the plan.
37
+ */
11
38
  readonly name: string;
39
+ /**
40
+ * The price of the plan. The unit depends on the type of currency.
41
+ * {@link SdPlatformResponseChargebeeCurrencyCode}
42
+ */
12
43
  readonly price: number;
44
+ /**
45
+ * Description about the plan to show in the hosted pages & customer portal.
46
+ */
13
47
  readonly description: string;
48
+ /**
49
+ * The currency code (ISO 4217 format) of the plan
50
+ */
14
51
  readonly currency_code: SdPlatformResponseChargebeeCurrencyCode;
52
+ /**
53
+ * Display name used in invoice. If it is not configured then name is used in invoice.
54
+ */
15
55
  readonly invoice_name: string;
56
+ /**
57
+ * If true, allow checkout through plan specific hosted page URL for this plan.
58
+ */
16
59
  readonly enabled_in_hosted_pages: boolean;
60
+ /**
61
+ * Is free plan?
62
+ */
17
63
  readonly cf_free_plan?: boolean;
64
+ /**
65
+ * When has or will be active
66
+ */
18
67
  readonly cf_active_from?: string;
68
+ /**
69
+ * Until when is active.
70
+ */
19
71
  readonly cf_active_to?: string;
72
+ /**
73
+ * Defines billing frequency in association with billing period.
74
+ * {@link SdPlatformResponseChargebeePeriodUnit}
75
+ */
20
76
  readonly period: number;
77
+ /**
78
+ * Defines billing frequency in association with billing period.
79
+ */
21
80
  readonly period_unit: string;
81
+ /**
82
+ * The free time window for your customer to try your product+
83
+ */
22
84
  readonly trial_period?: number;
85
+ /**
86
+ * Time unit for the trial period.
87
+ */
23
88
  readonly trial_period_unit?: string;
89
+ /**
90
+ * The features.
91
+ * {@link SdPlatformResponseFeatures}
92
+ */
24
93
  readonly features?: SdPlatformResponseFeatures;
25
94
  }
95
+ /**
96
+ * The configuration for chargebee.
97
+ */
26
98
  export interface SdPlatformResponseChargebeeConfig {
99
+ /**
100
+ * Gets the chargebee side.
101
+ */
27
102
  readonly site: string;
28
103
  }
104
+ /**
105
+ * [Hosted Page](https://apidocs.chargebee.com/docs/api/hosted_pages?prod_cat_ver=1#hosted_page_attributes) response.
106
+ */
29
107
  export interface SdPlatformResponseChargebeeHostedPage extends SdPlatformChargebeeHostedPage {
30
108
  }
109
+ /**
110
+ * [Portal session](https://apidocs.chargebee.com/docs/api/portal_sessions?prod_cat_ver=1#portal_session_attributes) response.
111
+ */
31
112
  export interface SdPlatformResponseChargebeePortalSession extends SdPlatformChargebeePortalSession {
32
113
  }
33
114
  //# sourceMappingURL=SdPlatformResponseChargebee.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"SdPlatformResponseChargebee.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformResponseChargebee.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AACjH,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,oBAAY,uCAAuC;IAE/C,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACd;AAED,MAAM,WAAW,+BAA+B;IAE5C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,uCAAuC,CAAC;IAChE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAC1C,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CAClD;AAED,MAAM,WAAW,iCAAiC;IAE9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,qCAAsC,SAAQ,6BAA6B;CAG3F;AAED,MAAM,WAAW,wCAAyC,SAAQ,gCAAgC;CAGjG"}
1
+ {"version":3,"file":"SdPlatformResponseChargebee.d.ts","sourceRoot":"","sources":["../../src/response/SdPlatformResponseChargebee.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AACjH,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE1E,oBAAY,uCAAuC;IAE/C,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,GAAG,QAAQ;CACd;AAED,oBAAY,qCAAqC;IAE7C;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,KAAK,UAAU;IACf;;OAEG;IACH,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,uCAAuC,CAAC;IAChE;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAC1C;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,0BAA0B,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAE9C;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qCAAsC,SAAQ,6BAA6B;CAG3F;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,gCAAgC;CAGjG"}