@d19n/youfibre-odin-sdk 2.0.63 → 2.0.65

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.
@@ -21,10 +21,18 @@ export interface CreateUserMessage extends OdinRecordCreatedEvent<CreateUserDto,
21
21
  /**
22
22
  * Properties for CreateUser action
23
23
  *
24
- * @property Required fields: 0
24
+ * @property Required fields: 1
25
25
  * @property Optional fields: 13
26
26
  */
27
27
  export interface CreateUserProperties {
28
+ /**
29
+ * UserId
30
+ *
31
+ * the id of the user in the organizations_users_table (IT Security - User)
32
+ * @type {UUID}
33
+ * @required
34
+ */
35
+ UserId: string;
28
36
  /**
29
37
  * TwilioWorkerStatus
30
38
  *
@@ -22,23 +22,37 @@ export interface UpdateUserMessage extends OdinRecordUpdatedEvent<UpdateUserDto,
22
22
  * Properties for UpdateUser action
23
23
  *
24
24
  * @property Required fields: 0
25
- * @property Optional fields: 12
25
+ * @property Optional fields: 19
26
26
  */
27
27
  export interface UpdateUserProperties {
28
28
  /**
29
- * UseResponseId
29
+ * FullName
30
30
  *
31
- * use response Id (IT Security - User)
32
- * @type {NUMBER}
31
+ * FullName used as
32
+ * @type {TEXT}
33
33
  */
34
- UseResponseId?: number | null;
34
+ FullName?: string | null;
35
35
  /**
36
- * AircallId
36
+ * EmailAddress
37
37
  *
38
- * the ID of the user in Air call (IT Security - User)
38
+ * email address (IT Security - User)
39
+ * @type {TEXT}
40
+ */
41
+ EmailAddress?: string | null;
42
+ /**
43
+ * TwilioWorkerStatus
44
+ *
45
+ * TwilioWorkerStatus (IT Security - User)
46
+ * @type {TEXT}
47
+ */
48
+ TwilioWorkerStatus?: string | null;
49
+ /**
50
+ * UseResponseId
51
+ *
52
+ * use response Id (IT Security - User)
39
53
  * @type {NUMBER}
40
54
  */
41
- AircallId?: number | null;
55
+ UseResponseId?: number | null;
42
56
  /**
43
57
  * StartingAddress
44
58
  *
@@ -46,13 +60,6 @@ export interface UpdateUserProperties {
46
60
  * @type {LOOKUP}
47
61
  */
48
62
  StartingAddress?: string | null;
49
- /**
50
- * TeamId
51
- *
52
- * Reference identifier for User relationships. Used for data integrity.
53
- * @type {LOOKUP}
54
- */
55
- TeamId?: string | null;
56
63
  /**
57
64
  * JobTitle
58
65
  *
@@ -61,12 +68,19 @@ export interface UpdateUserProperties {
61
68
  */
62
69
  JobTitle?: string | null;
63
70
  /**
64
- * WorkingArea
71
+ * SalesRegion
65
72
  *
66
- * The working area is aligned with an (EX polygon ID) (IT Security - User)
73
+ * the sales region the user works in (IT Security - User)
74
+ * @type {TEXT}
75
+ */
76
+ SalesRegion?: string | null;
77
+ /**
78
+ * AircallId
79
+ *
80
+ * the ID of the user in Air call (IT Security - User)
67
81
  * @type {NUMBER}
68
82
  */
69
- WorkingArea?: number | null;
83
+ AircallId?: number | null;
70
84
  /**
71
85
  * Accredited
72
86
  *
@@ -75,26 +89,54 @@ export interface UpdateUserProperties {
75
89
  */
76
90
  Accredited?: string | null;
77
91
  /**
78
- * Team
92
+ * Employment
79
93
  *
80
- * the team name (IT Security - User)
94
+ * full-time or part-time (IT Security - User)
81
95
  * @type {TEXT}
82
96
  */
83
- Team?: string | null;
97
+ Employment?: string | null;
84
98
  /**
85
- * TwilioSid
99
+ * SalesChannel
86
100
  *
87
- * Reference identifier for User relationships. Used for data integrity.
101
+ * the sales channel the user sells under (IT Security - User)
88
102
  * @type {TEXT}
89
103
  */
90
- TwilioSid?: string | null;
104
+ SalesChannel?: string | null;
91
105
  /**
92
- * TwilioWorkerStatus
106
+ * CompanyName
93
107
  *
94
- * TwilioWorkerStatus (IT Security - User)
108
+ * the company the user is works for (IT Security - User)
95
109
  * @type {TEXT}
96
110
  */
97
- TwilioWorkerStatus?: string | null;
111
+ CompanyName?: string | null;
112
+ /**
113
+ * SalesTerritory
114
+ *
115
+ * the sales territory the user works in (IT Security - User)
116
+ * @type {TEXT}
117
+ */
118
+ SalesTerritory?: string | null;
119
+ /**
120
+ * TeamId
121
+ *
122
+ * Reference identifier for User relationships. Used for data integrity.
123
+ * @type {LOOKUP}
124
+ */
125
+ TeamId?: string | null;
126
+ /**
127
+ * WorkingArea
128
+ *
129
+ * The working area is aligned with an (EX polygon ID) (IT Security - User)
130
+ * @type {NUMBER}
131
+ */
132
+ WorkingArea?: number | null;
133
+ /**
134
+ * ReportsTo
135
+ *
136
+ * The person this user reports to (IT Security - User)
137
+ * @type {TEXT}
138
+ */
139
+ ReportsTo?: string | null;
98
140
  /**
99
141
  * TwilioWorker
100
142
  *
@@ -103,12 +145,19 @@ export interface UpdateUserProperties {
103
145
  */
104
146
  TwilioWorker?: boolean | null;
105
147
  /**
106
- * email address
148
+ * Team
107
149
  *
108
- * email address (IT Security - User)
150
+ * the team name (IT Security - User)
109
151
  * @type {TEXT}
110
152
  */
111
- EmailAddress?: string | null;
153
+ Team?: string | null;
154
+ /**
155
+ * TwilioSid
156
+ *
157
+ * Reference identifier for User relationships. Used for data integrity.
158
+ * @type {TEXT}
159
+ */
160
+ TwilioSid?: string | null;
112
161
  }
113
162
  /**
114
163
  * UpdateUser
@@ -65,28 +65,18 @@ export declare enum UserPropertyKeys {
65
65
  Team = "Team",
66
66
  /** TwilioWorker (IT Security - User) */
67
67
  TwilioWorker = "TwilioWorker",
68
- /** the id of the user in the organizations_users_table (IT Security - User) */
69
- UserId = "UserId",
70
- /** The person this user reports to (IT Security - User) */
71
- ReportsTo = "ReportsTo",
72
68
  /** The working area is aligned with an (EX polygon ID) (IT Security - User) */
73
69
  WorkingArea = "WorkingArea",
74
70
  /** Reference identifier for User relationships. Used for data integrity. */
75
71
  TeamId = "TeamId",
72
+ /** The person this user reports to (IT Security - User) */
73
+ ReportsTo = "ReportsTo",
76
74
  /** the sales territory the user works in (IT Security - User) */
77
75
  SalesTerritory = "SalesTerritory",
78
- /** the company the user is works for (IT Security - User) */
79
- CompanyName = "CompanyName",
80
- /** the sales channel the user sells under (IT Security - User) */
81
- SalesChannel = "SalesChannel",
82
- /** full-time or part-time (IT Security - User) */
83
- Employment = "Employment",
84
76
  /** Can they climb a ladder ? (IT Security - User) */
85
77
  Accredited = "Accredited",
86
78
  /** the ID of the user in Air call (IT Security - User) */
87
79
  AircallId = "AircallId",
88
- /** the sales region the user works in (IT Security - User) */
89
- SalesRegion = "SalesRegion",
90
80
  /** the users job title (IT Security - User) */
91
81
  JobTitle = "JobTitle",
92
82
  /** the address the user is starting their day from (IT Security - User) */
@@ -97,8 +87,18 @@ export declare enum UserPropertyKeys {
97
87
  TwilioWorkerStatus = "TwilioWorkerStatus",
98
88
  /** FullName used as */
99
89
  FullName = "FullName",
90
+ /** the sales channel the user sells under (IT Security - User) */
91
+ SalesChannel = "SalesChannel",
92
+ /** full-time or part-time (IT Security - User) */
93
+ Employment = "Employment",
100
94
  /** email address (IT Security - User) */
101
- EmailAddress = "EmailAddress"
95
+ EmailAddress = "EmailAddress",
96
+ /** the company the user is works for (IT Security - User) */
97
+ CompanyName = "CompanyName",
98
+ /** the sales region the user works in (IT Security - User) */
99
+ SalesRegion = "SalesRegion",
100
+ /** the id of the user in the organizations_users_table (IT Security - User) */
101
+ UserId = "UserId"
102
102
  }
103
103
  /**
104
104
  * Properties for User records
@@ -128,18 +128,6 @@ export interface UserProperties {
128
128
  * @type {BOOLEAN}
129
129
  */
130
130
  TwilioWorker: boolean;
131
- /** the id of the user in the organizations_users_table (IT Security - User)
132
- *
133
- * @type {UUID}
134
- * @hidden This field is hidden in the UI
135
- */
136
- UserId: string;
137
- /** The person this user reports to (IT Security - User)
138
- *
139
- * @type {TEXT}
140
- * @hidden This field is hidden in the UI
141
- */
142
- ReportsTo: string;
143
131
  /** The working area is aligned with an (EX polygon ID) (IT Security - User)
144
132
  *
145
133
  * @type {NUMBER}
@@ -150,30 +138,16 @@ export interface UserProperties {
150
138
  * @type {LOOKUP}
151
139
  */
152
140
  TeamId: string;
153
- /** the sales territory the user works in (IT Security - User)
154
- *
155
- * @type {TEXT}
156
- * @hidden This field is hidden in the UI
157
- */
158
- SalesTerritory: string;
159
- /** the company the user is works for (IT Security - User)
160
- *
161
- * @type {TEXT}
162
- * @hidden This field is hidden in the UI
163
- */
164
- CompanyName: string;
165
- /** the sales channel the user sells under (IT Security - User)
141
+ /** The person this user reports to (IT Security - User)
166
142
  *
167
143
  * @type {TEXT}
168
- * @hidden This field is hidden in the UI
169
144
  */
170
- SalesChannel: string;
171
- /** full-time or part-time (IT Security - User)
145
+ ReportsTo: string;
146
+ /** the sales territory the user works in (IT Security - User)
172
147
  *
173
148
  * @type {TEXT}
174
- * @hidden This field is hidden in the UI
175
149
  */
176
- Employment: string;
150
+ SalesTerritory: string;
177
151
  /** Can they climb a ladder ? (IT Security - User)
178
152
  *
179
153
  * @type {ENUM}
@@ -185,12 +159,6 @@ export interface UserProperties {
185
159
  * @type {NUMBER}
186
160
  */
187
161
  AircallId: number;
188
- /** the sales region the user works in (IT Security - User)
189
- *
190
- * @type {TEXT}
191
- * @hidden This field is hidden in the UI
192
- */
193
- SalesRegion: string;
194
162
  /** the users job title (IT Security - User)
195
163
  *
196
164
  * @type {TEXT}
@@ -216,12 +184,37 @@ export interface UserProperties {
216
184
  * @type {TEXT}
217
185
  */
218
186
  FullName: string;
187
+ /** the sales channel the user sells under (IT Security - User)
188
+ *
189
+ * @type {TEXT}
190
+ */
191
+ SalesChannel: string;
192
+ /** full-time or part-time (IT Security - User)
193
+ *
194
+ * @type {TEXT}
195
+ */
196
+ Employment: string;
219
197
  /** email address (IT Security - User)
220
198
  *
221
199
  * @type {TEXT}
222
200
  * @pii This field contains personally identifiable information
223
201
  */
224
202
  EmailAddress: string;
203
+ /** the company the user is works for (IT Security - User)
204
+ *
205
+ * @type {TEXT}
206
+ */
207
+ CompanyName: string;
208
+ /** the sales region the user works in (IT Security - User)
209
+ *
210
+ * @type {TEXT}
211
+ */
212
+ SalesRegion: string;
213
+ /** the id of the user in the organizations_users_table (IT Security - User)
214
+ *
215
+ * @type {UUID}
216
+ */
217
+ UserId: string;
225
218
  }
