@novu/api 0.1.2 → 0.1.5

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 (93) hide show
  1. package/README.md +7 -3
  2. package/docs/sdks/messages/README.md +2 -8
  3. package/docs/sdks/notifications/README.md +2 -6
  4. package/docs/sdks/novunotifications/README.md +0 -6
  5. package/docs/sdks/preferences/README.md +166 -5
  6. package/docs/sdks/subscribers/README.md +2 -2
  7. package/docs/sdks/topics/README.md +0 -4
  8. package/funcs/subscribersPreferencesRetrieve.d.ts +16 -0
  9. package/funcs/subscribersPreferencesRetrieve.d.ts.map +1 -0
  10. package/funcs/subscribersPreferencesRetrieve.js +141 -0
  11. package/funcs/subscribersPreferencesRetrieve.js.map +1 -0
  12. package/funcs/subscribersPreferencesUpdate.d.ts +6 -2
  13. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  14. package/funcs/subscribersPreferencesUpdate.js +18 -12
  15. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  16. package/funcs/subscribersPreferencesUpdateLegacy.d.ts +13 -0
  17. package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +1 -0
  18. package/funcs/subscribersPreferencesUpdateLegacy.js +139 -0
  19. package/funcs/subscribersPreferencesUpdateLegacy.js.map +1 -0
  20. package/jsr.json +1 -1
  21. package/lib/config.d.ts +3 -3
  22. package/lib/config.js +3 -3
  23. package/models/components/getsubscriberpreferencesdto.d.ts +39 -0
  24. package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -0
  25. package/models/components/getsubscriberpreferencesdto.js +63 -0
  26. package/models/components/getsubscriberpreferencesdto.js.map +1 -0
  27. package/models/components/globalpreferencedto.d.ts +38 -0
  28. package/models/components/globalpreferencedto.d.ts.map +1 -0
  29. package/models/components/globalpreferencedto.js +62 -0
  30. package/models/components/globalpreferencedto.js.map +1 -0
  31. package/models/components/index.d.ts +7 -0
  32. package/models/components/index.d.ts.map +1 -1
  33. package/models/components/index.js +7 -0
  34. package/models/components/index.js.map +1 -1
  35. package/models/components/overrides.d.ts +112 -0
  36. package/models/components/overrides.d.ts.map +1 -0
  37. package/models/components/overrides.js +110 -0
  38. package/models/components/overrides.js.map +1 -0
  39. package/models/components/patchpreferencechannelsdto.d.ts +52 -0
  40. package/models/components/patchpreferencechannelsdto.d.ts.map +1 -0
  41. package/models/components/patchpreferencechannelsdto.js +76 -0
  42. package/models/components/patchpreferencechannelsdto.js.map +1 -0
  43. package/models/components/patchsubscriberpreferencesdto.d.ts +38 -0
  44. package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -0
  45. package/models/components/patchsubscriberpreferencesdto.js +62 -0
  46. package/models/components/patchsubscriberpreferencesdto.js.map +1 -0
  47. package/models/components/triggereventtoallrequestdto.d.ts +15 -15
  48. package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
  49. package/models/components/triggereventtoallrequestdto.js +20 -18
  50. package/models/components/triggereventtoallrequestdto.js.map +1 -1
  51. package/models/components/workflowinfodto.d.ts +42 -0
  52. package/models/components/workflowinfodto.d.ts.map +1 -0
  53. package/models/components/workflowinfodto.js +63 -0
  54. package/models/components/workflowinfodto.js.map +1 -0
  55. package/models/components/workflowpreferencedto.d.ts +50 -0
  56. package/models/components/workflowpreferencedto.d.ts.map +1 -0
  57. package/models/components/workflowpreferencedto.js +68 -0
  58. package/models/components/workflowpreferencedto.js.map +1 -0
  59. package/models/operations/index.d.ts +2 -0
  60. package/models/operations/index.d.ts.map +1 -1
  61. package/models/operations/index.js +2 -0
  62. package/models/operations/index.js.map +1 -1
  63. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts +66 -0
  64. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -0
  65. package/models/operations/subscriberscontrollergetsubscriberpreferences.js +110 -0
  66. package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -0
  67. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts +68 -0
  68. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts.map +1 -0
  69. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js +118 -0
  70. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js.map +1 -0
  71. package/package.json +1 -1
  72. package/sdk/preferences.d.ts +15 -1
  73. package/sdk/preferences.d.ts.map +1 -1
  74. package/sdk/preferences.js +22 -2
  75. package/sdk/preferences.js.map +1 -1
  76. package/sources/json-development.json +1165 -0
  77. package/src/funcs/subscribersPreferencesRetrieve.ts +203 -0
  78. package/src/funcs/subscribersPreferencesUpdate.ts +27 -20
  79. package/src/funcs/subscribersPreferencesUpdateLegacy.ts +202 -0
  80. package/src/lib/config.ts +3 -3
  81. package/src/models/components/getsubscriberpreferencesdto.ts +90 -0
  82. package/src/models/components/globalpreferencedto.ts +82 -0
  83. package/src/models/components/index.ts +7 -0
  84. package/src/models/components/overrides.ts +141 -0
  85. package/src/models/components/patchpreferencechannelsdto.ts +106 -0
  86. package/src/models/components/patchsubscriberpreferencesdto.ts +84 -0
  87. package/src/models/components/triggereventtoallrequestdto.ts +35 -24
  88. package/src/models/components/workflowinfodto.ts +81 -0
  89. package/src/models/components/workflowpreferencedto.ts +108 -0
  90. package/src/models/operations/index.ts +2 -0
  91. package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +183 -0
  92. package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts +189 -0
  93. package/src/sdk/preferences.ts +46 -2
@@ -13803,6 +13803,7 @@
13803
13803
  },
13804
13804
  "patch": {
13805
13805
  "operationId": "SubscribersV1Controller_updateSubscriberPreference",
13806
+ "x-speakeasy-name-override": "updateLegacy",
13806
13807
  "x-speakeasy-group": "Subscribers.Preferences",
13807
13808
  "summary": "Update subscriber preference",
13808
13809
  "parameters": [
@@ -19899,6 +19900,984 @@
19899
19900
  ]
19900
19901
  }
