@shapediver/api.platform-api-dto-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.
- package/README.md +14 -14
- package/dist/commons/SdPlatformApiTokenScopes.d.ts +47 -47
- package/dist/commons/SdPlatformApiTokenScopes.js +51 -51
- package/dist/commons/SdPlatformChargebee.d.ts +7 -7
- package/dist/commons/SdPlatformChargebee.js +2 -2
- package/dist/commons/SdPlatformModelCommons.d.ts +4 -4
- package/dist/commons/SdPlatformModelCommons.js +8 -8
- package/dist/commons/SdPlatformModelTokenScopes.d.ts +9 -9
- package/dist/commons/SdPlatformModelTokenScopes.js +13 -13
- package/dist/commons/SdPlatformNotificationCommons.d.ts +74 -62
- package/dist/commons/SdPlatformNotificationCommons.d.ts.map +1 -1
- package/dist/commons/SdPlatformNotificationCommons.js +84 -72
- package/dist/commons/SdPlatformNotificationCommons.js.map +1 -1
- package/dist/commons/SdPlatformOrganizationCommons.d.ts +29 -29
- package/dist/commons/SdPlatformOrganizationCommons.js +33 -33
- package/dist/commons/SdPlatformPolicyCommons.d.ts +301 -301
- package/dist/commons/SdPlatformPolicyCommons.js +290 -290
- package/dist/commons/SdPlatformUsedCredits.d.ts +6 -6
- package/dist/commons/SdPlatformUsedCredits.js +2 -2
- package/dist/commons/SdPlatformVisibility.d.ts +36 -36
- package/dist/commons/SdPlatformVisibility.js +43 -43
- package/dist/index.d.ts +54 -54
- package/dist/index.js +70 -70
- package/dist/request/SdPlatformAuthRequest.d.ts +53 -53
- package/dist/request/SdPlatformAuthRequest.js +20 -20
- package/dist/request/SdPlatformBaseRequestTypes.d.ts +45 -45
- package/dist/request/SdPlatformBaseRequestTypes.js +8 -8
- package/dist/request/SdPlatformRequestApiClients.d.ts +20 -20
- package/dist/request/SdPlatformRequestApiClients.js +2 -2
- package/dist/request/SdPlatformRequestApiToken.d.ts +23 -23
- package/dist/request/SdPlatformRequestApiToken.js +2 -2
- package/dist/request/SdPlatformRequestBackendSystem.d.ts +69 -69
- package/dist/request/SdPlatformRequestBackendSystem.js +2 -2
- package/dist/request/SdPlatformRequestBookmark.d.ts +7 -7
- package/dist/request/SdPlatformRequestBookmark.js +2 -2
- package/dist/request/SdPlatformRequestChargebee.d.ts +11 -11
- package/dist/request/SdPlatformRequestChargebee.js +2 -2
- package/dist/request/SdPlatformRequestDocument.d.ts +46 -46
- package/dist/request/SdPlatformRequestDocument.js +2 -2
- package/dist/request/SdPlatformRequestDomain.d.ts +18 -18
- package/dist/request/SdPlatformRequestDomain.js +2 -2
- package/dist/request/SdPlatformRequestImage.d.ts +16 -16
- package/dist/request/SdPlatformRequestImage.js +2 -2
- package/dist/request/SdPlatformRequestModel.d.ts +63 -63
- package/dist/request/SdPlatformRequestModel.js +10 -10
- package/dist/request/SdPlatformRequestModelSharing.d.ts +34 -34
- package/dist/request/SdPlatformRequestModelSharing.js +2 -2
- package/dist/request/SdPlatformRequestModelToken.d.ts +11 -11
- package/dist/request/SdPlatformRequestModelToken.js +2 -2
- package/dist/request/SdPlatformRequestModelTransfer.d.ts +15 -15
- package/dist/request/SdPlatformRequestModelTransfer.js +2 -2
- package/dist/request/SdPlatformRequestNotification.d.ts +40 -38
- package/dist/request/SdPlatformRequestNotification.d.ts.map +1 -1
- package/dist/request/SdPlatformRequestNotification.js +2 -2
- package/dist/request/SdPlatformRequestOpenIDProvider.d.ts +100 -100
- package/dist/request/SdPlatformRequestOpenIDProvider.js +2 -2
- package/dist/request/SdPlatformRequestOrganization.d.ts +57 -57
- package/dist/request/SdPlatformRequestOrganization.js +2 -2
- package/dist/request/SdPlatformRequestPolicy.d.ts +39 -39
- package/dist/request/SdPlatformRequestPolicy.js +2 -2
- package/dist/request/SdPlatformRequestSavedState.d.ts +35 -35
- package/dist/request/SdPlatformRequestSavedState.js +2 -2
- package/dist/request/SdPlatformRequestSavedStateSharing.d.ts +34 -34
- package/dist/request/SdPlatformRequestSavedStateSharing.js +2 -2
- package/dist/request/SdPlatformRequestUser.d.ts +89 -89
- package/dist/request/SdPlatformRequestUser.js +2 -2
- package/dist/request/SdPlatformRequestWebhook.d.ts +39 -39
- package/dist/request/SdPlatformRequestWebhook.js +2 -2
- package/dist/response/SdPlatformAuthResponse.d.ts +17 -17
- package/dist/response/SdPlatformAuthResponse.js +2 -2
- package/dist/response/SdPlatformBaseResponseTypes.d.ts +47 -47
- package/dist/response/SdPlatformBaseResponseTypes.js +2 -2
- package/dist/response/SdPlatformResponseAnalytics.d.ts +173 -173
- package/dist/response/SdPlatformResponseAnalytics.js +11 -11
- package/dist/response/SdPlatformResponseApiClient.d.ts +11 -11
- package/dist/response/SdPlatformResponseApiClient.js +2 -2
- package/dist/response/SdPlatformResponseApiToken.d.ts +24 -24
- package/dist/response/SdPlatformResponseApiToken.js +2 -2
- package/dist/response/SdPlatformResponseBackendSystem.d.ts +53 -53
- package/dist/response/SdPlatformResponseBackendSystem.js +2 -2
- package/dist/response/SdPlatformResponseChargebee.d.ts +32 -32
- package/dist/response/SdPlatformResponseChargebee.js +10 -10
- package/dist/response/SdPlatformResponseDocument.d.ts +112 -112
- package/dist/response/SdPlatformResponseDocument.js +2 -2
- package/dist/response/SdPlatformResponseDomain.d.ts +25 -25
- package/dist/response/SdPlatformResponseDomain.js +2 -2
- package/dist/response/SdPlatformResponseFeatures.d.ts +57 -57
- package/dist/response/SdPlatformResponseFeatures.js +2 -2
- package/dist/response/SdPlatformResponseHttpLog.d.ts +14 -14
- package/dist/response/SdPlatformResponseHttpLog.js +2 -2
- package/dist/response/SdPlatformResponseImage.d.ts +34 -34
- package/dist/response/SdPlatformResponseImage.js +2 -2
- package/dist/response/SdPlatformResponseModel.d.ts +310 -300
- package/dist/response/SdPlatformResponseModel.d.ts.map +1 -1
- package/dist/response/SdPlatformResponseModel.js +53 -53
- package/dist/response/SdPlatformResponseModelSharing.d.ts +62 -62
- package/dist/response/SdPlatformResponseModelSharing.js +2 -2
- package/dist/response/SdPlatformResponseModelToken.d.ts +23 -23
- package/dist/response/SdPlatformResponseModelToken.js +2 -2
- package/dist/response/SdPlatformResponseNotification.d.ts +64 -62
- package/dist/response/SdPlatformResponseNotification.d.ts.map +1 -1
- package/dist/response/SdPlatformResponseNotification.js +2 -2
- package/dist/response/SdPlatformResponseOpenIDProvider.d.ts +70 -70
- package/dist/response/SdPlatformResponseOpenIDProvider.js +2 -2
- package/dist/response/SdPlatformResponseOrganization.d.ts +64 -64
- package/dist/response/SdPlatformResponseOrganization.js +2 -2
- package/dist/response/SdPlatformResponsePolicy.d.ts +57 -57
- package/dist/response/SdPlatformResponsePolicy.js +2 -2
- package/dist/response/SdPlatformResponseSavedState.d.ts +56 -56
- package/dist/response/SdPlatformResponseSavedState.js +2 -2
- package/dist/response/SdPlatformResponseSavedStateSharing.d.ts +62 -62
- package/dist/response/SdPlatformResponseSavedStateSharing.js +2 -2
- package/dist/response/SdPlatformResponseTag.d.ts +16 -16
- package/dist/response/SdPlatformResponseTag.js +2 -2
- package/dist/response/SdPlatformResponseUser.d.ts +132 -132
- package/dist/response/SdPlatformResponseUser.js +2 -2
- package/package.json +1 -1
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* ShapeDiver Platform Authentication API response (OAuth 2.0)
|
|
3
|
-
*/
|
|
4
|
-
export interface SdPlatformAuthResponse {
|
|
5
|
-
access_token?: string;
|
|
6
|
-
refresh_token?: string;
|
|
7
|
-
expires_in?: number;
|
|
8
|
-
/** Always "Bearer" */
|
|
9
|
-
token_type?: string;
|
|
10
|
-
scope?: string;
|
|
11
|
-
}
|
|
12
|
-
export interface SdPlatformAuthorizationCodeResponse {
|
|
13
|
-
readonly code: string;
|
|
14
|
-
}
|
|
15
|
-
export interface SdPlatformAuthLogoutResponse {
|
|
16
|
-
success: boolean;
|
|
17
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* ShapeDiver Platform Authentication API response (OAuth 2.0)
|
|
3
|
+
*/
|
|
4
|
+
export interface SdPlatformAuthResponse {
|
|
5
|
+
access_token?: string;
|
|
6
|
+
refresh_token?: string;
|
|
7
|
+
expires_in?: number;
|
|
8
|
+
/** Always "Bearer" */
|
|
9
|
+
token_type?: string;
|
|
10
|
+
scope?: string;
|
|
11
|
+
}
|
|
12
|
+
export interface SdPlatformAuthorizationCodeResponse {
|
|
13
|
+
readonly code: string;
|
|
14
|
+
}
|
|
15
|
+
export interface SdPlatformAuthLogoutResponse {
|
|
16
|
+
success: boolean;
|
|
17
|
+
}
|
|
18
18
|
//# sourceMappingURL=SdPlatformAuthResponse.d.ts.map
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=SdPlatformAuthResponse.js.map
|
|
@@ -1,48 +1,48 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Common ShapeDiver Platform GET response.
|
|
3
|
-
*/
|
|
4
|
-
export interface SdPlatformGetResponse<T> {
|
|
5
|
-
readonly success: boolean;
|
|
6
|
-
readonly version: string;
|
|
7
|
-
readonly data: T;
|
|
8
|
-
}
|
|
9
|
-
/**
|
|
10
|
-
* Common ShapeDiver Platform query response.
|
|
11
|
-
*/
|
|
12
|
-
export interface SdPlatformQueryResponse<T> {
|
|
13
|
-
readonly success: boolean;
|
|
14
|
-
readonly version: string;
|
|
15
|
-
readonly data: {
|
|
16
|
-
result: Array<T>;
|
|
17
|
-
pagination: {
|
|
18
|
-
limit: number;
|
|
19
|
-
next_offset: string;
|
|
20
|
-
};
|
|
21
|
-
};
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Common ShapeDiver Platform POST response.
|
|
25
|
-
*/
|
|
26
|
-
export interface SdPlatformPostResponse<T> {
|
|
27
|
-
success: boolean;
|
|
28
|
-
readonly version: string;
|
|
29
|
-
message: string;
|
|
30
|
-
data: T;
|
|
31
|
-
}
|
|
32
|
-
/**
|
|
33
|
-
* Common ShapeDiver Platform PATCH response.
|
|
34
|
-
*/
|
|
35
|
-
export interface SdPlatformPatchResponse<T> {
|
|
36
|
-
success: boolean;
|
|
37
|
-
readonly version: string;
|
|
38
|
-
patched_properties?: Array<string>;
|
|
39
|
-
data: T;
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Common ShapeDiver Platform DELETE response.
|
|
43
|
-
*/
|
|
44
|
-
export interface SdPlatformDeleteResponse {
|
|
45
|
-
readonly version: string;
|
|
46
|
-
success: boolean;
|
|
47
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Common ShapeDiver Platform GET response.
|
|
3
|
+
*/
|
|
4
|
+
export interface SdPlatformGetResponse<T> {
|
|
5
|
+
readonly success: boolean;
|
|
6
|
+
readonly version: string;
|
|
7
|
+
readonly data: T;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Common ShapeDiver Platform query response.
|
|
11
|
+
*/
|
|
12
|
+
export interface SdPlatformQueryResponse<T> {
|
|
13
|
+
readonly success: boolean;
|
|
14
|
+
readonly version: string;
|
|
15
|
+
readonly data: {
|
|
16
|
+
result: Array<T>;
|
|
17
|
+
pagination: {
|
|
18
|
+
limit: number;
|
|
19
|
+
next_offset: string;
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Common ShapeDiver Platform POST response.
|
|
25
|
+
*/
|
|
26
|
+
export interface SdPlatformPostResponse<T> {
|
|
27
|
+
success: boolean;
|
|
28
|
+
readonly version: string;
|
|
29
|
+
message: string;
|
|
30
|
+
data: T;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Common ShapeDiver Platform PATCH response.
|
|
34
|
+
*/
|
|
35
|
+
export interface SdPlatformPatchResponse<T> {
|
|
36
|
+
success: boolean;
|
|
37
|
+
readonly version: string;
|
|
38
|
+
patched_properties?: Array<string>;
|
|
39
|
+
data: T;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Common ShapeDiver Platform DELETE response.
|
|
43
|
+
*/
|
|
44
|
+
export interface SdPlatformDeleteResponse {
|
|
45
|
+
readonly version: string;
|
|
46
|
+
success: boolean;
|
|
47
|
+
}
|
|
48
48
|
//# sourceMappingURL=SdPlatformBaseResponseTypes.d.ts.map
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=SdPlatformBaseResponseTypes.js.map
|
|
@@ -1,174 +1,174 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Analytics on session duration.
|
|
3
|
-
*/
|
|
4
|
-
export interface SdPlatformResponseSessionAnalyticsOnDuration {
|
|
5
|
-
/** Average duration of sessions. */
|
|
6
|
-
avg: number;
|
|
7
|
-
/** Number of (technical) sessions from all sources (duration) or from one specific source (app, embedded, backend, desktop). */
|
|
8
|
-
count: number;
|
|
9
|
-
/** Billable duration-based credit count for all sessions, based on maximum duration of 10 minutes per credit. */
|
|
10
|
-
billable_count: number;
|
|
11
|
-
/** Cumulative distribution function of the session duration. */
|
|
12
|
-
max?: number;
|
|
13
|
-
/** Cumulative distribution function of the session duration. */
|
|
14
|
-
min?: number;
|
|
15
|
-
/** Total duration of sessions. */
|
|
16
|
-
sum: number;
|
|
17
|
-
/** Cumulative distribution function of the session duration. */
|
|
18
|
-
p05: number;
|
|
19
|
-
/** Cumulative distribution function of the session duration. */
|
|
20
|
-
p10: number;
|
|
21
|
-
/** Cumulative distribution function of the session duration. */
|
|
22
|
-
p15: number;
|
|
23
|
-
/** Cumulative distribution function of the session duration. */
|
|
24
|
-
p20: number;
|
|
25
|
-
/** Cumulative distribution function of the session duration. */
|
|
26
|
-
p25: number;
|
|
27
|
-
/** Cumulative distribution function of the session duration. */
|
|
28
|
-
p30: number;
|
|
29
|
-
/** Cumulative distribution function of the session duration. */
|
|
30
|
-
p35: number;
|
|
31
|
-
/** Cumulative distribution function of the session duration. */
|
|
32
|
-
p40: number;
|
|
33
|
-
/** Cumulative distribution function of the session duration. */
|
|
34
|
-
p45: number;
|
|
35
|
-
/** Cumulative distribution function of the session duration. */
|
|
36
|
-
p50: number;
|
|
37
|
-
/** Cumulative distribution function of the session duration. */
|
|
38
|
-
p55: number;
|
|
39
|
-
/** Cumulative distribution function of the session duration. */
|
|
40
|
-
p60: number;
|
|
41
|
-
/** Cumulative distribution function of the session duration. */
|
|
42
|
-
p65: number;
|
|
43
|
-
/** Cumulative distribution function of the session duration. */
|
|
44
|
-
p70: number;
|
|
45
|
-
/** Cumulative distribution function of the session duration. */
|
|
46
|
-
p75: number;
|
|
47
|
-
/** Cumulative distribution function of the session duration. */
|
|
48
|
-
p80: number;
|
|
49
|
-
/** Cumulative distribution function of the session duration. */
|
|
50
|
-
p85: number;
|
|
51
|
-
/** Cumulative distribution function of the session duration. */
|
|
52
|
-
p90: number;
|
|
53
|
-
/** Cumulative distribution function of the session duration. */
|
|
54
|
-
p95: number;
|
|
55
|
-
}
|
|
56
|
-
/**
|
|
57
|
-
* Analytics on a type of action (customization, export) per session.
|
|
58
|
-
*/
|
|
59
|
-
export interface SdPlatformResponseSessionAnalyticsOnAction {
|
|
60
|
-
/** Average number of actions per session, for sessions for which the type of action happened. */
|
|
61
|
-
avg: number;
|
|
62
|
-
/** Number of sessions for which the type of action happened. */
|
|
63
|
-
count: number;
|
|
64
|
-
/** Billable duration-based credit count for sessions for which the type of action happened. */
|
|
65
|
-
billable_count: number;
|
|
66
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
67
|
-
max?: number;
|
|
68
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
69
|
-
min?: number;
|
|
70
|
-
/** Total number of actions that happened. */
|
|
71
|
-
sum: number;
|
|
72
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
73
|
-
p05: number;
|
|
74
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
75
|
-
p10: number;
|
|
76
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
77
|
-
p15: number;
|
|
78
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
79
|
-
p20: number;
|
|
80
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
81
|
-
p25: number;
|
|
82
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
83
|
-
p30: number;
|
|
84
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
85
|
-
p35: number;
|
|
86
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
87
|
-
p40: number;
|
|
88
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
89
|
-
p45: number;
|
|
90
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
91
|
-
p50: number;
|
|
92
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
93
|
-
p55: number;
|
|
94
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
95
|
-
p60: number;
|
|
96
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
97
|
-
p65: number;
|
|
98
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
99
|
-
p70: number;
|
|
100
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
101
|
-
p75: number;
|
|
102
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
103
|
-
p80: number;
|
|
104
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
105
|
-
p85: number;
|
|
106
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
107
|
-
p90: number;
|
|
108
|
-
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
109
|
-
p95: number;
|
|
110
|
-
/** Total number of actions, for embedded sessions for which the type of action happened. */
|
|
111
|
-
sum_embedded: number;
|
|
112
|
-
/** Total number of actions, for ShapeDiver Platform sessions for which the type of action happened. */
|
|
113
|
-
sum_app: number;
|
|
114
|
-
/** Total number of actions, for backend sessions for which the type of action happened. */
|
|
115
|
-
sum_backend: number;
|
|
116
|
-
/** Total number of actions, for desktop client sessions for which the type of action happened. */
|
|
117
|
-
sum_desktop: number;
|
|
118
|
-
}
|
|
119
|
-
/**
|
|
120
|
-
* Analytics on duration depending on type of session (source of traffic), and on action (customization, export).
|
|
121
|
-
*/
|
|
122
|
-
export interface SdPlatformResponseModelSessionAnalytics {
|
|
123
|
-
/** Analytics on session duration for all traffic sources. */
|
|
124
|
-
duration?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
125
|
-
/** Analytics on session duration for sessions from the ShapeDiver Platform. */
|
|
126
|
-
app?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
127
|
-
/** Analytics on session duration for backend sessions. */
|
|
128
|
-
backend?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
129
|
-
/** Analytics on session duration for desktop client sessions. */
|
|
130
|
-
desktop?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
131
|
-
/** Analytics on session duration for embedded sessions. */
|
|
132
|
-
embedded?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
133
|
-
/** Analytics on customization requests. */
|
|
134
|
-
customize?: SdPlatformResponseSessionAnalyticsOnAction;
|
|
135
|
-
/** Analytics on export requests. */
|
|
136
|
-
export?: SdPlatformResponseSessionAnalyticsOnAction;
|
|
137
|
-
}
|
|
138
|
-
export declare enum SdPlatformResponseAnalyticsTimestampType {
|
|
139
|
-
Hour = "hour",
|
|
140
|
-
Day = "day",
|
|
141
|
-
Month = "month",
|
|
142
|
-
Year = "year"
|
|
143
|
-
}
|
|
144
|
-
/**
|
|
145
|
-
* Analytics on session duration and on actions, for all models of a user, for a given timestamp.
|
|
146
|
-
*/
|
|
147
|
-
export interface SdPlatformResponseUserModelSessionAnalyticsPerTimestamp {
|
|
148
|
-
/** id of user */
|
|
149
|
-
user_id: string;
|
|
150
|
-
/** type of timestamp */
|
|
151
|
-
timestamp_type: SdPlatformResponseAnalyticsTimestampType;
|
|
152
|
-
/** timestamp in epoch format */
|
|
153
|
-
timestamp_date: number;
|
|
154
|
-
/** timestamp in format YYYY or YYYYMM or YYYYMMDD or YYYYMMDDHH */
|
|
155
|
-
timestamp: string;
|
|
156
|
-
/** aggregated analytics data */
|
|
157
|
-
data: SdPlatformResponseModelSessionAnalytics;
|
|
158
|
-
}
|
|
159
|
-
/**
|
|
160
|
-
* Analytics on session duration and on actions, for all models of a organization, for a given timestamp.
|
|
161
|
-
*/
|
|
162
|
-
export interface SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp {
|
|
163
|
-
/** id of organization */
|
|
164
|
-
organization_id: string;
|
|
165
|
-
/** type of timestamp */
|
|
166
|
-
timestamp_type: SdPlatformResponseAnalyticsTimestampType;
|
|
167
|
-
/** timestamp in epoch format */
|
|
168
|
-
timestamp_date: number;
|
|
169
|
-
/** timestamp in format YYYY or YYYYMM or YYYYMMDD or YYYYMMDDHH */
|
|
170
|
-
timestamp: string;
|
|
171
|
-
/** aggregated analytics data */
|
|
172
|
-
data: SdPlatformResponseModelSessionAnalytics;
|
|
173
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Analytics on session duration.
|
|
3
|
+
*/
|
|
4
|
+
export interface SdPlatformResponseSessionAnalyticsOnDuration {
|
|
5
|
+
/** Average duration of sessions. */
|
|
6
|
+
avg: number;
|
|
7
|
+
/** Number of (technical) sessions from all sources (duration) or from one specific source (app, embedded, backend, desktop). */
|
|
8
|
+
count: number;
|
|
9
|
+
/** Billable duration-based credit count for all sessions, based on maximum duration of 10 minutes per credit. */
|
|
10
|
+
billable_count: number;
|
|
11
|
+
/** Cumulative distribution function of the session duration. */
|
|
12
|
+
max?: number;
|
|
13
|
+
/** Cumulative distribution function of the session duration. */
|
|
14
|
+
min?: number;
|
|
15
|
+
/** Total duration of sessions. */
|
|
16
|
+
sum: number;
|
|
17
|
+
/** Cumulative distribution function of the session duration. */
|
|
18
|
+
p05: number;
|
|
19
|
+
/** Cumulative distribution function of the session duration. */
|
|
20
|
+
p10: number;
|
|
21
|
+
/** Cumulative distribution function of the session duration. */
|
|
22
|
+
p15: number;
|
|
23
|
+
/** Cumulative distribution function of the session duration. */
|
|
24
|
+
p20: number;
|
|
25
|
+
/** Cumulative distribution function of the session duration. */
|
|
26
|
+
p25: number;
|
|
27
|
+
/** Cumulative distribution function of the session duration. */
|
|
28
|
+
p30: number;
|
|
29
|
+
/** Cumulative distribution function of the session duration. */
|
|
30
|
+
p35: number;
|
|
31
|
+
/** Cumulative distribution function of the session duration. */
|
|
32
|
+
p40: number;
|
|
33
|
+
/** Cumulative distribution function of the session duration. */
|
|
34
|
+
p45: number;
|
|
35
|
+
/** Cumulative distribution function of the session duration. */
|
|
36
|
+
p50: number;
|
|
37
|
+
/** Cumulative distribution function of the session duration. */
|
|
38
|
+
p55: number;
|
|
39
|
+
/** Cumulative distribution function of the session duration. */
|
|
40
|
+
p60: number;
|
|
41
|
+
/** Cumulative distribution function of the session duration. */
|
|
42
|
+
p65: number;
|
|
43
|
+
/** Cumulative distribution function of the session duration. */
|
|
44
|
+
p70: number;
|
|
45
|
+
/** Cumulative distribution function of the session duration. */
|
|
46
|
+
p75: number;
|
|
47
|
+
/** Cumulative distribution function of the session duration. */
|
|
48
|
+
p80: number;
|
|
49
|
+
/** Cumulative distribution function of the session duration. */
|
|
50
|
+
p85: number;
|
|
51
|
+
/** Cumulative distribution function of the session duration. */
|
|
52
|
+
p90: number;
|
|
53
|
+
/** Cumulative distribution function of the session duration. */
|
|
54
|
+
p95: number;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Analytics on a type of action (customization, export) per session.
|
|
58
|
+
*/
|
|
59
|
+
export interface SdPlatformResponseSessionAnalyticsOnAction {
|
|
60
|
+
/** Average number of actions per session, for sessions for which the type of action happened. */
|
|
61
|
+
avg: number;
|
|
62
|
+
/** Number of sessions for which the type of action happened. */
|
|
63
|
+
count: number;
|
|
64
|
+
/** Billable duration-based credit count for sessions for which the type of action happened. */
|
|
65
|
+
billable_count: number;
|
|
66
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
67
|
+
max?: number;
|
|
68
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
69
|
+
min?: number;
|
|
70
|
+
/** Total number of actions that happened. */
|
|
71
|
+
sum: number;
|
|
72
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
73
|
+
p05: number;
|
|
74
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
75
|
+
p10: number;
|
|
76
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
77
|
+
p15: number;
|
|
78
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
79
|
+
p20: number;
|
|
80
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
81
|
+
p25: number;
|
|
82
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
83
|
+
p30: number;
|
|
84
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
85
|
+
p35: number;
|
|
86
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
87
|
+
p40: number;
|
|
88
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
89
|
+
p45: number;
|
|
90
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
91
|
+
p50: number;
|
|
92
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
93
|
+
p55: number;
|
|
94
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
95
|
+
p60: number;
|
|
96
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
97
|
+
p65: number;
|
|
98
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
99
|
+
p70: number;
|
|
100
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
101
|
+
p75: number;
|
|
102
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
103
|
+
p80: number;
|
|
104
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
105
|
+
p85: number;
|
|
106
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
107
|
+
p90: number;
|
|
108
|
+
/** Cumulative distribution function of the number of actions per session, for sessions for which the type of action happened. */
|
|
109
|
+
p95: number;
|
|
110
|
+
/** Total number of actions, for embedded sessions for which the type of action happened. */
|
|
111
|
+
sum_embedded: number;
|
|
112
|
+
/** Total number of actions, for ShapeDiver Platform sessions for which the type of action happened. */
|
|
113
|
+
sum_app: number;
|
|
114
|
+
/** Total number of actions, for backend sessions for which the type of action happened. */
|
|
115
|
+
sum_backend: number;
|
|
116
|
+
/** Total number of actions, for desktop client sessions for which the type of action happened. */
|
|
117
|
+
sum_desktop: number;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Analytics on duration depending on type of session (source of traffic), and on action (customization, export).
|
|
121
|
+
*/
|
|
122
|
+
export interface SdPlatformResponseModelSessionAnalytics {
|
|
123
|
+
/** Analytics on session duration for all traffic sources. */
|
|
124
|
+
duration?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
125
|
+
/** Analytics on session duration for sessions from the ShapeDiver Platform. */
|
|
126
|
+
app?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
127
|
+
/** Analytics on session duration for backend sessions. */
|
|
128
|
+
backend?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
129
|
+
/** Analytics on session duration for desktop client sessions. */
|
|
130
|
+
desktop?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
131
|
+
/** Analytics on session duration for embedded sessions. */
|
|
132
|
+
embedded?: SdPlatformResponseSessionAnalyticsOnDuration;
|
|
133
|
+
/** Analytics on customization requests. */
|
|
134
|
+
customize?: SdPlatformResponseSessionAnalyticsOnAction;
|
|
135
|
+
/** Analytics on export requests. */
|
|
136
|
+
export?: SdPlatformResponseSessionAnalyticsOnAction;
|
|
137
|
+
}
|
|
138
|
+
export declare enum SdPlatformResponseAnalyticsTimestampType {
|
|
139
|
+
Hour = "hour",
|
|
140
|
+
Day = "day",
|
|
141
|
+
Month = "month",
|
|
142
|
+
Year = "year"
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Analytics on session duration and on actions, for all models of a user, for a given timestamp.
|
|
146
|
+
*/
|
|
147
|
+
export interface SdPlatformResponseUserModelSessionAnalyticsPerTimestamp {
|
|
148
|
+
/** id of user */
|
|
149
|
+
user_id: string;
|
|
150
|
+
/** type of timestamp */
|
|
151
|
+
timestamp_type: SdPlatformResponseAnalyticsTimestampType;
|
|
152
|
+
/** timestamp in epoch format */
|
|
153
|
+
timestamp_date: number;
|
|
154
|
+
/** timestamp in format YYYY or YYYYMM or YYYYMMDD or YYYYMMDDHH */
|
|
155
|
+
timestamp: string;
|
|
156
|
+
/** aggregated analytics data */
|
|
157
|
+
data: SdPlatformResponseModelSessionAnalytics;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* Analytics on session duration and on actions, for all models of a organization, for a given timestamp.
|
|
161
|
+
*/
|
|
162
|
+
export interface SdPlatformResponseOrganizationModelSessionAnalyticsPerTimestamp {
|
|
163
|
+
/** id of organization */
|
|
164
|
+
organization_id: string;
|
|
165
|
+
/** type of timestamp */
|
|
166
|
+
timestamp_type: SdPlatformResponseAnalyticsTimestampType;
|
|
167
|
+
/** timestamp in epoch format */
|
|
168
|
+
timestamp_date: number;
|
|
169
|
+
/** timestamp in format YYYY or YYYYMM or YYYYMMDD or YYYYMMDDHH */
|
|
170
|
+
timestamp: string;
|
|
171
|
+
/** aggregated analytics data */
|
|
172
|
+
data: SdPlatformResponseModelSessionAnalytics;
|
|
173
|
+
}
|
|
174
174
|
//# sourceMappingURL=SdPlatformResponseAnalytics.d.ts.map
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.SdPlatformResponseAnalyticsTimestampType = void 0;
|
|
4
|
-
var SdPlatformResponseAnalyticsTimestampType;
|
|
5
|
-
(function (SdPlatformResponseAnalyticsTimestampType) {
|
|
6
|
-
SdPlatformResponseAnalyticsTimestampType["Hour"] = "hour";
|
|
7
|
-
SdPlatformResponseAnalyticsTimestampType["Day"] = "day";
|
|
8
|
-
SdPlatformResponseAnalyticsTimestampType["Month"] = "month";
|
|
9
|
-
SdPlatformResponseAnalyticsTimestampType["Year"] = "year";
|
|
10
|
-
})(SdPlatformResponseAnalyticsTimestampType = exports.SdPlatformResponseAnalyticsTimestampType || (exports.SdPlatformResponseAnalyticsTimestampType = {}));
|
|
11
|
-
;
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SdPlatformResponseAnalyticsTimestampType = void 0;
|
|
4
|
+
var SdPlatformResponseAnalyticsTimestampType;
|
|
5
|
+
(function (SdPlatformResponseAnalyticsTimestampType) {
|
|
6
|
+
SdPlatformResponseAnalyticsTimestampType["Hour"] = "hour";
|
|
7
|
+
SdPlatformResponseAnalyticsTimestampType["Day"] = "day";
|
|
8
|
+
SdPlatformResponseAnalyticsTimestampType["Month"] = "month";
|
|
9
|
+
SdPlatformResponseAnalyticsTimestampType["Year"] = "year";
|
|
10
|
+
})(SdPlatformResponseAnalyticsTimestampType = exports.SdPlatformResponseAnalyticsTimestampType || (exports.SdPlatformResponseAnalyticsTimestampType = {}));
|
|
11
|
+
;
|
|
12
12
|
//# sourceMappingURL=SdPlatformResponseAnalytics.js.map
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
export interface SdPlatformResponseApiClient {
|
|
2
|
-
readonly client_id: string;
|
|
3
|
-
readonly client_secret?: string;
|
|
4
|
-
readonly client_name?: string;
|
|
5
|
-
readonly refresh_token: boolean;
|
|
6
|
-
readonly access_token_lifetime?: number;
|
|
7
|
-
readonly refresh_token_lifetime?: number;
|
|
8
|
-
readonly refresh_token_limit?: number;
|
|
9
|
-
readonly required_feature?: string;
|
|
10
|
-
readonly allowed_origins: Array<string>;
|
|
11
|
-
}
|
|
1
|
+
export interface SdPlatformResponseApiClient {
|
|
2
|
+
readonly client_id: string;
|
|
3
|
+
readonly client_secret?: string;
|
|
4
|
+
readonly client_name?: string;
|
|
5
|
+
readonly refresh_token: boolean;
|
|
6
|
+
readonly access_token_lifetime?: number;
|
|
7
|
+
readonly refresh_token_lifetime?: number;
|
|
8
|
+
readonly refresh_token_limit?: number;
|
|
9
|
+
readonly required_feature?: string;
|
|
10
|
+
readonly allowed_origins: Array<string>;
|
|
11
|
+
}
|
|
12
12
|
//# sourceMappingURL=SdPlatformResponseApiClient.d.ts.map
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=SdPlatformResponseApiClient.js.map
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
import { SdPlatformApiTokenScopes } from "../commons/SdPlatformApiTokenScopes";
|
|
2
|
-
/**
|
|
3
|
-
* An API token
|
|
4
|
-
*/
|
|
5
|
-
export interface SdPlatformResponseApiToken {
|
|
6
|
-
/** the key id of the API token, to be used as username when authenticating */
|
|
7
|
-
readonly key_id: string;
|
|
8
|
-
/** scopes which the API token is limited to */
|
|
9
|
-
readonly scope: Array<SdPlatformApiTokenScopes>;
|
|
10
|
-
/** epoch timestamp until which the API token shall be valid */
|
|
11
|
-
readonly valid_until?: number;
|
|
12
|
-
/** whether the token is currently active */
|
|
13
|
-
readonly active: boolean;
|
|
14
|
-
/** description of the token */
|
|
15
|
-
readonly description: string;
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* An API token which has been newly created
|
|
19
|
-
* Note: This is your only chance to obtain the key_secret!
|
|
20
|
-
*/
|
|
21
|
-
export interface SdPlatformResponseApiTokenWithSecret extends SdPlatformResponseApiToken {
|
|
22
|
-
/** the key secret of the API token, to be used as the password when authenticating */
|
|
23
|
-
readonly key_secret: string;
|
|
24
|
-
}
|
|
1
|
+
import { SdPlatformApiTokenScopes } from "../commons/SdPlatformApiTokenScopes";
|
|
2
|
+
/**
|
|
3
|
+
* An API token
|
|
4
|
+
*/
|
|
5
|
+
export interface SdPlatformResponseApiToken {
|
|
6
|
+
/** the key id of the API token, to be used as username when authenticating */
|
|
7
|
+
readonly key_id: string;
|
|
8
|
+
/** scopes which the API token is limited to */
|
|
9
|
+
readonly scope: Array<SdPlatformApiTokenScopes>;
|
|
10
|
+
/** epoch timestamp until which the API token shall be valid */
|
|
11
|
+
readonly valid_until?: number;
|
|
12
|
+
/** whether the token is currently active */
|
|
13
|
+
readonly active: boolean;
|
|
14
|
+
/** description of the token */
|
|
15
|
+
readonly description: string;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* An API token which has been newly created
|
|
19
|
+
* Note: This is your only chance to obtain the key_secret!
|
|
20
|
+
*/
|
|
21
|
+
export interface SdPlatformResponseApiTokenWithSecret extends SdPlatformResponseApiToken {
|
|
22
|
+
/** the key secret of the API token, to be used as the password when authenticating */
|
|
23
|
+
readonly key_secret: string;
|
|
24
|
+
}
|
|
25
25
|
//# sourceMappingURL=SdPlatformResponseApiToken.d.ts.map
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=SdPlatformResponseApiToken.js.map
|