226
219
  /**
227
220
  * User entity from IdentityModule
@@ -50,28 +50,18 @@ var UserPropertyKeys;
50
50
  UserPropertyKeys["Team"] = "Team";
51
51
  /** TwilioWorker (IT Security - User) */
52
52
  UserPropertyKeys["TwilioWorker"] = "TwilioWorker";
53
- /** the id of the user in the organizations_users_table (IT Security - User) */
54
- UserPropertyKeys["UserId"] = "UserId";
55
- /** The person this user reports to (IT Security - User) */
56
- UserPropertyKeys["ReportsTo"] = "ReportsTo";
57
53
  /** The working area is aligned with an (EX polygon ID) (IT Security - User) */
58
54
  UserPropertyKeys["WorkingArea"] = "WorkingArea";
59
55
  /** Reference identifier for User relationships. Used for data integrity. */
60
56
  UserPropertyKeys["TeamId"] = "TeamId";
57
+ /** The person this user reports to (IT Security - User) */
58
+ UserPropertyKeys["ReportsTo"] = "ReportsTo";
61
59
  /** the sales territory the user works in (IT Security - User) */
62
60
  UserPropertyKeys["SalesTerritory"] = "SalesTerritory";
63
- /** the company the user is works for (IT Security - User) */
64
- UserPropertyKeys["CompanyName"] = "CompanyName";
65
- /** the sales channel the user sells under (IT Security - User) */
66
- UserPropertyKeys["SalesChannel"] = "SalesChannel";
67
- /** full-time or part-time (IT Security - User) */
68
- UserPropertyKeys["Employment"] = "Employment";
69
61
  /** Can they climb a ladder ? (IT Security - User) */