19901
19902
  },
19903
+ "/v2/subscribers/{subscriberId}/preferences": {
19904
+ "get": {
19905
+ "operationId": "SubscribersController_getSubscriberPreferences",
19906
+ "x-speakeasy-name-override": "retrieve",
19907
+ "x-speakeasy-group": "Subscribers.Preferences",
19908
+ "summary": "Get subscriber preferences",
19909
+ "description": "Get subscriber global and workflow specific preferences",
19910
+ "parameters": [
19911
+ {
19912
+ "name": "subscriberId",
19913
+ "required": true,
19914
+ "in": "path",
19915
+ "schema": {
19916
+ "type": "string"
19917
+ }
19918
+ },
19919
+ {
19920
+ "name": "idempotency-key",
19921
+ "in": "header",
19922
+ "description": "A header for idempotency purposes",
19923
+ "required": false,
19924
+ "schema": {
19925
+ "type": "string"
19926
+ }
19927
+ }
19928
+ ],
19929
+ "responses": {
19930
+ "200": {
19931
+ "description": "OK",
19932
+ "headers": {
19933
+ "Content-Type": {
19934
+ "$ref": "#/components/headers/Content-Type"
19935
+ },
19936
+ "RateLimit-Limit": {
19937
+ "$ref": "#/components/headers/RateLimit-Limit"
19938
+ },
19939
+ "RateLimit-Remaining": {
19940
+ "$ref": "#/components/headers/RateLimit-Remaining"
19941
+ },
19942
+ "RateLimit-Reset": {
19943
+ "$ref": "#/components/headers/RateLimit-Reset"
19944
+ },
19945
+ "RateLimit-Policy": {
19946
+ "$ref": "#/components/headers/RateLimit-Policy"
19947
+ },
19948
+ "Idempotency-Key": {
19949
+ "$ref": "#/components/headers/Idempotency-Key"
19950
+ },
19951
+ "Idempotency-Replay": {
19952
+ "$ref": "#/components/headers/Idempotency-Replay"
19953
+ }
19954
+ },
19955
+ "content": {
19956
+ "application/json": {
19957
+ "schema": {
19958
+ "$ref": "#/components/schemas/GetSubscriberPreferencesDto"
19959
+ }
19960
+ }
19961
+ }
19962
+ },
19963
+ "400": {
19964
+ "description": "Bad Request",
19965
+ "headers": {
19966
+ "Content-Type": {
19967
+ "$ref": "#/components/headers/Content-Type"
19968
+ },
19969
+ "RateLimit-Limit": {
19970
+ "$ref": "#/components/headers/RateLimit-Limit"
19971
+ },
19972
+ "RateLimit-Remaining": {
19973
+ "$ref": "#/components/headers/RateLimit-Remaining"
19974
+ },
19975
+ "RateLimit-Reset": {
19976
+ "$ref": "#/components/headers/RateLimit-Reset"
19977
+ },
19978
+ "RateLimit-Policy": {
19979
+ "$ref": "#/components/headers/RateLimit-Policy"
19980
+ },
19981
+ "Idempotency-Key": {
19982
+ "$ref": "#/components/headers/Idempotency-Key"
19983
+ },
19984
+ "Idempotency-Replay": {
19985
+ "$ref": "#/components/headers/Idempotency-Replay"
19986
+ }
19987
+ },
19988
+ "content": {
19989
+ "application/json": {
19990
+ "schema": {
19991
+ "$ref": "#/components/schemas/ErrorDto"
19992
+ }
19993
+ }
19994
+ }
19995
+ },
19996
+ "401": {
19997
+ "description": "Unauthorized",
19998
+ "headers": {
19999
+ "Content-Type": {
20000
+ "$ref": "#/components/headers/Content-Type"
20001
+ },
20002
+ "RateLimit-Limit": {
20003
+ "$ref": "#/components/headers/RateLimit-Limit"
20004
+ },
20005
+ "RateLimit-Remaining": {
20006
+ "$ref": "#/components/headers/RateLimit-Remaining"
20007
+ },
20008
+ "RateLimit-Reset": {
20009
+ "$ref": "#/components/headers/RateLimit-Reset"
20010
+ },
20011
+ "RateLimit-Policy": {
20012
+ "$ref": "#/components/headers/RateLimit-Policy"
20013
+ },
20014
+ "Idempotency-Key": {
20015
+ "$ref": "#/components/headers/Idempotency-Key"
20016
+ },
20017
+ "Idempotency-Replay": {
20018
+ "$ref": "#/components/headers/Idempotency-Replay"
20019
+ }
20020
+ },
20021
+ "content": {
20022
+ "application/json": {
20023
+ "schema": {
20024
+ "$ref": "#/components/schemas/ErrorDto"
20025
+ }
20026
+ }
20027
+ }
20028
+ },
20029
+ "403": {
20030
+ "description": "Forbidden",
20031
+ "headers": {
20032
+ "Content-Type": {
20033
+ "$ref": "#/components/headers/Content-Type"
20034
+ },
20035
+ "RateLimit-Limit": {
20036
+ "$ref": "#/components/headers/RateLimit-Limit"
20037
+ },
20038
+ "RateLimit-Remaining": {
20039
+ "$ref": "#/components/headers/RateLimit-Remaining"
20040
+ },
20041
+ "RateLimit-Reset": {
20042
+ "$ref": "#/components/headers/RateLimit-Reset"
20043
+ },
20044
+ "RateLimit-Policy": {
20045
+ "$ref": "#/components/headers/RateLimit-Policy"
20046
+ },
20047
+ "Idempotency-Key": {
20048
+ "$ref": "#/components/headers/Idempotency-Key"
20049
+ },
20050
+ "Idempotency-Replay": {
20051
+ "$ref": "#/components/headers/Idempotency-Replay"
20052
+ }
20053
+ },
20054
+ "content": {
20055
+ "application/json": {
20056
+ "schema": {
20057
+ "$ref": "#/components/schemas/ErrorDto"
20058
+ }
20059
+ }
20060
+ }
20061
+ },
20062
+ "404": {
20063
+ "description": "Not Found",
20064
+ "headers": {
20065
+ "Content-Type": {
20066
+ "$ref": "#/components/headers/Content-Type"
20067
+ },
20068
+ "RateLimit-Limit": {
20069
+ "$ref": "#/components/headers/RateLimit-Limit"
20070
+ },
20071
+ "RateLimit-Remaining": {
20072
+ "$ref": "#/components/headers/RateLimit-Remaining"
20073
+ },
20074
+ "RateLimit-Reset": {
20075
+ "$ref": "#/components/headers/RateLimit-Reset"
20076
+ },
20077
+ "RateLimit-Policy": {
20078
+ "$ref": "#/components/headers/RateLimit-Policy"
20079
+ },
20080
+ "Idempotency-Key": {
20081
+ "$ref": "#/components/headers/Idempotency-Key"
20082
+ },
20083
+ "Idempotency-Replay": {
20084
+ "$ref": "#/components/headers/Idempotency-Replay"
20085
+ }
20086
+ },
20087
+ "content": {
20088
+ "application/json": {
20089
+ "schema": {
20090
+ "$ref": "#/components/schemas/ErrorDto"
20091
+ }
20092
+ }
20093
+ }
20094
+ },
20095
+ "405": {
20096
+ "description": "Method Not Allowed",
20097
+ "headers": {
20098
+ "Content-Type": {
20099
+ "$ref": "#/components/headers/Content-Type"
20100
+ },
20101
+ "RateLimit-Limit": {
20102
+ "$ref": "#/components/headers/RateLimit-Limit"
20103
+ },
20104
+ "RateLimit-Remaining": {
20105
+ "$ref": "#/components/headers/RateLimit-Remaining"
20106
+ },
20107
+ "RateLimit-Reset": {
20108
+ "$ref": "#/components/headers/RateLimit-Reset"
20109
+ },
20110
+ "RateLimit-Policy": {
20111
+ "$ref": "#/components/headers/RateLimit-Policy"
20112
+ },
20113
+ "Idempotency-Key": {
20114
+ "$ref": "#/components/headers/Idempotency-Key"
20115
+ },
20116
+ "Idempotency-Replay": {
20117
+ "$ref": "#/components/headers/Idempotency-Replay"
20118
+ }
20119
+ },
20120
+ "content": {
20121
+ "application/json": {
20122
+ "schema": {
20123
+ "$ref": "#/components/schemas/ErrorDto"
20124
+ }
20125
+ }
20126
+ }
20127
+ },
20128
+ "409": {
20129
+ "description": "Conflict",
20130
+ "headers": {
20131
+ "Content-Type": {
20132
+ "$ref": "#/components/headers/Content-Type"
20133
+ },
20134
+ "RateLimit-Limit": {
20135
+ "$ref": "#/components/headers/RateLimit-Limit"
20136
+ },
20137
+ "RateLimit-Remaining": {
20138
+ "$ref": "#/components/headers/RateLimit-Remaining"
20139
+ },
20140
+ "RateLimit-Reset": {
20141
+ "$ref": "#/components/headers/RateLimit-Reset"
20142
+ },
20143
+ "RateLimit-Policy": {
20144
+ "$ref": "#/components/headers/RateLimit-Policy"
20145
+ },
20146
+ "Idempotency-Key": {
20147
+ "$ref": "#/components/headers/Idempotency-Key"
20148
+ },
20149
+ "Idempotency-Replay": {
20150
+ "$ref": "#/components/headers/Idempotency-Replay"
20151
+ }
20152
+ },
20153
+ "content": {
20154
+ "application/json": {
20155
+ "schema": {
20156
+ "$ref": "#/components/schemas/ErrorDto"
20157
+ }
20158
+ }
20159
+ }
20160
+ },
20161
+ "413": {
20162
+ "description": "Payload Too Large",
20163
+ "headers": {
20164
+ "Content-Type": {
20165
+ "$ref": "#/components/headers/Content-Type"
20166
+ },
20167
+ "RateLimit-Limit": {
20168
+ "$ref": "#/components/headers/RateLimit-Limit"
20169
+ },
20170
+ "RateLimit-Remaining": {
20171
+ "$ref": "#/components/headers/RateLimit-Remaining"
20172
+ },
20173
+ "RateLimit-Reset": {
20174
+ "$ref": "#/components/headers/RateLimit-Reset"
20175
+ },
20176
+ "RateLimit-Policy": {
20177
+ "$ref": "#/components/headers/RateLimit-Policy"
20178
+ },
20179
+ "Idempotency-Key": {
20180
+ "$ref": "#/components/headers/Idempotency-Key"
20181
+ },
20182
+ "Idempotency-Replay": {
20183
+ "$ref": "#/components/headers/Idempotency-Replay"
20184
+ }
20185
+ },
20186
+ "content": {
20187
+ "application/json": {
20188
+ "schema": {
20189
+ "$ref": "#/components/schemas/ErrorDto"
20190
+ }
20191
+ }
20192
+ }
20193
+ },
20194
+ "414": {
20195
+ "description": "URI Too Long",
20196
+ "content": {
20197
+ "application/json": {
20198
+ "schema": {
20199
+ "$ref": "#/components/schemas/ErrorDto"
20200
+ }
20201
+ }
20202
+ }
20203
+ },
20204
+ "415": {
20205
+ "description": "Unsupported Media Type",
20206
+ "headers": {
20207
+ "Content-Type": {
20208
+ "$ref": "#/components/headers/Content-Type"
20209
+ },
20210
+ "RateLimit-Limit": {
20211
+ "$ref": "#/components/headers/RateLimit-Limit"
20212
+ },
20213
+ "RateLimit-Remaining": {
20214
+ "$ref": "#/components/headers/RateLimit-Remaining"
20215
+ },
20216
+ "RateLimit-Reset": {
20217
+ "$ref": "#/components/headers/RateLimit-Reset"
20218
+ },
20219
+ "RateLimit-Policy": {
20220
+ "$ref": "#/components/headers/RateLimit-Policy"
20221
+ },
20222
+ "Idempotency-Key": {
20223
+ "$ref": "#/components/headers/Idempotency-Key"
20224
+ },
20225
+ "Idempotency-Replay": {
20226
+ "$ref": "#/components/headers/Idempotency-Replay"
20227
+ }
20228
+ },
20229
+ "content": {
20230
+ "application/json": {
20231
+ "schema": {
20232
+ "$ref": "#/components/schemas/ErrorDto"
20233
+ }
20234
+ }
20235
+ }
20236
+ },
20237
+ "422": {
20238
+ "description": "Unprocessable Entity",
20239
+ "headers": {
20240
+ "Content-Type": {
20241
+ "$ref": "#/components/headers/Content-Type"
20242
+ },
20243
+ "RateLimit-Limit": {
20244
+ "$ref": "#/components/headers/RateLimit-Limit"
20245
+ },
20246
+ "RateLimit-Remaining": {
20247
+ "$ref": "#/components/headers/RateLimit-Remaining"
20248
+ },
20249
+ "RateLimit-Reset": {
20250
+ "$ref": "#/components/headers/RateLimit-Reset"
20251
+ },
20252
+ "RateLimit-Policy": {
20253
+ "$ref": "#/components/headers/RateLimit-Policy"
20254
+ },
20255
+ "Idempotency-Key": {
20256
+ "$ref": "#/components/headers/Idempotency-Key"
20257
+ },
20258
+ "Idempotency-Replay": {
20259
+ "$ref": "#/components/headers/Idempotency-Replay"
20260
+ }
20261
+ },
20262
+ "content": {
20263
+ "application/json": {
20264
+ "schema": {
20265
+ "$ref": "#/components/schemas/ValidationErrorDto"
20266
+ }
20267
+ }
20268
+ }
20269
+ },
20270
+ "429": {
20271
+ "description": "The client has sent too many requests in a given amount of time. ",
20272
+ "headers": {
20273
+ "Content-Type": {
20274
+ "$ref": "#/components/headers/Content-Type"
20275
+ },
20276
+ "RateLimit-Limit": {
20277
+ "$ref": "#/components/headers/RateLimit-Limit"
20278
+ },
20279
+ "RateLimit-Remaining": {
20280
+ "$ref": "#/components/headers/RateLimit-Remaining"
20281
+ },
20282
+ "RateLimit-Reset": {
20283
+ "$ref": "#/components/headers/RateLimit-Reset"
20284
+ },
20285
+ "RateLimit-Policy": {
20286
+ "$ref": "#/components/headers/RateLimit-Policy"
20287
+ },
20288
+ "Idempotency-Key": {
20289
+ "$ref": "#/components/headers/Idempotency-Key"
20290
+ },
20291
+ "Idempotency-Replay": {
20292
+ "$ref": "#/components/headers/Idempotency-Replay"
20293
+ },
20294
+ "Retry-After": {
20295
+ "$ref": "#/components/headers/Retry-After"
20296
+ }
20297
+ },
20298
+ "content": {
20299
+ "application/json": {
20300
+ "schema": {
20301
+ "type": "string",
20302
+ "example": "API rate limit exceeded"
20303
+ }
20304
+ }
20305
+ }
20306
+ },
20307
+ "500": {
20308
+ "description": "Internal Server Error",
20309
+ "headers": {
20310
+ "Content-Type": {
20311
+ "$ref": "#/components/headers/Content-Type"
20312
+ },
20313
+ "RateLimit-Limit": {
20314
+ "$ref": "#/components/headers/RateLimit-Limit"
20315
+ },
20316
+ "RateLimit-Remaining": {
20317
+ "$ref": "#/components/headers/RateLimit-Remaining"
20318
+ },
20319
+ "RateLimit-Reset": {
20320
+ "$ref": "#/components/headers/RateLimit-Reset"
20321
+ },
20322
+ "RateLimit-Policy": {
20323
+ "$ref": "#/components/headers/RateLimit-Policy"
20324
+ },
20325
+ "Idempotency-Key": {
20326
+ "$ref": "#/components/headers/Idempotency-Key"
20327
+ },
20328
+ "Idempotency-Replay": {
20329
+ "$ref": "#/components/headers/Idempotency-Replay"
20330
+ }
20331
+ },
20332
+ "content": {
20333
+ "application/json": {
20334
+ "schema": {
20335
+ "$ref": "#/components/schemas/ErrorDto"
20336
+ }
20337
+ }
20338
+ }
20339
+ },
20340
+ "503": {
20341
+ "description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
20342
+ "headers": {
20343
+ "Content-Type": {
20344
+ "$ref": "#/components/headers/Content-Type"
20345
+ },
20346
+ "RateLimit-Limit": {
20347
+ "$ref": "#/components/headers/RateLimit-Limit"
20348
+ },
20349
+ "RateLimit-Remaining": {
20350
+ "$ref": "#/components/headers/RateLimit-Remaining"
20351
+ },
20352
+ "RateLimit-Reset": {
20353
+ "$ref": "#/components/headers/RateLimit-Reset"
20354
+ },
20355
+ "RateLimit-Policy": {
20356
+ "$ref": "#/components/headers/RateLimit-Policy"
20357
+ },
20358
+ "Idempotency-Key": {
20359
+ "$ref": "#/components/headers/Idempotency-Key"
20360
+ },
20361
+ "Idempotency-Replay": {
20362
+ "$ref": "#/components/headers/Idempotency-Replay"
20363
+ },
20364
+ "Retry-After": {
20365
+ "$ref": "#/components/headers/Retry-After"
20366
+ }
20367
+ },
20368
+ "content": {
20369
+ "application/json": {
20370
+ "schema": {
20371
+ "type": "string",
20372
+ "example": "Please wait some time, then try again."
20373
+ }
20374
+ }
20375
+ }
20376
+ }
20377
+ },
20378
+ "tags": [
20379
+ "Subscribers"
20380
+ ],
20381
+ "security": [
20382
+ {
20383
+ "secretKey": []
20384
+ }
20385
+ ]
20386
+ },
20387
+ "patch": {
20388
+ "operationId": "SubscribersController_updateSubscriberPreferences",
20389
+ "x-speakeasy-name-override": "update",
20390
+ "x-speakeasy-group": "Subscribers.Preferences",
20391
+ "summary": "Update subscriber global or workflow specific preferences",
20392
+ "description": "Update subscriber global or workflow specific preferences",
20393
+ "parameters": [
20394
+ {
20395
+ "name": "subscriberId",
20396
+ "required": true,
20397
+ "in": "path",
20398
+ "schema": {
20399
+ "type": "string"
20400
+ }
20401
+ },
20402
+ {
20403
+ "name": "idempotency-key",
20404
+ "in": "header",
20405
+ "description": "A header for idempotency purposes",
20406
+ "required": false,
20407
+ "schema": {
20408
+ "type": "string"
20409
+ }
20410
+ }
20411
+ ],
20412
+ "requestBody": {
20413
+ "required": true,
20414
+ "content": {
20415
+ "application/json": {
20416
+ "schema": {
20417
+ "$ref": "#/components/schemas/PatchSubscriberPreferencesDto"
20418
+ }
20419
+ }
20420
+ }
20421
+ },
20422
+ "responses": {
20423
+ "200": {
20424
+ "description": "OK",
20425
+ "headers": {
20426
+ "Content-Type": {
20427
+ "$ref": "#/components/headers/Content-Type"
20428
+ },
20429
+ "RateLimit-Limit": {
20430
+ "$ref": "#/components/headers/RateLimit-Limit"
20431
+ },
20432
+ "RateLimit-Remaining": {
20433
+ "$ref": "#/components/headers/RateLimit-Remaining"
20434
+ },
20435
+ "RateLimit-Reset": {
20436
+ "$ref": "#/components/headers/RateLimit-Reset"
20437
+ },
20438
+ "RateLimit-Policy": {
20439
+ "$ref": "#/components/headers/RateLimit-Policy"
20440
+ },
20441
+ "Idempotency-Key": {
20442
+ "$ref": "#/components/headers/Idempotency-Key"
20443
+ },
20444
+ "Idempotency-Replay": {
20445
+ "$ref": "#/components/headers/Idempotency-Replay"
20446
+ }
20447
+ },
20448
+ "content": {
20449
+ "application/json": {
20450
+ "schema": {
20451
+ "$ref": "#/components/schemas/GetSubscriberPreferencesDto"
20452
+ }
20453
+ }
20454
+ }
20455
+ },
20456
+ "400": {
20457
+ "description": "Bad Request",
20458
+ "headers": {
20459
+ "Content-Type": {
20460
+ "$ref": "#/components/headers/Content-Type"
20461
+ },
20462
+ "RateLimit-Limit": {
20463
+ "$ref": "#/components/headers/RateLimit-Limit"
20464
+ },
20465
+ "RateLimit-Remaining": {
20466
+ "$ref": "#/components/headers/RateLimit-Remaining"
20467
+ },
20468
+ "RateLimit-Reset": {
20469
+ "$ref": "#/components/headers/RateLimit-Reset"
20470
+ },
20471
+ "RateLimit-Policy": {
20472
+ "$ref": "#/components/headers/RateLimit-Policy"
20473
+ },
20474
+ "Idempotency-Key": {
20475
+ "$ref": "#/components/headers/Idempotency-Key"
20476
+ },
20477
+ "Idempotency-Replay": {
20478
+ "$ref": "#/components/headers/Idempotency-Replay"
20479
+ }
20480
+ },
20481
+ "content": {
20482
+ "application/json": {
20483
+ "schema": {
20484
+ "$ref": "#/components/schemas/ErrorDto"
20485
+ }
20486
+ }
20487
+ }
20488
+ },
20489
+ "401": {
20490
+ "description": "Unauthorized",
20491
+ "headers": {
20492
+ "Content-Type": {
20493
+ "$ref": "#/components/headers/Content-Type"
20494
+ },
20495
+ "RateLimit-Limit": {
20496
+ "$ref": "#/components/headers/RateLimit-Limit"
20497
+ },
20498
+ "RateLimit-Remaining": {
20499
+ "$ref": "#/components/headers/RateLimit-Remaining"
20500
+ },
20501
+ "RateLimit-Reset": {
20502
+ "$ref": "#/components/headers/RateLimit-Reset"
20503
+ },
20504
+ "RateLimit-Policy": {
20505
+ "$ref": "#/components/headers/RateLimit-Policy"
20506
+ },
20507
+ "Idempotency-Key": {
20508
+ "$ref": "#/components/headers/Idempotency-Key"
20509
+ },
20510
+ "Idempotency-Replay": {
20511
+ "$ref": "#/components/headers/Idempotency-Replay"
20512
+ }
20513
+ },
20514
+ "content": {
20515
+ "application/json": {
20516
+ "schema": {
20517
+ "$ref": "#/components/schemas/ErrorDto"
20518
+ }
20519
+ }
20520
+ }
20521
+ },
20522
+ "403": {
20523
+ "description": "Forbidden",
20524
+ "headers": {
20525
+ "Content-Type": {
20526
+ "$ref": "#/components/headers/Content-Type"
20527
+ },
20528
+ "RateLimit-Limit": {
20529
+ "$ref": "#/components/headers/RateLimit-Limit"
20530
+ },
20531
+ "RateLimit-Remaining": {
20532
+ "$ref": "#/components/headers/RateLimit-Remaining"
20533
+ },
20534
+ "RateLimit-Reset": {
20535
+ "$ref": "#/components/headers/RateLimit-Reset"
20536
+ },
20537
+ "RateLimit-Policy": {
20538
+ "$ref": "#/components/headers/RateLimit-Policy"
20539
+ },
20540
+ "Idempotency-Key": {
20541
+ "$ref": "#/components/headers/Idempotency-Key"
20542
+ },
20543
+ "Idempotency-Replay": {
20544
+ "$ref": "#/components/headers/Idempotency-Replay"
20545
+ }
20546
+ },
20547
+ "content": {
20548
+ "application/json": {
20549
+ "schema": {
20550
+ "$ref": "#/components/schemas/ErrorDto"
20551
+ }
20552
+ }
20553
+ }
20554
+ },
20555
+ "404": {
20556
+ "description": "Not Found",
20557
+ "headers": {
20558
+ "Content-Type": {
20559
+ "$ref": "#/components/headers/Content-Type"
20560
+ },
20561
+ "RateLimit-Limit": {
20562
+ "$ref": "#/components/headers/RateLimit-Limit"
20563
+ },
20564
+ "RateLimit-Remaining": {
20565
+ "$ref": "#/components/headers/RateLimit-Remaining"
20566
+ },
20567
+ "RateLimit-Reset": {
20568
+ "$ref": "#/components/headers/RateLimit-Reset"
20569
+ },
20570
+ "RateLimit-Policy": {
20571
+ "$ref": "#/components/headers/RateLimit-Policy"
20572
+ },
20573
+ "Idempotency-Key": {
20574
+ "$ref": "#/components/headers/Idempotency-Key"
20575
+ },
20576
+ "Idempotency-Replay": {
20577
+ "$ref": "#/components/headers/Idempotency-Replay"
20578
+ }
20579
+ },
20580
+ "content": {
20581
+ "application/json": {
20582
+ "schema": {
20583
+ "$ref": "#/components/schemas/ErrorDto"
20584
+ }
20585
+ }
20586
+ }
20587
+ },
20588
+ "405": {
20589
+ "description": "Method Not Allowed",
20590
+ "headers": {
20591
+ "Content-Type": {
20592
+ "$ref": "#/components/headers/Content-Type"
20593
+ },
20594
+ "RateLimit-Limit": {
20595
+ "$ref": "#/components/headers/RateLimit-Limit"
20596
+ },
20597
+ "RateLimit-Remaining": {
20598
+ "$ref": "#/components/headers/RateLimit-Remaining"
20599
+ },
20600
+ "RateLimit-Reset": {
20601
+ "$ref": "#/components/headers/RateLimit-Reset"
20602
+ },
20603
+ "RateLimit-Policy": {
20604
+ "$ref": "#/components/headers/RateLimit-Policy"
20605
+ },
20606
+ "Idempotency-Key": {
20607
+ "$ref": "#/components/headers/Idempotency-Key"
20608
+ },
20609
+ "Idempotency-Replay": {
20610
+ "$ref": "#/components/headers/Idempotency-Replay"
20611
+ }
20612
+ },
20613
+ "content": {
20614
+ "application/json": {
20615
+ "schema": {
20616
+ "$ref": "#/components/schemas/ErrorDto"
20617
+ }
20618
+ }
20619
+ }
20620
+ },
20621
+ "409": {
20622
+ "description": "Conflict",
20623
+ "headers": {
20624
+ "Content-Type": {
20625
+ "$ref": "#/components/headers/Content-Type"
20626
+ },
20627
+ "RateLimit-Limit": {
20628
+ "$ref": "#/components/headers/RateLimit-Limit"
20629
+ },
20630
+ "RateLimit-Remaining": {
20631
+ "$ref": "#/components/headers/RateLimit-Remaining"
20632
+ },
20633
+ "RateLimit-Reset": {
20634
+ "$ref": "#/components/headers/RateLimit-Reset"
20635
+ },
20636
+ "RateLimit-Policy": {
20637
+ "$ref": "#/components/headers/RateLimit-Policy"
20638
+ },
20639
+ "Idempotency-Key": {
20640
+ "$ref": "#/components/headers/Idempotency-Key"
20641
+ },
20642
+ "Idempotency-Replay": {
20643
+ "$ref": "#/components/headers/Idempotency-Replay"
20644
+ }
20645
+ },
20646
+ "content": {
20647
+ "application/json": {
20648
+ "schema": {
20649
+ "$ref": "#/components/schemas/ErrorDto"
20650
+ }
20651
+ }
20652
+ }
20653
+ },
20654
+ "413": {
20655
+ "description": "Payload Too Large",
20656
+ "headers": {
20657
+ "Content-Type": {
20658
+ "$ref": "#/components/headers/Content-Type"
20659
+ },
20660
+ "RateLimit-Limit": {
20661
+ "$ref": "#/components/headers/RateLimit-Limit"
20662
+ },
20663
+ "RateLimit-Remaining": {
20664
+ "$ref": "#/components/headers/RateLimit-Remaining"
20665
+ },
20666
+ "RateLimit-Reset": {
20667
+ "$ref": "#/components/headers/RateLimit-Reset"
20668
+ },
20669
+ "RateLimit-Policy": {
20670
+ "$ref": "#/components/headers/RateLimit-Policy"
20671
+ },
20672
+ "Idempotency-Key": {
20673
+ "$ref": "#/components/headers/Idempotency-Key"
20674
+ },
20675
+ "Idempotency-Replay": {
20676
+ "$ref": "#/components/headers/Idempotency-Replay"
20677
+ }
20678
+ },
20679
+ "content": {
20680
+ "application/json": {
20681
+ "schema": {
20682
+ "$ref": "#/components/schemas/ErrorDto"
20683
+ }
20684
+ }
20685
+ }
20686
+ },
20687
+ "414": {
20688
+ "description": "URI Too Long",
20689
+ "content": {
20690
+ "application/json": {
20691
+ "schema": {
20692
+ "$ref": "#/components/schemas/ErrorDto"
20693
+ }
20694
+ }
20695
+ }
20696
+ },
20697
+ "415": {
20698
+ "description": "Unsupported Media Type",
20699
+ "headers": {
20700
+ "Content-Type": {
20701
+ "$ref": "#/components/headers/Content-Type"
20702
+ },
20703
+ "RateLimit-Limit": {
20704
+ "$ref": "#/components/headers/RateLimit-Limit"
20705
+ },
20706
+ "RateLimit-Remaining": {
20707
+ "$ref": "#/components/headers/RateLimit-Remaining"
20708
+ },
20709
+ "RateLimit-Reset": {
20710
+ "$ref": "#/components/headers/RateLimit-Reset"
20711
+ },
20712
+ "RateLimit-Policy": {
20713
+ "$ref": "#/components/headers/RateLimit-Policy"
20714
+ },
20715
+ "Idempotency-Key": {
20716
+ "$ref": "#/components/headers/Idempotency-Key"
20717
+ },
20718
+ "Idempotency-Replay": {
20719
+ "$ref": "#/components/headers/Idempotency-Replay"
20720
+ }
20721
+ },
20722
+ "content": {
20723
+ "application/json": {
20724
+ "schema": {
20725
+ "$ref": "#/components/schemas/ErrorDto"
20726
+ }
20727
+ }
20728
+ }
20729
+ },
20730
+ "422": {
20731
+ "description": "Unprocessable Entity",
20732
+ "headers": {
20733
+ "Content-Type": {
20734
+ "$ref": "#/components/headers/Content-Type"
20735
+ },
20736
+ "RateLimit-Limit": {
20737
+ "$ref": "#/components/headers/RateLimit-Limit"
20738
+ },
20739
+ "RateLimit-Remaining": {
20740
+ "$ref": "#/components/headers/RateLimit-Remaining"
20741
+ },
20742
+ "RateLimit-Reset": {
20743
+ "$ref": "#/components/headers/RateLimit-Reset"
20744
+ },
20745
+ "RateLimit-Policy": {
20746
+ "$ref": "#/components/headers/RateLimit-Policy"
20747
+ },
20748
+ "Idempotency-Key": {
20749
+ "$ref": "#/components/headers/Idempotency-Key"
20750
+ },
20751
+ "Idempotency-Replay": {
20752
+ "$ref": "#/components/headers/Idempotency-Replay"
20753
+ }
20754
+ },
20755
+ "content": {
20756
+ "application/json": {
20757
+ "schema": {
20758
+ "$ref": "#/components/schemas/ValidationErrorDto"
20759
+ }
20760
+ }
20761
+ }
20762
+ },
20763
+ "429": {
20764
+ "description": "The client has sent too many requests in a given amount of time. ",
20765
+ "headers": {
20766
+ "Content-Type": {
20767
+ "$ref": "#/components/headers/Content-Type"
20768
+ },
20769
+ "RateLimit-Limit": {
20770
+ "$ref": "#/components/headers/RateLimit-Limit"
20771
+ },
20772
+ "RateLimit-Remaining": {
20773
+ "$ref": "#/components/headers/RateLimit-Remaining"
20774
+ },
20775
+ "RateLimit-Reset": {
20776
+ "$ref": "#/components/headers/RateLimit-Reset"
20777
+ },
20778
+ "RateLimit-Policy": {
20779
+ "$ref": "#/components/headers/RateLimit-Policy"
20780
+ },
20781
+ "Idempotency-Key": {
20782
+ "$ref": "#/components/headers/Idempotency-Key"
20783
+ },
20784
+ "Idempotency-Replay": {
20785
+ "$ref": "#/components/headers/Idempotency-Replay"
20786
+ },
20787
+ "Retry-After": {
20788
+ "$ref": "#/components/headers/Retry-After"
20789
+ }
20790
+ },
20791
+ "content": {
20792
+ "application/json": {
20793
+ "schema": {
20794
+ "type": "string",
20795
+ "example": "API rate limit exceeded"
20796
+ }
20797
+ }
20798
+ }
20799
+ },
20800
+ "500": {
20801
+ "description": "Internal Server Error",
20802
+ "headers": {
20803
+ "Content-Type": {
20804
+ "$ref": "#/components/headers/Content-Type"
20805
+ },
20806
+ "RateLimit-Limit": {
20807
+ "$ref": "#/components/headers/RateLimit-Limit"
20808
+ },
20809
+ "RateLimit-Remaining": {
20810
+ "$ref": "#/components/headers/RateLimit-Remaining"
20811
+ },
20812
+ "RateLimit-Reset": {
20813
+ "$ref": "#/components/headers/RateLimit-Reset"
20814
+ },
20815
+ "RateLimit-Policy": {
20816
+ "$ref": "#/components/headers/RateLimit-Policy"
20817
+ },
20818
+ "Idempotency-Key": {
20819
+ "$ref": "#/components/headers/Idempotency-Key"
20820
+ },
20821
+ "Idempotency-Replay": {
20822
+ "$ref": "#/components/headers/Idempotency-Replay"
20823
+ }
20824
+ },
20825
+ "content": {
20826
+ "application/json": {
20827
+ "schema": {
20828
+ "$ref": "#/components/schemas/ErrorDto"
20829
+ }
20830
+ }
20831
+ }
20832
+ },
20833
+ "503": {
20834
+ "description": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.",
20835
+ "headers": {
20836
+ "Content-Type": {
20837
+ "$ref": "#/components/headers/Content-Type"
20838
+ },
20839
+ "RateLimit-Limit": {
20840
+ "$ref": "#/components/headers/RateLimit-Limit"
20841
+ },
20842
+ "RateLimit-Remaining": {
20843
+ "$ref": "#/components/headers/RateLimit-Remaining"
20844
+ },
20845
+ "RateLimit-Reset": {
20846
+ "$ref": "#/components/headers/RateLimit-Reset"
20847
+ },
20848
+ "RateLimit-Policy": {
20849
+ "$ref": "#/components/headers/RateLimit-Policy"
20850
+ },
20851
+ "Idempotency-Key": {
20852
+ "$ref": "#/components/headers/Idempotency-Key"
20853
+ },
20854
+ "Idempotency-Replay": {
20855
+ "$ref": "#/components/headers/Idempotency-Replay"
20856
+ },
20857
+ "Retry-After": {
20858
+ "$ref": "#/components/headers/Retry-After"
20859
+ }
20860
+ },
20861
+ "content": {
20862
+ "application/json": {
20863
+ "schema": {
20864
+ "type": "string",
20865
+ "example": "Please wait some time, then try again."
20866
+ }
20867
+ }
20868
+ }
20869
+ }
20870
+ },
20871
+ "tags": [
20872
+ "Subscribers"
20873
+ ],
20874
+ "security": [
20875
+ {
20876
+ "secretKey": []
20877
+ }
20878
+ ]
20879
+ }
20880
+ },
19902
20881
  "/v1/messages": {
19903
20882
  "get": {
19904
20883
  "operationId": "MessagesController_getMessages",
@@ -25447,6 +26426,13 @@
25447
26426
  "externalDocs": {
25448
26427
  "url": "https://docs.novu.co/activity-feed"
25449
26428
  }
26429
+ },
26430
+ {
26431
+ "name": "Translations",
26432
+ "description": "Translations are used to localize your messages for different languages and regions. Novu provides a way to create and manage translations for your messages. You can create translations for your messages in different languages and regions, and assign them to your subscribers based on their preferences.",
26433
+ "externalDocs": {
26434
+ "url": "https://docs.novu.co/content-creation-design/translations"
26435
+ }
25450
26436
  }
25451
26437
  ],
