@suprsend/node-sdk 1.11.1 → 1.13.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.
Files changed (48) hide show
  1. package/dist/constants.js +2 -8
  2. package/dist/event.js +2 -2
  3. package/dist/events_bulk.js +2 -2
  4. package/dist/index.js +25 -2
  5. package/dist/object_edit.js +352 -0
  6. package/dist/object_edit_internal_helper.js +395 -0
  7. package/dist/objects_api.js +527 -0
  8. package/dist/request_json/workflow.json +7 -29
  9. package/dist/request_json/workflow_trigger.json +7 -29
  10. package/dist/subscriber.js +12 -28
  11. package/dist/subscriber_helper.js +40 -363
  12. package/dist/subscriber_list.js +2 -2
  13. package/dist/user_edit.js +412 -0
  14. package/dist/user_edit_internal_helper.js +363 -0
  15. package/dist/users_api.js +535 -0
  16. package/dist/users_edit_bulk.js +312 -0
  17. package/dist/workflow.js +2 -2
  18. package/dist/workflow_request.js +2 -2
  19. package/dist/workflow_trigger_bulk.js +2 -2
  20. package/dist/workflows_bulk.js +2 -2
  21. package/package.json +1 -1
  22. package/src/constants.js +0 -4
  23. package/src/event.js +4 -5
  24. package/src/events_bulk.js +3 -5
  25. package/src/index.js +9 -1
  26. package/src/object_edit.js +308 -0
  27. package/src/object_edit_internal_helper.js +332 -0
  28. package/src/objects_api.js +320 -0
  29. package/src/request_json/workflow.json +7 -29
  30. package/src/request_json/workflow_trigger.json +7 -29
  31. package/src/subscriber.js +10 -21
  32. package/src/subscriber_helper.js +41 -365
  33. package/src/subscriber_list.js +4 -4
  34. package/src/user_edit.js +360 -0
  35. package/src/user_edit_internal_helper.js +297 -0
  36. package/src/users_api.js +301 -0
  37. package/src/users_edit_bulk.js +211 -0
  38. package/src/workflow.js +4 -5
  39. package/src/workflow_request.js +4 -4
  40. package/src/workflow_trigger_bulk.js +2 -4
  41. package/src/workflows_bulk.js +3 -5
  42. package/types/index.d.ts +168 -13
  43. package/dist/language_codes.js +0 -197
  44. package/dist/object.js +0 -919
  45. package/dist/object_helper.js +0 -659
  46. package/src/language_codes.js +0 -188
  47. package/src/object.js +0 -621
  48. package/src/object_helper.js +0 -593
