@suprsend/node-sdk 1.12.0 → 1.13.1

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