70
62
  UserPropertyKeys["Accredited"] = "Accredited";
71
63
  /** the ID of the user in Air call (IT Security - User) */
72
64
  UserPropertyKeys["AircallId"] = "AircallId";
73
- /** the sales region the user works in (IT Security - User) */
74
- UserPropertyKeys["SalesRegion"] = "SalesRegion";
75
65
  /** the users job title (IT Security - User) */
76
66
  UserPropertyKeys["JobTitle"] = "JobTitle";
77
67
  /** the address the user is starting their day from (IT Security - User) */
@@ -82,8 +72,18 @@ var UserPropertyKeys;
82
72
  UserPropertyKeys["TwilioWorkerStatus"] = "TwilioWorkerStatus";
83
73
  /** FullName used as */
84
74
  UserPropertyKeys["FullName"] = "FullName";
75
+ /** the sales channel the user sells under (IT Security - User) */
76
+ UserPropertyKeys["SalesChannel"] = "SalesChannel";
77
+ /** full-time or part-time (IT Security - User) */
78
+ UserPropertyKeys["Employment"] = "Employment";
85
79
  /** email address (IT Security - User) */
86
80
  UserPropertyKeys["EmailAddress"] = "EmailAddress";
81
+ /** the company the user is works for (IT Security - User) */
82
+ UserPropertyKeys["CompanyName"] = "CompanyName";
83
+ /** the sales region the user works in (IT Security - User) */
84
+ UserPropertyKeys["SalesRegion"] = "SalesRegion";
85
+ /** the id of the user in the organizations_users_table (IT Security - User) */
86
+ UserPropertyKeys["UserId"] = "UserId";
87
87
  })(UserPropertyKeys = exports.UserPropertyKeys || (exports.UserPropertyKeys = {}));
88
88
  /**
89
89
  * User entity from IdentityModule
@@ -495,7 +495,7 @@ export declare class UserRecord<TProps = UserProperties> {
495
495
  * const payload = record.createUser({ ... }).dryRun();
496
496
  * ```
497
497
  */
498
- createUser(properties?: CreateUserProperties, options?: {
498
+ createUser(properties: CreateUserProperties, options?: {
499
499
  type?: string;
500
500
  journeyId?: string;
501
501
  stageKey?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.63",
3
+ "version": "2.0.65",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",