package/types/index.d.ts CHANGED
@@ -12,6 +12,7 @@ declare namespace suprsend {
12
12
 
13
13
  interface SBulkResponse {
14
14
  status: string;
15
+ status_code: number;
15
16
  failed_records: Dictionary[];
16
17
  total: number;
17
18
  success: number;
@@ -139,7 +140,11 @@ declare namespace suprsend {
139
140
 
140
141
  // tenants
141
142
  interface TenantsApi {
142
- list(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
143
+ list(options?: {
144
+ limit?: number;
145
+ offset?: number;
146
+ [key: string]: any;
147
+ }): Promise<Dictionary>;
143
148
 
144
149
  get(tenant_id: any): Promise<Dictionary>;
145
150
 
@@ -148,7 +153,11 @@ declare namespace suprsend {
148
153
 
149
154
  // brands
150
155
  interface BrandsApi {
151
- list(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
156
+ list(options?: {
157
+ limit?: number;
158
+ offset?: number;
159
+ [key: string]: any;
160
+ }): Promise<Dictionary>;
152
161
 
153
162
  get(brand_id: any): Promise<Dictionary>;
154
163
 
@@ -175,7 +184,11 @@ declare namespace suprsend {
175
184
  interface SubscriberListsApi {
176
185
  create(payload: Dictionary): Promise<Dictionary>;
177
186
 
178
- get_all(options?: { limit?: number; offset?: number }): Promise<Dictionary>;
187
+ get_all(options?: {
188
+ limit?: number;
189
+ offset?: number;
190
+ [key: string]: any;
191
+ }): Promise<Dictionary>;
179
192
 
180
193
  get(list_id: string): Promise<Dictionary>;
181
194
 
@@ -238,31 +251,116 @@ declare namespace suprsend {
238
251
 
239
252
  // objects
240
253
  interface ObjectsApi {
241
- list(object_type: string, options?: {}): Promise<Dictionary>;
254
+ list(
255
+ object_type: string,
256
+ options?: {
257
+ limit?: number;
258
+ after?: string;
259
+ before?: string;
260
+ [key: string]: any;
261
+ }
262
+ ): Promise<Dictionary>;
242
263
 
243
264
  get(object_type: string, object_id: string): Promise<Dictionary>;
244
265
 
245
- upsert(object_type: string, object_id: string, object_payload?: Dictionary): Promise<Dictionary>;
266
+ upsert(
267
+ object_type: string,
268
+ object_id: string,
269
+ payload?: Dictionary
270
+ ): Promise<Dictionary>;
271
+
272
+ edit(instance: ObjectEdit): Promise<Dictionary>;
246
273
 
247
- edit(object_type: string, object_id: string, edit_payload?: Dictionary): Promise<Dictionary>;
274
+ edit(
275
+ object_type: string,
276
+ object_id: string,
277
+ payload?: Dictionary
278
+ ): Promise<Dictionary>;
248
279
 
249
280
  delete(object_type: string, object_id: string): Promise<Dictionary>;
250
281
 
251
- bulk_delete(object_type: string, payload?: Dictionary): Promise<Dictionary>;
282
+ bulk_delete(
283
+ object_type: string,
284
+ payload: { object_ids: string[] }
285
+ ): Promise<Dictionary>;
252
286
 
253
- get_subscriptions(object_type: string, object_id: string, options?: {}): Promise<Dictionary>;
287
+ get_subscriptions(
288
+ object_type: string,
289
+ object_id: string,
290
+ options?: {
291
+ limit?: number;
292
+ after?: string;
293
+ before?: string;
294
+ [key: string]: any;
295
+ }
296
+ ): Promise<Dictionary>;
254
297
 
255
- create_subscriptions(object_type: string, object_id: string, subscriptions?: Dictionary): Promise<Dictionary>;
298
+ create_subscriptions(
299
+ object_type: string,
300
+ object_id: string,
301
+ payload: Dictionary
302
+ ): Promise<Dictionary>;
256
303
 
257
- delete_subscriptions(object_type: string, object_id: string, subscriptions?: Dictionary): Promise<Dictionary>;
304
+ delete_subscriptions(
305
+ object_type: string,
306
+ object_id: string,
307
+ payload: Dictionary
308
+ ): Promise<Dictionary>;
309
+
310
+ get_objects_subscribed_to(
311
+ object_type: string,
312
+ object_id: string,
313
+ options?: {
314
+ limit?: number;
315
+ after?: string;
316
+ before?: string;
317
+ [key: string]: any;
318
+ }
319
+ ): Promise<Dictionary>;
320
+
321
+ get_instance(object_type: string, object_id: string): ObjectEdit;
258
322
 
259
- get_instance(object_type: string, object_id: string): Object;
323
+ get_edit_instance(object_type: string, object_id: string): ObjectEdit;
260
324
  }
261
325
 
262
326
  // subscribers
263
- interface Object {
264
- save(): Promise<SResponse>;
327
+ interface ObjectEdit {
328
+ append(key: string | Dictionary, value?: any): void;
329
+ set(key: string | Dictionary, value?: any): void;
330
+ set_once(key: string | Dictionary, value?: any): void;
331
+ increment(key: string | Dictionary, value?: number): void;
332
+ remove(key: string | Dictionary, value?: any): void;
333
+ unset(keys: string | string[]): void;
334
+
335
+ set_preferred_language(lang_code: string): void;
336
+ set_timezone(timezone: string): void;
337
+
338
+ add_email(email: string): void;
339
+ remove_email(email: string): void;
340
+
341
+ add_sms(mobile_no: string): void;
342
+ remove_sms(mobile_no: string): void;
343
+
344
+ add_whatsapp(mobile_no: string): void;
345
+ remove_whatsapp(mobile_no: string): void;
346
+
347
+ add_androidpush(push_token: string, provider?: string): void;
348
+ remove_androidpush(push_token: string, provider?: string): void;
265
349
 
350
+ add_iospush(push_token: string, provider?: string): void;
351
+ remove_iospush(push_token: string, provider?: string): void;
352
+
353
+ add_webpush(push_token: Dictionary, provider?: string): void;
354
+ remove_webpush(push_token: Dictionary, provider?: string): void;
355
+
356
+ add_slack(value: Dictionary): void;
357
+ remove_slack(value: Dictionary): void;
358
+
359
+ add_ms_teams(value: Dictionary): void;
360
+ remove_ms_teams(value: Dictionary): void;
361
+ }
362
+
363
+ interface UserEdit {
266
364
  append(key: string | Dictionary, value?: any): void;
267
365
  set(key: string | Dictionary, value?: any): void;
268
366
  set_once(key: string | Dictionary, value?: any): void;
@@ -298,6 +396,61 @@ declare namespace suprsend {
298
396
  remove_ms_teams(value: Dictionary): void;
299
397
  }
300
398
 
399
+ interface UsersApi {
400
+ list(options?: {
401
+ limit?: number;
402
+ after?: string;
403
+ before?: string;
404
+ [key: string]: any;
405
+ }): Promise<Dictionary>;
406
+
407
+ get(distinct_id: string): Promise<Dictionary>;
408
+
409
+ upsert(distinct_id: string, payload?: Dictionary): Promise<Dictionary>;
410
+
411
+ delete(distinct_id: string): Promise<Dictionary>;
412
+
413
+ bulk_delete(payload: { distinct_ids: string[] }): Promise<Dictionary>;
414
+
415
+ async_edit(instance: UserEdit): Promise<Dictionary>;
416
+
417
+ edit(instance: UserEdit): Promise<Dictionary>;
418
+
419
+ edit(distinct_id: string, payload?: Dictionary): Promise<Dictionary>;
420
+
421
+ merge(distinct_id: string, from_distinct_id: string): Promise<Dictionary>;
422
+
423
+ get_objects_subscribed_to(
424
+ distinct_id: string,
425
+ options?: {
426
+ limit?: number;
427
+ after?: string;
428
+ before?: string;
429
+ [key: string]: any;
430
+ }
431
+ ): Promise<Dictionary>;
432
+
433
+ get_lists_subscribed_to(
434
+ distinct_id: string,
435
+ options?: {
436
+ limit?: number;
437
+ after?: string;
438
+ before?: string;
439
+ [key: string]: any;
440
+ }
441
+ ): Promise<Dictionary>;
442
+
443
+ get_edit_instance(distinct_id: string): UserEdit;
444
+
445
+ get_bulk_edit_instance(): BulkUsersEdit;
446
+ }
447
+
448
+ interface BulkUsersEdit {
449
+ append(...users: UserEdit[]): void;
450
+
451
+ save(): Promise<SBulkResponse>;
452
+ }
453
+
301
454
  interface Suprsend {
302
455
  new (
303
456
  workspace_env: string,
@@ -323,6 +476,8 @@ declare namespace suprsend {
323
476
 
324
477
  objects: ObjectsApi;
325
478
 
479
+ users: UsersApi;
480
+
326
481
  add_attachment(
327
482
  body: Dictionary,
328
483
  file_path: string,
@@ -1,197 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports["default"] = void 0;
8
- var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
9
- var LANG_CODE_NAME_MAPPING = {
10
- aa: "Afar",
11
- ab: "Abkhazian",
12
- ae: "Avestan",
13
- af: "Afrikaans",
14
- ak: "Akan",
15
- am: "Amharic",
16
- an: "Aragonese",
17
- ar: "Arabic",
18
- as: "Assamese",
19
- av: "Avaric",
20
- ay: "Aymara",
21
- az: "Azerbaijani",
22
- ba: "Bashkir",
23
- be: "Belarusian",
24
- bg: "Bulgarian",
25
- bi: "Bislama",
26
- bm: "Bambara",
27
- bn: "Bengali",
28
- bo: "Tibetan",
29
- br: "Breton",
30
- bs: "Bosnian",
31
- ca: "Catalan; Valencian",
32
- ce: "Chechen",
33
- ch: "Chamorro",
34
- co: "Corsican",
35
- cr: "Cree",
36
- cs: "Czech",
37
- cu: "Church Slavic; Old Slavonic; Church Slavonic; Old Bulgarian; Old Church Slavonic",
38
- cv: "Chuvash",
39
- cy: "Welsh",
40
- da: "Danish",
41
- de: "German",
42
- dv: "Divehi; Dhivehi; Maldivian",
43
- dz: "Dzongkha",
44
- ee: "Ewe",
45
- el: "Greek, Modern (1453-)",
46
- en: "English",
47
- eo: "Esperanto",
48
- es: "Spanish; Castilian",
49
- et: "Estonian",
50
- eu: "Basque",
51
- fa: "Persian",
52
- ff: "Fulah",
53
- fi: "Finnish",
54
- fj: "Fijian",
55
- fo: "Faroese",
56
- fr: "French",
57
- fy: "Western Frisian",
58
- ga: "Irish",
59
- gd: "Gaelic; Scottish Gaelic",
60
- gl: "Galician",
61
- gn: "Guarani",
62
- gu: "Gujarati",
63
- gv: "Manx",
64
- ha: "Hausa",
65
- he: "Hebrew",
66
- hi: "Hindi",
67
- ho: "Hiri Motu",
68
- hr: "Croatian",
69
- ht: "Haitian; Haitian Creole",
70
- hu: "Hungarian",
71
- hy: "Armenian",
72
- hz: "Herero",
73
- ia: "Interlingua (International Auxiliary Language Association)",
74
- id: "Indonesian",
75
- ie: "Interlingue; Occidental",
76
- ig: "Igbo",
77
- ii: "Sichuan Yi; Nuosu",
78
- ik: "Inupiaq",
79
- io: "Ido",
80
- is: "Icelandic",
81
- it: "Italian",
82
- iu: "Inuktitut",
83
- ja: "Japanese",
84
- jv: "Javanese",
85
- ka: "Georgian",
86
- kg: "Kongo",
87
- ki: "Kikuyu; Gikuyu",
88
- kj: "Kuanyama; Kwanyama",
89
- kk: "Kazakh",
90
- kl: "Kalaallisut; Greenlandic",
91
- km: "Central Khmer",
92
- kn: "Kannada",
93
- ko: "Korean",
94
- kr: "Kanuri",
95
- ks: "Kashmiri",
96
- ku: "Kurdish",
97
- kv: "Komi",
98
- kw: "Cornish",
99
- ky: "Kirghiz; Kyrgyz",
100
- la: "Latin",
101
- lb: "Luxembourgish; Letzeburgesch",
102
- lg: "Ganda",
103
- li: "Limburgan; Limburger; Limburgish",
104
- ln: "Lingala",
105
- lo: "Lao",
106
- lt: "Lithuanian",
107
- lu: "Luba-Katanga",
108
- lv: "Latvian",
109
- mg: "Malagasy",
110
- mh: "Marshallese",
111
- mi: "Maori",
112
- mk: "Macedonian",
113
- ml: "Malayalam",
114
- mn: "Mongolian",
115
- mr: "Marathi",
116
- ms: "Malay",
117
- mt: "Maltese",
118
- my: "Burmese",
119
- na: "Nauru",
120
- nb: "Bokmål, Norwegian; Norwegian Bokmål",
121
- nd: "Ndebele, North; North Ndebele",
122
- ne: "Nepali",
123
- ng: "Ndonga",
124
- nl: "Dutch; Flemish",
125
- nn: "Norwegian Nynorsk; Nynorsk, Norwegian",
126
- no: "Norwegian",
127
- nr: "Ndebele, South; South Ndebele",
128
- nv: "Navajo; Navaho",
129
- ny: "Chichewa; Chewa; Nyanja",
130
- oc: "Occitan (post 1500)",
131
- oj: "Ojibwa",
132
- om: "Oromo",
133
- or: "Oriya",
134
- os: "Ossetian; Ossetic",
135
- pa: "Panjabi; Punjabi",
136
- pi: "Pali",
137
- pl: "Polish",
138
- ps: "Pushto; Pashto",
139
- pt: "Portuguese",
140
- qu: "Quechua",
141
- rm: "Romansh",
142
- rn: "Rundi",
143
- ro: "Romanian; Moldavian; Moldovan",
144
- ru: "Russian",
145
- rw: "Kinyarwanda",
146
- sa: "Sanskrit",
147
- sc: "Sardinian",
148
- sd: "Sindhi",
149
- se: "Northern Sami",
150
- sg: "Sango",
151
- si: "Sinhala; Sinhalese",
152
- sk: "Slovak",
153
- sl: "Slovenian",
154
- sm: "Samoan",
155
- sn: "Shona",
156
- so: "Somali",
157
- sq: "Albanian",
158
- sr: "Serbian",
159
- ss: "Swati",
160
- st: "Sotho, Southern",
161
- su: "Sundanese",
162
- sv: "Swedish",
163
- sw: "Swahili",
164
- ta: "Tamil",
165
- te: "Telugu",
166
- tg: "Tajik",
167
- th: "Thai",
168
- ti: "Tigrinya",
169
- tk: "Turkmen",
170
- tl: "Tagalog",
171
- tn: "Tswana",
172
- to: "Tonga (Tonga Islands)",
173
- tr: "Turkish",
174
- ts: "Tsonga",
175
- tt: "Tatar",
176
- tw: "Twi",
177
- ty: "Tahitian",
178
- ug: "Uighur; Uyghur",
179
- uk: "Ukrainian",
180
- ur: "Urdu",
181
- uz: "Uzbek",
182
- ve: "Venda",
183
- vi: "Vietnamese",
184
- vo: "Volapük",
185
- wa: "Walloon",
186
- wo: "Wolof",
187
- xh: "Xhosa",
188
- yi: "Yiddish",
189
- yo: "Yoruba",
190
- za: "Zhuang; Chuang",
191
- zh: "Chinese",
192
- zu: "Zulu"
193
- };
194
- var ALL_LANG_CODES = (0, _toConsumableArray2["default"])(new Set(Object.keys(LANG_CODE_NAME_MAPPING)));
195
- var _default = ALL_LANG_CODES;
196
- exports["default"] = _default;
197
- module.exports = exports.default;