25452
26438
  "servers": [
@@ -29328,6 +30314,185 @@
29328
30314
  "status"
29329
30315
  ]
29330
30316
  },
30317
+ "GlobalPreferenceDto": {
30318
+ "type": "object",
30319
+ "properties": {
30320
+ "enabled": {
30321
+ "type": "boolean",
30322
+ "description": "Whether notifications are enabled globally"
30323
+ },
30324
+ "channels": {
30325
+ "description": "Channel-specific preference settings",
30326
+ "allOf": [
30327
+ {
30328
+ "$ref": "#/components/schemas/PreferenceChannels"
30329
+ }
30330
+ ]
30331
+ }
30332
+ },
30333
+ "required": [
30334
+ "enabled",
30335
+ "channels"
30336
+ ]
30337
+ },
30338
+ "Overrides": {
30339
+ "type": "object",
30340
+ "properties": {
30341
+ "channel": {
30342
+ "enum": [
30343
+ "in_app",
30344
+ "email",
30345
+ "sms",
30346
+ "chat",
30347
+ "push"
30348
+ ],
30349
+ "type": "string",
30350
+ "description": "The channel type which is overridden"
30351
+ },
30352
+ "source": {
30353
+ "enum": [
30354
+ "subscriber",
30355
+ "template",
30356
+ "workflowOverride"
30357
+ ],
30358
+ "type": "string",
30359
+ "description": "The source of overrides"
30360
+ }
30361
+ },
30362
+ "required": [
30363
+ "channel",
30364
+ "source"
30365
+ ]
30366
+ },
30367
+ "WorkflowInfoDto": {
30368
+ "type": "object",
30369
+ "properties": {
30370
+ "slug": {
30371
+ "type": "string",
30372
+ "description": "Workflow slug"
30373
+ },
30374
+ "identifier": {
30375
+ "type": "string",
30376
+ "description": "Unique identifier of the workflow"
30377
+ },
30378
+ "name": {
30379
+ "type": "string",
30380
+ "description": "Display name of the workflow"
30381
+ }
30382
+ },
30383
+ "required": [
30384
+ "slug",
30385
+ "identifier",
30386
+ "name"
30387
+ ]
30388
+ },
30389
+ "WorkflowPreferenceDto": {
30390
+ "type": "object",
30391
+ "properties": {
30392
+ "enabled": {
30393
+ "type": "boolean",
30394
+ "description": "Whether notifications are enabled for this workflow"
30395
+ },
30396
+ "channels": {
30397
+ "description": "Channel-specific preference settings for this workflow",
30398
+ "allOf": [
30399
+ {
30400
+ "$ref": "#/components/schemas/PreferenceChannels"
30401
+ }
30402
+ ]
30403
+ },
30404
+ "overrides": {
30405
+ "description": "List of preference overrides",
30406
+ "type": "array",
30407
+ "items": {
30408
+ "$ref": "#/components/schemas/Overrides"
30409
+ }
30410
+ },
30411
+ "workflow": {
30412
+ "description": "Workflow information",
30413
+ "allOf": [
30414
+ {
30415
+ "$ref": "#/components/schemas/WorkflowInfoDto"
30416
+ }
30417
+ ]
30418
+ }
30419
+ },
30420
+ "required": [
30421
+ "enabled",
30422
+ "channels",
30423
+ "overrides",
30424
+ "workflow"
30425
+ ]
30426
+ },
30427
+ "GetSubscriberPreferencesDto": {
30428
+ "type": "object",
30429
+ "properties": {
30430
+ "global": {
30431
+ "description": "Global preference settings",
30432
+ "allOf": [
30433
+ {
30434
+ "$ref": "#/components/schemas/GlobalPreferenceDto"
30435
+ }
30436
+ ]
30437
+ },
30438
+ "workflows": {
30439
+ "description": "Workflow-specific preference settings",
30440
+ "type": "array",
30441
+ "items": {
30442
+ "$ref": "#/components/schemas/WorkflowPreferenceDto"
30443
+ }
30444
+ }
30445
+ },
30446
+ "required": [
30447
+ "global",
30448
+ "workflows"
30449
+ ]
30450
+ },
30451
+ "PatchPreferenceChannelsDto": {
30452
+ "type": "object",
30453
+ "properties": {
30454
+ "email": {
30455
+ "type": "boolean",
30456
+ "description": "Email channel preference"
30457
+ },
30458
+ "sms": {
30459
+ "type": "boolean",
30460
+ "description": "SMS channel preference"
30461
+ },
30462
+ "in_app": {
30463
+ "type": "boolean",
30464
+ "description": "In-app channel preference"
30465
+ },
30466
+ "push": {
30467
+ "type": "boolean",
30468
+ "description": "Push channel preference"
30469
+ },
30470
+ "chat": {
30471
+ "type": "boolean",
30472
+ "description": "Chat channel preference"
30473
+ }
30474
+ }
30475
+ },
30476
+ "PatchSubscriberPreferencesDto": {
30477
+ "type": "object",
30478
+ "properties": {
30479
+ "channels": {
30480
+ "description": "Channel-specific preference settings",
30481
+ "allOf": [
30482
+ {
30483
+ "$ref": "#/components/schemas/PatchPreferenceChannelsDto"
30484
+ }
30485
+ ]
30486
+ },
30487
+ "workflowId": {
30488
+ "type": "string",
30489
+ "description": "If provided, update workflow specific preferences, otherwise update global preferences"
30490
+ }
30491
+ },
30492
+ "required": [
30493
+ "channels"
30494
+ ]
30495
+ },
29331
30496
  "DeleteMessageResponseDto": {
29332
30497
  "type": "object",
29333
30498
  "properties": {