@kernelminds/scailo-sdk 0.1.1 → 0.1.3
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/cjs/index.js +34 -0
- package/lib/cjs/permissions.js +13 -10
- package/lib/cjs/src/forms_fields.scailo_pb.js +45 -24
- package/lib/cjs/src/transactional_emails.scailo_connect.js +132 -0
- package/lib/cjs/src/transactional_emails.scailo_pb.js +948 -0
- package/lib/cjs/types/index.d.ts +31 -0
- package/lib/cjs/types/index.d.ts.map +1 -1
- package/lib/cjs/types/permissions.d.ts +15 -0
- package/lib/cjs/types/permissions.d.ts.map +1 -1
- package/lib/cjs/types/src/forms_fields.scailo_pb.d.ts +36 -18
- package/lib/cjs/types/src/forms_fields.scailo_pb.d.ts.map +1 -1
- package/lib/cjs/types/src/transactional_emails.scailo_connect.d.ts +126 -0
- package/lib/cjs/types/src/transactional_emails.scailo_connect.d.ts.map +1 -0
- package/lib/cjs/types/src/transactional_emails.scailo_pb.d.ts +698 -0
- package/lib/cjs/types/src/transactional_emails.scailo_pb.d.ts.map +1 -0
- package/lib/esm/index.js +34 -0
- package/lib/esm/permissions.js +13 -10
- package/lib/esm/src/forms_fields.scailo_pb.js +45 -24
- package/lib/esm/src/transactional_emails.scailo_connect.js +132 -0
- package/lib/esm/src/transactional_emails.scailo_pb.js +966 -0
- package/lib/esm/types/index.d.ts +31 -0
- package/lib/esm/types/index.d.ts.map +1 -1
- package/lib/esm/types/permissions.d.ts +15 -0
- package/lib/esm/types/permissions.d.ts.map +1 -1
- package/lib/esm/types/src/forms_fields.scailo_pb.d.ts +36 -18
- package/lib/esm/types/src/forms_fields.scailo_pb.d.ts.map +1 -1
- package/lib/esm/types/src/transactional_emails.scailo_connect.d.ts +126 -0
- package/lib/esm/types/src/transactional_emails.scailo_connect.d.ts.map +1 -0
- package/lib/esm/types/src/transactional_emails.scailo_pb.d.ts +698 -0
- package/lib/esm/types/src/transactional_emails.scailo_pb.d.ts.map +1 -0
- package/package.json +1 -1
|
@@ -0,0 +1,698 @@
|
|
|
1
|
+
import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
|
|
2
|
+
import { Message, proto3 } from "@bufbuild/protobuf";
|
|
3
|
+
import { BOOL_FILTER, EmployeeMetadata, SORT_ORDER } from "./base.scailo_pb.js";
|
|
4
|
+
/**
|
|
5
|
+
*
|
|
6
|
+
* Describes the available sort keys for retrieving transactional emails
|
|
7
|
+
*
|
|
8
|
+
* @generated from enum Scailo.TRANSACTIONAL_EMAIL_SORT_KEY
|
|
9
|
+
*/
|
|
10
|
+
export declare enum TRANSACTIONAL_EMAIL_SORT_KEY {
|
|
11
|
+
/**
|
|
12
|
+
* Fetch ordered results by id
|
|
13
|
+
*
|
|
14
|
+
* @generated from enum value: TRANSACTIONAL_EMAIL_SORT_KEY_ID_UNSPECIFIED = 0;
|
|
15
|
+
*/
|
|
16
|
+
TRANSACTIONAL_EMAIL_SORT_KEY_ID_UNSPECIFIED = 0,
|
|
17
|
+
/**
|
|
18
|
+
* Fetch ordered results by the creation timestamp
|
|
19
|
+
*
|
|
20
|
+
* @generated from enum value: TRANSACTIONAL_EMAIL_SORT_KEY_CREATED_AT = 1;
|
|
21
|
+
*/
|
|
22
|
+
TRANSACTIONAL_EMAIL_SORT_KEY_CREATED_AT = 1,
|
|
23
|
+
/**
|
|
24
|
+
* Fetch ordered results by the modified timestamp
|
|
25
|
+
*
|
|
26
|
+
* @generated from enum value: TRANSACTIONAL_EMAIL_SORT_KEY_MODIFIED_AT = 2;
|
|
27
|
+
*/
|
|
28
|
+
TRANSACTIONAL_EMAIL_SORT_KEY_MODIFIED_AT = 2
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* Describes the necessary data structure during creation of a transactional email
|
|
33
|
+
*
|
|
34
|
+
* @generated from message Scailo.TransactionalEmailsServiceCreateRequest
|
|
35
|
+
*/
|
|
36
|
+
export declare class TransactionalEmailsServiceCreateRequest extends Message<TransactionalEmailsServiceCreateRequest> {
|
|
37
|
+
/**
|
|
38
|
+
* Stores a globally unique entity UUID. This will be set at the organization level
|
|
39
|
+
*
|
|
40
|
+
* @generated from field: string entity_uuid = 1;
|
|
41
|
+
*/
|
|
42
|
+
entityUuid: string;
|
|
43
|
+
/**
|
|
44
|
+
* Stores any comment that the user might add during this operation
|
|
45
|
+
*
|
|
46
|
+
* @generated from field: string user_comment = 2;
|
|
47
|
+
*/
|
|
48
|
+
userComment: string;
|
|
49
|
+
/**
|
|
50
|
+
* Stores the name of the sender
|
|
51
|
+
*
|
|
52
|
+
* @generated from field: string sender_name = 10;
|
|
53
|
+
*/
|
|
54
|
+
senderName: string;
|
|
55
|
+
/**
|
|
56
|
+
* Stores the title of the transactional email
|
|
57
|
+
*
|
|
58
|
+
* @generated from field: string title = 11;
|
|
59
|
+
*/
|
|
60
|
+
title: string;
|
|
61
|
+
/**
|
|
62
|
+
* Stores the email address to which the reply could be sent
|
|
63
|
+
*
|
|
64
|
+
* @generated from field: string reply_to = 12;
|
|
65
|
+
*/
|
|
66
|
+
replyTo: string;
|
|
67
|
+
/**
|
|
68
|
+
* Stores the subject of the transactional email
|
|
69
|
+
*
|
|
70
|
+
* @generated from field: string subject = 13;
|
|
71
|
+
*/
|
|
72
|
+
subject: string;
|
|
73
|
+
/**
|
|
74
|
+
* Stores the content of the transactional email
|
|
75
|
+
*
|
|
76
|
+
* @generated from field: string content = 14;
|
|
77
|
+
*/
|
|
78
|
+
content: string;
|
|
79
|
+
/**
|
|
80
|
+
* The list of recipients
|
|
81
|
+
*
|
|
82
|
+
* @generated from field: repeated Scailo.TransactionalEmailsServiceAddRecipientRequest recipients = 30;
|
|
83
|
+
*/
|
|
84
|
+
recipients: TransactionalEmailsServiceAddRecipientRequest[];
|
|
85
|
+
/**
|
|
86
|
+
* The list of attachments
|
|
87
|
+
*
|
|
88
|
+
* @generated from field: repeated Scailo.TransactionalEmailsServiceAddAttachmentRequest attachments = 40;
|
|
89
|
+
*/
|
|
90
|
+
attachments: TransactionalEmailsServiceAddAttachmentRequest[];
|
|
91
|
+
constructor(data?: PartialMessage<TransactionalEmailsServiceCreateRequest>);
|
|
92
|
+
static readonly runtime: typeof proto3;
|
|
93
|
+
static readonly typeName = "Scailo.TransactionalEmailsServiceCreateRequest";
|
|
94
|
+
static readonly fields: FieldList;
|
|
95
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServiceCreateRequest;
|
|
96
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceCreateRequest;
|
|
97
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceCreateRequest;
|
|
98
|
+
static equals(a: TransactionalEmailsServiceCreateRequest | PlainMessage<TransactionalEmailsServiceCreateRequest> | undefined, b: TransactionalEmailsServiceCreateRequest | PlainMessage<TransactionalEmailsServiceCreateRequest> | undefined): boolean;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
* Describes the data structure of each transactional email on the platform
|
|
103
|
+
*
|
|
104
|
+
* @generated from message Scailo.TransactionalEmail
|
|
105
|
+
*/
|
|
106
|
+
export declare class TransactionalEmail extends Message<TransactionalEmail> {
|
|
107
|
+
/**
|
|
108
|
+
* Stores a globally unique entity UUID. This will be set at the organization level
|
|
109
|
+
*
|
|
110
|
+
* @generated from field: string entity_uuid = 1;
|
|
111
|
+
*/
|
|
112
|
+
entityUuid: string;
|
|
113
|
+
/**
|
|
114
|
+
* Stores the metadata of this resource
|
|
115
|
+
*
|
|
116
|
+
* @generated from field: Scailo.EmployeeMetadata metadata = 2;
|
|
117
|
+
*/
|
|
118
|
+
metadata?: EmployeeMetadata;
|
|
119
|
+
/**
|
|
120
|
+
* Stores the name of the sender
|
|
121
|
+
*
|
|
122
|
+
* @generated from field: string sender_name = 10;
|
|
123
|
+
*/
|
|
124
|
+
senderName: string;
|
|
125
|
+
/**
|
|
126
|
+
* Stores the title of the transactional email
|
|
127
|
+
*
|
|
128
|
+
* @generated from field: string title = 11;
|
|
129
|
+
*/
|
|
130
|
+
title: string;
|
|
131
|
+
/**
|
|
132
|
+
* Stores the email address to which the reply could be sent
|
|
133
|
+
*
|
|
134
|
+
* @generated from field: string reply_to = 12;
|
|
135
|
+
*/
|
|
136
|
+
replyTo: string;
|
|
137
|
+
/**
|
|
138
|
+
* Stores the subject of the transactional email
|
|
139
|
+
*
|
|
140
|
+
* @generated from field: string subject = 13;
|
|
141
|
+
*/
|
|
142
|
+
subject: string;
|
|
143
|
+
/**
|
|
144
|
+
* Stores the content of the transactional email
|
|
145
|
+
*
|
|
146
|
+
* @generated from field: string content = 14;
|
|
147
|
+
*/
|
|
148
|
+
content: string;
|
|
149
|
+
/**
|
|
150
|
+
* Stores the tracking URL of the transactional email
|
|
151
|
+
*
|
|
152
|
+
* @generated from field: string tracking_url = 20;
|
|
153
|
+
*/
|
|
154
|
+
trackingUrl: string;
|
|
155
|
+
constructor(data?: PartialMessage<TransactionalEmail>);
|
|
156
|
+
static readonly runtime: typeof proto3;
|
|
157
|
+
static readonly typeName = "Scailo.TransactionalEmail";
|
|
158
|
+
static readonly fields: FieldList;
|
|
159
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmail;
|
|
160
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmail;
|
|
161
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmail;
|
|
162
|
+
static equals(a: TransactionalEmail | PlainMessage<TransactionalEmail> | undefined, b: TransactionalEmail | PlainMessage<TransactionalEmail> | undefined): boolean;
|
|
163
|
+
}
|
|
164
|
+
/**
|
|
165
|
+
*
|
|
166
|
+
* Describes the data structure that stores a list of transactional emails
|
|
167
|
+
*
|
|
168
|
+
* @generated from message Scailo.TransactionalEmailsList
|
|
169
|
+
*/
|
|
170
|
+
export declare class TransactionalEmailsList extends Message<TransactionalEmailsList> {
|
|
171
|
+
/**
|
|
172
|
+
* List of transactional emails
|
|
173
|
+
*
|
|
174
|
+
* @generated from field: repeated Scailo.TransactionalEmail list = 1;
|
|
175
|
+
*/
|
|
176
|
+
list: TransactionalEmail[];
|
|
177
|
+
constructor(data?: PartialMessage<TransactionalEmailsList>);
|
|
178
|
+
static readonly runtime: typeof proto3;
|
|
179
|
+
static readonly typeName = "Scailo.TransactionalEmailsList";
|
|
180
|
+
static readonly fields: FieldList;
|
|
181
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsList;
|
|
182
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsList;
|
|
183
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsList;
|
|
184
|
+
static equals(a: TransactionalEmailsList | PlainMessage<TransactionalEmailsList> | undefined, b: TransactionalEmailsList | PlainMessage<TransactionalEmailsList> | undefined): boolean;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
*
|
|
188
|
+
* Describes the data structure that responds to a pagination request
|
|
189
|
+
*
|
|
190
|
+
* @generated from message Scailo.TransactionalEmailPaginationResp
|
|
191
|
+
*/
|
|
192
|
+
export declare class TransactionalEmailPaginationResp extends Message<TransactionalEmailPaginationResp> {
|
|
193
|
+
/**
|
|
194
|
+
* The number of records in this payload
|
|
195
|
+
*
|
|
196
|
+
* @generated from field: uint64 count = 1;
|
|
197
|
+
*/
|
|
198
|
+
count: bigint;
|
|
199
|
+
/**
|
|
200
|
+
* The number that has been offset before fetching the records. This is the same value that has been sent as part of the pagination request
|
|
201
|
+
*
|
|
202
|
+
* @generated from field: uint64 offset = 2;
|
|
203
|
+
*/
|
|
204
|
+
offset: bigint;
|
|
205
|
+
/**
|
|
206
|
+
* The total number of records that are available
|
|
207
|
+
*
|
|
208
|
+
* @generated from field: uint64 total = 3;
|
|
209
|
+
*/
|
|
210
|
+
total: bigint;
|
|
211
|
+
/**
|
|
212
|
+
* The list of records
|
|
213
|
+
*
|
|
214
|
+
* @generated from field: repeated Scailo.TransactionalEmail payload = 4;
|
|
215
|
+
*/
|
|
216
|
+
payload: TransactionalEmail[];
|
|
217
|
+
constructor(data?: PartialMessage<TransactionalEmailPaginationResp>);
|
|
218
|
+
static readonly runtime: typeof proto3;
|
|
219
|
+
static readonly typeName = "Scailo.TransactionalEmailPaginationResp";
|
|
220
|
+
static readonly fields: FieldList;
|
|
221
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailPaginationResp;
|
|
222
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailPaginationResp;
|
|
223
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailPaginationResp;
|
|
224
|
+
static equals(a: TransactionalEmailPaginationResp | PlainMessage<TransactionalEmailPaginationResp> | undefined, b: TransactionalEmailPaginationResp | PlainMessage<TransactionalEmailPaginationResp> | undefined): boolean;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
*
|
|
228
|
+
* Describes a pagination request to retrieve records
|
|
229
|
+
*
|
|
230
|
+
* @generated from message Scailo.TransactionalEmailsServicePaginationReq
|
|
231
|
+
*/
|
|
232
|
+
export declare class TransactionalEmailsServicePaginationReq extends Message<TransactionalEmailsServicePaginationReq> {
|
|
233
|
+
/**
|
|
234
|
+
* If true, then returns only active records. If false, then returns only inactive records
|
|
235
|
+
*
|
|
236
|
+
* @generated from field: Scailo.BOOL_FILTER is_active = 1;
|
|
237
|
+
*/
|
|
238
|
+
isActive: BOOL_FILTER;
|
|
239
|
+
/**
|
|
240
|
+
* The number of records that need to be sent in the response
|
|
241
|
+
*
|
|
242
|
+
* @generated from field: int64 count = 2;
|
|
243
|
+
*/
|
|
244
|
+
count: bigint;
|
|
245
|
+
/**
|
|
246
|
+
* The number that need to be offset by before fetching the records
|
|
247
|
+
*
|
|
248
|
+
* @generated from field: uint64 offset = 3;
|
|
249
|
+
*/
|
|
250
|
+
offset: bigint;
|
|
251
|
+
/**
|
|
252
|
+
* The sort order that is to be used to fetch the pagination response
|
|
253
|
+
*
|
|
254
|
+
* @generated from field: Scailo.SORT_ORDER sort_order = 4;
|
|
255
|
+
*/
|
|
256
|
+
sortOrder: SORT_ORDER;
|
|
257
|
+
/**
|
|
258
|
+
* The sort key that is to be used to fetch the pagination response
|
|
259
|
+
*
|
|
260
|
+
* @generated from field: Scailo.TRANSACTIONAL_EMAIL_SORT_KEY sort_key = 5;
|
|
261
|
+
*/
|
|
262
|
+
sortKey: TRANSACTIONAL_EMAIL_SORT_KEY;
|
|
263
|
+
constructor(data?: PartialMessage<TransactionalEmailsServicePaginationReq>);
|
|
264
|
+
static readonly runtime: typeof proto3;
|
|
265
|
+
static readonly typeName = "Scailo.TransactionalEmailsServicePaginationReq";
|
|
266
|
+
static readonly fields: FieldList;
|
|
267
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServicePaginationReq;
|
|
268
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServicePaginationReq;
|
|
269
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServicePaginationReq;
|
|
270
|
+
static equals(a: TransactionalEmailsServicePaginationReq | PlainMessage<TransactionalEmailsServicePaginationReq> | undefined, b: TransactionalEmailsServicePaginationReq | PlainMessage<TransactionalEmailsServicePaginationReq> | undefined): boolean;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
*
|
|
274
|
+
* Describes the base request payload of a filter search
|
|
275
|
+
*
|
|
276
|
+
* @generated from message Scailo.TransactionalEmailsServiceFilterReq
|
|
277
|
+
*/
|
|
278
|
+
export declare class TransactionalEmailsServiceFilterReq extends Message<TransactionalEmailsServiceFilterReq> {
|
|
279
|
+
/**
|
|
280
|
+
* If true, then returns only active records. If false, then returns only inactive records
|
|
281
|
+
*
|
|
282
|
+
* @generated from field: Scailo.BOOL_FILTER is_active = 1;
|
|
283
|
+
*/
|
|
284
|
+
isActive: BOOL_FILTER;
|
|
285
|
+
/**
|
|
286
|
+
* The number of records that need to be sent in the response. Returns all records if it is set to -1
|
|
287
|
+
*
|
|
288
|
+
* @generated from field: int64 count = 2;
|
|
289
|
+
*/
|
|
290
|
+
count: bigint;
|
|
291
|
+
/**
|
|
292
|
+
* The number that need to be offset by before fetching the records
|
|
293
|
+
*
|
|
294
|
+
* @generated from field: uint64 offset = 3;
|
|
295
|
+
*/
|
|
296
|
+
offset: bigint;
|
|
297
|
+
/**
|
|
298
|
+
* The sort order that is to be used to fetch the pagination response
|
|
299
|
+
*
|
|
300
|
+
* @generated from field: Scailo.SORT_ORDER sort_order = 4;
|
|
301
|
+
*/
|
|
302
|
+
sortOrder: SORT_ORDER;
|
|
303
|
+
/**
|
|
304
|
+
* The sort key that is to be used to fetch the pagination response
|
|
305
|
+
*
|
|
306
|
+
* @generated from field: Scailo.TRANSACTIONAL_EMAIL_SORT_KEY sort_key = 5;
|
|
307
|
+
*/
|
|
308
|
+
sortKey: TRANSACTIONAL_EMAIL_SORT_KEY;
|
|
309
|
+
/**
|
|
310
|
+
* The minimum timestamp that needs to be considered to filter by creation
|
|
311
|
+
*
|
|
312
|
+
* @generated from field: uint64 creation_timestamp_start = 101;
|
|
313
|
+
*/
|
|
314
|
+
creationTimestampStart: bigint;
|
|
315
|
+
/**
|
|
316
|
+
* The maximum timestamp that needs to be considered to filter by creation
|
|
317
|
+
*
|
|
318
|
+
* @generated from field: uint64 creation_timestamp_end = 102;
|
|
319
|
+
*/
|
|
320
|
+
creationTimestampEnd: bigint;
|
|
321
|
+
/**
|
|
322
|
+
* The minimum timestamp that needs to be considered to filter by modification
|
|
323
|
+
*
|
|
324
|
+
* @generated from field: uint64 modification_timestamp_start = 103;
|
|
325
|
+
*/
|
|
326
|
+
modificationTimestampStart: bigint;
|
|
327
|
+
/**
|
|
328
|
+
* The maximum timestamp that needs to be considered to filter by modification
|
|
329
|
+
*
|
|
330
|
+
* @generated from field: uint64 modification_timestamp_end = 104;
|
|
331
|
+
*/
|
|
332
|
+
modificationTimestampEnd: bigint;
|
|
333
|
+
/**
|
|
334
|
+
* The entity UUID that is to be used to filter records
|
|
335
|
+
*
|
|
336
|
+
* @generated from field: string entity_uuid = 8;
|
|
337
|
+
*/
|
|
338
|
+
entityUuid: string;
|
|
339
|
+
/**
|
|
340
|
+
* Stores the name of the sender
|
|
341
|
+
*
|
|
342
|
+
* @generated from field: string sender_name = 20;
|
|
343
|
+
*/
|
|
344
|
+
senderName: string;
|
|
345
|
+
/**
|
|
346
|
+
* Stores the title of the transactional email
|
|
347
|
+
*
|
|
348
|
+
* @generated from field: string title = 21;
|
|
349
|
+
*/
|
|
350
|
+
title: string;
|
|
351
|
+
/**
|
|
352
|
+
* Stores the email address to which the reply could be sent
|
|
353
|
+
*
|
|
354
|
+
* @generated from field: string reply_to = 22;
|
|
355
|
+
*/
|
|
356
|
+
replyTo: string;
|
|
357
|
+
/**
|
|
358
|
+
* Stores the subject of the transactional email
|
|
359
|
+
*
|
|
360
|
+
* @generated from field: string subject = 23;
|
|
361
|
+
*/
|
|
362
|
+
subject: string;
|
|
363
|
+
/**
|
|
364
|
+
* Stores the email address of the recipient
|
|
365
|
+
*
|
|
366
|
+
* @generated from field: string recipient_email_address = 40;
|
|
367
|
+
*/
|
|
368
|
+
recipientEmailAddress: string;
|
|
369
|
+
constructor(data?: PartialMessage<TransactionalEmailsServiceFilterReq>);
|
|
370
|
+
static readonly runtime: typeof proto3;
|
|
371
|
+
static readonly typeName = "Scailo.TransactionalEmailsServiceFilterReq";
|
|
372
|
+
static readonly fields: FieldList;
|
|
373
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServiceFilterReq;
|
|
374
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceFilterReq;
|
|
375
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceFilterReq;
|
|
376
|
+
static equals(a: TransactionalEmailsServiceFilterReq | PlainMessage<TransactionalEmailsServiceFilterReq> | undefined, b: TransactionalEmailsServiceFilterReq | PlainMessage<TransactionalEmailsServiceFilterReq> | undefined): boolean;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
*
|
|
380
|
+
* Describes the base request payload of a count search
|
|
381
|
+
*
|
|
382
|
+
* @generated from message Scailo.TransactionalEmailsServiceCountReq
|
|
383
|
+
*/
|
|
384
|
+
export declare class TransactionalEmailsServiceCountReq extends Message<TransactionalEmailsServiceCountReq> {
|
|
385
|
+
/**
|
|
386
|
+
* If true, then returns only active records. If false, then returns only inactive records
|
|
387
|
+
*
|
|
388
|
+
* @generated from field: Scailo.BOOL_FILTER is_active = 1;
|
|
389
|
+
*/
|
|
390
|
+
isActive: BOOL_FILTER;
|
|
391
|
+
/**
|
|
392
|
+
* The minimum timestamp that needs to be considered to filter by creation
|
|
393
|
+
*
|
|
394
|
+
* @generated from field: uint64 creation_timestamp_start = 101;
|
|
395
|
+
*/
|
|
396
|
+
creationTimestampStart: bigint;
|
|
397
|
+
/**
|
|
398
|
+
* The maximum timestamp that needs to be considered to filter by creation
|
|
399
|
+
*
|
|
400
|
+
* @generated from field: uint64 creation_timestamp_end = 102;
|
|
401
|
+
*/
|
|
402
|
+
creationTimestampEnd: bigint;
|
|
403
|
+
/**
|
|
404
|
+
* The minimum timestamp that needs to be considered to filter by modification
|
|
405
|
+
*
|
|
406
|
+
* @generated from field: uint64 modification_timestamp_start = 103;
|
|
407
|
+
*/
|
|
408
|
+
modificationTimestampStart: bigint;
|
|
409
|
+
/**
|
|
410
|
+
* The maximum timestamp that needs to be considered to filter by modification
|
|
411
|
+
*
|
|
412
|
+
* @generated from field: uint64 modification_timestamp_end = 104;
|
|
413
|
+
*/
|
|
414
|
+
modificationTimestampEnd: bigint;
|
|
415
|
+
/**
|
|
416
|
+
* The entity UUID that is to be used to filter records
|
|
417
|
+
*
|
|
418
|
+
* @generated from field: string entity_uuid = 8;
|
|
419
|
+
*/
|
|
420
|
+
entityUuid: string;
|
|
421
|
+
/**
|
|
422
|
+
* Stores the name of the sender
|
|
423
|
+
*
|
|
424
|
+
* @generated from field: string sender_name = 20;
|
|
425
|
+
*/
|
|
426
|
+
senderName: string;
|
|
427
|
+
/**
|
|
428
|
+
* Stores the title of the transactional email
|
|
429
|
+
*
|
|
430
|
+
* @generated from field: string title = 21;
|
|
431
|
+
*/
|
|
432
|
+
title: string;
|
|
433
|
+
/**
|
|
434
|
+
* Stores the email address to which the reply could be sent
|
|
435
|
+
*
|
|
436
|
+
* @generated from field: string reply_to = 22;
|
|
437
|
+
*/
|
|
438
|
+
replyTo: string;
|
|
439
|
+
/**
|
|
440
|
+
* Stores the subject of the transactional email
|
|
441
|
+
*
|
|
442
|
+
* @generated from field: string subject = 23;
|
|
443
|
+
*/
|
|
444
|
+
subject: string;
|
|
445
|
+
/**
|
|
446
|
+
* Stores the email address of the recipient
|
|
447
|
+
*
|
|
448
|
+
* @generated from field: string recipient_email_address = 40;
|
|
449
|
+
*/
|
|
450
|
+
recipientEmailAddress: string;
|
|
451
|
+
constructor(data?: PartialMessage<TransactionalEmailsServiceCountReq>);
|
|
452
|
+
static readonly runtime: typeof proto3;
|
|
453
|
+
static readonly typeName = "Scailo.TransactionalEmailsServiceCountReq";
|
|
454
|
+
static readonly fields: FieldList;
|
|
455
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServiceCountReq;
|
|
456
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceCountReq;
|
|
457
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceCountReq;
|
|
458
|
+
static equals(a: TransactionalEmailsServiceCountReq | PlainMessage<TransactionalEmailsServiceCountReq> | undefined, b: TransactionalEmailsServiceCountReq | PlainMessage<TransactionalEmailsServiceCountReq> | undefined): boolean;
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
*
|
|
462
|
+
* Describes the request payload for performing a generic search operation on transactional emails
|
|
463
|
+
*
|
|
464
|
+
* @generated from message Scailo.TransactionalEmailsServiceSearchAllReq
|
|
465
|
+
*/
|
|
466
|
+
export declare class TransactionalEmailsServiceSearchAllReq extends Message<TransactionalEmailsServiceSearchAllReq> {
|
|
467
|
+
/**
|
|
468
|
+
* If true, then returns only active records. If false, then returns only inactive records
|
|
469
|
+
*
|
|
470
|
+
* @generated from field: Scailo.BOOL_FILTER is_active = 1;
|
|
471
|
+
*/
|
|
472
|
+
isActive: BOOL_FILTER;
|
|
473
|
+
/**
|
|
474
|
+
* The number of records that need to be sent in the response. Returns all records if it is set to -1
|
|
475
|
+
*
|
|
476
|
+
* @generated from field: int64 count = 2;
|
|
477
|
+
*/
|
|
478
|
+
count: bigint;
|
|
479
|
+
/**
|
|
480
|
+
* The number that need to be offset by before fetching the records
|
|
481
|
+
*
|
|
482
|
+
* @generated from field: uint64 offset = 3;
|
|
483
|
+
*/
|
|
484
|
+
offset: bigint;
|
|
485
|
+
/**
|
|
486
|
+
* The sort order that is to be used to fetch the pagination response
|
|
487
|
+
*
|
|
488
|
+
* @generated from field: Scailo.SORT_ORDER sort_order = 4;
|
|
489
|
+
*/
|
|
490
|
+
sortOrder: SORT_ORDER;
|
|
491
|
+
/**
|
|
492
|
+
* The sort key that is to be used to fetch the response
|
|
493
|
+
*
|
|
494
|
+
* @generated from field: Scailo.TRANSACTIONAL_EMAIL_SORT_KEY sort_key = 5;
|
|
495
|
+
*/
|
|
496
|
+
sortKey: TRANSACTIONAL_EMAIL_SORT_KEY;
|
|
497
|
+
/**
|
|
498
|
+
* The entity UUID that is to be used to filter transactional emails
|
|
499
|
+
*
|
|
500
|
+
* @generated from field: string entity_uuid = 6;
|
|
501
|
+
*/
|
|
502
|
+
entityUuid: string;
|
|
503
|
+
/**
|
|
504
|
+
* Describes the key with which the search operation needs to be performed
|
|
505
|
+
*
|
|
506
|
+
* @generated from field: string search_key = 10;
|
|
507
|
+
*/
|
|
508
|
+
searchKey: string;
|
|
509
|
+
constructor(data?: PartialMessage<TransactionalEmailsServiceSearchAllReq>);
|
|
510
|
+
static readonly runtime: typeof proto3;
|
|
511
|
+
static readonly typeName = "Scailo.TransactionalEmailsServiceSearchAllReq";
|
|
512
|
+
static readonly fields: FieldList;
|
|
513
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServiceSearchAllReq;
|
|
514
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceSearchAllReq;
|
|
515
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceSearchAllReq;
|
|
516
|
+
static equals(a: TransactionalEmailsServiceSearchAllReq | PlainMessage<TransactionalEmailsServiceSearchAllReq> | undefined, b: TransactionalEmailsServiceSearchAllReq | PlainMessage<TransactionalEmailsServiceSearchAllReq> | undefined): boolean;
|
|
517
|
+
}
|
|
518
|
+
/**
|
|
519
|
+
*
|
|
520
|
+
* Describes the necessary data structure during addition of a recipient
|
|
521
|
+
*
|
|
522
|
+
* @generated from message Scailo.TransactionalEmailsServiceAddRecipientRequest
|
|
523
|
+
*/
|
|
524
|
+
export declare class TransactionalEmailsServiceAddRecipientRequest extends Message<TransactionalEmailsServiceAddRecipientRequest> {
|
|
525
|
+
/**
|
|
526
|
+
* Stores the email address of the recipient
|
|
527
|
+
*
|
|
528
|
+
* @generated from field: string address = 10;
|
|
529
|
+
*/
|
|
530
|
+
address: string;
|
|
531
|
+
constructor(data?: PartialMessage<TransactionalEmailsServiceAddRecipientRequest>);
|
|
532
|
+
static readonly runtime: typeof proto3;
|
|
533
|
+
static readonly typeName = "Scailo.TransactionalEmailsServiceAddRecipientRequest";
|
|
534
|
+
static readonly fields: FieldList;
|
|
535
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServiceAddRecipientRequest;
|
|
536
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceAddRecipientRequest;
|
|
537
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceAddRecipientRequest;
|
|
538
|
+
static equals(a: TransactionalEmailsServiceAddRecipientRequest | PlainMessage<TransactionalEmailsServiceAddRecipientRequest> | undefined, b: TransactionalEmailsServiceAddRecipientRequest | PlainMessage<TransactionalEmailsServiceAddRecipientRequest> | undefined): boolean;
|
|
539
|
+
}
|
|
540
|
+
/**
|
|
541
|
+
*
|
|
542
|
+
* Describes the data structure that stores the recipient information of a transactional email
|
|
543
|
+
*
|
|
544
|
+
* @generated from message Scailo.TransactionalEmailRecipient
|
|
545
|
+
*/
|
|
546
|
+
export declare class TransactionalEmailRecipient extends Message<TransactionalEmailRecipient> {
|
|
547
|
+
/**
|
|
548
|
+
* Stores a globally unique entity UUID. This will be set at the organization level
|
|
549
|
+
*
|
|
550
|
+
* @generated from field: string entity_uuid = 1;
|
|
551
|
+
*/
|
|
552
|
+
entityUuid: string;
|
|
553
|
+
/**
|
|
554
|
+
* Stores the metadata of this client
|
|
555
|
+
*
|
|
556
|
+
* @generated from field: Scailo.EmployeeMetadata metadata = 2;
|
|
557
|
+
*/
|
|
558
|
+
metadata?: EmployeeMetadata;
|
|
559
|
+
/**
|
|
560
|
+
* The ID of the transactional email
|
|
561
|
+
*
|
|
562
|
+
* @generated from field: uint64 transactional_email_id = 10;
|
|
563
|
+
*/
|
|
564
|
+
transactionalEmailId: bigint;
|
|
565
|
+
/**
|
|
566
|
+
* The email address of the recipient
|
|
567
|
+
*
|
|
568
|
+
* @generated from field: string address = 11;
|
|
569
|
+
*/
|
|
570
|
+
address: string;
|
|
571
|
+
constructor(data?: PartialMessage<TransactionalEmailRecipient>);
|
|
572
|
+
static readonly runtime: typeof proto3;
|
|
573
|
+
static readonly typeName = "Scailo.TransactionalEmailRecipient";
|
|
574
|
+
static readonly fields: FieldList;
|
|
575
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailRecipient;
|
|
576
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailRecipient;
|
|
577
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailRecipient;
|
|
578
|
+
static equals(a: TransactionalEmailRecipient | PlainMessage<TransactionalEmailRecipient> | undefined, b: TransactionalEmailRecipient | PlainMessage<TransactionalEmailRecipient> | undefined): boolean;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
*
|
|
582
|
+
* Describes the message consisting of the list of transactional email recipients
|
|
583
|
+
*
|
|
584
|
+
* @generated from message Scailo.TransactionalEmailRecipientsList
|
|
585
|
+
*/
|
|
586
|
+
export declare class TransactionalEmailRecipientsList extends Message<TransactionalEmailRecipientsList> {
|
|
587
|
+
/**
|
|
588
|
+
* List of records
|
|
589
|
+
*
|
|
590
|
+
* @generated from field: repeated Scailo.TransactionalEmailRecipient list = 1;
|
|
591
|
+
*/
|
|
592
|
+
list: TransactionalEmailRecipient[];
|
|
593
|
+
constructor(data?: PartialMessage<TransactionalEmailRecipientsList>);
|
|
594
|
+
static readonly runtime: typeof proto3;
|
|
595
|
+
static readonly typeName = "Scailo.TransactionalEmailRecipientsList";
|
|
596
|
+
static readonly fields: FieldList;
|
|
597
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailRecipientsList;
|
|
598
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailRecipientsList;
|
|
599
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailRecipientsList;
|
|
600
|
+
static equals(a: TransactionalEmailRecipientsList | PlainMessage<TransactionalEmailRecipientsList> | undefined, b: TransactionalEmailRecipientsList | PlainMessage<TransactionalEmailRecipientsList> | undefined): boolean;
|
|
601
|
+
}
|
|
602
|
+
/**
|
|
603
|
+
*
|
|
604
|
+
* Describes the necessary data structure during addition of a recipient
|
|
605
|
+
*
|
|
606
|
+
* @generated from message Scailo.TransactionalEmailsServiceAddAttachmentRequest
|
|
607
|
+
*/
|
|
608
|
+
export declare class TransactionalEmailsServiceAddAttachmentRequest extends Message<TransactionalEmailsServiceAddAttachmentRequest> {
|
|
609
|
+
/**
|
|
610
|
+
* Stores the name of the attachment
|
|
611
|
+
*
|
|
612
|
+
* @generated from field: string name = 10;
|
|
613
|
+
*/
|
|
614
|
+
name: string;
|
|
615
|
+
/**
|
|
616
|
+
* Stores the content of the attachment
|
|
617
|
+
*
|
|
618
|
+
* @generated from field: bytes content = 11;
|
|
619
|
+
*/
|
|
620
|
+
content: Uint8Array;
|
|
621
|
+
constructor(data?: PartialMessage<TransactionalEmailsServiceAddAttachmentRequest>);
|
|
622
|
+
static readonly runtime: typeof proto3;
|
|
623
|
+
static readonly typeName = "Scailo.TransactionalEmailsServiceAddAttachmentRequest";
|
|
624
|
+
static readonly fields: FieldList;
|
|
625
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailsServiceAddAttachmentRequest;
|
|
626
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceAddAttachmentRequest;
|
|
627
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailsServiceAddAttachmentRequest;
|
|
628
|
+
static equals(a: TransactionalEmailsServiceAddAttachmentRequest | PlainMessage<TransactionalEmailsServiceAddAttachmentRequest> | undefined, b: TransactionalEmailsServiceAddAttachmentRequest | PlainMessage<TransactionalEmailsServiceAddAttachmentRequest> | undefined): boolean;
|
|
629
|
+
}
|
|
630
|
+
/**
|
|
631
|
+
*
|
|
632
|
+
* Describes the data structure that stores the attachment information of a transactional email
|
|
633
|
+
*
|
|
634
|
+
* @generated from message Scailo.TransactionalEmailAttachment
|
|
635
|
+
*/
|
|
636
|
+
export declare class TransactionalEmailAttachment extends Message<TransactionalEmailAttachment> {
|
|
637
|
+
/**
|
|
638
|
+
* Stores a globally unique entity UUID. This will be set at the organization level
|
|
639
|
+
*
|
|
640
|
+
* @generated from field: string entity_uuid = 1;
|
|
641
|
+
*/
|
|
642
|
+
entityUuid: string;
|
|
643
|
+
/**
|
|
644
|
+
* Stores the metadata of this client
|
|
645
|
+
*
|
|
646
|
+
* @generated from field: Scailo.EmployeeMetadata metadata = 2;
|
|
647
|
+
*/
|
|
648
|
+
metadata?: EmployeeMetadata;
|
|
649
|
+
/**
|
|
650
|
+
* The ID of the transactional email
|
|
651
|
+
*
|
|
652
|
+
* @generated from field: uint64 transactional_email_id = 10;
|
|
653
|
+
*/
|
|
654
|
+
transactionalEmailId: bigint;
|
|
655
|
+
/**
|
|
656
|
+
* The name of the attachment
|
|
657
|
+
*
|
|
658
|
+
* @generated from field: string name = 11;
|
|
659
|
+
*/
|
|
660
|
+
name: string;
|
|
661
|
+
/**
|
|
662
|
+
* The content of the attachment
|
|
663
|
+
*
|
|
664
|
+
* @generated from field: bytes content = 12;
|
|
665
|
+
*/
|
|
666
|
+
content: Uint8Array;
|
|
667
|
+
constructor(data?: PartialMessage<TransactionalEmailAttachment>);
|
|
668
|
+
static readonly runtime: typeof proto3;
|
|
669
|
+
static readonly typeName = "Scailo.TransactionalEmailAttachment";
|
|
670
|
+
static readonly fields: FieldList;
|
|
671
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailAttachment;
|
|
672
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailAttachment;
|
|
673
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailAttachment;
|
|
674
|
+
static equals(a: TransactionalEmailAttachment | PlainMessage<TransactionalEmailAttachment> | undefined, b: TransactionalEmailAttachment | PlainMessage<TransactionalEmailAttachment> | undefined): boolean;
|
|
675
|
+
}
|
|
676
|
+
/**
|
|
677
|
+
*
|
|
678
|
+
* Describes the message consisting of the list of transactional email attachments
|
|
679
|
+
*
|
|
680
|
+
* @generated from message Scailo.TransactionalEmailAttachmentsList
|
|
681
|
+
*/
|
|
682
|
+
export declare class TransactionalEmailAttachmentsList extends Message<TransactionalEmailAttachmentsList> {
|
|
683
|
+
/**
|
|
684
|
+
* List of records
|
|
685
|
+
*
|
|
686
|
+
* @generated from field: repeated Scailo.TransactionalEmailAttachment list = 1;
|
|
687
|
+
*/
|
|
688
|
+
list: TransactionalEmailAttachment[];
|
|
689
|
+
constructor(data?: PartialMessage<TransactionalEmailAttachmentsList>);
|
|
690
|
+
static readonly runtime: typeof proto3;
|
|
691
|
+
static readonly typeName = "Scailo.TransactionalEmailAttachmentsList";
|
|
692
|
+
static readonly fields: FieldList;
|
|
693
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TransactionalEmailAttachmentsList;
|
|
694
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TransactionalEmailAttachmentsList;
|
|
695
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TransactionalEmailAttachmentsList;
|
|
696
|
+
static equals(a: TransactionalEmailAttachmentsList | PlainMessage<TransactionalEmailAttachmentsList> | undefined, b: TransactionalEmailAttachmentsList | PlainMessage<TransactionalEmailAttachmentsList> | undefined): boolean;
|
|
697
|
+
}
|
|
698
|
+
//# sourceMappingURL=transactional_emails.scailo_pb.d.ts.map
|