@novu/api 0.1.2 → 0.1.6

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 (134) hide show
  1. package/README.md +18 -11
  2. package/docs/sdks/legacy/README.md +86 -0
  3. package/docs/sdks/messages/README.md +2 -8
  4. package/docs/sdks/notifications/README.md +2 -6
  5. package/docs/sdks/novunotifications/README.md +0 -6
  6. package/docs/sdks/preferences/README.md +123 -37
  7. package/docs/sdks/subscribers/README.md +7 -7
  8. package/docs/sdks/topics/README.md +0 -4
  9. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts +14 -0
  10. package/funcs/subscribersPreferencesLegacyUpdateGlobal.d.ts.map +1 -0
  11. package/funcs/{subscribersPreferencesUpdateGlobal.js → subscribersPreferencesLegacyUpdateGlobal.js} +4 -4
  12. package/funcs/subscribersPreferencesLegacyUpdateGlobal.js.map +1 -0
  13. package/funcs/{subscribersPreferencesUpdateGlobal.d.ts → subscribersPreferencesListLegacy.d.ts} +5 -4
  14. package/funcs/subscribersPreferencesListLegacy.d.ts.map +1 -0
  15. package/funcs/{subscribersPreferencesList.js → subscribersPreferencesListLegacy.js} +6 -4
  16. package/funcs/subscribersPreferencesListLegacy.js.map +1 -0
  17. package/funcs/subscribersPreferencesRetrieve.d.ts +16 -0
  18. package/funcs/subscribersPreferencesRetrieve.d.ts.map +1 -0
  19. package/funcs/subscribersPreferencesRetrieve.js +141 -0
  20. package/funcs/subscribersPreferencesRetrieve.js.map +1 -0
  21. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts +15 -0
  22. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.d.ts.map +1 -0
  23. package/funcs/{subscribersPreferencesRetrieveByLevel.js → subscribersPreferencesRetrieveByLevelLegacy.js} +6 -4
  24. package/funcs/subscribersPreferencesRetrieveByLevelLegacy.js.map +1 -0
  25. package/funcs/subscribersPreferencesUpdate.d.ts +6 -2
  26. package/funcs/subscribersPreferencesUpdate.d.ts.map +1 -1
  27. package/funcs/subscribersPreferencesUpdate.js +18 -12
  28. package/funcs/subscribersPreferencesUpdate.js.map +1 -1
  29. package/funcs/subscribersPreferencesUpdateLegacy.d.ts +13 -0
  30. package/funcs/subscribersPreferencesUpdateLegacy.d.ts.map +1 -0
  31. package/funcs/subscribersPreferencesUpdateLegacy.js +139 -0
  32. package/funcs/subscribersPreferencesUpdateLegacy.js.map +1 -0
  33. package/funcs/{subscribersUpdate.d.ts → subscribersUpdateLegacy.d.ts} +2 -2
  34. package/funcs/subscribersUpdateLegacy.d.ts.map +1 -0
  35. package/funcs/{subscribersUpdate.js → subscribersUpdateLegacy.js} +4 -4
  36. package/funcs/subscribersUpdateLegacy.js.map +1 -0
  37. package/jsr.json +1 -1
  38. package/lib/config.d.ts +3 -3
  39. package/lib/config.js +3 -3
  40. package/models/components/getsubscriberpreferencesdto.d.ts +39 -0
  41. package/models/components/getsubscriberpreferencesdto.d.ts.map +1 -0
  42. package/models/components/getsubscriberpreferencesdto.js +63 -0
  43. package/models/components/getsubscriberpreferencesdto.js.map +1 -0
  44. package/models/components/globalpreferencedto.d.ts +38 -0
  45. package/models/components/globalpreferencedto.d.ts.map +1 -0
  46. package/models/components/globalpreferencedto.js +62 -0
  47. package/models/components/globalpreferencedto.js.map +1 -0
  48. package/models/components/index.d.ts +7 -0
  49. package/models/components/index.d.ts.map +1 -1
  50. package/models/components/index.js +7 -0
  51. package/models/components/index.js.map +1 -1
  52. package/models/components/overrides.d.ts +112 -0
  53. package/models/components/overrides.d.ts.map +1 -0
  54. package/models/components/overrides.js +110 -0
  55. package/models/components/overrides.js.map +1 -0
  56. package/models/components/patchpreferencechannelsdto.d.ts +52 -0
  57. package/models/components/patchpreferencechannelsdto.d.ts.map +1 -0
  58. package/models/components/patchpreferencechannelsdto.js +76 -0
  59. package/models/components/patchpreferencechannelsdto.js.map +1 -0
  60. package/models/components/patchsubscriberpreferencesdto.d.ts +38 -0
  61. package/models/components/patchsubscriberpreferencesdto.d.ts.map +1 -0
  62. package/models/components/patchsubscriberpreferencesdto.js +62 -0
  63. package/models/components/patchsubscriberpreferencesdto.js.map +1 -0
  64. package/models/components/triggereventtoallrequestdto.d.ts +15 -15
  65. package/models/components/triggereventtoallrequestdto.d.ts.map +1 -1
  66. package/models/components/triggereventtoallrequestdto.js +20 -18
  67. package/models/components/triggereventtoallrequestdto.js.map +1 -1
  68. package/models/components/workflowinfodto.d.ts +42 -0
  69. package/models/components/workflowinfodto.d.ts.map +1 -0
  70. package/models/components/workflowinfodto.js +63 -0
  71. package/models/components/workflowinfodto.js.map +1 -0
  72. package/models/components/workflowpreferencedto.d.ts +50 -0
  73. package/models/components/workflowpreferencedto.d.ts.map +1 -0
  74. package/models/components/workflowpreferencedto.js +68 -0
  75. package/models/components/workflowpreferencedto.js.map +1 -0
  76. package/models/operations/index.d.ts +2 -0
  77. package/models/operations/index.d.ts.map +1 -1
  78. package/models/operations/index.js +2 -0
  79. package/models/operations/index.js.map +1 -1
  80. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts +66 -0
  81. package/models/operations/subscriberscontrollergetsubscriberpreferences.d.ts.map +1 -0
  82. package/models/operations/subscriberscontrollergetsubscriberpreferences.js +110 -0
  83. package/models/operations/subscriberscontrollergetsubscriberpreferences.js.map +1 -0
  84. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts +68 -0
  85. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.d.ts.map +1 -0
  86. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js +118 -0
  87. package/models/operations/subscriberscontrollerupdatesubscriberpreferences.js.map +1 -0
  88. package/package.json +1 -1
  89. package/sdk/legacy.d.ts +10 -0
  90. package/sdk/legacy.d.ts.map +1 -0
  91. package/sdk/legacy.js +19 -0
  92. package/sdk/legacy.js.map +1 -0
  93. package/sdk/preferences.d.ts +24 -7
  94. package/sdk/preferences.d.ts.map +1 -1
  95. package/sdk/preferences.js +35 -14
  96. package/sdk/preferences.js.map +1 -1
  97. package/sdk/subscribers.d.ts +1 -1
  98. package/sdk/subscribers.d.ts.map +1 -1
  99. package/sdk/subscribers.js +3 -3
  100. package/sdk/subscribers.js.map +1 -1
  101. package/sources/json-development.json +1225 -57
  102. package/src/funcs/{subscribersPreferencesUpdateGlobal.ts → subscribersPreferencesLegacyUpdateGlobal.ts} +1 -1
  103. package/src/funcs/{subscribersPreferencesList.ts → subscribersPreferencesListLegacy.ts} +3 -1
  104. package/src/funcs/subscribersPreferencesRetrieve.ts +203 -0
  105. package/src/funcs/{subscribersPreferencesRetrieveByLevel.ts → subscribersPreferencesRetrieveByLevelLegacy.ts} +3 -1
  106. package/src/funcs/subscribersPreferencesUpdate.ts +27 -20
  107. package/src/funcs/subscribersPreferencesUpdateLegacy.ts +202 -0
  108. package/src/funcs/{subscribersUpdate.ts → subscribersUpdateLegacy.ts} +1 -1
  109. package/src/lib/config.ts +3 -3
  110. package/src/models/components/getsubscriberpreferencesdto.ts +90 -0
  111. package/src/models/components/globalpreferencedto.ts +82 -0
  112. package/src/models/components/index.ts +7 -0
  113. package/src/models/components/overrides.ts +141 -0
  114. package/src/models/components/patchpreferencechannelsdto.ts +106 -0
  115. package/src/models/components/patchsubscriberpreferencesdto.ts +84 -0
  116. package/src/models/components/triggereventtoallrequestdto.ts +35 -24
  117. package/src/models/components/workflowinfodto.ts +81 -0
  118. package/src/models/components/workflowpreferencedto.ts +108 -0
  119. package/src/models/operations/index.ts +2 -0
  120. package/src/models/operations/subscriberscontrollergetsubscriberpreferences.ts +183 -0
  121. package/src/models/operations/subscriberscontrollerupdatesubscriberpreferences.ts +189 -0
  122. package/src/sdk/legacy.ts +32 -0
  123. package/src/sdk/preferences.ts +58 -26
  124. package/src/sdk/subscribers.ts +3 -3
  125. package/funcs/subscribersPreferencesList.d.ts +0 -13
  126. package/funcs/subscribersPreferencesList.d.ts.map +0 -1
  127. package/funcs/subscribersPreferencesList.js.map +0 -1
  128. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts +0 -13
  129. package/funcs/subscribersPreferencesRetrieveByLevel.d.ts.map +0 -1
  130. package/funcs/subscribersPreferencesRetrieveByLevel.js.map +0 -1
  131. package/funcs/subscribersPreferencesUpdateGlobal.d.ts.map +0 -1
  132. package/funcs/subscribersPreferencesUpdateGlobal.js.map +0 -1
  133. package/funcs/subscribersUpdate.d.ts.map +0 -1
  134. package/funcs/subscribersUpdate.js.map +0 -1
