@giosg/types 6.7.0 → 7.1.0
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/lib/GiosgTCApi.d.ts +7 -2
- package/lib/GiosgTCApi.d.ts.map +1 -1
- package/lib/GiosgTCApi.js +5 -0
- package/lib/cjs/GiosgTCApi.d.ts +118 -0
- package/lib/cjs/GiosgTCApi.d.ts.map +1 -0
- package/lib/cjs/GiosgTCApi.js +25 -0
- package/lib/cjs/actions.d.ts +72 -0
- package/lib/cjs/actions.d.ts.map +1 -0
- package/lib/cjs/actions.js +63 -0
- package/lib/cjs/apps.d.ts +99 -0
- package/lib/cjs/apps.d.ts.map +1 -0
- package/lib/cjs/apps.js +2 -0
- package/lib/cjs/assets.d.ts +144 -0
- package/lib/cjs/assets.d.ts.map +1 -0
- package/lib/cjs/assets.js +2 -0
- package/lib/cjs/brands.d.ts +41 -0
- package/lib/cjs/brands.d.ts.map +1 -0
- package/lib/cjs/brands.js +2 -0
- package/lib/cjs/call.d.ts +41 -0
- package/lib/cjs/call.d.ts.map +1 -0
- package/lib/cjs/call.js +2 -0
- package/lib/cjs/canned_answers.d.ts +26 -0
- package/lib/cjs/canned_answers.d.ts.map +1 -0
- package/lib/cjs/canned_answers.js +2 -0
- package/lib/cjs/chat.d.ts +1071 -0
- package/lib/cjs/chat.d.ts.map +1 -0
- package/lib/cjs/chat.js +2 -0
- package/lib/cjs/common.d.ts +7 -0
- package/lib/cjs/common.d.ts.map +1 -0
- package/lib/cjs/common.js +628 -0
- package/lib/cjs/conditions.d.ts +98 -0
- package/lib/cjs/conditions.d.ts.map +1 -0
- package/lib/cjs/conditions.js +80 -0
- package/lib/cjs/customer.d.ts +519 -0
- package/lib/cjs/customer.d.ts.map +1 -0
- package/lib/cjs/customer.js +2 -0
- package/lib/cjs/customership.d.ts +79 -0
- package/lib/cjs/customership.d.ts.map +1 -0
- package/lib/cjs/customership.js +2 -0
- package/lib/cjs/email.d.ts +47 -0
- package/lib/cjs/email.d.ts.map +1 -0
- package/lib/cjs/email.js +2 -0
- package/lib/cjs/experiments.d.ts +168 -0
- package/lib/cjs/experiments.d.ts.map +1 -0
- package/lib/cjs/experiments.js +2 -0
- package/lib/cjs/goals.d.ts +126 -0
- package/lib/cjs/goals.d.ts.map +1 -0
- package/lib/cjs/goals.js +2 -0
- package/lib/cjs/index.d.ts +36 -0
- package/lib/cjs/index.d.ts.map +1 -0
- package/lib/cjs/index.js +32 -0
- package/lib/cjs/leadforms.d.ts +30 -0
- package/lib/cjs/leadforms.d.ts.map +1 -0
- package/lib/cjs/leadforms.js +2 -0
- package/lib/cjs/linkpreview.d.ts +16 -0
- package/lib/cjs/linkpreview.d.ts.map +1 -0
- package/lib/cjs/linkpreview.js +2 -0
- package/lib/cjs/oath.d.ts +75 -0
- package/lib/cjs/oath.d.ts.map +1 -0
- package/lib/cjs/oath.js +25 -0
- package/lib/cjs/partnerships.d.ts +54 -0
- package/lib/cjs/partnerships.d.ts.map +1 -0
- package/lib/cjs/partnerships.js +2 -0
- package/lib/cjs/permissions.d.ts +26 -0
- package/lib/cjs/permissions.d.ts.map +1 -0
- package/lib/cjs/permissions.js +2 -0
- package/lib/cjs/public.d.ts +420 -0
- package/lib/cjs/public.d.ts.map +1 -0
- package/lib/cjs/public.js +12 -0
- package/lib/cjs/rooms.d.ts +205 -0
- package/lib/cjs/rooms.d.ts.map +1 -0
- package/lib/cjs/rooms.js +2 -0
- package/lib/cjs/routers.d.ts +76 -0
- package/lib/cjs/routers.d.ts.map +1 -0
- package/lib/cjs/routers.js +2 -0
- package/lib/cjs/rules.d.ts +229 -0
- package/lib/cjs/rules.d.ts.map +1 -0
- package/lib/cjs/rules.js +2 -0
- package/lib/cjs/sharing.d.ts +111 -0
- package/lib/cjs/sharing.d.ts.map +1 -0
- package/lib/cjs/sharing.js +2 -0
- package/lib/cjs/shoppingcarts.d.ts +33 -0
- package/lib/cjs/shoppingcarts.d.ts.map +1 -0
- package/lib/cjs/shoppingcarts.js +2 -0
- package/lib/cjs/system.d.ts +21 -0
- package/lib/cjs/system.d.ts.map +1 -0
- package/lib/cjs/system.js +2 -0
- package/lib/cjs/target.d.ts +105 -0
- package/lib/cjs/target.d.ts.map +1 -0
- package/lib/cjs/target.js +2 -0
- package/lib/cjs/teams.d.ts +78 -0
- package/lib/cjs/teams.d.ts.map +1 -0
- package/lib/cjs/teams.js +2 -0
- package/lib/cjs/types.d.ts +226 -0
- package/lib/cjs/types.d.ts.map +1 -0
- package/lib/cjs/types.js +29 -0
- package/lib/cjs/uploads.d.ts +55 -0
- package/lib/cjs/uploads.d.ts.map +1 -0
- package/lib/cjs/uploads.js +2 -0
- package/lib/cjs/userclients.d.ts +79 -0
- package/lib/cjs/userclients.d.ts.map +1 -0
- package/lib/cjs/userclients.js +2 -0
- package/lib/cjs/variables.d.ts +41 -0
- package/lib/cjs/variables.d.ts.map +1 -0
- package/lib/cjs/variables.js +2 -0
- package/lib/cjs/visitor.d.ts +210 -0
- package/lib/cjs/visitor.d.ts.map +1 -0
- package/lib/cjs/visitor.js +2 -0
- package/lib/cjs/webhooks.d.ts +61 -0
- package/lib/cjs/webhooks.d.ts.map +1 -0
- package/lib/cjs/webhooks.js +2 -0
- package/lib/index.d.ts +3 -3
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +1 -1
- package/lib/mjs/GiosgTCApi.d.ts +118 -0
- package/lib/mjs/GiosgTCApi.d.ts.map +1 -0
- package/lib/mjs/GiosgTCApi.js +22 -0
- package/lib/mjs/actions.d.ts +72 -0
- package/lib/mjs/actions.d.ts.map +1 -0
- package/lib/mjs/actions.js +60 -0
- package/lib/mjs/apps.d.ts +99 -0
- package/lib/mjs/apps.d.ts.map +1 -0
- package/lib/mjs/apps.js +0 -0
- package/lib/mjs/assets.d.ts +144 -0
- package/lib/mjs/assets.d.ts.map +1 -0
- package/lib/mjs/assets.js +0 -0
- package/lib/mjs/brands.d.ts +41 -0
- package/lib/mjs/brands.d.ts.map +1 -0
- package/lib/mjs/brands.js +0 -0
- package/lib/mjs/call.d.ts +41 -0
- package/lib/mjs/call.d.ts.map +1 -0
- package/lib/mjs/call.js +0 -0
- package/lib/mjs/canned_answers.d.ts +26 -0
- package/lib/mjs/canned_answers.d.ts.map +1 -0
- package/lib/mjs/canned_answers.js +0 -0
- package/lib/mjs/chat.d.ts +1071 -0
- package/lib/mjs/chat.d.ts.map +1 -0
- package/lib/mjs/chat.js +0 -0
- package/lib/mjs/common.d.ts +7 -0
- package/lib/mjs/common.d.ts.map +1 -0
- package/lib/mjs/common.js +625 -0
- package/lib/mjs/conditions.d.ts +98 -0
- package/lib/mjs/conditions.d.ts.map +1 -0
- package/lib/mjs/conditions.js +77 -0
- package/lib/mjs/customer.d.ts +519 -0
- package/lib/mjs/customer.d.ts.map +1 -0
- package/lib/mjs/customer.js +0 -0
- package/lib/mjs/customership.d.ts +79 -0
- package/lib/mjs/customership.d.ts.map +1 -0
- package/lib/mjs/customership.js +0 -0
- package/lib/mjs/email.d.ts +47 -0
- package/lib/mjs/email.d.ts.map +1 -0
- package/lib/mjs/email.js +0 -0
- package/lib/mjs/experiments.d.ts +168 -0
- package/lib/mjs/experiments.d.ts.map +1 -0
- package/lib/mjs/experiments.js +0 -0
- package/lib/mjs/goals.d.ts +126 -0
- package/lib/mjs/goals.d.ts.map +1 -0
- package/lib/mjs/goals.js +0 -0
- package/lib/mjs/index.d.ts +36 -0
- package/lib/mjs/index.d.ts.map +1 -0
- package/lib/mjs/index.js +7 -0
- package/lib/mjs/leadforms.d.ts +30 -0
- package/lib/mjs/leadforms.d.ts.map +1 -0
- package/lib/mjs/leadforms.js +0 -0
- package/lib/mjs/linkpreview.d.ts +16 -0
- package/lib/mjs/linkpreview.d.ts.map +1 -0
- package/lib/mjs/linkpreview.js +0 -0
- package/lib/mjs/oath.d.ts +75 -0
- package/lib/mjs/oath.d.ts.map +1 -0
- package/lib/mjs/oath.js +22 -0
- package/lib/mjs/partnerships.d.ts +54 -0
- package/lib/mjs/partnerships.d.ts.map +1 -0
- package/lib/mjs/partnerships.js +0 -0
- package/lib/mjs/permissions.d.ts +26 -0
- package/lib/mjs/permissions.d.ts.map +1 -0
- package/lib/mjs/permissions.js +0 -0
- package/lib/mjs/public.d.ts +420 -0
- package/lib/mjs/public.d.ts.map +1 -0
- package/lib/mjs/public.js +9 -0
- package/lib/mjs/rooms.d.ts +205 -0
- package/lib/mjs/rooms.d.ts.map +1 -0
- package/lib/mjs/rooms.js +0 -0
- package/lib/mjs/routers.d.ts +76 -0
- package/lib/mjs/routers.d.ts.map +1 -0
- package/lib/mjs/routers.js +0 -0
- package/lib/mjs/rules.d.ts +229 -0
- package/lib/mjs/rules.d.ts.map +1 -0
- package/lib/mjs/rules.js +0 -0
- package/lib/mjs/sharing.d.ts +111 -0
- package/lib/mjs/sharing.d.ts.map +1 -0
- package/lib/mjs/sharing.js +0 -0
- package/lib/mjs/shoppingcarts.d.ts +33 -0
- package/lib/mjs/shoppingcarts.d.ts.map +1 -0
- package/lib/mjs/shoppingcarts.js +0 -0
- package/lib/mjs/system.d.ts +21 -0
- package/lib/mjs/system.d.ts.map +1 -0
- package/lib/mjs/system.js +0 -0
- package/lib/mjs/target.d.ts +105 -0
- package/lib/mjs/target.d.ts.map +1 -0
- package/lib/mjs/target.js +0 -0
- package/lib/mjs/teams.d.ts +78 -0
- package/lib/mjs/teams.d.ts.map +1 -0
- package/lib/mjs/teams.js +0 -0
- package/lib/mjs/types.d.ts +226 -0
- package/lib/mjs/types.d.ts.map +1 -0
- package/lib/mjs/types.js +26 -0
- package/lib/mjs/uploads.d.ts +55 -0
- package/lib/mjs/uploads.d.ts.map +1 -0
- package/lib/mjs/uploads.js +0 -0
- package/lib/mjs/userclients.d.ts +79 -0
- package/lib/mjs/userclients.d.ts.map +1 -0
- package/lib/mjs/userclients.js +0 -0
- package/lib/mjs/variables.d.ts +41 -0
- package/lib/mjs/variables.d.ts.map +1 -0
- package/lib/mjs/variables.js +0 -0
- package/lib/mjs/visitor.d.ts +210 -0
- package/lib/mjs/visitor.d.ts.map +1 -0
- package/lib/mjs/visitor.js +0 -0
- package/lib/mjs/webhooks.d.ts +61 -0
- package/lib/mjs/webhooks.d.ts.map +1 -0
- package/lib/mjs/webhooks.js +0 -0
- package/lib/public.d.ts +10 -0
- package/lib/public.d.ts.map +1 -1
- package/lib/rooms.d.ts +6 -0
- package/lib/rooms.d.ts.map +1 -1
- package/package.json +12 -3
- package/CHANGELOG.md +0 -234
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
import { NestedOrganization, NestedUser } from "./customer";
|
|
2
|
+
import { RoomUid, RoomSettingsUid, OrganizationUid, RouterUid, BrandUid, UserUid, RoomLegacyToken, LegacyChatDialogUid, PublicKeyUid } from "./types";
|
|
3
|
+
import { LanguageCode } from "./common";
|
|
4
|
+
import { NestedRouter } from "./routers";
|
|
5
|
+
export interface NestedRoom {
|
|
6
|
+
/** Unique identifier of the room */
|
|
7
|
+
id: RoomUid;
|
|
8
|
+
/** Display name of the room. It may be equal to the name attribute, unless the room is shared */
|
|
9
|
+
display_name: string;
|
|
10
|
+
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
|
|
11
|
+
domain: string | null;
|
|
12
|
+
/** Unique identifier of the organization that owns the room */
|
|
13
|
+
organization_id: OrganizationUid;
|
|
14
|
+
/** Organization that owns the room */
|
|
15
|
+
organization: NestedOrganization;
|
|
16
|
+
}
|
|
17
|
+
export declare type ServiceHours = {
|
|
18
|
+
enabled: boolean;
|
|
19
|
+
monday_from: string | null;
|
|
20
|
+
monday_to: string | null;
|
|
21
|
+
tuesday_from: string | null;
|
|
22
|
+
tuesday_to: string | null;
|
|
23
|
+
wednesday_from: string | null;
|
|
24
|
+
wednesday_to: string | null;
|
|
25
|
+
thursday_from: string | null;
|
|
26
|
+
thursday_to: string | null;
|
|
27
|
+
friday_from: string | null;
|
|
28
|
+
friday_to: string | null;
|
|
29
|
+
saturday_from: string | null;
|
|
30
|
+
saturday_to: string | null;
|
|
31
|
+
sunday_from: string | null;
|
|
32
|
+
sunday_to: string | null;
|
|
33
|
+
};
|
|
34
|
+
export interface OrganizationRoomSettings {
|
|
35
|
+
/** Unique identifier of the organization room settings */
|
|
36
|
+
id: RoomSettingsUid;
|
|
37
|
+
/** Unique identifier of the organization that owns the room */
|
|
38
|
+
organization_id: OrganizationUid;
|
|
39
|
+
/** Organization that owns the room */
|
|
40
|
+
organization: NestedOrganization;
|
|
41
|
+
/** Unique identifier of the room to which the settings apply */
|
|
42
|
+
room_id: RoomUid;
|
|
43
|
+
/** Room to which the settings apply */
|
|
44
|
+
room: NestedRoom;
|
|
45
|
+
/** Unique identifier of the router that is used to route chats in the room */
|
|
46
|
+
router_id: RouterUid | null;
|
|
47
|
+
/** Router that is used to route chats in the room */
|
|
48
|
+
router: NestedRouter | null;
|
|
49
|
+
/** Unique identifier of the brand that is used in the room. If null then the default theme is used */
|
|
50
|
+
brand_id: BrandUid | null;
|
|
51
|
+
/** Defines whether pending visitor messages should be hidden in giosg console */
|
|
52
|
+
is_pending_chat_messages_hidden: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* Defines whether the chat shall open in the same browser tab using the newer client. By default
|
|
55
|
+
* a legacy mobile chat client is used and the chat opens into a new browser tab
|
|
56
|
+
*/
|
|
57
|
+
is_mobile_chat_in_same_tab: boolean;
|
|
58
|
+
/** Defines whether Google Analytics tracking is enabled */
|
|
59
|
+
is_analytics_tracking_enabled: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Defined whether automatic tagging of chat conversations is enabled for room.
|
|
62
|
+
* If set to true, will automatically add tags "Auto: email" and "Auto: phonenumber" to chat's
|
|
63
|
+
* if visitor sends email address or phonenumber to chat.
|
|
64
|
+
*/
|
|
65
|
+
is_auto_tagging_enabled: boolean;
|
|
66
|
+
/** Type of the Google Analytics object. This is required if "is_analytics_tracking_enabled" is true */
|
|
67
|
+
analytics_object_type: "gaq" | "datalayer" | "ga-send" | "custom" | null;
|
|
68
|
+
/** This is required if "analytics_object_type" is "custom" */
|
|
69
|
+
analytics_custom_object: string | null;
|
|
70
|
+
/** Defines whether AJAX tracking is enabled */
|
|
71
|
+
is_ajax_tracking_enabled: boolean;
|
|
72
|
+
/** Defines whether the room only accepts signed visitor variables and chat widget URLs */
|
|
73
|
+
is_signature_required: boolean;
|
|
74
|
+
/** Date when the room settings were created */
|
|
75
|
+
created_at: string;
|
|
76
|
+
/** Date when the room settings were changed for the last time */
|
|
77
|
+
updated_at: string;
|
|
78
|
+
/** Unique identifier of the chat dialog used in the room. */
|
|
79
|
+
legacy_chat_dialog_id: LegacyChatDialogUid;
|
|
80
|
+
/** Transparency and cookies are enabled or not. */
|
|
81
|
+
are_consents_enabled_by_default: boolean;
|
|
82
|
+
/** Service Hours setting for room*/
|
|
83
|
+
service_hours?: ServiceHours;
|
|
84
|
+
}
|
|
85
|
+
export interface OrganizationRoomSettingsPayload {
|
|
86
|
+
/** Unique identifier of the router that is used to route chats in the room */
|
|
87
|
+
router_id?: RouterUid | null;
|
|
88
|
+
/** Unique identifier of the brand that is used in the room. If null then the default theme is used */
|
|
89
|
+
brand_id?: BrandUid | null;
|
|
90
|
+
/** Defines whether pending visitor messages should be hidden in giosg console */
|
|
91
|
+
is_pending_chat_messages_hidden: boolean;
|
|
92
|
+
/**
|
|
93
|
+
* Defines whether the chat shall open in the same browser tab using the newer client. By default
|
|
94
|
+
* a legacy mobile chat client is used and the chat opens into a new browser tab
|
|
95
|
+
*/
|
|
96
|
+
is_mobile_chat_in_same_tab: boolean;
|
|
97
|
+
/**
|
|
98
|
+
* Defined whether automatic tagging of chat conversations is enabled for room.
|
|
99
|
+
* If set to true, will automatically add tags "Auto: email" and "Auto: phonenumber" to chat's
|
|
100
|
+
* if visitor sends email address or phonenumber to chat.
|
|
101
|
+
*/
|
|
102
|
+
is_auto_tagging_enabled: boolean;
|
|
103
|
+
/** Defines whether Google Analytics tracking is enabled */
|
|
104
|
+
is_analytics_tracking_enabled: boolean;
|
|
105
|
+
/** Type of the Google Analytics object. This is required if "is_analytics_tracking_enabled" is true */
|
|
106
|
+
analytics_object_type?: "gaq" | "datalayer" | "ga-send" | "custom";
|
|
107
|
+
/** This is required if analytics_object_type is custom */
|
|
108
|
+
analytics_custom_object?: string;
|
|
109
|
+
/** Defines whether AJAX tracking is enabled */
|
|
110
|
+
is_ajax_tracking_enabled: boolean;
|
|
111
|
+
/** Defines whether the room only accepts signed visitor variables and chat widget URLs */
|
|
112
|
+
is_signature_required?: boolean;
|
|
113
|
+
/** Transparency and cookies are enabled or not. */
|
|
114
|
+
are_consents_enabled_by_default: boolean;
|
|
115
|
+
/** Service Hours setting for room*/
|
|
116
|
+
service_hours?: ServiceHours;
|
|
117
|
+
}
|
|
118
|
+
export interface RoomAllowedDomainLink {
|
|
119
|
+
/** Unique identifier of the organization who owns the domain link */
|
|
120
|
+
organization_id: OrganizationUid;
|
|
121
|
+
/** Organization who owns the domain link */
|
|
122
|
+
organization: NestedOrganization;
|
|
123
|
+
/** Unique identifier of the room which has access to the domain link */
|
|
124
|
+
room_id: RoomUid;
|
|
125
|
+
/** Room which has access to the domain link */
|
|
126
|
+
room: NestedRoom;
|
|
127
|
+
/** Unique identifier of the domain room */
|
|
128
|
+
domain_room_id: RoomUid;
|
|
129
|
+
/** Domain room */
|
|
130
|
+
domain_room: NestedRoom;
|
|
131
|
+
/** Date when the domain link was created */
|
|
132
|
+
created_at: string;
|
|
133
|
+
/** Date when the domain link was changed for the last time */
|
|
134
|
+
updated_at: string;
|
|
135
|
+
}
|
|
136
|
+
export interface RoomAllowedDomainLinkPayload {
|
|
137
|
+
/** Unique identifier of the domain room */
|
|
138
|
+
domain_room_id: RoomUid;
|
|
139
|
+
}
|
|
140
|
+
export interface RoomCreatePayload {
|
|
141
|
+
/** Name of the room */
|
|
142
|
+
name: string;
|
|
143
|
+
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
|
|
144
|
+
domain?: string | null;
|
|
145
|
+
/** Language of the room as a RFC 3066 code. Defaults to en */
|
|
146
|
+
language_code?: LanguageCode;
|
|
147
|
+
}
|
|
148
|
+
export interface Room {
|
|
149
|
+
/** Unique identifier of the room */
|
|
150
|
+
id: RoomUid;
|
|
151
|
+
/** Name of the room */
|
|
152
|
+
name: string;
|
|
153
|
+
/** Display name of the room. It may be equal to the name attribute, unless the room is shared */
|
|
154
|
+
display_name: string;
|
|
155
|
+
/** Domain hostname of the room. Exists only if the room is a domain room, otherwise null */
|
|
156
|
+
domain: string | null;
|
|
157
|
+
/** Legacy signed unique identifier of the room. Deprecated, use an id attribute instead */
|
|
158
|
+
token: RoomLegacyToken;
|
|
159
|
+
/** Language of the room as a RFC 3066 code. Defaults to en */
|
|
160
|
+
language_code: LanguageCode;
|
|
161
|
+
/** Unique identifier of the organization that owns the room */
|
|
162
|
+
organization_id: OrganizationUid;
|
|
163
|
+
/** Organization that owns the room */
|
|
164
|
+
organization: NestedOrganization;
|
|
165
|
+
/** Unique identifier of the user who changed the room for the last time, or null if unknown*/
|
|
166
|
+
updated_by_user_id: UserUid;
|
|
167
|
+
/** User who changed the room for the last time, or null if unknown */
|
|
168
|
+
updated_by_user: NestedUser;
|
|
169
|
+
/** Date when the room was created */
|
|
170
|
+
created_at: string;
|
|
171
|
+
/** Date when the room was changed for the last time */
|
|
172
|
+
updated_at: string;
|
|
173
|
+
/**
|
|
174
|
+
* Defines whether the room is currently online, i.e. there is at least one online user and the organization
|
|
175
|
+
* is allowed to be online at the room
|
|
176
|
+
*/
|
|
177
|
+
is_online: boolean;
|
|
178
|
+
/**
|
|
179
|
+
* Defines whether the room exists no more. The resource exists only for historical purposes and
|
|
180
|
+
* cannot be used in any other context
|
|
181
|
+
*/
|
|
182
|
+
is_deleted: boolean;
|
|
183
|
+
/** Defines whether the room is shared to your organization */
|
|
184
|
+
is_shared: boolean;
|
|
185
|
+
/** Defines whether the room has service hours enabled */
|
|
186
|
+
is_service_hours_enabled: boolean;
|
|
187
|
+
/**
|
|
188
|
+
* Defines whether the room is currently open, i.e. currently in service hours if the room has service
|
|
189
|
+
* hours enabled. By default always true
|
|
190
|
+
*/
|
|
191
|
+
is_open: boolean;
|
|
192
|
+
/** Defines whether the room has chat encryption enabled */
|
|
193
|
+
is_chat_encryption_enabled: boolean;
|
|
194
|
+
/** Unique identifier of the public key used to encrypt chats. */
|
|
195
|
+
public_key_id: PublicKeyUid | null;
|
|
196
|
+
/** If non-null, defines the number of days after chat session has closed to purge sensitive data from the chat session. */
|
|
197
|
+
sensitive_data_purge_ttl: number | null;
|
|
198
|
+
}
|
|
199
|
+
export interface RoomPayload {
|
|
200
|
+
/** Name of the room */
|
|
201
|
+
name: string;
|
|
202
|
+
/** Language of the room as a RFC 3066 code. Defaults to en */
|
|
203
|
+
language_code?: LanguageCode;
|
|
204
|
+
}
|
|
205
|
+
//# sourceMappingURL=rooms.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rooms.d.ts","sourceRoot":"","sources":["../../src/rooms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EACL,OAAO,EACP,eAAe,EACf,eAAe,EACf,SAAS,EACT,QAAQ,EACR,OAAO,EACP,eAAe,EACf,mBAAmB,EACnB,YAAY,EACb,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,iGAAiG;IACjG,YAAY,EAAE,MAAM,CAAC;IAErB,4FAA4F;IAC5F,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;IAEjC,sCAAsC;IACtC,YAAY,EAAE,kBAAkB,CAAC;CAClC;AAED,oBAAY,YAAY,GAAG;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC,0DAA0D;IAC1D,EAAE,EAAE,eAAe,CAAC;IAEpB,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;IAEjC,sCAAsC;IACtC,YAAY,EAAE,kBAAkB,CAAC;IAEjC,gEAAgE;IAChE,OAAO,EAAE,OAAO,CAAC;IAEjB,uCAAuC;IACvC,IAAI,EAAE,UAAU,CAAC;IAEjB,8EAA8E;IAC9E,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAE5B,qDAAqD;IACrD,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAE5B,sGAAsG;IACtG,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE1B,iFAAiF;IACjF,+BAA+B,EAAE,OAAO,CAAC;IAEzC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC,2DAA2D;IAC3D,6BAA6B,EAAE,OAAO,CAAC;IAEvC;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC,uGAAuG;IACvG,qBAAqB,EAAE,KAAK,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC;IAEzE,8DAA8D;IAC9D,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC,+CAA+C;IAC/C,wBAAwB,EAAE,OAAO,CAAC;IAElC,0FAA0F;IAC1F,qBAAqB,EAAE,OAAO,CAAC;IAE/B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAC;IAEnB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC;IAEnB,6DAA6D;IAC7D,qBAAqB,EAAE,mBAAmB,CAAC;IAE3C,mDAAmD;IACnD,+BAA+B,EAAE,OAAO,CAAC;IAEzC,oCAAoC;IACpC,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,WAAW,+BAA+B;IAC9C,8EAA8E;IAC9E,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAE7B,sGAAsG;IACtG,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE3B,iFAAiF;IACjF,+BAA+B,EAAE,OAAO,CAAC;IAEzC;;;OAGG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;;;OAIG;IACH,uBAAuB,EAAE,OAAO,CAAC;IAEjC,2DAA2D;IAC3D,6BAA6B,EAAE,OAAO,CAAC;IAEvC,uGAAuG;IACvG,qBAAqB,CAAC,EAAE,KAAK,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEnE,0DAA0D;IAC1D,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,+CAA+C;IAC/C,wBAAwB,EAAE,OAAO,CAAC;IAElC,0FAA0F;IAC1F,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,mDAAmD;IACnD,+BAA+B,EAAE,OAAO,CAAC;IAEzC,oCAAoC;IACpC,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,WAAW,qBAAqB;IACpC,qEAAqE;IACrE,eAAe,EAAE,eAAe,CAAC;IAEjC,4CAA4C;IAC5C,YAAY,EAAE,kBAAkB,CAAC;IAEjC,wEAAwE;IACxE,OAAO,EAAE,OAAO,CAAC;IAEjB,+CAA+C;IAC/C,IAAI,EAAE,UAAU,CAAC;IAEjB,2CAA2C;IAC3C,cAAc,EAAE,OAAO,CAAC;IAExB,kBAAkB;IAClB,WAAW,EAAE,UAAU,CAAC;IAExB,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAC;IAEnB,8DAA8D;IAC9D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,2CAA2C;IAC3C,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,4FAA4F;IAC5F,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,8DAA8D;IAC9D,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B;AAED,MAAM,WAAW,IAAI;IACnB,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,iGAAiG;IACjG,YAAY,EAAE,MAAM,CAAC;IAErB,4FAA4F;IAC5F,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,2FAA2F;IAC3F,KAAK,EAAE,eAAe,CAAC;IAEvB,8DAA8D;IAC9D,aAAa,EAAE,YAAY,CAAC;IAE5B,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;IAEjC,sCAAsC;IACtC,YAAY,EAAE,kBAAkB,CAAC;IAEjC,8FAA8F;IAC9F,kBAAkB,EAAE,OAAO,CAAC;IAE5B,sEAAsE;IACtE,eAAe,EAAE,UAAU,CAAC;IAE5B,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB,8DAA8D;IAC9D,SAAS,EAAE,OAAO,CAAC;IAEnB,yDAAyD;IACzD,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB,2DAA2D;IAC3D,0BAA0B,EAAE,OAAO,CAAC;IAEpC,iEAAiE;IACjE,aAAa,EAAE,YAAY,GAAG,IAAI,CAAC;IAEnC,2HAA2H;IAC3H,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;CACzC;AAED,MAAM,WAAW,WAAW;IAC1B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,8DAA8D;IAC9D,aAAa,CAAC,EAAE,YAAY,CAAC;CAC9B"}
|
package/lib/cjs/rooms.js
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { UserUid, OrganizationUid, TeamUid, RouterUid, RouterStepUid } from "./types";
|
|
2
|
+
import { NestedUser, NestedOrganization } from "./customer";
|
|
3
|
+
import { NestedTeam } from "./teams";
|
|
4
|
+
export interface RouterStepPrecondition {
|
|
5
|
+
/** Type of precondition. Can be one of the following: users_offline, users_absent, task_waited */
|
|
6
|
+
type: "users_offline" | "users_absent" | "task_waited";
|
|
7
|
+
/** The value of the precondition. The interpretation depends on the precondition type:
|
|
8
|
+
users_offline: Percentage (%) of users that are offline in all previous steps. Value of 100 means that 100% of users are offline in all previous steps. Value of 0 means that all users are online in all previous steps.
|
|
9
|
+
users_absent: Percentage (%) of users that are absent in all previous steps. Value of 100 means that 100% of users are absent in all previous steps. Value of 0 means that all users are present in all previous steps.
|
|
10
|
+
task_waited: How many seconds the task has waited all in all. Value of 100 means that the task has waited for 100 seconds all in all.
|
|
11
|
+
Values are always integers!
|
|
12
|
+
*/
|
|
13
|
+
value: number;
|
|
14
|
+
}
|
|
15
|
+
export interface RouterStep {
|
|
16
|
+
/** The time when the router step was created */
|
|
17
|
+
created_at: string;
|
|
18
|
+
/** The user who created the router step */
|
|
19
|
+
created_by_user: NestedUser;
|
|
20
|
+
/** The id of the user who created the router step */
|
|
21
|
+
created_by_user_id: UserUid;
|
|
22
|
+
/** The unique identifier of this routing step */
|
|
23
|
+
id: RouterStepUid;
|
|
24
|
+
/** Index of the routing step relative to other routing steps in a router. Index is set automatically when router is created or updated. The first item in the router's steps array will get index of 0. */
|
|
25
|
+
index: number;
|
|
26
|
+
/** Array of organization IDs that tasks will be routed to. Can contain only your organization and your partner organizations. Can be an empty array. */
|
|
27
|
+
organization_ids: OrganizationUid[];
|
|
28
|
+
/** The organizations for which the router step may direct tasks */
|
|
29
|
+
organizations: NestedOrganization[];
|
|
30
|
+
/** Array of RouterStepPrecondition objects for this step. This should be an empty array for the first step. Otherwise it should contain at least one RouterStepPrecondition object! */
|
|
31
|
+
preconditions: RouterStepPrecondition[];
|
|
32
|
+
/** Array of team IDs that tasks will be routed to. Can contain only your organization's teams. Can be an empty array. */
|
|
33
|
+
team_ids: TeamUid[];
|
|
34
|
+
/** The teams for which the router step may direct tasks */
|
|
35
|
+
teams: NestedTeam[];
|
|
36
|
+
/** The time when the router step was last updated */
|
|
37
|
+
updated_at: string;
|
|
38
|
+
/** The user who last updated the router step */
|
|
39
|
+
updated_by_user: NestedUser;
|
|
40
|
+
/** The id of the user who last updated the router step */
|
|
41
|
+
updated_by_user_id: UserUid;
|
|
42
|
+
/** Array of user IDs that tasks will be routed to. Can contain only your organization's users. Can be an empty array. */
|
|
43
|
+
user_ids: UserUid[];
|
|
44
|
+
/** The users for which the router step may direct tasks */
|
|
45
|
+
users: NestedUser[];
|
|
46
|
+
}
|
|
47
|
+
export declare type RouterStepPayload = Pick<RouterStep, "organization_ids" | "preconditions" | "team_ids" | "user_ids">;
|
|
48
|
+
export interface Router {
|
|
49
|
+
/** The time when the router was created */
|
|
50
|
+
created_at: string;
|
|
51
|
+
/** The user who created the router */
|
|
52
|
+
created_by_user: NestedUser;
|
|
53
|
+
/** The id of the user who created the router */
|
|
54
|
+
created_by_user_id: UserUid;
|
|
55
|
+
/** The id of the router */
|
|
56
|
+
id: RouterUid;
|
|
57
|
+
/** The name of the router */
|
|
58
|
+
name: string;
|
|
59
|
+
/** The organization which owns the router */
|
|
60
|
+
organization: NestedOrganization;
|
|
61
|
+
/** The id of the organization which owns the router */
|
|
62
|
+
organization_id: OrganizationUid;
|
|
63
|
+
/** The router steps which belong to the router */
|
|
64
|
+
steps: RouterStep[];
|
|
65
|
+
/** The time when the router was last updated */
|
|
66
|
+
updated_at: string;
|
|
67
|
+
/** The user who last updated the router */
|
|
68
|
+
updated_by_user: NestedUser;
|
|
69
|
+
/** The id of the user who last updated the router */
|
|
70
|
+
updated_by_user_id: UserUid;
|
|
71
|
+
}
|
|
72
|
+
export interface RouterPayload extends Pick<Router, "name"> {
|
|
73
|
+
steps: RouterStepPayload[];
|
|
74
|
+
}
|
|
75
|
+
export declare type NestedRouter = Pick<Router, "id" | "name" | "organization" | "organization_id">;
|
|
76
|
+
//# sourceMappingURL=routers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"routers.d.ts","sourceRoot":"","sources":["../../src/routers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACtF,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,WAAW,sBAAsB;IACrC,kGAAkG;IAClG,IAAI,EAAE,eAAe,GAAG,cAAc,GAAG,aAAa,CAAC;IACvD;;;;;QAKI;IACJ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,eAAe,EAAE,UAAU,CAAC;IAC5B,qDAAqD;IACrD,kBAAkB,EAAE,OAAO,CAAC;IAC5B,iDAAiD;IACjD,EAAE,EAAE,aAAa,CAAC;IAClB,2MAA2M;IAC3M,KAAK,EAAE,MAAM,CAAC;IACd,wJAAwJ;IACxJ,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC,mEAAmE;IACnE,aAAa,EAAE,kBAAkB,EAAE,CAAC;IACpC,uLAAuL;IACvL,aAAa,EAAE,sBAAsB,EAAE,CAAC;IACxC,yHAAyH;IACzH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,2DAA2D;IAC3D,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,eAAe,EAAE,UAAU,CAAC;IAC5B,0DAA0D;IAC1D,kBAAkB,EAAE,OAAO,CAAC;IAC5B,yHAAyH;IACzH,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,2DAA2D;IAC3D,KAAK,EAAE,UAAU,EAAE,CAAC;CACrB;AAED,oBAAY,iBAAiB,GAAG,IAAI,CAClC,UAAU,EACV,kBAAkB,GAAG,eAAe,GAAG,UAAU,GAAG,UAAU,CAC/D,CAAC;AAEF,MAAM,WAAW,MAAM;IACrB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,eAAe,EAAE,UAAU,CAAC;IAC5B,gDAAgD;IAChD,kBAAkB,EAAE,OAAO,CAAC;IAC5B,2BAA2B;IAC3B,EAAE,EAAE,SAAS,CAAC;IACd,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,YAAY,EAAE,kBAAkB,CAAC;IACjC,uDAAuD;IACvD,eAAe,EAAE,eAAe,CAAC;IACjC,kDAAkD;IAClD,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,eAAe,EAAE,UAAU,CAAC;IAC5B,qDAAqD;IACrD,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC;IACzD,KAAK,EAAE,iBAAiB,EAAE,CAAC;CAC5B;AAED,oBAAY,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC,CAAC"}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
import { NestedGoal } from "./goals";
|
|
2
|
+
import { NestedOrganization, NestedUser } from "./customer";
|
|
3
|
+
import { NestedRoom } from "./rooms";
|
|
4
|
+
import { RuleUid, OrganizationUid, RoomUid, GoalUid, UserUid, RuleConditionUid, RuleActionUid } from "./types";
|
|
5
|
+
import { ConditionType, ConditionSettingsType } from "./conditions";
|
|
6
|
+
import { ActionType, ActionSettingsType } from "./actions";
|
|
7
|
+
export interface ExperimentRuleCondition {
|
|
8
|
+
/** Unique identifier of the rule condition */
|
|
9
|
+
id: RuleConditionUid;
|
|
10
|
+
/** Together with other conditions’ indices, defines the order in which the conditions are matched in the rule. Set automatically from the order of the conditions array */
|
|
11
|
+
index: number;
|
|
12
|
+
/** Defines whether the default or opposite match type shall be used */
|
|
13
|
+
is_opposite: boolean;
|
|
14
|
+
/** Type of the condition */
|
|
15
|
+
type: ConditionType;
|
|
16
|
+
/** The value related to the type. Required with most types */
|
|
17
|
+
value: string | null;
|
|
18
|
+
/** Other condition settings. Required with some condition types */
|
|
19
|
+
settings: ConditionSettingsType;
|
|
20
|
+
}
|
|
21
|
+
export interface ExperimentRuleConditionPayload {
|
|
22
|
+
/** Defines whether the default or opposite match type shall be used */
|
|
23
|
+
is_opposite?: boolean;
|
|
24
|
+
/** Type of the condition */
|
|
25
|
+
type: ConditionType;
|
|
26
|
+
/** The value related to the type. Required with most types */
|
|
27
|
+
value?: string | null;
|
|
28
|
+
/** Other condition settings. Required with some condition types */
|
|
29
|
+
settings?: ConditionSettingsType;
|
|
30
|
+
}
|
|
31
|
+
export interface ExperimentRule {
|
|
32
|
+
/** Unique identifier of the rule */
|
|
33
|
+
id: RuleUid;
|
|
34
|
+
/** Name of the rule */
|
|
35
|
+
name: string;
|
|
36
|
+
/** Organization that owns the rule */
|
|
37
|
+
organization: NestedOrganization;
|
|
38
|
+
/** Unique identifier of the organization that owns the rule */
|
|
39
|
+
organization_id: OrganizationUid;
|
|
40
|
+
/** Ordered list of conditions of the rule. The list order defines the matching order */
|
|
41
|
+
conditions: ExperimentRuleCondition[];
|
|
42
|
+
/** Ordered list of actions of the rule. The list order defines the execution order */
|
|
43
|
+
actions: RuleAction[];
|
|
44
|
+
/** A list of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
45
|
+
rooms: NestedRoom[];
|
|
46
|
+
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
47
|
+
room_ids: RoomUid[];
|
|
48
|
+
/** The goal set for the rule */
|
|
49
|
+
goal: NestedGoal;
|
|
50
|
+
/** Unique identifier of the goal set for the rule */
|
|
51
|
+
goal_id: GoalUid;
|
|
52
|
+
/** Type of the rule */
|
|
53
|
+
type: "experiment";
|
|
54
|
+
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
|
|
55
|
+
match_once_per: "session" | "page" | "visitor" | null;
|
|
56
|
+
/** Defines whether the rule was created automatically instead of being created from the Rule management UI */
|
|
57
|
+
is_auto_generated: boolean;
|
|
58
|
+
/** Defines whether the rule is protected and cannot be deleted */
|
|
59
|
+
is_protected: boolean;
|
|
60
|
+
/** Defines whether the rule is currently enabled */
|
|
61
|
+
is_enabled: boolean;
|
|
62
|
+
/** Defines whether the rule can be triggered in all of the organization’s rooms */
|
|
63
|
+
is_global: boolean;
|
|
64
|
+
/** Date when the rule was created */
|
|
65
|
+
created_at: string;
|
|
66
|
+
/** Date when the rule was changed for the last time */
|
|
67
|
+
updated_at: string;
|
|
68
|
+
/** User who created the rule*/
|
|
69
|
+
created_by_user: NestedUser;
|
|
70
|
+
/** Unique identifier of the user who created the rule */
|
|
71
|
+
created_by_user_id: UserUid;
|
|
72
|
+
/** User who changed the rule for the last time */
|
|
73
|
+
updated_by_user: NestedUser;
|
|
74
|
+
/** Unique identifier of the user who changed the rule for the last time */
|
|
75
|
+
updated_by_user_id: UserUid;
|
|
76
|
+
}
|
|
77
|
+
export interface ExperimentRulePayload {
|
|
78
|
+
/** Name of the rule */
|
|
79
|
+
name: string;
|
|
80
|
+
/** Ordered list of conditions of the rule. The list order defines the matching order */
|
|
81
|
+
conditions?: ExperimentRuleConditionPayload[];
|
|
82
|
+
/** Ordered list of actions of the rule. The list order defines the execution order */
|
|
83
|
+
actions: RuleActionPayload[];
|
|
84
|
+
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
85
|
+
room_ids?: RoomUid[];
|
|
86
|
+
/** Unique identifier of the goal set for the rule */
|
|
87
|
+
goal_id?: GoalUid;
|
|
88
|
+
/** Type of the rule */
|
|
89
|
+
type?: "experiment";
|
|
90
|
+
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
|
|
91
|
+
match_once_per?: "session" | "page" | "visitor" | null;
|
|
92
|
+
/** Defines whether the rule is currently enabled */
|
|
93
|
+
is_enabled?: boolean;
|
|
94
|
+
/** Defines whether the rule can be triggered in all of the organization’s rooms */
|
|
95
|
+
is_global?: boolean;
|
|
96
|
+
}
|
|
97
|
+
export interface RuleAction {
|
|
98
|
+
/** Unique identifier of the rule action */
|
|
99
|
+
id: RuleActionUid;
|
|
100
|
+
/** Together with other actions’ indices, defines the order in which the actions are executed in the rule. Set automatically from the order of the conditions array */
|
|
101
|
+
index: number;
|
|
102
|
+
/** Type of the action */
|
|
103
|
+
type: ActionType;
|
|
104
|
+
/** The value related to the type. Required with most types */
|
|
105
|
+
value: string | null;
|
|
106
|
+
/** Other action settings. Required with some action types */
|
|
107
|
+
settings: ActionSettingsType;
|
|
108
|
+
}
|
|
109
|
+
export interface RuleActionPayload {
|
|
110
|
+
/** Type of the action */
|
|
111
|
+
type: ActionType;
|
|
112
|
+
/** The value related to the type. Required with most types */
|
|
113
|
+
value?: string | null;
|
|
114
|
+
/** Other action settings. Required with some action types */
|
|
115
|
+
settings?: ActionSettingsType;
|
|
116
|
+
/** Order of the rule action */
|
|
117
|
+
index?: number;
|
|
118
|
+
}
|
|
119
|
+
export interface RuleCondition {
|
|
120
|
+
/** Unique identifier of the rule */
|
|
121
|
+
id: RuleConditionUid;
|
|
122
|
+
/** Together with other conditions’ indices, defines the order in which the conditions are matched in the rule. Set automatically from the order of the conditions array */
|
|
123
|
+
index: number;
|
|
124
|
+
/** Defines whether the default or opposite match type shall be used */
|
|
125
|
+
is_opposite: boolean;
|
|
126
|
+
/** Type of the condition */
|
|
127
|
+
type: ConditionType;
|
|
128
|
+
/** The value related to the type. Required with most types */
|
|
129
|
+
value: string | null;
|
|
130
|
+
/** Other condition settings. Required with some condition types */
|
|
131
|
+
settings: ConditionSettingsType;
|
|
132
|
+
}
|
|
133
|
+
export interface RuleConditionPayload {
|
|
134
|
+
/** Defines whether the default or opposite match type shall be used */
|
|
135
|
+
is_opposite?: boolean;
|
|
136
|
+
/** Type of the condition */
|
|
137
|
+
type: ConditionType;
|
|
138
|
+
/** The value related to the type. Required with most types */
|
|
139
|
+
value?: string | null;
|
|
140
|
+
/** Other condition settings. Required with some condition types */
|
|
141
|
+
settings?: ConditionSettingsType;
|
|
142
|
+
}
|
|
143
|
+
export interface Rule {
|
|
144
|
+
/** Unique identifier of the rule */
|
|
145
|
+
id: RuleUid;
|
|
146
|
+
/** Name of the rule */
|
|
147
|
+
name: string;
|
|
148
|
+
/** Organization that owns the rule */
|
|
149
|
+
organization: NestedOrganization;
|
|
150
|
+
/** Unique identifier of the organization that owns the rule */
|
|
151
|
+
organization_id: OrganizationUid;
|
|
152
|
+
/** Ordered list of conditions of the rule. The list order defines the matching order */
|
|
153
|
+
conditions: RuleCondition[];
|
|
154
|
+
/** Ordered list of actions of the rule. The list order defines the execution order */
|
|
155
|
+
actions: RuleAction[];
|
|
156
|
+
/** A list of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
157
|
+
rooms: NestedRoom[];
|
|
158
|
+
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
159
|
+
room_ids: RoomUid[];
|
|
160
|
+
/** The goal set for the rule */
|
|
161
|
+
goal: NestedGoal;
|
|
162
|
+
/** Unique identifier of the goal set for the rule */
|
|
163
|
+
goal_id: GoalUid;
|
|
164
|
+
/** Type of the rule */
|
|
165
|
+
type: "normal" | "target" | "experiment";
|
|
166
|
+
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
|
|
167
|
+
match_once_per: "session" | "page" | "visitor" | null;
|
|
168
|
+
/** Defines whether the rule was created automatically instead of being created from the rule management UI */
|
|
169
|
+
is_auto_generated: boolean;
|
|
170
|
+
/** Defines whether the rule is protected and cannot be deleted */
|
|
171
|
+
is_protected: boolean;
|
|
172
|
+
/** Defines whether the rule is currently enabled */
|
|
173
|
+
is_enabled: boolean;
|
|
174
|
+
/** Defines whether the rule can be triggered in all of the organization’s rooms */
|
|
175
|
+
is_global: boolean;
|
|
176
|
+
/** Date when the rule was created */
|
|
177
|
+
created_at: string;
|
|
178
|
+
/** Date when the rule was changed for the last time */
|
|
179
|
+
updated_at: string;
|
|
180
|
+
/** User who created the rule*/
|
|
181
|
+
created_by_user: NestedUser;
|
|
182
|
+
/** Unique identifier of the user who created the rule*/
|
|
183
|
+
created_by_user_id: UserUid;
|
|
184
|
+
/** User who changed the rule for the last time*/
|
|
185
|
+
updated_by_user: NestedUser;
|
|
186
|
+
/** Unique identifier of the user who changed the rule for the last time*/
|
|
187
|
+
updated_by_user_id: UserUid;
|
|
188
|
+
}
|
|
189
|
+
export interface RulePayload {
|
|
190
|
+
/** Name of the rule */
|
|
191
|
+
name: string;
|
|
192
|
+
/** Ordered list of conditions of the rule. The list order defines the matching order */
|
|
193
|
+
conditions?: RuleConditionPayload[];
|
|
194
|
+
/** Ordered list of actions of the rule. The list order defines the execution order */
|
|
195
|
+
actions: RuleActionPayload[];
|
|
196
|
+
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
197
|
+
room_ids?: RoomUid[];
|
|
198
|
+
/** Unique identifier of the goal set for the rule */
|
|
199
|
+
goal_id?: GoalUid;
|
|
200
|
+
/** Type of the rule */
|
|
201
|
+
type?: "normal" | "target";
|
|
202
|
+
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
|
|
203
|
+
match_once_per?: "session" | "page" | "visitor" | null;
|
|
204
|
+
/** Defines whether the rule is currently enabled */
|
|
205
|
+
is_enabled?: boolean;
|
|
206
|
+
/** Defines whether the rule can be triggered in all of the organization’s rooms */
|
|
207
|
+
is_global?: boolean;
|
|
208
|
+
}
|
|
209
|
+
export interface RuleUpdatePayload {
|
|
210
|
+
/** Name of the rule */
|
|
211
|
+
name?: string;
|
|
212
|
+
/** Ordered list of conditions of the rule. The list order defines the matching order */
|
|
213
|
+
conditions?: RuleConditionPayload[];
|
|
214
|
+
/** Ordered list of actions of the rule. The list order defines the execution order */
|
|
215
|
+
actions?: RuleActionPayload[];
|
|
216
|
+
/** A list of unique identifiers of rooms where the rule can be triggered. Can only be set if "is_global" is false */
|
|
217
|
+
room_ids?: RoomUid[];
|
|
218
|
+
/** Unique identifier of the goal set for the rule */
|
|
219
|
+
goal_id?: GoalUid;
|
|
220
|
+
/** Type of the rule */
|
|
221
|
+
type?: "normal" | "target";
|
|
222
|
+
/** How often the rule can match. By default is null and the rule can match every time the conditions change or the page is loaded */
|
|
223
|
+
match_once_per?: "session" | "page" | "visitor" | null;
|
|
224
|
+
/** Defines whether the rule is currently enabled */
|
|
225
|
+
is_enabled?: boolean;
|
|
226
|
+
/** Defines whether the rule can be triggered in all of the organization’s rooms */
|
|
227
|
+
is_global?: boolean;
|
|
228
|
+
}
|
|
229
|
+
//# sourceMappingURL=rules.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../src/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EACL,OAAO,EACP,eAAe,EACf,OAAO,EACP,OAAO,EACP,OAAO,EACP,gBAAgB,EAChB,aAAa,EACd,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAE3D,MAAM,WAAW,uBAAuB;IACtC,8CAA8C;IAC9C,EAAE,EAAE,gBAAgB,CAAC;IAErB,2KAA2K;IAC3K,KAAK,EAAE,MAAM,CAAC;IAEd,uEAAuE;IACvE,WAAW,EAAE,OAAO,CAAC;IAErB,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;IAEpB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,mEAAmE;IACnE,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAED,MAAM,WAAW,8BAA8B;IAC7C,uEAAuE;IACvE,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;IAEpB,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,cAAc;IAC7B,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,YAAY,EAAE,kBAAkB,CAAC;IAEjC,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;IAEjC,wFAAwF;IACxF,UAAU,EAAE,uBAAuB,EAAE,CAAC;IAEtC,sFAAsF;IACtF,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB,+FAA+F;IAC/F,KAAK,EAAE,UAAU,EAAE,CAAC;IAEpB,qHAAqH;IACrH,QAAQ,EAAE,OAAO,EAAE,CAAC;IAEpB,gCAAgC;IAChC,IAAI,EAAE,UAAU,CAAC;IAEjB,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAC;IAEjB,uBAAuB;IACvB,IAAI,EAAE,YAAY,CAAC;IAEnB,qIAAqI;IACrI,cAAc,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEtD,8GAA8G;IAC9G,iBAAiB,EAAE,OAAO,CAAC;IAE3B,kEAAkE;IAClE,YAAY,EAAE,OAAO,CAAC;IAEtB,oDAAoD;IACpD,UAAU,EAAE,OAAO,CAAC;IAEpB,mFAAmF;IACnF,SAAS,EAAE,OAAO,CAAC;IAEnB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IAEnB,+BAA+B;IAC/B,eAAe,EAAE,UAAU,CAAC;IAE5B,yDAAyD;IACzD,kBAAkB,EAAE,OAAO,CAAC;IAE5B,kDAAkD;IAClD,eAAe,EAAE,UAAU,CAAC;IAE5B,2EAA2E;IAC3E,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,wFAAwF;IACxF,UAAU,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAE9C,sFAAsF;IACtF,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAE7B,qHAAqH;IACrH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IAErB,qDAAqD;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,uBAAuB;IACvB,IAAI,CAAC,EAAE,YAAY,CAAC;IAEpB,qIAAqI;IACrI,cAAc,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEvD,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mFAAmF;IACnF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB,2CAA2C;IAC3C,EAAE,EAAE,aAAa,CAAC;IAElB,sKAAsK;IACtK,KAAK,EAAE,MAAM,CAAC;IAEd,yBAAyB;IACzB,IAAI,EAAE,UAAU,CAAC;IAEjB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,6DAA6D;IAC7D,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB;IAChC,yBAAyB;IACzB,IAAI,EAAE,UAAU,CAAC;IAEjB,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAE9B,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,oCAAoC;IACpC,EAAE,EAAE,gBAAgB,CAAC;IAErB,2KAA2K;IAC3K,KAAK,EAAE,MAAM,CAAC;IAEd,uEAAuE;IACvE,WAAW,EAAE,OAAO,CAAC;IAErB,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;IAEpB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,mEAAmE;IACnE,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,uEAAuE;IACvE,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,4BAA4B;IAC5B,IAAI,EAAE,aAAa,CAAC;IAEpB,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,IAAI;IACnB,oCAAoC;IACpC,EAAE,EAAE,OAAO,CAAC;IAEZ,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,sCAAsC;IACtC,YAAY,EAAE,kBAAkB,CAAC;IAEjC,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;IAEjC,wFAAwF;IACxF,UAAU,EAAE,aAAa,EAAE,CAAC;IAE5B,sFAAsF;IACtF,OAAO,EAAE,UAAU,EAAE,CAAC;IAEtB,+FAA+F;IAC/F,KAAK,EAAE,UAAU,EAAE,CAAC;IAEpB,qHAAqH;IACrH,QAAQ,EAAE,OAAO,EAAE,CAAC;IAEpB,gCAAgC;IAChC,IAAI,EAAE,UAAU,CAAC;IAEjB,qDAAqD;IACrD,OAAO,EAAE,OAAO,CAAC;IAEjB,uBAAuB;IACvB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,YAAY,CAAC;IAEzC,qIAAqI;IACrI,cAAc,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEtD,8GAA8G;IAC9G,iBAAiB,EAAE,OAAO,CAAC;IAE3B,kEAAkE;IAClE,YAAY,EAAE,OAAO,CAAC;IAEtB,oDAAoD;IACpD,UAAU,EAAE,OAAO,CAAC;IAEpB,mFAAmF;IACnF,SAAS,EAAE,OAAO,CAAC;IAEnB,qCAAqC;IACrC,UAAU,EAAE,MAAM,CAAC;IAEnB,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IAEnB,+BAA+B;IAC/B,eAAe,EAAE,UAAU,CAAC;IAE5B,wDAAwD;IACxD,kBAAkB,EAAE,OAAO,CAAC;IAE5B,iDAAiD;IACjD,eAAe,EAAE,UAAU,CAAC;IAE5B,0EAA0E;IAC1E,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,wFAAwF;IACxF,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEpC,sFAAsF;IACtF,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAE7B,qHAAqH;IACrH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IAErB,qDAAqD;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,uBAAuB;IACvB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE3B,qIAAqI;IACrI,cAAc,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEvD,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mFAAmF;IACnF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,wFAAwF;IACxF,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEpC,sFAAsF;IACtF,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAE9B,qHAAqH;IACrH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IAErB,qDAAqD;IACrD,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,uBAAuB;IACvB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE3B,qIAAqI;IACrI,cAAc,CAAC,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAEvD,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mFAAmF;IACnF,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB"}
|
package/lib/cjs/rules.js
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
import { NestedGiosgApp } from "./apps";
|
|
2
|
+
import { NestedOrganization, NestedUser } from "./customer";
|
|
3
|
+
import { NestedRoom } from "./rooms";
|
|
4
|
+
import { OrganizationUid, AppShareUid, RoomShareUid, RoomUid, UserUid, RouterUid, TeamShareUid, TeamUid } from "./types";
|
|
5
|
+
import { Router } from "./routers";
|
|
6
|
+
import { NestedTeam, NestedIncomingSharedTeam } from "./teams";
|
|
7
|
+
/** TODO: Add jsdocs and check nullability of fields */
|
|
8
|
+
export interface AppShare {
|
|
9
|
+
id: AppShareUid;
|
|
10
|
+
organization_id: OrganizationUid;
|
|
11
|
+
organization: NestedOrganization;
|
|
12
|
+
app_id: string;
|
|
13
|
+
app: NestedGiosgApp;
|
|
14
|
+
app_organization_id: OrganizationUid;
|
|
15
|
+
app_organization: NestedOrganization;
|
|
16
|
+
created_at: string;
|
|
17
|
+
updated_at: string;
|
|
18
|
+
created_by_user_id: string;
|
|
19
|
+
created_by_user: NestedUser;
|
|
20
|
+
updated_by_user_id: string;
|
|
21
|
+
updated_by_user: NestedUser;
|
|
22
|
+
}
|
|
23
|
+
export interface AppSharePayload {
|
|
24
|
+
organization_id: OrganizationUid;
|
|
25
|
+
}
|
|
26
|
+
interface RoomShare {
|
|
27
|
+
/** Unique identifier for the share resource. */
|
|
28
|
+
id: RoomShareUid;
|
|
29
|
+
/** ID of the partner organization to whom the room resource is shared. Must be an existing partner. Cannot be changed after creation. */
|
|
30
|
+
organization_id: OrganizationUid;
|
|
31
|
+
/** The organization object to whom the room resource was shared. */
|
|
32
|
+
organization: NestedOrganization;
|
|
33
|
+
/** ID of the organization who shared the room resource. */
|
|
34
|
+
room_organization_id: OrganizationUid;
|
|
35
|
+
/** The organization object who shared the room resource. */
|
|
36
|
+
room_organization: NestedOrganization;
|
|
37
|
+
/** ID of the room resource. */
|
|
38
|
+
room_id: RoomUid;
|
|
39
|
+
/** The room object. */
|
|
40
|
+
room: NestedRoom;
|
|
41
|
+
/** When the room resource was shared. */
|
|
42
|
+
created_at: string;
|
|
43
|
+
/** When was the last time the sharing was updated. This cannot change currently after creation. */
|
|
44
|
+
updated_at: string;
|
|
45
|
+
/** ID of the user who shared the room resource. */
|
|
46
|
+
created_by_user_id: UserUid;
|
|
47
|
+
/** The user resource who shared the room resource, with all of the available attributes. */
|
|
48
|
+
created_by_user: NestedUser;
|
|
49
|
+
/** ID of the last user which updated this room share resource. */
|
|
50
|
+
updated_by_user_id: UserUid;
|
|
51
|
+
/** Last user which updated this room share resource. This cannot change currently after creation. */
|
|
52
|
+
updated_by_user: NestedUser;
|
|
53
|
+
}
|
|
54
|
+
export declare type RoomSharePayload = Pick<RoomShare, "organization_id" | "room_id">;
|
|
55
|
+
export interface OutgoingRoomShare extends RoomShare {
|
|
56
|
+
/** The router resource which is set to this room resource by the organization for whom the room is shared to. */
|
|
57
|
+
organization_router: {
|
|
58
|
+
/** The ID of the router resource. */
|
|
59
|
+
id: RouterUid;
|
|
60
|
+
};
|
|
61
|
+
/** The router resource which is set to this room resource by the room owner organization. */
|
|
62
|
+
room_organization_router: Router;
|
|
63
|
+
}
|
|
64
|
+
export interface IncomingRoomShare extends RoomShare {
|
|
65
|
+
/** The router resource which is set to this room resource by the organization for whom the room is shared to. */
|
|
66
|
+
organization_router: Router;
|
|
67
|
+
/** The router resource which is set to this room resource by the room owner organization. */
|
|
68
|
+
room_organization_router: {
|
|
69
|
+
/** The ID of the router resource. */
|
|
70
|
+
id: RouterUid;
|
|
71
|
+
/** Defines whether the router resource is routing tasks to the organization for whom the room is shared to. */
|
|
72
|
+
is_routing_to_receiver_organization: boolean;
|
|
73
|
+
};
|
|
74
|
+
}
|
|
75
|
+
interface TeamShare {
|
|
76
|
+
/** Unique identifier for the shared resource. */
|
|
77
|
+
id: TeamShareUid;
|
|
78
|
+
/** ID of the partner organization to whom the team resource is shared. Must be an existing partner. Cannot be changed after creation. */
|
|
79
|
+
organization_id: OrganizationUid;
|
|
80
|
+
/** The organization object to whom the team resource was shared. */
|
|
81
|
+
organization: NestedOrganization;
|
|
82
|
+
/** ID of the organization who shared the team resource. */
|
|
83
|
+
team_organization_id: OrganizationUid;
|
|
84
|
+
/** The organization object who shared the team resource. */
|
|
85
|
+
team_organization: NestedOrganization;
|
|
86
|
+
/** ID of the team resource. */
|
|
87
|
+
team_id: TeamUid;
|
|
88
|
+
/** When the team resource was shared. */
|
|
89
|
+
created_at: string;
|
|
90
|
+
/** When was the last time the sharing was updated. This cannot change currently after creation. */
|
|
91
|
+
updated_at: string;
|
|
92
|
+
/** ID of the user who shared the team resource. */
|
|
93
|
+
created_by_user_id: UserUid;
|
|
94
|
+
/** The user resource who shared the team resource, with all of the available attributes. */
|
|
95
|
+
created_by_user: NestedUser;
|
|
96
|
+
/** ID of the last user which updated this team share resource. */
|
|
97
|
+
updated_by_user_id: UserUid;
|
|
98
|
+
/** Last user which updated this team share resource. This cannot change currently after creation. */
|
|
99
|
+
updated_by_user: NestedUser;
|
|
100
|
+
}
|
|
101
|
+
export interface IncomingTeamShare extends TeamShare {
|
|
102
|
+
/** The team object. */
|
|
103
|
+
team: NestedIncomingSharedTeam;
|
|
104
|
+
}
|
|
105
|
+
export interface OutgoingTeamShare extends TeamShare {
|
|
106
|
+
/** The team object. */
|
|
107
|
+
team: NestedTeam;
|
|
108
|
+
}
|
|
109
|
+
export declare type TeamSharePayload = Pick<TeamShare, "organization_id" | "team_id">;
|
|
110
|
+
export {};
|
|
111
|
+
//# sourceMappingURL=sharing.d.ts.map
|