@@ -8878,6 +8878,7 @@
8878
8878
  },
8879
8879
  "put": {
8880
8880
  "operationId": "SubscribersV1Controller_updateSubscriber",
8881
+ "x-speakeasy-name-override": "updateLegacy",
8881
8882
  "summary": "Update subscriber",
8882
8883
  "description": "Used to update the subscriber entity with new information",
8883
8884
  "parameters": [
@@ -12307,9 +12308,10 @@
12307
12308
  "/v1/subscribers/{subscriberId}/preferences": {
12308
12309
  "get": {
12309
12310
  "operationId": "SubscribersV1Controller_listSubscriberPreferences",
12310
- "x-speakeasy-name-override": "list",
12311
+ "x-speakeasy-name-override": "listLegacy",
12311
12312
  "x-speakeasy-group": "Subscribers.Preferences",
12312
12313
  "summary": "Get subscriber preferences",
12314
+ "deprecated": true,
12313
12315
  "parameters": [
12314
12316
  {
12315
12317
  "name": "subscriberId",
@@ -12802,7 +12804,7 @@
12802
12804
  "patch": {
12803
12805
  "operationId": "SubscribersV1Controller_updateSubscriberGlobalPreferences",
12804
12806
  "x-speakeasy-name-override": "updateGlobal",
12805
- "x-speakeasy-group": "Subscribers.Preferences",
12807
+ "x-speakeasy-group": "Subscribers.Preferences.legacy",
12806
12808
  "summary": "Update subscriber global preferences",
12807
12809
  "parameters": [
12808
12810
  {
@@ -13295,9 +13297,10 @@
13295
13297
  "/v1/subscribers/{subscriberId}/preferences/{parameter}": {
13296
13298
  "get": {
13297
13299
  "operationId": "SubscribersV1Controller_getSubscriberPreferenceByLevel",
13298
- "x-speakeasy-name-override": "retrieveByLevel",
13300
+ "x-speakeasy-name-override": "retrieveByLevelLegacy",
13299
13301
  "x-speakeasy-group": "Subscribers.Preferences",
13300
13302
  "summary": "Get subscriber preferences by level",
13303
+ "deprecated": true,
13301
13304
  "parameters": [
13302
13305
  {
13303
13306
  "name": "includeInactiveChannels",
@@ -13803,6 +13806,7 @@
13803
13806
  },
13804
13807
  "patch": {
13805
13808
  "operationId": "SubscribersV1Controller_updateSubscriberPreference",
13809
+ "x-speakeasy-name-override": "updateLegacy",
13806
13810
  "x-speakeasy-group": "Subscribers.Preferences",
13807
13811
  "summary": "Update subscriber preference",
13808
13812
  "parameters": [
@@ -17945,33 +17949,999 @@
17945
17949
  "schema": {
17946
17950
  "type": "string"
17947
17951
  }
17948
- },
17952
+ },
17953
+ {
17954
+ "name": "limit",
17955
+ "required": false,
17956
+ "in": "query",
17957
+ "schema": {
17958
+ "type": "number"
17959
+ }
17960
+ },
17961
+ {
17962
+ "name": "orderDirection",
17963
+ "required": false,
17964
+ "in": "query",
17965
+ "schema": {
17966
+ "enum": [
17967
+ "ASC",
17968
+ "DESC"
17969
+ ],
17970
+ "type": "string"
17971
+ }
17972
+ },
17973
+ {
17974
+ "name": "orderBy",
17975
+ "required": false,
17976
+ "in": "query",
17977
+ "schema": {}
17978
+ },
17979
+ {
17980
+ "name": "idempotency-key",
17981
+ "in": "header",
17982
+ "description": "A header for idempotency purposes",
17983
+ "required": false,
17984
+ "schema": {
17985
+ "type": "string"
17986
+ }
17987
+ }
17988
+ ],
17989
+ "responses": {
17990
+ "200": {
17991
+ "description": "OK",
17992
+ "headers": {
17993
+ "Content-Type": {
17994
+ "$ref": "#/components/headers/Content-Type"
17995
+ },
17996
+ "RateLimit-Limit": {
17997
+ "$ref": "#/components/headers/RateLimit-Limit"
17998
+ },
17999
+ "RateLimit-Remaining": {
18000
+ "$ref": "#/components/headers/RateLimit-Remaining"
18001
+ },
18002
+ "RateLimit-Reset": {
18003
+ "$ref": "#/components/headers/RateLimit-Reset"
18004
+ },
18005
+ "RateLimit-Policy": {
18006
+ "$ref": "#/components/headers/RateLimit-Policy"
18007
+ },
18008
+ "Idempotency-Key": {
18009
+ "$ref": "#/components/headers/Idempotency-Key"
18010
+ },
18011
+ "Idempotency-Replay": {
18012
+ "$ref": "#/components/headers/Idempotency-Replay"
18013
+ }
18014
+ },
18015
+ "content": {
18016
+ "application/json": {
18017
+ "schema": {
18018
+ "$ref": "#/components/schemas/ListSubscribersResponseDto"
18019
+ }
18020
+ }
18021
+ }
18022
+ },
18023
+ "400": {
18024
+ "description": "Bad Request",
18025
+ "headers": {
18026
+ "Content-Type": {
18027
+ "$ref": "#/components/headers/Content-Type"
18028
+ },
18029
+ "RateLimit-Limit": {
18030
+ "$ref": "#/components/headers/RateLimit-Limit"
18031
+ },
18032
+ "RateLimit-Remaining": {
18033
+ "$ref": "#/components/headers/RateLimit-Remaining"
18034
+ },
18035
+ "RateLimit-Reset": {
18036
+ "$ref": "#/components/headers/RateLimit-Reset"
18037
+ },
18038
+ "RateLimit-Policy": {
18039
+ "$ref": "#/components/headers/RateLimit-Policy"
18040
+ },
18041
+ "Idempotency-Key": {
18042
+ "$ref": "#/components/headers/Idempotency-Key"
18043
+ },
18044
+ "Idempotency-Replay": {
18045
+ "$ref": "#/components/headers/Idempotency-Replay"
18046
+ }
18047
+ },
18048
+ "content": {
18049
+ "application/json": {
18050
+ "schema": {
18051
+ "$ref": "#/components/schemas/ErrorDto"
18052
+ }
18053
+ }
18054
+ }
18055
+ },
18056
+ "401": {
18057
+ "description": "Unauthorized",
18058
+ "headers": {
18059
+ "Content-Type": {
18060
+ "$ref": "#/components/headers/Content-Type"
18061
+ },
18062
+ "RateLimit-Limit": {
18063
+ "$ref": "#/components/headers/RateLimit-Limit"
18064
+ },
18065
+ "RateLimit-Remaining": {
18066
+ "$ref": "#/components/headers/RateLimit-Remaining"
18067
+ },
18068
+ "RateLimit-Reset": {
18069
+ "$ref": "#/components/headers/RateLimit-Reset"
18070
+ },
18071
+ "RateLimit-Policy": {
18072
+ "$ref": "#/components/headers/RateLimit-Policy"
18073
+ },
18074
+ "Idempotency-Key": {
18075
+ "$ref": "#/components/headers/Idempotency-Key"
18076
+ },
18077
+ "Idempotency-Replay": {
18078
+ "$ref": "#/components/headers/Idempotency-Replay"
18079
+ }
18080
+ },
18081
+ "content": {
18082
+ "application/json": {
18083
+ "schema": {
18084
+ "$ref": "#/components/schemas/ErrorDto"
18085
+ }
18086
+ }
18087
+ }
18088
+ },
18089
+ "403": {
18090
+ "description": "Forbidden",
18091
+ "headers": {
18092
+ "Content-Type": {
18093
+ "$ref": "#/components/headers/Content-Type"
18094
+ },
18095
+ "RateLimit-Limit": {
18096
+ "$ref": "#/components/headers/RateLimit-Limit"
18097
+ },
18098
+ "RateLimit-Remaining": {
18099
+ "$ref": "#/components/headers/RateLimit-Remaining"
18100
+ },
18101
+ "RateLimit-Reset": {
18102
+ "$ref": "#/components/headers/RateLimit-Reset"
18103
+ },
18104
+ "RateLimit-Policy": {
18105
+ "$ref": "#/components/headers/RateLimit-Policy"
18106
+ },
18107
+ "Idempotency-Key": {
18108
+ "$ref": "#/components/headers/Idempotency-Key"
18109
+ },
18110
+ "Idempotency-Replay": {
18111
+ "$ref": "#/components/headers/Idempotency-Replay"
18112
+ }
18113
+ },
18114
+ "content": {
18115
+ "application/json": {
18116
+ "schema": {
18117
+ "$ref": "#/components/schemas/ErrorDto"
18118
+ }
18119
+ }
18120
+ }
18121
+ },
18122
+ "404": {
18123
+ "description": "Not Found",
18124
+ "headers": {
18125
+ "Content-Type": {
18126
+ "$ref": "#/components/headers/Content-Type"
18127
+ },
18128
+ "RateLimit-Limit": {
18129
+ "$ref": "#/components/headers/RateLimit-Limit"
18130
+ },
18131
+ "RateLimit-Remaining": {
18132
+ "$ref": "#/components/headers/RateLimit-Remaining"
18133
+ },
18134
+ "RateLimit-Reset": {
18135
+ "$ref": "#/components/headers/RateLimit-Reset"
18136
+ },
18137
+ "RateLimit-Policy": {
18138
+ "$ref": "#/components/headers/RateLimit-Policy"
18139
+ },
18140
+ "Idempotency-Key": {
18141
+ "$ref": "#/components/headers/Idempotency-Key"
18142
+ },
18143
+ "Idempotency-Replay": {
18144
+ "$ref": "#/components/headers/Idempotency-Replay"
18145
+ }
18146
+ },
18147
+ "content": {
18148
+ "application/json": {
18149
+ "schema": {
18150
+ "$ref": "#/components/schemas/ErrorDto"
18151
+ }
18152
+ }
18153
+ }
18154
+ },
18155
+ "405": {
18156
+ "description": "Method Not Allowed",
18157
+ "headers": {
18158
+ "Content-Type": {
18159
+ "$ref": "#/components/headers/Content-Type"
18160
+ },
18161
+ "RateLimit-Limit": {
18162
+ "$ref": "#/components/headers/RateLimit-Limit"
18163
+ },
18164
+ "RateLimit-Remaining": {
18165
+ "$ref": "#/components/headers/RateLimit-Remaining"
18166
+ },
18167
+ "RateLimit-Reset": {
18168
+ "$ref": "#/components/headers/RateLimit-Reset"
18169
+ },
18170
+ "RateLimit-Policy": {
18171
+ "$ref": "#/components/headers/RateLimit-Policy"
18172
+ },
18173
+ "Idempotency-Key": {
18174
+ "$ref": "#/components/headers/Idempotency-Key"
18175
+ },
18176
+ "Idempotency-Replay": {
18177
+ "$ref": "#/components/headers/Idempotency-Replay"
18178
+ }
18179
+ },
18180
+ "content": {
18181
+ "application/json": {
18182
+ "schema": {
18183
+ "$ref": "#/components/schemas/ErrorDto"
18184
+ }
18185
+ }
18186
+ }
18187
+ },
18188
+ "409": {
18189
+ "description": "Conflict",
18190
+ "headers": {
18191
+ "Content-Type": {
18192
+ "$ref": "#/components/headers/Content-Type"
18193
+ },
18194
+ "RateLimit-Limit": {
18195
+ "$ref": "#/components/headers/RateLimit-Limit"
18196
+ },
18197
+ "RateLimit-Remaining": {
18198
+ "$ref": "#/components/headers/RateLimit-Remaining"
18199
+ },
18200
+ "RateLimit-Reset": {
18201
+ "$ref": "#/components/headers/RateLimit-Reset"
18202
+ },
18203
+ "RateLimit-Policy": {
18204
+ "$ref": "#/components/headers/RateLimit-Policy"
18205
+ },
18206
+ "Idempotency-Key": {
18207
+ "$ref": "#/components/headers/Idempotency-Key"
18208
+ },
18209
+ "Idempotency-Replay": {
18210
+ "$ref": "#/components/headers/Idempotency-Replay"
18211
+ }
18212
+ },
18213
+ "content": {
18214
+ "application/json": {
18215
+ "schema": {
18216
+ "$ref": "#/components/schemas/ErrorDto"
18217
+ }
18218
+ }
18219
+ }
18220
+ },
18221
+ "413": {
18222
+ "description": "Payload Too Large",
18223
+ "headers": {
18224
+ "Content-Type": {
18225
+ "$ref": "#/components/headers/Content-Type"
18226
+ },
18227
+ "RateLimit-Limit": {
18228
+ "$ref": "#/components/headers/RateLimit-Limit"
18229
+ },
18230
+ "RateLimit-Remaining": {
18231
+ "$ref": "#/components/headers/RateLimit-Remaining"
18232
+ },
18233
+ "RateLimit-Reset": {
18234
+ "$ref": "#/components/headers/RateLimit-Reset"
18235
+ },
18236
+ "RateLimit-Policy": {
18237
+ "$ref": "#/components/headers/RateLimit-Policy"
18238
+ },
18239
+ "Idempotency-Key": {
18240
+ "$ref": "#/components/headers/Idempotency-Key"
18241
+ },
18242
+ "Idempotency-Replay": {
18243
+ "$ref": "#/components/headers/Idempotency-Replay"
18244
+ }
18245
+ },
18246
+ "content": {
18247
+ "application/json": {
18248
+ "schema": {
18249
+ "$ref": "#/components/schemas/ErrorDto"
18250
+ }
18251
+ }
18252
+ }
18253
+ },
18254
+ "414": {
18255
+ "description": "URI Too Long",
18256
+ "content": {
18257
+ "application/json": {
18258
+ "schema": {
18259
+ "$ref": "#/components/schemas/ErrorDto"
18260
+ }
18261
+ }
18262
+ }
18263
+ },
18264
+ "415": {
18265
+ "description": "Unsupported Media Type",
18266
+ "headers": {
18267
+ "Content-Type": {
18268
+ "$ref": "#/components/headers/Content-Type"
18269
+ },
18270
+ "RateLimit-Limit": {
18271
+ "$ref": "#/components/headers/RateLimit-Limit"
18272
+ },
18273
+ "RateLimit-Remaining": {
18274
+ "$ref": "#/components/headers/RateLimit-Remaining"
18275
+ },
18276
+ "RateLimit-Reset": {
18277
+ "$ref": "#/components/headers/RateLimit-Reset"
18278
+ },
18279
+ "RateLimit-Policy": {
18280
+ "$ref": "#/components/headers/RateLimit-Policy"
18281
+ },
18282
+ "Idempotency-Key": {
18283
+ "$ref": "#/components/headers/Idempotency-Key"
18284
+ },
18285
+ "Idempotency-Replay": {
18286
+ "$ref": "#/components/headers/Idempotency-Replay"
18287
+ }
18288
+ },
18289
+ "content": {
18290
+ "application/json": {
18291
+ "schema": {
18292
+ "$ref": "#/components/schemas/ErrorDto"
18293
+ }
18294
+ }
18295
+ }
18296
+ },
18297
+ "422": {
18298
+ "description": "Unprocessable Entity",
18299
+ "headers": {
18300
+ "Content-Type": {
18301
+ "$ref": "#/components/headers/Content-Type"
18302
+ },
18303
+ "RateLimit-Limit": {
18304
+ "$ref": "#/components/headers/RateLimit-Limit"
18305
+ },
18306
+ "RateLimit-Remaining": {
18307
+ "$ref": "#/components/headers/RateLimit-Remaining"
18308
+ },
18309
+ "RateLimit-Reset": {
18310
+ "$ref": "#/components/headers/RateLimit-Reset"
18311
+ },
18312
+ "RateLimit-Policy": {
18313
+ "$ref": "#/components/headers/RateLimit-Policy"
18314
+ },
18315
+ "Idempotency-Key": {
18316
+ "$ref": "#/components/headers/Idempotency-Key"
18317
+ },
18318
+ "Idempotency-Replay": {
18319
+ "$ref": "#/components/headers/Idempotency-Replay"
18320
+ }
18321
+ },
18322
+ "content": {
18323
+ "application/json": {
18324
+ "schema": {
18325
+ "$ref": "#/components/schemas/ValidationErrorDto"
18326
+ }
18327
+ }
18328
+ }
18329
+ },
18330
+ "429": {
18331
+ "description": "The client has sent too many requests in a given amount of time. ",
18332
+ "headers": {
18333
+ "Content-Type": {
18334
+ "$ref": "#/components/headers/Content-Type"
18335
+ },
18336
+ "RateLimit-Limit": {
18337
+ "$ref": "#/components/headers/RateLimit-Limit"
18338
+ },
18339
+ "RateLimit-Remaining": {
18340
+ "$ref": "#/components/headers/RateLimit-Remaining"
18341
+ },
18342
+ "RateLimit-Reset": {
18343
+ "$ref": "#/components/headers/RateLimit-Reset"
18344
+ },
18345
+ "RateLimit-Policy": {
18346
+ "$ref": "#/components/headers/RateLimit-Policy"
18347
+ },
18348
+ "Idempotency-Key": {
18349
+ "$ref": "#/components/headers/Idempotency-Key"
18350
+ },
18351
+ "Idempotency-Replay": {
18352
+ "$ref": "#/components/headers/Idempotency-Replay"
18353
+ },
18354
+ "Retry-After": {
18355
+ "$ref": "#/components/headers/Retry-After"
18356
+ }
18357
+ },
18358
+ "content": {
18359
+ "application/json": {
18360
+ "schema": {
18361
+ "type": "string",
18362
+ "example": "API rate limit exceeded"
18363
+ }
18364
+ }
18365
+ }
18366
+ },
18367
+ "500": {
18368
+ "description": "Internal Server Error",
18369
+ "headers": {
18370
+ "Content-Type": {
18371
+ "$ref": "#/components/headers/Content-Type"
18372
+ },
18373
+ "RateLimit-Limit": {
18374
+ "$ref": "#/components/headers/RateLimit-Limit"
18375
+ },
18376
+ "RateLimit-Remaining": {
18377
+ "$ref": "#/components/headers/RateLimit-Remaining"
18378
+ },
18379
+ "RateLimit-Reset": {
18380
+ "$ref": "#/components/headers/RateLimit-Reset"
18381
+ },
18382
+ "RateLimit-Policy": {
18383
+ "$ref": "#/components/headers/RateLimit-Policy"
18384
+ },
18385
+ "Idempotency-Key": {
18386
+ "$ref": "#/components/headers/Idempotency-Key"
18387
+ },
18388
+ "Idempotency-Replay": {
18389
+ "$ref": "#/components/headers/Idempotency-Replay"
18390
+ }
18391
+ },
18392
+ "content": {
18393
+ "application/json": {
18394
+ "schema": {
18395
+ "$ref": "#/components/schemas/ErrorDto"
18396
+ }
18397
+ }
18398
+ }
18399
+ },
18400
+ "503": {
18401
+ "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.",
18402
+ "headers": {
18403
+ "Content-Type": {
18404
+ "$ref": "#/components/headers/Content-Type"
18405
+ },
18406
+ "RateLimit-Limit": {
18407
+ "$ref": "#/components/headers/RateLimit-Limit"
18408
+ },
18409
+ "RateLimit-Remaining": {
18410
+ "$ref": "#/components/headers/RateLimit-Remaining"
18411
+ },
18412
+ "RateLimit-Reset": {
18413
+ "$ref": "#/components/headers/RateLimit-Reset"
18414
+ },
18415
+ "RateLimit-Policy": {
18416
+ "$ref": "#/components/headers/RateLimit-Policy"
18417
+ },
18418
+ "Idempotency-Key": {
18419
+ "$ref": "#/components/headers/Idempotency-Key"
18420
+ },
18421
+ "Idempotency-Replay": {
18422
+ "$ref": "#/components/headers/Idempotency-Replay"
18423
+ },
18424
+ "Retry-After": {
18425
+ "$ref": "#/components/headers/Retry-After"
18426
+ }
18427
+ },
18428
+ "content": {
18429
+ "application/json": {
18430
+ "schema": {
18431
+ "type": "string",
18432
+ "example": "Please wait some time, then try again."
18433
+ }
18434
+ }
18435
+ }
18436
+ }
18437
+ },
18438
+ "tags": [
18439
+ "Subscribers"
18440
+ ],
18441
+ "security": [
18442
+ {
18443
+ "secretKey": []
18444
+ }
18445
+ ]
18446
+ }
18447
+ },
18448
+ "/v2/subscribers/{subscriberId}": {
18449
+ "get": {
18450
+ "operationId": "SubscribersController_getSubscriber",
18451
+ "x-speakeasy-name-override": "retrieve",
18452
+ "summary": "Get subscriber",
18453
+ "description": "Get subscriber by your internal id used to identify the subscriber",
18454
+ "parameters": [
18455
+ {
18456
+ "name": "subscriberId",
18457
+ "required": true,
18458
+ "in": "path",
18459
+ "schema": {
18460
+ "type": "string"
18461
+ }
18462
+ },
18463
+ {
18464
+ "name": "idempotency-key",
18465
+ "in": "header",
18466
+ "description": "A header for idempotency purposes",
18467
+ "required": false,
18468
+ "schema": {
18469
+ "type": "string"
18470
+ }
18471
+ }
18472
+ ],
18473
+ "responses": {
18474
+ "200": {
18475
+ "description": "OK",
18476
+ "headers": {
18477
+ "Content-Type": {
18478
+ "$ref": "#/components/headers/Content-Type"
18479
+ },
18480
+ "RateLimit-Limit": {
18481
+ "$ref": "#/components/headers/RateLimit-Limit"
18482
+ },
18483
+ "RateLimit-Remaining": {
18484
+ "$ref": "#/components/headers/RateLimit-Remaining"
18485
+ },
18486
+ "RateLimit-Reset": {
18487
+ "$ref": "#/components/headers/RateLimit-Reset"
18488
+ },
18489
+ "RateLimit-Policy": {
18490
+ "$ref": "#/components/headers/RateLimit-Policy"
18491
+ },
18492
+ "Idempotency-Key": {
18493
+ "$ref": "#/components/headers/Idempotency-Key"
18494
+ },
18495
+ "Idempotency-Replay": {
18496
+ "$ref": "#/components/headers/Idempotency-Replay"
18497
+ }
18498
+ },
18499
+ "content": {
18500
+ "application/json": {
18501
+ "schema": {
18502
+ "$ref": "#/components/schemas/SubscriberResponseDto"
18503
+ }
18504
+ }
18505
+ }
18506
+ },
18507
+ "400": {
18508
+ "description": "Bad Request",
18509
+ "headers": {
18510
+ "Content-Type": {
18511
+ "$ref": "#/components/headers/Content-Type"
18512
+ },
18513
+ "RateLimit-Limit": {
18514
+ "$ref": "#/components/headers/RateLimit-Limit"
18515
+ },
18516
+ "RateLimit-Remaining": {
18517
+ "$ref": "#/components/headers/RateLimit-Remaining"
18518
+ },
18519
+ "RateLimit-Reset": {
18520
+ "$ref": "#/components/headers/RateLimit-Reset"
18521
+ },
18522
+ "RateLimit-Policy": {
18523
+ "$ref": "#/components/headers/RateLimit-Policy"
18524
+ },
18525
+ "Idempotency-Key": {
18526
+ "$ref": "#/components/headers/Idempotency-Key"
18527
+ },
18528
+ "Idempotency-Replay": {
18529
+ "$ref": "#/components/headers/Idempotency-Replay"
18530
+ }
18531
+ },
18532
+ "content": {
18533
+ "application/json": {
18534
+ "schema": {
18535
+ "$ref": "#/components/schemas/ErrorDto"
18536
+ }
18537
+ }
18538
+ }
18539
+ },
18540
+ "401": {
18541
+ "description": "Unauthorized",
18542
+ "headers": {
18543
+ "Content-Type": {
18544
+ "$ref": "#/components/headers/Content-Type"
18545
+ },
18546
+ "RateLimit-Limit": {
18547
+ "$ref": "#/components/headers/RateLimit-Limit"
18548
+ },
18549
+ "RateLimit-Remaining": {
18550
+ "$ref": "#/components/headers/RateLimit-Remaining"
18551
+ },
18552
+ "RateLimit-Reset": {
18553
+ "$ref": "#/components/headers/RateLimit-Reset"
18554
+ },
18555
+ "RateLimit-Policy": {
18556
+ "$ref": "#/components/headers/RateLimit-Policy"
18557
+ },
18558
+ "Idempotency-Key": {
18559
+ "$ref": "#/components/headers/Idempotency-Key"
18560
+ },
18561
+ "Idempotency-Replay": {
18562
+ "$ref": "#/components/headers/Idempotency-Replay"
18563
+ }
18564
+ },
18565
+ "content": {
18566
+ "application/json": {
18567
+ "schema": {
18568
+ "$ref": "#/components/schemas/ErrorDto"
18569
+ }
18570
+ }
18571
+ }
18572
+ },
18573
+ "403": {
18574
+ "description": "Forbidden",
18575
+ "headers": {
18576
+ "Content-Type": {
18577
+ "$ref": "#/components/headers/Content-Type"
18578
+ },
18579
+ "RateLimit-Limit": {
18580
+ "$ref": "#/components/headers/RateLimit-Limit"
18581
+ },
18582
+ "RateLimit-Remaining": {
18583
+ "$ref": "#/components/headers/RateLimit-Remaining"
18584
+ },
18585
+ "RateLimit-Reset": {
18586
+ "$ref": "#/components/headers/RateLimit-Reset"
18587
+ },
18588
+ "RateLimit-Policy": {
18589
+ "$ref": "#/components/headers/RateLimit-Policy"
18590
+ },
18591
+ "Idempotency-Key": {
18592
+ "$ref": "#/components/headers/Idempotency-Key"
18593
+ },
18594
+ "Idempotency-Replay": {
18595
+ "$ref": "#/components/headers/Idempotency-Replay"
18596
+ }
18597
+ },
18598
+ "content": {
18599
+ "application/json": {
18600
+ "schema": {
18601
+ "$ref": "#/components/schemas/ErrorDto"
18602
+ }
18603
+ }
18604
+ }
18605
+ },
18606
+ "404": {
18607
+ "description": "Not Found",
18608
+ "headers": {
18609
+ "Content-Type": {
18610
+ "$ref": "#/components/headers/Content-Type"
18611
+ },
18612
+ "RateLimit-Limit": {
18613
+ "$ref": "#/components/headers/RateLimit-Limit"
18614
+ },
18615
+ "RateLimit-Remaining": {
18616
+ "$ref": "#/components/headers/RateLimit-Remaining"
18617
+ },
18618
+ "RateLimit-Reset": {
18619
+ "$ref": "#/components/headers/RateLimit-Reset"
18620
+ },
18621
+ "RateLimit-Policy": {
18622
+ "$ref": "#/components/headers/RateLimit-Policy"
18623
+ },
18624
+ "Idempotency-Key": {
18625
+ "$ref": "#/components/headers/Idempotency-Key"
18626
+ },
18627
+ "Idempotency-Replay": {
18628
+ "$ref": "#/components/headers/Idempotency-Replay"
18629
+ }
18630
+ },
18631
+ "content": {
18632
+ "application/json": {
18633
+ "schema": {
18634
+ "$ref": "#/components/schemas/ErrorDto"
18635
+ }
18636
+ }
18637
+ }
18638
+ },
18639
+ "405": {
18640
+ "description": "Method Not Allowed",
18641
+ "headers": {
18642
+ "Content-Type": {
18643
+ "$ref": "#/components/headers/Content-Type"
18644
+ },
18645
+ "RateLimit-Limit": {
18646
+ "$ref": "#/components/headers/RateLimit-Limit"
18647
+ },
18648
+ "RateLimit-Remaining": {
18649
+ "$ref": "#/components/headers/RateLimit-Remaining"
18650
+ },
18651
+ "RateLimit-Reset": {
18652
+ "$ref": "#/components/headers/RateLimit-Reset"
18653
+ },
18654
+ "RateLimit-Policy": {
18655
+ "$ref": "#/components/headers/RateLimit-Policy"
18656
+ },
18657
+ "Idempotency-Key": {
18658
+ "$ref": "#/components/headers/Idempotency-Key"
18659
+ },
18660
+ "Idempotency-Replay": {
18661
+ "$ref": "#/components/headers/Idempotency-Replay"
18662
+ }
18663
+ },
18664
+ "content": {
18665
+ "application/json": {
18666
+ "schema": {
18667
+ "$ref": "#/components/schemas/ErrorDto"
18668
+ }
18669
+ }
18670
+ }
18671
+ },
18672
+ "409": {
18673
+ "description": "Conflict",
18674
+ "headers": {
18675
+ "Content-Type": {
18676
+ "$ref": "#/components/headers/Content-Type"
18677
+ },
18678
+ "RateLimit-Limit": {
18679
+ "$ref": "#/components/headers/RateLimit-Limit"
18680
+ },
18681
+ "RateLimit-Remaining": {
18682
+ "$ref": "#/components/headers/RateLimit-Remaining"
18683
+ },
18684
+ "RateLimit-Reset": {
18685
+ "$ref": "#/components/headers/RateLimit-Reset"
18686
+ },
18687
+ "RateLimit-Policy": {
18688
+ "$ref": "#/components/headers/RateLimit-Policy"
18689
+ },
18690
+ "Idempotency-Key": {
18691
+ "$ref": "#/components/headers/Idempotency-Key"
18692
+ },
18693
+ "Idempotency-Replay": {
18694
+ "$ref": "#/components/headers/Idempotency-Replay"
18695
+ }
18696
+ },
18697
+ "content": {
18698
+ "application/json": {
18699
+ "schema": {
18700
+ "$ref": "#/components/schemas/ErrorDto"
18701
+ }
18702
+ }
18703
+ }
18704
+ },
18705
+ "413": {
18706
+ "description": "Payload Too Large",
18707
+ "headers": {
18708
+ "Content-Type": {
18709
+ "$ref": "#/components/headers/Content-Type"
18710
+ },
18711
+ "RateLimit-Limit": {
18712
+ "$ref": "#/components/headers/RateLimit-Limit"
18713
+ },
18714
+ "RateLimit-Remaining": {
18715
+ "$ref": "#/components/headers/RateLimit-Remaining"
18716
+ },
18717
+ "RateLimit-Reset": {
18718
+ "$ref": "#/components/headers/RateLimit-Reset"
18719
+ },
18720
+ "RateLimit-Policy": {
18721
+ "$ref": "#/components/headers/RateLimit-Policy"
18722
+ },
18723
+ "Idempotency-Key": {
18724
+ "$ref": "#/components/headers/Idempotency-Key"
18725
+ },
18726
+ "Idempotency-Replay": {
18727
+ "$ref": "#/components/headers/Idempotency-Replay"
18728
+ }
18729
+ },
18730
+ "content": {
18731
+ "application/json": {
18732
+ "schema": {
18733
+ "$ref": "#/components/schemas/ErrorDto"
18734
+ }
18735
+ }
18736
+ }
18737
+ },
18738
+ "414": {
18739
+ "description": "URI Too Long",
18740
+ "content": {
18741
+ "application/json": {
18742
+ "schema": {
18743
+ "$ref": "#/components/schemas/ErrorDto"
18744
+ }
18745
+ }
18746
+ }
18747
+ },
18748
+ "415": {
18749
+ "description": "Unsupported Media Type",
18750
+ "headers": {
18751
+ "Content-Type": {
18752
+ "$ref": "#/components/headers/Content-Type"
18753
+ },
18754
+ "RateLimit-Limit": {
18755
+ "$ref": "#/components/headers/RateLimit-Limit"
18756
+ },
18757
+ "RateLimit-Remaining": {
18758
+ "$ref": "#/components/headers/RateLimit-Remaining"
18759
+ },
18760
+ "RateLimit-Reset": {
18761
+ "$ref": "#/components/headers/RateLimit-Reset"
18762
+ },
18763
+ "RateLimit-Policy": {
18764
+ "$ref": "#/components/headers/RateLimit-Policy"
18765
+ },
18766
+ "Idempotency-Key": {
18767
+ "$ref": "#/components/headers/Idempotency-Key"
18768
+ },
18769
+ "Idempotency-Replay": {
18770
+ "$ref": "#/components/headers/Idempotency-Replay"
18771
+ }
18772
+ },
18773
+ "content": {
18774
+ "application/json": {
18775
+ "schema": {
18776
+ "$ref": "#/components/schemas/ErrorDto"
18777
+ }
18778
+ }
18779
+ }
18780
+ },
18781
+ "422": {
18782
+ "description": "Unprocessable Entity",
18783
+ "headers": {
18784
+ "Content-Type": {
18785
+ "$ref": "#/components/headers/Content-Type"
18786
+ },
18787
+ "RateLimit-Limit": {
18788
+ "$ref": "#/components/headers/RateLimit-Limit"
18789
+ },
18790
+ "RateLimit-Remaining": {
18791
+ "$ref": "#/components/headers/RateLimit-Remaining"
18792
+ },
18793
+ "RateLimit-Reset": {
18794
+ "$ref": "#/components/headers/RateLimit-Reset"
18795
+ },
18796
+ "RateLimit-Policy": {
18797
+ "$ref": "#/components/headers/RateLimit-Policy"
18798
+ },
18799
+ "Idempotency-Key": {
18800
+ "$ref": "#/components/headers/Idempotency-Key"
18801
+ },
18802
+ "Idempotency-Replay": {
18803
+ "$ref": "#/components/headers/Idempotency-Replay"
18804
+ }
18805
+ },
18806
+ "content": {
18807
+ "application/json": {
18808
+ "schema": {
18809
+ "$ref": "#/components/schemas/ValidationErrorDto"
18810
+ }
18811
+ }
18812
+ }
18813
+ },
18814
+ "429": {
18815
+ "description": "The client has sent too many requests in a given amount of time. ",
18816
+ "headers": {
18817
+ "Content-Type": {
18818
+ "$ref": "#/components/headers/Content-Type"
18819
+ },
18820
+ "RateLimit-Limit": {
18821
+ "$ref": "#/components/headers/RateLimit-Limit"
18822
+ },
18823
+ "RateLimit-Remaining": {
18824
+ "$ref": "#/components/headers/RateLimit-Remaining"
18825
+ },
18826
+ "RateLimit-Reset": {
18827
+ "$ref": "#/components/headers/RateLimit-Reset"
18828
+ },
18829
+ "RateLimit-Policy": {
18830
+ "$ref": "#/components/headers/RateLimit-Policy"
18831
+ },
18832
+ "Idempotency-Key": {
18833
+ "$ref": "#/components/headers/Idempotency-Key"
18834
+ },
18835
+ "Idempotency-Replay": {
18836
+ "$ref": "#/components/headers/Idempotency-Replay"
18837
+ },
18838
+ "Retry-After": {
18839
+ "$ref": "#/components/headers/Retry-After"
18840
+ }
18841
+ },
18842
+ "content": {
18843
+ "application/json": {
18844
+ "schema": {
18845
+ "type": "string",
18846
+ "example": "API rate limit exceeded"
18847
+ }
18848
+ }
18849
+ }
18850
+ },
18851
+ "500": {
18852
+ "description": "Internal Server Error",
18853
+ "headers": {
18854
+ "Content-Type": {
18855
+ "$ref": "#/components/headers/Content-Type"
18856
+ },
18857
+ "RateLimit-Limit": {
18858
+ "$ref": "#/components/headers/RateLimit-Limit"
18859
+ },
18860
+ "RateLimit-Remaining": {
18861
+ "$ref": "#/components/headers/RateLimit-Remaining"
18862
+ },
18863
+ "RateLimit-Reset": {
18864
+ "$ref": "#/components/headers/RateLimit-Reset"
18865
+ },
18866
+ "RateLimit-Policy": {
18867
+ "$ref": "#/components/headers/RateLimit-Policy"
18868
+ },
18869
+ "Idempotency-Key": {
18870
+ "$ref": "#/components/headers/Idempotency-Key"
18871
+ },
18872
+ "Idempotency-Replay": {
18873
+ "$ref": "#/components/headers/Idempotency-Replay"
18874
+ }
18875
+ },
18876
+ "content": {
18877
+ "application/json": {
18878
+ "schema": {
18879
+ "$ref": "#/components/schemas/ErrorDto"
18880
+ }
18881
+ }
18882
+ }
18883
+ },
18884
+ "503": {
18885
+ "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.",
18886
+ "headers": {
18887
+ "Content-Type": {
18888
+ "$ref": "#/components/headers/Content-Type"
18889
+ },
18890
+ "RateLimit-Limit": {
18891
+ "$ref": "#/components/headers/RateLimit-Limit"
18892
+ },
18893
+ "RateLimit-Remaining": {
18894
+ "$ref": "#/components/headers/RateLimit-Remaining"
18895
+ },
18896
+ "RateLimit-Reset": {
18897
+ "$ref": "#/components/headers/RateLimit-Reset"
18898
+ },
18899
+ "RateLimit-Policy": {
18900
+ "$ref": "#/components/headers/RateLimit-Policy"
18901
+ },
18902
+ "Idempotency-Key": {
18903
+ "$ref": "#/components/headers/Idempotency-Key"
18904
+ },
18905
+ "Idempotency-Replay": {
18906
+ "$ref": "#/components/headers/Idempotency-Replay"
18907
+ },
18908
+ "Retry-After": {
18909
+ "$ref": "#/components/headers/Retry-After"
18910
+ }
18911
+ },
18912
+ "content": {
18913
+ "application/json": {
18914
+ "schema": {
18915
+ "type": "string",
18916
+ "example": "Please wait some time, then try again."
18917
+ }
18918
+ }
18919
+ }
18920
+ }
18921
+ },
18922
+ "tags": [
18923
+ "Subscribers"
18924
+ ],
18925
+ "security": [
17949
18926
  {
17950
- "name": "limit",
17951
- "required": false,
17952
- "in": "query",
17953
- "schema": {
17954
- "type": "number"
17955
- }
17956
- },
18927
+ "secretKey": []
18928
+ }
18929
+ ]
18930
+ },
18931
+ "patch": {
18932
+ "operationId": "SubscribersController_patchSubscriber",
18933
+ "x-speakeasy-name-override": "patch",
18934
+ "summary": "Patch subscriber",
18935
+ "description": "Patch subscriber by your internal id used to identify the subscriber",
18936
+ "parameters": [
17957
18937
  {
17958
- "name": "orderDirection",
17959
- "required": false,
17960
- "in": "query",
18938
+ "name": "subscriberId",
18939
+ "required": true,
18940
+ "in": "path",
17961
18941
  "schema": {
17962
- "enum": [
17963
- "ASC",
17964
- "DESC"
17965
- ],
17966
18942
  "type": "string"
17967
18943
  }
17968
18944
  },
17969
- {
17970
- "name": "orderBy",
17971
- "required": false,
17972
- "in": "query",
17973
- "schema": {}
17974
- },
17975
18945
  {
17976
18946
  "name": "idempotency-key",
17977
18947
  "in": "header",
@@ -17982,6 +18952,16 @@
17982
18952
  }
17983
18953
  }
17984
18954
  ],
18955
+ "requestBody": {
18956
+ "required": true,
18957
+ "content": {
18958
+ "application/json": {
18959
+ "schema": {
18960
+ "$ref": "#/components/schemas/PatchSubscriberRequestDto"
18961
+ }
18962
+ }
18963
+ }
18964
+ },
17985
18965
  "responses": {
17986
18966
  "200": {
17987
18967
  "description": "OK",
@@ -18011,7 +18991,7 @@
18011
18991
  "content": {
18012
18992
  "application/json": {
18013
18993
  "schema": {
18014
- "$ref": "#/components/schemas/ListSubscribersResponseDto"
18994
+ "$ref": "#/components/schemas/SubscriberResponseDto"
18015
18995
  }
18016
18996
  }
18017
18997
  }
@@ -18439,14 +19419,12 @@
18439
19419
  "secretKey": []
18440
19420
  }
18441
19421
  ]
18442
- }
18443
- },
18444
- "/v2/subscribers/{subscriberId}": {
18445
- "get": {
18446
- "operationId": "SubscribersController_getSubscriber",
18447
- "x-speakeasy-name-override": "retrieve",
18448
- "summary": "Get subscriber",
18449
- "description": "Get subscriber by your internal id used to identify the subscriber",
19422
+ },
19423
+ "delete": {
19424
+ "operationId": "SubscribersController_removeSubscriber",
19425
+ "x-speakeasy-name-override": "delete",
19426
+ "summary": "Delete subscriber",
19427
+ "description": "Deletes a subscriber entity from the Novu platform",
18450
19428
  "parameters": [
18451
19429
  {
18452
19430
  "name": "subscriberId",
@@ -18495,7 +19473,7 @@
18495
19473
  "content": {
18496
19474
  "application/json": {
18497
19475
  "schema": {
18498
- "$ref": "#/components/schemas/SubscriberResponseDto"
19476
+ "$ref": "#/components/schemas/RemoveSubscriberResponseDto"
18499
19477
  }
18500
19478
  }
18501
19479
  }
@@ -18923,12 +19901,15 @@
18923
19901
  "secretKey": []
18924
19902
  }
18925
19903
  ]
18926
- },
18927
- "patch": {
18928
- "operationId": "SubscribersController_patchSubscriber",
18929
- "x-speakeasy-name-override": "patch",
18930
- "summary": "Patch subscriber",
18931
- "description": "Patch subscriber by your internal id used to identify the subscriber",
19904
+ }
19905
+ },
19906
+ "/v2/subscribers/{subscriberId}/preferences": {
19907
+ "get": {
19908
+ "operationId": "SubscribersController_getSubscriberPreferences",
19909
+ "x-speakeasy-name-override": "retrieve",
19910
+ "x-speakeasy-group": "Subscribers.Preferences",
19911
+ "summary": "Get subscriber preferences",
19912
+ "description": "Get subscriber global and workflow specific preferences",
18932
19913
  "parameters": [
18933
19914
  {
18934
19915
  "name": "subscriberId",
@@ -18948,16 +19929,6 @@
18948
19929
  }
18949
19930
  }
18950
19931
  ],
18951
- "requestBody": {
18952
- "required": true,
18953
- "content": {
18954
- "application/json": {
18955
- "schema": {
18956
- "$ref": "#/components/schemas/PatchSubscriberRequestDto"
18957
- }
18958
- }
18959
- }
18960
- },
18961
19932
  "responses": {
18962
19933
  "200": {
18963
19934
  "description": "OK",
@@ -18987,7 +19958,7 @@
18987
19958
  "content": {
18988
19959
  "application/json": {
18989
19960
  "schema": {
18990
- "$ref": "#/components/schemas/SubscriberResponseDto"
19961
+ "$ref": "#/components/schemas/GetSubscriberPreferencesDto"
18991
19962
  }
18992
19963
  }
18993
19964
  }
@@ -19416,11 +20387,12 @@
19416
20387
  }
19417
20388
  ]
19418
20389
  },
19419
- "delete": {
19420
- "operationId": "SubscribersController_removeSubscriber",
19421
- "x-speakeasy-name-override": "delete",
19422
- "summary": "Delete subscriber",
19423
- "description": "Deletes a subscriber entity from the Novu platform",
20390
+ "patch": {
20391
+ "operationId": "SubscribersController_updateSubscriberPreferences",
20392
+ "x-speakeasy-name-override": "update",
20393
+ "x-speakeasy-group": "Subscribers.Preferences",
20394
+ "summary": "Update subscriber global or workflow specific preferences",
20395
+ "description": "Update subscriber global or workflow specific preferences",
19424
20396
  "parameters": [
19425
20397
  {
19426
20398
  "name": "subscriberId",
@@ -19440,6 +20412,16 @@
19440
20412
  }
19441
20413
  }
19442
20414
  ],
20415
+ "requestBody": {
20416
+ "required": true,
20417
+ "content": {
20418
+ "application/json": {
20419
+ "schema": {
20420
+ "$ref": "#/components/schemas/PatchSubscriberPreferencesDto"
20421
+ }
20422
+ }
20423
+ }
20424
+ },
19443
20425
  "responses": {
19444
20426
  "200": {
19445
20427
  "description": "OK",
@@ -19469,7 +20451,7 @@
19469
20451
  "content": {
19470
20452
  "application/json": {
19471
20453
  "schema": {
19472
- "$ref": "#/components/schemas/RemoveSubscriberResponseDto"
20454
+ "$ref": "#/components/schemas/GetSubscriberPreferencesDto"
19473
20455
  }
19474
20456
  }
19475
20457
  }
@@ -25447,6 +26429,13 @@
25447
26429
  "externalDocs": {
25448
26430
  "url": "https://docs.novu.co/activity-feed"
25449
26431
  }
26432
+ },
26433
+ {
26434
+ "name": "Translations",
26435
+ "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.",
26436
+ "externalDocs": {
26437
+ "url": "https://docs.novu.co/content-creation-design/translations"
26438
+ }
25450
26439
  }
25451
26440
  ],
25452
26441
  "servers": [
@@ -29328,6 +30317,185 @@
29328
30317
  "status"
29329
30318
  ]
29330
30319
  },
30320
+ "GlobalPreferenceDto": {
30321
+ "type": "object",
30322
+ "properties": {
30323
+ "enabled": {
30324
+ "type": "boolean",
30325
+ "description": "Whether notifications are enabled globally"
30326
+ },
30327
+ "channels": {
30328
+ "description": "Channel-specific preference settings",
30329
+ "allOf": [
30330
+ {
30331
+ "$ref": "#/components/schemas/PreferenceChannels"
30332
+ }
30333
+ ]
30334
+ }
30335
+ },
30336
+ "required": [
30337
+ "enabled",
30338
+ "channels"
30339
+ ]
30340
+ },
30341
+ "Overrides": {
30342
+ "type": "object",
30343
+ "properties": {
30344
+ "channel": {
30345
+ "enum": [
30346
+ "in_app",
30347
+ "email",
30348
+ "sms",
30349
+ "chat",
30350
+ "push"
30351
+ ],
30352
+ "type": "string",
30353
+ "description": "The channel type which is overridden"
30354
+ },
30355
+ "source": {
30356
+ "enum": [
30357
+ "subscriber",
30358
+ "template",
30359
+ "workflowOverride"
30360
+ ],
30361
+ "type": "string",
30362
+ "description": "The source of overrides"
30363
+ }
30364
+ },
30365
+ "required": [
30366
+ "channel",
30367
+ "source"
30368
+ ]
30369
+ },
30370
+ "WorkflowInfoDto": {
30371
+ "type": "object",
30372
+ "properties": {
30373
+ "slug": {
30374
+ "type": "string",
30375
+ "description": "Workflow slug"
30376
+ },
30377
+ "identifier": {
30378
+ "type": "string",
30379
+ "description": "Unique identifier of the workflow"
30380
+ },
30381
+ "name": {
30382
+ "type": "string",
30383
+ "description": "Display name of the workflow"
30384
+ }
30385
+ },
30386
+ "required": [
30387
+ "slug",
30388
+ "identifier",
30389
+ "name"
30390
+ ]
30391
+ },
30392
+ "WorkflowPreferenceDto": {
30393
+ "type": "object",
30394
+ "properties": {
30395
+ "enabled": {
30396
+ "type": "boolean",
30397
+ "description": "Whether notifications are enabled for this workflow"
30398
+ },
30399
+ "channels": {
30400
+ "description": "Channel-specific preference settings for this workflow",
30401
+ "allOf": [
30402
+ {
30403
+ "$ref": "#/components/schemas/PreferenceChannels"
30404
+ }
30405
+ ]
30406
+ },
30407
+ "overrides": {
30408
+ "description": "List of preference overrides",
30409
+ "type": "array",
30410
+ "items": {
30411
+ "$ref": "#/components/schemas/Overrides"
30412
+ }
30413
+ },
30414
+ "workflow": {
30415
+ "description": "Workflow information",
30416
+ "allOf": [
30417
+ {
30418
+ "$ref": "#/components/schemas/WorkflowInfoDto"
30419
+ }
30420
+ ]
30421
+ }
30422
+ },
30423
+ "required": [
30424
+ "enabled",
30425
+ "channels",
30426
+ "overrides",
30427
+ "workflow"
30428
+ ]
30429
+ },
30430
+ "GetSubscriberPreferencesDto": {
30431
+ "type": "object",
30432
+ "properties": {
30433
+ "global": {
30434
+ "description": "Global preference settings",
30435
+ "allOf": [
30436
+ {
30437
+ "$ref": "#/components/schemas/GlobalPreferenceDto"
30438
+ }
30439
+ ]
30440
+ },
30441
+ "workflows": {
30442
+ "description": "Workflow-specific preference settings",
30443
+ "type": "array",
30444
+ "items": {
30445
+ "$ref": "#/components/schemas/WorkflowPreferenceDto"
30446
+ }
30447
+ }
30448
+ },
30449
+ "required": [
30450
+ "global",
30451
+ "workflows"
30452
+ ]
30453
+ },
30454
+ "PatchPreferenceChannelsDto": {
30455
+ "type": "object",
30456
+ "properties": {
30457
+ "email": {
30458
+ "type": "boolean",
30459
+ "description": "Email channel preference"
30460
+ },
30461
+ "sms": {
30462
+ "type": "boolean",
30463
+ "description": "SMS channel preference"
30464
+ },
30465
+ "in_app": {
30466
+ "type": "boolean",
30467
+ "description": "In-app channel preference"
30468
+ },
30469
+ "push": {
30470
+ "type": "boolean",
30471
+ "description": "Push channel preference"
30472
+ },
30473
+ "chat": {
30474
+ "type": "boolean",
30475
+ "description": "Chat channel preference"
30476
+ }
30477
+ }
30478
+ },
30479
+ "PatchSubscriberPreferencesDto": {
30480
+ "type": "object",
30481
+ "properties": {
30482
+ "channels": {
30483
+ "description": "Channel-specific preference settings",
30484
+ "allOf": [
30485
+ {
30486
+ "$ref": "#/components/schemas/PatchPreferenceChannelsDto"
30487
+ }
30488
+ ]
30489
+ },
30490
+ "workflowId": {
30491
+ "type": "string",
30492
+ "description": "If provided, update workflow specific preferences, otherwise update global preferences"
30493
+ }
30494
+ },
30495
+ "required": [
30496
+ "channels"
30497
+ ]
30498
+ },
29331
30499
  "DeleteMessageResponseDto": {
29332
30500
  "type": "object",
29333
30501
  "properties": {