@novu/api 3.14.3 → 3.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -30
- package/funcs/activityTrack.d.ts +1 -1
- package/funcs/activityTrack.js +1 -1
- package/funcs/environmentVariablesCreate.d.ts +1 -1
- package/funcs/environmentVariablesCreate.js +1 -1
- package/funcs/environmentVariablesDelete.d.ts +2 -2
- package/funcs/environmentVariablesDelete.d.ts.map +1 -1
- package/funcs/environmentVariablesDelete.js +7 -7
- package/funcs/environmentVariablesDelete.js.map +1 -1
- package/funcs/environmentVariablesList.d.ts +1 -1
- package/funcs/environmentVariablesList.js +1 -1
- package/funcs/environmentVariablesRetrieve.d.ts +2 -2
- package/funcs/environmentVariablesRetrieve.d.ts.map +1 -1
- package/funcs/environmentVariablesRetrieve.js +7 -7
- package/funcs/environmentVariablesRetrieve.js.map +1 -1
- package/funcs/environmentVariablesUpdate.d.ts +2 -2
- package/funcs/environmentVariablesUpdate.d.ts.map +1 -1
- package/funcs/environmentVariablesUpdate.js +7 -7
- package/funcs/environmentVariablesUpdate.js.map +1 -1
- package/funcs/environmentVariablesUsage.d.ts +3 -3
- package/funcs/environmentVariablesUsage.d.ts.map +1 -1
- package/funcs/environmentVariablesUsage.js +8 -8
- package/funcs/environmentVariablesUsage.js.map +1 -1
- package/funcs/subscribersNotificationsArchive.d.ts +2 -2
- package/funcs/subscribersNotificationsArchive.js +2 -2
- package/funcs/subscribersNotificationsArchiveAll.d.ts +1 -1
- package/funcs/subscribersNotificationsArchiveAll.js +1 -1
- package/funcs/subscribersNotificationsArchiveAllRead.d.ts +1 -1
- package/funcs/subscribersNotificationsArchiveAllRead.js +1 -1
- package/funcs/subscribersNotificationsCompleteAction.d.ts +2 -2
- package/funcs/subscribersNotificationsCompleteAction.js +2 -2
- package/funcs/subscribersNotificationsCount.d.ts +2 -2
- package/funcs/subscribersNotificationsCount.js +2 -2
- package/funcs/subscribersNotificationsDelete.d.ts +2 -2
- package/funcs/subscribersNotificationsDelete.js +2 -2
- package/funcs/subscribersNotificationsDeleteAll.d.ts +1 -1
- package/funcs/subscribersNotificationsDeleteAll.js +1 -1
- package/funcs/subscribersNotificationsList.d.ts +1 -1
- package/funcs/subscribersNotificationsList.js +1 -2
- package/funcs/subscribersNotificationsList.js.map +1 -1
- package/funcs/subscribersNotificationsMarkAllAsRead.d.ts +1 -1
- package/funcs/subscribersNotificationsMarkAllAsRead.js +1 -1
- package/funcs/subscribersNotificationsMarkAsRead.d.ts +2 -2
- package/funcs/subscribersNotificationsMarkAsRead.js +2 -2
- package/funcs/subscribersNotificationsMarkAsSeen.d.ts +1 -1
- package/funcs/subscribersNotificationsMarkAsSeen.js +1 -1
- package/funcs/subscribersNotificationsMarkAsUnread.d.ts +2 -2
- package/funcs/subscribersNotificationsMarkAsUnread.js +2 -2
- package/funcs/subscribersNotificationsRevertAction.d.ts +2 -2
- package/funcs/subscribersNotificationsRevertAction.js +2 -2
- package/funcs/subscribersNotificationsSnooze.d.ts +2 -2
- package/funcs/subscribersNotificationsSnooze.js +2 -2
- package/funcs/subscribersNotificationsUnarchive.d.ts +2 -2
- package/funcs/subscribersNotificationsUnarchive.js +2 -2
- package/funcs/subscribersNotificationsUnsnooze.d.ts +2 -2
- package/funcs/subscribersNotificationsUnsnooze.js +2 -2
- package/funcs/translationsMasterUpload.js +3 -2
- package/funcs/translationsMasterUpload.js.map +1 -1
- package/funcs/translationsUpload.js +3 -2
- package/funcs/translationsUpload.js.map +1 -1
- package/funcs/workflowsStepsGeneratePreview.d.ts +1 -1
- package/funcs/workflowsStepsGeneratePreview.js +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +4 -4
- package/lib/config.js +4 -4
- package/lib/config.js.map +1 -1
- package/lib/encodings.d.ts +1 -0
- package/lib/encodings.d.ts.map +1 -1
- package/lib/encodings.js +7 -0
- package/lib/encodings.js.map +1 -1
- package/models/components/getchannelconnectionresponsedto.d.ts +1 -0
- package/models/components/getchannelconnectionresponsedto.d.ts.map +1 -1
- package/models/components/getchannelconnectionresponsedto.js +1 -0
- package/models/components/getchannelconnectionresponsedto.js.map +1 -1
- package/models/components/getchannelendpointresponsedto.d.ts +1 -0
- package/models/components/getchannelendpointresponsedto.d.ts.map +1 -1
- package/models/components/getchannelendpointresponsedto.js +1 -0
- package/models/components/getchannelendpointresponsedto.js.map +1 -1
- package/models/components/marksubscribernotificationsasseendto.d.ts +12 -3
- package/models/components/marksubscribernotificationsasseendto.d.ts.map +1 -1
- package/models/components/marksubscribernotificationsasseendto.js +9 -2
- package/models/components/marksubscribernotificationsasseendto.js.map +1 -1
- package/models/components/providersidenum.d.ts +1 -0
- package/models/components/providersidenum.d.ts.map +1 -1
- package/models/components/providersidenum.js +1 -0
- package/models/components/providersidenum.js.map +1 -1
- package/models/components/updateallsubscribernotificationsdto.d.ts +12 -3
- package/models/components/updateallsubscribernotificationsdto.d.ts.map +1 -1
- package/models/components/updateallsubscribernotificationsdto.js +8 -2
- package/models/components/updateallsubscribernotificationsdto.js.map +1 -1
- package/models/operations/environmentvariablescontrollerdeleteenvironmentvariable.d.ts +5 -2
- package/models/operations/environmentvariablescontrollerdeleteenvironmentvariable.d.ts.map +1 -1
- package/models/operations/environmentvariablescontrollerdeleteenvironmentvariable.js +1 -1
- package/models/operations/environmentvariablescontrollerdeleteenvironmentvariable.js.map +1 -1
- package/models/operations/environmentvariablescontrollergetenvironmentvariable.d.ts +5 -2
- package/models/operations/environmentvariablescontrollergetenvironmentvariable.d.ts.map +1 -1
- package/models/operations/environmentvariablescontrollergetenvironmentvariable.js +1 -1
- package/models/operations/environmentvariablescontrollergetenvironmentvariable.js.map +1 -1
- package/models/operations/environmentvariablescontrollergetenvironmentvariableusage.d.ts +5 -2
- package/models/operations/environmentvariablescontrollergetenvironmentvariableusage.d.ts.map +1 -1
- package/models/operations/environmentvariablescontrollergetenvironmentvariableusage.js +1 -1
- package/models/operations/environmentvariablescontrollergetenvironmentvariableusage.js.map +1 -1
- package/models/operations/environmentvariablescontrollerupdateenvironmentvariable.d.ts +5 -2
- package/models/operations/environmentvariablescontrollerupdateenvironmentvariable.d.ts.map +1 -1
- package/models/operations/environmentvariablescontrollerupdateenvironmentvariable.js +1 -1
- package/models/operations/environmentvariablescontrollerupdateenvironmentvariable.js.map +1 -1
- package/models/operations/subscriberscontrollergetsubscribernotifications.d.ts +0 -5
- package/models/operations/subscriberscontrollergetsubscribernotifications.d.ts.map +1 -1
- package/models/operations/subscriberscontrollergetsubscribernotifications.js +0 -1
- package/models/operations/subscriberscontrollergetsubscribernotifications.js.map +1 -1
- package/package.json +1 -1
- package/sdk/activity.d.ts +1 -1
- package/sdk/activity.js +1 -1
- package/sdk/environmentvariables.d.ts +11 -11
- package/sdk/environmentvariables.d.ts.map +1 -1
- package/sdk/environmentvariables.js +15 -15
- package/sdk/environmentvariables.js.map +1 -1
- package/sdk/novunotifications.d.ts +26 -26
- package/sdk/novunotifications.js +26 -26
- package/sdk/steps.d.ts +1 -1
- package/sdk/steps.js +1 -1
- package/src/funcs/activityTrack.ts +1 -1
- package/src/funcs/environmentVariablesCreate.ts +1 -1
- package/src/funcs/environmentVariablesDelete.ts +9 -7
- package/src/funcs/environmentVariablesList.ts +1 -1
- package/src/funcs/environmentVariablesRetrieve.ts +9 -7
- package/src/funcs/environmentVariablesUpdate.ts +9 -7
- package/src/funcs/environmentVariablesUsage.ts +8 -8
- package/src/funcs/subscribersNotificationsArchive.ts +2 -2
- package/src/funcs/subscribersNotificationsArchiveAll.ts +1 -1
- package/src/funcs/subscribersNotificationsArchiveAllRead.ts +1 -1
- package/src/funcs/subscribersNotificationsCompleteAction.ts +2 -2
- package/src/funcs/subscribersNotificationsCount.ts +2 -2
- package/src/funcs/subscribersNotificationsDelete.ts +2 -2
- package/src/funcs/subscribersNotificationsDeleteAll.ts +1 -1
- package/src/funcs/subscribersNotificationsList.ts +1 -2
- package/src/funcs/subscribersNotificationsMarkAllAsRead.ts +1 -1
- package/src/funcs/subscribersNotificationsMarkAsRead.ts +2 -2
- package/src/funcs/subscribersNotificationsMarkAsSeen.ts +1 -1
- package/src/funcs/subscribersNotificationsMarkAsUnread.ts +2 -2
- package/src/funcs/subscribersNotificationsRevertAction.ts +2 -2
- package/src/funcs/subscribersNotificationsSnooze.ts +2 -2
- package/src/funcs/subscribersNotificationsUnarchive.ts +2 -2
- package/src/funcs/subscribersNotificationsUnsnooze.ts +2 -2
- package/src/funcs/translationsMasterUpload.ts +4 -3
- package/src/funcs/translationsUpload.ts +4 -3
- package/src/funcs/workflowsStepsGeneratePreview.ts +1 -1
- package/src/lib/config.ts +4 -4
- package/src/lib/encodings.ts +9 -0
- package/src/models/components/getchannelconnectionresponsedto.ts +1 -0
- package/src/models/components/getchannelendpointresponsedto.ts +1 -0
- package/src/models/components/marksubscribernotificationsasseendto.ts +31 -4
- package/src/models/components/providersidenum.ts +1 -0
- package/src/models/components/updateallsubscribernotificationsdto.ts +20 -4
- package/src/models/operations/environmentvariablescontrollerdeleteenvironmentvariable.ts +6 -3
- package/src/models/operations/environmentvariablescontrollergetenvironmentvariable.ts +6 -3
- package/src/models/operations/environmentvariablescontrollergetenvironmentvariableusage.ts +6 -3
- package/src/models/operations/environmentvariablescontrollerupdateenvironmentvariable.ts +6 -3
- package/src/models/operations/subscriberscontrollergetsubscribernotifications.ts +0 -6
- package/src/sdk/activity.ts +1 -1
- package/src/sdk/environmentvariables.ts +15 -15
- package/src/sdk/novunotifications.ts +26 -26
- package/src/sdk/steps.ts +1 -1
|
@@ -58,7 +58,6 @@ exports.SubscribersControllerGetSubscriberNotificationsRequest$outboundSchema =
|
|
|
58
58
|
limit: z.number().default(10),
|
|
59
59
|
after: z.string().optional(),
|
|
60
60
|
offset: z.number().optional(),
|
|
61
|
-
tags: z.array(z.string()).optional(),
|
|
62
61
|
read: z.boolean().optional(),
|
|
63
62
|
archived: z.boolean().optional(),
|
|
64
63
|
snoozed: z.boolean().optional(),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"subscriberscontrollergetsubscribernotifications.js","sourceRoot":"","sources":["../../src/models/operations/subscriberscontrollergetsubscribernotifications.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"subscriberscontrollergetsubscribernotifications.js","sourceRoot":"","sources":["../../src/models/operations/subscriberscontrollergetsubscribernotifications.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0HH,oIASC;AAkBD,0IAaC;AAhKD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AAGjD,mEAAqD;AAGxC,QAAA,QAAQ,GAAG;IACtB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AA0DX,gBAAgB;AACH,QAAA,uBAAuB,GAAqC,CAAC;KACvE,UAAU,CAAC,gBAAQ,CAAC,CAAC;AAoBxB,gBAAgB;AACH,QAAA,qEAAqE,GAK5E,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/B,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC5B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC,QAAQ,EAAE;IACrD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC3C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACtC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,cAAc,EAAE,iBAAiB;KAClC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,SAAgB,4DAA4D,CAC1E,sDACwD;IAExD,OAAO,IAAI,CAAC,SAAS,CACnB,6EAAqE,CAAC,KAAK,CACzE,sDAAsD,CACvD,CACF,CAAC;AACJ,CAAC;AAED,gBAAgB;AACH,QAAA,qEAAqE,GAK5E,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;IAClD,MAAM,EAAE,UAAU,CAAC,mDAAmD;CACvE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,SAAS,EAAE,SAAS;QACpB,QAAQ,EAAE,QAAQ;KACnB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,SAAgB,+DAA+D,CAC7E,UAAkB;IAKlB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CACJ,6EAAqE;SAClE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACzB,qFAAqF,CACtF,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
package/sdk/activity.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import * as components from "../models/components/index.js";
|
|
|
3
3
|
import * as operations from "../models/operations/index.js";
|
|
4
4
|
export declare class Activity extends ClientSDK {
|
|
5
5
|
/**
|
|
6
|
-
* Track activity and engagement events
|
|
6
|
+
* Track provider activity and engagement events
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
9
|
* Track activity and engagement events for a specific delivery provider
|
package/sdk/activity.js
CHANGED
|
@@ -9,7 +9,7 @@ const sdks_js_1 = require("../lib/sdks.js");
|
|
|
9
9
|
const fp_js_1 = require("../types/fp.js");
|
|
10
10
|
class Activity extends sdks_js_1.ClientSDK {
|
|
11
11
|
/**
|
|
12
|
-
* Track activity and engagement events
|
|
12
|
+
* Track provider activity and engagement events
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
15
|
* Track activity and engagement events for a specific delivery provider
|
|
@@ -3,14 +3,14 @@ import * as components from "../models/components/index.js";
|
|
|
3
3
|
import * as operations from "../models/operations/index.js";
|
|
4
4
|
export declare class EnvironmentVariables extends ClientSDK {
|
|
5
5
|
/**
|
|
6
|
-
* List
|
|
6
|
+
* List all variables
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
9
|
* Returns all environment variables for the current organization. Secret values are masked.
|
|
10
10
|
*/
|
|
11
11
|
list(search?: string | undefined, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.EnvironmentVariablesControllerListEnvironmentVariablesResponse>;
|
|
12
12
|
/**
|
|
13
|
-
* Create
|
|
13
|
+
* Create a variable
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
16
|
* Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.
|
|
@@ -20,29 +20,29 @@ export declare class EnvironmentVariables extends ClientSDK {
|
|
|
20
20
|
* Get environment variable
|
|
21
21
|
*
|
|
22
22
|
* @remarks
|
|
23
|
-
* Returns a single environment variable by
|
|
23
|
+
* Returns a single environment variable by key. Secret values are masked.
|
|
24
24
|
*/
|
|
25
|
-
retrieve(
|
|
25
|
+
retrieve(variableKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.EnvironmentVariablesControllerGetEnvironmentVariableResponse>;
|
|
26
26
|
/**
|
|
27
|
-
* Update
|
|
27
|
+
* Update a variable
|
|
28
28
|
*
|
|
29
29
|
* @remarks
|
|
30
30
|
* Updates an existing environment variable. Providing values replaces all existing per-environment values.
|
|
31
31
|
*/
|
|
32
|
-
update(updateEnvironmentVariableRequestDto: components.UpdateEnvironmentVariableRequestDto,
|
|
32
|
+
update(updateEnvironmentVariableRequestDto: components.UpdateEnvironmentVariableRequestDto, variableKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.EnvironmentVariablesControllerUpdateEnvironmentVariableResponse>;
|
|
33
33
|
/**
|
|
34
34
|
* Delete environment variable
|
|
35
35
|
*
|
|
36
36
|
* @remarks
|
|
37
|
-
* Deletes an environment variable by
|
|
37
|
+
* Deletes an environment variable by key.
|
|
38
38
|
*/
|
|
39
|
-
delete(
|
|
39
|
+
delete(variableKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.EnvironmentVariablesControllerDeleteEnvironmentVariableResponse | undefined>;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Retrieve a variable usage
|
|
42
42
|
*
|
|
43
43
|
* @remarks
|
|
44
|
-
* Returns the workflows that reference this environment variable via {{env.KEY}} in their step controls.
|
|
44
|
+
* Returns the workflows that reference this environment variable via `{{env.KEY}}` in their step controls. **variableId** is required.
|
|
45
45
|
*/
|
|
46
|
-
usage(
|
|
46
|
+
usage(variableKey: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.EnvironmentVariablesControllerGetEnvironmentVariableUsageResponse>;
|
|
47
47
|
}
|
|
48
48
|
//# sourceMappingURL=environmentvariables.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"environmentvariables.d.ts","sourceRoot":"","sources":["../src/sdk/environmentvariables.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,oBAAqB,SAAQ,SAAS;IACjD;;;;;OAKG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,EAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,8DAA8D,CAC1E;IASD;;;;;OAKG;IACG,MAAM,CACV,mCAAmC,EACjC,UAAU,CAAC,mCAAmC,EAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,+DAA+D,CAC3E;IASD;;;;;OAKG;IACG,QAAQ,CACZ,
|
|
1
|
+
{"version":3,"file":"environmentvariables.d.ts","sourceRoot":"","sources":["../src/sdk/environmentvariables.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,qBAAa,oBAAqB,SAAQ,SAAS;IACjD;;;;;OAKG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,EAC3B,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,8DAA8D,CAC1E;IASD;;;;;OAKG;IACG,MAAM,CACV,mCAAmC,EACjC,UAAU,CAAC,mCAAmC,EAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,+DAA+D,CAC3E;IASD;;;;;OAKG;IACG,QAAQ,CACZ,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,4DAA4D,CACxE;IASD;;;;;OAKG;IACG,MAAM,CACV,mCAAmC,EACjC,UAAU,CAAC,mCAAmC,EAChD,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,+DAA+D,CAC3E;IAUD;;;;;OAKG;IACG,MAAM,CACV,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACN,UAAU,CAAC,+DAA+D,GAC1E,SAAS,CACZ;IASD;;;;;OAKG;IACG,KAAK,CACT,WAAW,EAAE,MAAM,EACnB,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,iEAAiE,CAC7E;CAQF"}
|
|
@@ -14,7 +14,7 @@ const sdks_js_1 = require("../lib/sdks.js");
|
|
|
14
14
|
const fp_js_1 = require("../types/fp.js");
|
|
15
15
|
class EnvironmentVariables extends sdks_js_1.ClientSDK {
|
|
16
16
|
/**
|
|
17
|
-
* List
|
|
17
|
+
* List all variables
|
|
18
18
|
*
|
|
19
19
|
* @remarks
|
|
20
20
|
* Returns all environment variables for the current organization. Secret values are masked.
|
|
@@ -23,7 +23,7 @@ class EnvironmentVariables extends sdks_js_1.ClientSDK {
|
|
|
23
23
|
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesList_js_1.environmentVariablesList)(this, search, idempotencyKey, options));
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
* Create
|
|
26
|
+
* Create a variable
|
|
27
27
|
*
|
|
28
28
|
* @remarks
|
|
29
29
|
* Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.
|
|
@@ -35,37 +35,37 @@ class EnvironmentVariables extends sdks_js_1.ClientSDK {
|
|
|
35
35
|
* Get environment variable
|
|
36
36
|
*
|
|
37
37
|
* @remarks
|
|
38
|
-
* Returns a single environment variable by
|
|
38
|
+
* Returns a single environment variable by key. Secret values are masked.
|
|
39
39
|
*/
|
|
40
|
-
async retrieve(
|
|
41
|
-
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesRetrieve_js_1.environmentVariablesRetrieve)(this,
|
|
40
|
+
async retrieve(variableKey, idempotencyKey, options) {
|
|
41
|
+
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesRetrieve_js_1.environmentVariablesRetrieve)(this, variableKey, idempotencyKey, options));
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
|
-
* Update
|
|
44
|
+
* Update a variable
|
|
45
45
|
*
|
|
46
46
|
* @remarks
|
|
47
47
|
* Updates an existing environment variable. Providing values replaces all existing per-environment values.
|
|
48
48
|
*/
|
|
49
|
-
async update(updateEnvironmentVariableRequestDto,
|
|
50
|
-
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesUpdate_js_1.environmentVariablesUpdate)(this, updateEnvironmentVariableRequestDto,
|
|
49
|
+
async update(updateEnvironmentVariableRequestDto, variableKey, idempotencyKey, options) {
|
|
50
|
+
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesUpdate_js_1.environmentVariablesUpdate)(this, updateEnvironmentVariableRequestDto, variableKey, idempotencyKey, options));
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
53
|
* Delete environment variable
|
|
54
54
|
*
|
|
55
55
|
* @remarks
|
|
56
|
-
* Deletes an environment variable by
|
|
56
|
+
* Deletes an environment variable by key.
|
|
57
57
|
*/
|
|
58
|
-
async delete(
|
|
59
|
-
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesDelete_js_1.environmentVariablesDelete)(this,
|
|
58
|
+
async delete(variableKey, idempotencyKey, options) {
|
|
59
|
+
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesDelete_js_1.environmentVariablesDelete)(this, variableKey, idempotencyKey, options));
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Retrieve a variable usage
|
|
63
63
|
*
|
|
64
64
|
* @remarks
|
|
65
|
-
* Returns the workflows that reference this environment variable via {{env.KEY}} in their step controls.
|
|
65
|
+
* Returns the workflows that reference this environment variable via `{{env.KEY}}` in their step controls. **variableId** is required.
|
|
66
66
|
*/
|
|
67
|
-
async usage(
|
|
68
|
-
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesUsage_js_1.environmentVariablesUsage)(this,
|
|
67
|
+
async usage(variableKey, idempotencyKey, options) {
|
|
68
|
+
return (0, fp_js_1.unwrapAsync)((0, environmentVariablesUsage_js_1.environmentVariablesUsage)(this, variableKey, idempotencyKey, options));
|
|
69
69
|
}
|
|
70
70
|
}
|
|
71
71
|
exports.EnvironmentVariables = EnvironmentVariables;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"environmentvariables.js","sourceRoot":"","sources":["../src/sdk/environmentvariables.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,0FAAoF;AACpF,sFAAgF;AAChF,8FAAwF;AACxF,0FAAoF;AACpF,wFAAkF;AAClF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,oBAAqB,SAAQ,mBAAS;IACjD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,MAA2B,EAC3B,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,MAAM,EACN,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,mCACgD,EAChD,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,mCAAmC,EACnC,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,
|
|
1
|
+
{"version":3,"file":"environmentvariables.js","sourceRoot":"","sources":["../src/sdk/environmentvariables.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,0FAAoF;AACpF,0FAAoF;AACpF,sFAAgF;AAChF,8FAAwF;AACxF,0FAAoF;AACpF,wFAAkF;AAClF,4CAA2D;AAG3D,0CAA6C;AAE7C,MAAa,oBAAqB,SAAQ,mBAAS;IACjD;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,MAA2B,EAC3B,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,sDAAwB,EACzC,IAAI,EACJ,MAAM,EACN,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,mCACgD,EAChD,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,mCAAmC,EACnC,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,WAAmB,EACnB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,8DAA4B,EAC7C,IAAI,EACJ,WAAW,EACX,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,mCACgD,EAChD,WAAmB,EACnB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,mCAAmC,EACnC,WAAW,EACX,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,WAAmB,EACnB,cAAmC,EACnC,OAAwB;QAKxB,OAAO,IAAA,mBAAW,EAAC,IAAA,0DAA0B,EAC3C,IAAI,EACJ,WAAW,EACX,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CACT,WAAmB,EACnB,cAAmC,EACnC,OAAwB;QAIxB,OAAO,IAAA,mBAAW,EAAC,IAAA,wDAAyB,EAC1C,IAAI,EACJ,WAAW,EACX,cAAc,EACd,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAnID,oDAmIC"}
|
|
@@ -6,114 +6,114 @@ export declare class NovuNotifications extends ClientSDK {
|
|
|
6
6
|
* Retrieve subscriber notifications
|
|
7
7
|
*
|
|
8
8
|
* @remarks
|
|
9
|
-
* Retrieve in-app notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
9
|
+
* Retrieve in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
10
10
|
* Supports filtering by tags, read/archived/snoozed/seen state, data attributes, severity, date range, and context keys.
|
|
11
11
|
*/
|
|
12
12
|
list(request: operations.SubscribersControllerGetSubscriberNotificationsRequest, options?: RequestOptions): Promise<operations.SubscribersControllerGetSubscriberNotificationsResponse>;
|
|
13
13
|
/**
|
|
14
|
-
* Delete notification
|
|
14
|
+
* Delete a notification
|
|
15
15
|
*
|
|
16
16
|
* @remarks
|
|
17
|
-
* Delete a specific notification by its unique identifier **notificationId**.
|
|
17
|
+
* Delete a specific in-app (inbox) notification permanently by its unique identifier **notificationId**.
|
|
18
18
|
*/
|
|
19
19
|
delete(request: operations.SubscribersControllerDeleteNotificationRequest, options?: RequestOptions): Promise<operations.SubscribersControllerDeleteNotificationResponse | undefined>;
|
|
20
20
|
/**
|
|
21
|
-
* Complete notification action
|
|
21
|
+
* Complete a notification action
|
|
22
22
|
*
|
|
23
23
|
* @remarks
|
|
24
|
-
* Mark a notification action (primary or secondary) as completed by its unique identifier **notificationId** and action type
|
|
24
|
+
* Mark a single in-app (inbox) notification's action (primary or secondary) as completed by its unique identifier **notificationId** and action type **actionType**.
|
|
25
25
|
*/
|
|
26
26
|
completeAction(request: operations.SubscribersControllerCompleteNotificationActionRequest, options?: RequestOptions): Promise<operations.SubscribersControllerCompleteNotificationActionResponse>;
|
|
27
27
|
/**
|
|
28
|
-
* Revert notification action
|
|
28
|
+
* Revert a notification action
|
|
29
29
|
*
|
|
30
30
|
* @remarks
|
|
31
|
-
* Revert a notification action (primary or secondary) to pending state by its unique identifier **notificationId** and action type
|
|
31
|
+
* Revert a single in-app (inbox) notification's action (primary or secondary) to pending state by its unique identifier **notificationId** and action type **actionType**.
|
|
32
32
|
*/
|
|
33
33
|
revertAction(request: operations.SubscribersControllerRevertNotificationActionRequest, options?: RequestOptions): Promise<operations.SubscribersControllerRevertNotificationActionResponse>;
|
|
34
34
|
/**
|
|
35
|
-
* Archive notification
|
|
35
|
+
* Archive a notification
|
|
36
36
|
*
|
|
37
37
|
* @remarks
|
|
38
|
-
* Archive a specific notification by its unique identifier **notificationId**.
|
|
38
|
+
* Archive a specific in-app (inbox) notification by its unique identifier **notificationId**.
|
|
39
39
|
*/
|
|
40
40
|
archive(request: operations.SubscribersControllerArchiveNotificationRequest, options?: RequestOptions): Promise<operations.SubscribersControllerArchiveNotificationResponse>;
|
|
41
41
|
/**
|
|
42
|
-
* Mark notification as read
|
|
42
|
+
* Mark a notification as read
|
|
43
43
|
*
|
|
44
44
|
* @remarks
|
|
45
|
-
* Mark a specific notification as read by its unique identifier **notificationId**.
|
|
45
|
+
* Mark a specific in-app (inbox) notification as read by its unique identifier **notificationId**.
|
|
46
46
|
*/
|
|
47
47
|
markAsRead(request: operations.SubscribersControllerMarkNotificationAsReadRequest, options?: RequestOptions): Promise<operations.SubscribersControllerMarkNotificationAsReadResponse>;
|
|
48
48
|
/**
|
|
49
|
-
* Snooze notification
|
|
49
|
+
* Snooze a notification
|
|
50
50
|
*
|
|
51
51
|
* @remarks
|
|
52
|
-
* Snooze a specific notification by its unique identifier **notificationId** until a specified time.
|
|
52
|
+
* Snooze a specific in-app (inbox) notification by its unique identifier **notificationId** until a specified time.
|
|
53
53
|
*/
|
|
54
54
|
snooze(request: operations.SubscribersControllerSnoozeNotificationRequest, options?: RequestOptions): Promise<operations.SubscribersControllerSnoozeNotificationResponse>;
|
|
55
55
|
/**
|
|
56
|
-
* Unarchive notification
|
|
56
|
+
* Unarchive a notification
|
|
57
57
|
*
|
|
58
58
|
* @remarks
|
|
59
|
-
* Unarchive a specific notification by its unique identifier **notificationId**.
|
|
59
|
+
* Unarchive a specific in-app (inbox) notification by its unique identifier **notificationId**.
|
|
60
60
|
*/
|
|
61
61
|
unarchive(request: operations.SubscribersControllerUnarchiveNotificationRequest, options?: RequestOptions): Promise<operations.SubscribersControllerUnarchiveNotificationResponse>;
|
|
62
62
|
/**
|
|
63
|
-
* Mark notification as unread
|
|
63
|
+
* Mark a notification as unread
|
|
64
64
|
*
|
|
65
65
|
* @remarks
|
|
66
|
-
* Mark a specific notification as unread by its unique identifier **notificationId**.
|
|
66
|
+
* Mark a specific in-app (inbox) notification as unread by its unique identifier **notificationId**.
|
|
67
67
|
*/
|
|
68
68
|
markAsUnread(request: operations.SubscribersControllerMarkNotificationAsUnreadRequest, options?: RequestOptions): Promise<operations.SubscribersControllerMarkNotificationAsUnreadResponse>;
|
|
69
69
|
/**
|
|
70
|
-
* Unsnooze notification
|
|
70
|
+
* Unsnooze a notification
|
|
71
71
|
*
|
|
72
72
|
* @remarks
|
|
73
|
-
* Unsnooze a specific notification by its unique identifier **notificationId**.
|
|
73
|
+
* Unsnooze a specific in-app (inbox) notification by its unique identifier **notificationId**.
|
|
74
74
|
*/
|
|
75
75
|
unsnooze(request: operations.SubscribersControllerUnsnoozeNotificationRequest, options?: RequestOptions): Promise<operations.SubscribersControllerUnsnoozeNotificationResponse>;
|
|
76
76
|
/**
|
|
77
77
|
* Archive all notifications
|
|
78
78
|
*
|
|
79
79
|
* @remarks
|
|
80
|
-
* Archive all notifications matching the specified filters. Supports context-based filtering.
|
|
80
|
+
* Archive all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
|
|
81
81
|
*/
|
|
82
82
|
archiveAll(updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerArchiveAllNotificationsResponse | undefined>;
|
|
83
83
|
/**
|
|
84
84
|
* Retrieve subscriber notifications count
|
|
85
85
|
*
|
|
86
86
|
* @remarks
|
|
87
|
-
* Retrieve count of notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
88
|
-
* Supports multiple filters to count notifications by different criteria, including context keys.
|
|
87
|
+
* Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
88
|
+
* Supports multiple filters to count in-app (inbox) notifications by different criteria, including context keys.
|
|
89
89
|
*/
|
|
90
90
|
count(subscriberId: string, filters: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerGetSubscriberNotificationsCountResponse>;
|
|
91
91
|
/**
|
|
92
92
|
* Delete all notifications
|
|
93
93
|
*
|
|
94
94
|
* @remarks
|
|
95
|
-
*
|
|
95
|
+
* Permanently delete all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
|
|
96
96
|
*/
|
|
97
97
|
deleteAll(updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerDeleteAllNotificationsResponse | undefined>;
|
|
98
98
|
/**
|
|
99
99
|
* Mark all notifications as read
|
|
100
100
|
*
|
|
101
101
|
* @remarks
|
|
102
|
-
* Mark all notifications matching the specified filters as read. Supports context-based filtering.
|
|
102
|
+
* Mark all in-app (inbox) notifications matching the specified filters as read. Supports context-based filtering.
|
|
103
103
|
*/
|
|
104
104
|
markAllAsRead(updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerMarkAllNotificationsAsReadResponse | undefined>;
|
|
105
105
|
/**
|
|
106
106
|
* Archive all read notifications
|
|
107
107
|
*
|
|
108
108
|
* @remarks
|
|
109
|
-
* Archive all read notifications matching the specified filters. Supports context-based filtering.
|
|
109
|
+
* Archive all read in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
|
|
110
110
|
*/
|
|
111
111
|
archiveAllRead(updateAllSubscriberNotificationsDto: components.UpdateAllSubscriberNotificationsDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerArchiveAllReadNotificationsResponse | undefined>;
|
|
112
112
|
/**
|
|
113
113
|
* Mark notifications as seen
|
|
114
114
|
*
|
|
115
115
|
* @remarks
|
|
116
|
-
* Mark specific
|
|
116
|
+
* Mark specific and multiple in-app (inbox) notifications as seen. Supports context-based filtering.
|
|
117
117
|
*/
|
|
118
118
|
markAsSeen(markSubscriberNotificationsAsSeenDto: components.MarkSubscriberNotificationsAsSeenDto, subscriberId: string, idempotencyKey?: string | undefined, options?: RequestOptions): Promise<operations.SubscribersControllerMarkNotificationsAsSeenResponse | undefined>;
|
|
119
119
|
/**
|
package/sdk/novunotifications.js
CHANGED
|
@@ -29,89 +29,89 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
29
29
|
* Retrieve subscriber notifications
|
|
30
30
|
*
|
|
31
31
|
* @remarks
|
|
32
|
-
* Retrieve in-app notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
32
|
+
* Retrieve in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
33
33
|
* Supports filtering by tags, read/archived/snoozed/seen state, data attributes, severity, date range, and context keys.
|
|
34
34
|
*/
|
|
35
35
|
async list(request, options) {
|
|
36
36
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsList_js_1.subscribersNotificationsList)(this, request, options));
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Delete notification
|
|
39
|
+
* Delete a notification
|
|
40
40
|
*
|
|
41
41
|
* @remarks
|
|
42
|
-
* Delete a specific notification by its unique identifier **notificationId**.
|
|
42
|
+
* Delete a specific in-app (inbox) notification permanently by its unique identifier **notificationId**.
|
|
43
43
|
*/
|
|
44
44
|
async delete(request, options) {
|
|
45
45
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsDelete_js_1.subscribersNotificationsDelete)(this, request, options));
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
* Complete notification action
|
|
48
|
+
* Complete a notification action
|
|
49
49
|
*
|
|
50
50
|
* @remarks
|
|
51
|
-
* Mark a notification action (primary or secondary) as completed by its unique identifier **notificationId** and action type
|
|
51
|
+
* Mark a single in-app (inbox) notification's action (primary or secondary) as completed by its unique identifier **notificationId** and action type **actionType**.
|
|
52
52
|
*/
|
|
53
53
|
async completeAction(request, options) {
|
|
54
54
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsCompleteAction_js_1.subscribersNotificationsCompleteAction)(this, request, options));
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Revert notification action
|
|
57
|
+
* Revert a notification action
|
|
58
58
|
*
|
|
59
59
|
* @remarks
|
|
60
|
-
* Revert a notification action (primary or secondary) to pending state by its unique identifier **notificationId** and action type
|
|
60
|
+
* Revert a single in-app (inbox) notification's action (primary or secondary) to pending state by its unique identifier **notificationId** and action type **actionType**.
|
|
61
61
|
*/
|
|
62
62
|
async revertAction(request, options) {
|
|
63
63
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsRevertAction_js_1.subscribersNotificationsRevertAction)(this, request, options));
|
|
64
64
|
}
|
|
65
65
|
/**
|
|
66
|
-
* Archive notification
|
|
66
|
+
* Archive a notification
|
|
67
67
|
*
|
|
68
68
|
* @remarks
|
|
69
|
-
* Archive a specific notification by its unique identifier **notificationId**.
|
|
69
|
+
* Archive a specific in-app (inbox) notification by its unique identifier **notificationId**.
|
|
70
70
|
*/
|
|
71
71
|
async archive(request, options) {
|
|
72
72
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsArchive_js_1.subscribersNotificationsArchive)(this, request, options));
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
|
-
* Mark notification as read
|
|
75
|
+
* Mark a notification as read
|
|
76
76
|
*
|
|
77
77
|
* @remarks
|
|
78
|
-
* Mark a specific notification as read by its unique identifier **notificationId**.
|
|
78
|
+
* Mark a specific in-app (inbox) notification as read by its unique identifier **notificationId**.
|
|
79
79
|
*/
|
|
80
80
|
async markAsRead(request, options) {
|
|
81
81
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAsRead_js_1.subscribersNotificationsMarkAsRead)(this, request, options));
|
|
82
82
|
}
|
|
83
83
|
/**
|
|
84
|
-
* Snooze notification
|
|
84
|
+
* Snooze a notification
|
|
85
85
|
*
|
|
86
86
|
* @remarks
|
|
87
|
-
* Snooze a specific notification by its unique identifier **notificationId** until a specified time.
|
|
87
|
+
* Snooze a specific in-app (inbox) notification by its unique identifier **notificationId** until a specified time.
|
|
88
88
|
*/
|
|
89
89
|
async snooze(request, options) {
|
|
90
90
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsSnooze_js_1.subscribersNotificationsSnooze)(this, request, options));
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
|
-
* Unarchive notification
|
|
93
|
+
* Unarchive a notification
|
|
94
94
|
*
|
|
95
95
|
* @remarks
|
|
96
|
-
* Unarchive a specific notification by its unique identifier **notificationId**.
|
|
96
|
+
* Unarchive a specific in-app (inbox) notification by its unique identifier **notificationId**.
|
|
97
97
|
*/
|
|
98
98
|
async unarchive(request, options) {
|
|
99
99
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsUnarchive_js_1.subscribersNotificationsUnarchive)(this, request, options));
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Mark notification as unread
|
|
102
|
+
* Mark a notification as unread
|
|
103
103
|
*
|
|
104
104
|
* @remarks
|
|
105
|
-
* Mark a specific notification as unread by its unique identifier **notificationId**.
|
|
105
|
+
* Mark a specific in-app (inbox) notification as unread by its unique identifier **notificationId**.
|
|
106
106
|
*/
|
|
107
107
|
async markAsUnread(request, options) {
|
|
108
108
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAsUnread_js_1.subscribersNotificationsMarkAsUnread)(this, request, options));
|
|
109
109
|
}
|
|
110
110
|
/**
|
|
111
|
-
* Unsnooze notification
|
|
111
|
+
* Unsnooze a notification
|
|
112
112
|
*
|
|
113
113
|
* @remarks
|
|
114
|
-
* Unsnooze a specific notification by its unique identifier **notificationId**.
|
|
114
|
+
* Unsnooze a specific in-app (inbox) notification by its unique identifier **notificationId**.
|
|
115
115
|
*/
|
|
116
116
|
async unsnooze(request, options) {
|
|
117
117
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsUnsnooze_js_1.subscribersNotificationsUnsnooze)(this, request, options));
|
|
@@ -120,7 +120,7 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
120
120
|
* Archive all notifications
|
|
121
121
|
*
|
|
122
122
|
* @remarks
|
|
123
|
-
* Archive all notifications matching the specified filters. Supports context-based filtering.
|
|
123
|
+
* Archive all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
|
|
124
124
|
*/
|
|
125
125
|
async archiveAll(updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
|
|
126
126
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsArchiveAll_js_1.subscribersNotificationsArchiveAll)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
|
|
@@ -129,8 +129,8 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
129
129
|
* Retrieve subscriber notifications count
|
|
130
130
|
*
|
|
131
131
|
* @remarks
|
|
132
|
-
* Retrieve count of notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
133
|
-
* Supports multiple filters to count notifications by different criteria, including context keys.
|
|
132
|
+
* Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier **subscriberId**.
|
|
133
|
+
* Supports multiple filters to count in-app (inbox) notifications by different criteria, including context keys.
|
|
134
134
|
*/
|
|
135
135
|
async count(subscriberId, filters, idempotencyKey, options) {
|
|
136
136
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsCount_js_1.subscribersNotificationsCount)(this, subscriberId, filters, idempotencyKey, options));
|
|
@@ -139,7 +139,7 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
139
139
|
* Delete all notifications
|
|
140
140
|
*
|
|
141
141
|
* @remarks
|
|
142
|
-
*
|
|
142
|
+
* Permanently delete all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
|
|
143
143
|
*/
|
|
144
144
|
async deleteAll(updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
|
|
145
145
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsDeleteAll_js_1.subscribersNotificationsDeleteAll)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
|
|
@@ -148,7 +148,7 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
148
148
|
* Mark all notifications as read
|
|
149
149
|
*
|
|
150
150
|
* @remarks
|
|
151
|
-
* Mark all notifications matching the specified filters as read. Supports context-based filtering.
|
|
151
|
+
* Mark all in-app (inbox) notifications matching the specified filters as read. Supports context-based filtering.
|
|
152
152
|
*/
|
|
153
153
|
async markAllAsRead(updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
|
|
154
154
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAllAsRead_js_1.subscribersNotificationsMarkAllAsRead)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
|
|
@@ -157,7 +157,7 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
157
157
|
* Archive all read notifications
|
|
158
158
|
*
|
|
159
159
|
* @remarks
|
|
160
|
-
* Archive all read notifications matching the specified filters. Supports context-based filtering.
|
|
160
|
+
* Archive all read in-app (inbox) notifications matching the specified filters. Supports context-based filtering.
|
|
161
161
|
*/
|
|
162
162
|
async archiveAllRead(updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options) {
|
|
163
163
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsArchiveAllRead_js_1.subscribersNotificationsArchiveAllRead)(this, updateAllSubscriberNotificationsDto, subscriberId, idempotencyKey, options));
|
|
@@ -166,7 +166,7 @@ class NovuNotifications extends sdks_js_1.ClientSDK {
|
|
|
166
166
|
* Mark notifications as seen
|
|
167
167
|
*
|
|
168
168
|
* @remarks
|
|
169
|
-
* Mark specific
|
|
169
|
+
* Mark specific and multiple in-app (inbox) notifications as seen. Supports context-based filtering.
|
|
170
170
|
*/
|
|
171
171
|
async markAsSeen(markSubscriberNotificationsAsSeenDto, subscriberId, idempotencyKey, options) {
|
|
172
172
|
return (0, fp_js_1.unwrapAsync)((0, subscribersNotificationsMarkAsSeen_js_1.subscribersNotificationsMarkAsSeen)(this, markSubscriberNotificationsAsSeenDto, subscriberId, idempotencyKey, options));
|
package/sdk/steps.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
|
|
|
2
2
|
import * as operations from "../models/operations/index.js";
|
|
3
3
|
export declare class Steps extends ClientSDK {
|
|
4
4
|
/**
|
|
5
|
-
* Generate step preview
|
|
5
|
+
* Generate a step preview
|
|
6
6
|
*
|
|
7
7
|
* @remarks
|
|
8
8
|
* Generates a preview for a specific workflow step by its unique identifier **stepId**
|
package/sdk/steps.js
CHANGED
|
@@ -10,7 +10,7 @@ const sdks_js_1 = require("../lib/sdks.js");
|
|
|
10
10
|
const fp_js_1 = require("../types/fp.js");
|
|
11
11
|
class Steps extends sdks_js_1.ClientSDK {
|
|
12
12
|
/**
|
|
13
|
-
* Generate step preview
|
|
13
|
+
* Generate a step preview
|
|
14
14
|
*
|
|
15
15
|
* @remarks
|
|
16
16
|
* Generates a preview for a specific workflow step by its unique identifier **stepId**
|
|
@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Track activity and engagement events
|
|
30
|
+
* Track provider activity and engagement events
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
33
|
* Track activity and engagement events for a specific delivery provider
|
|
@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
27
27
|
import { Result } from "../types/fp.js";
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* Create
|
|
30
|
+
* Create a variable
|
|
31
31
|
*
|
|
32
32
|
* @remarks
|
|
33
33
|
* Creates a new environment variable. Keys must be uppercase with underscores only (e.g. BASE_URL). Secret variables are encrypted at rest and masked in API responses.
|
|
@@ -29,11 +29,11 @@ import { Result } from "../types/fp.js";
|
|
|
29
29
|
* Delete environment variable
|
|
30
30
|
*
|
|
31
31
|
* @remarks
|
|
32
|
-
* Deletes an environment variable by
|
|
32
|
+
* Deletes an environment variable by key.
|
|
33
33
|
*/
|
|
34
34
|
export function environmentVariablesDelete(
|
|
35
35
|
client: NovuCore,
|
|
36
|
-
|
|
36
|
+
variableKey: string,
|
|
37
37
|
idempotencyKey?: string | undefined,
|
|
38
38
|
options?: RequestOptions,
|
|
39
39
|
): APIPromise<
|
|
@@ -54,7 +54,7 @@ export function environmentVariablesDelete(
|
|
|
54
54
|
> {
|
|
55
55
|
return new APIPromise($do(
|
|
56
56
|
client,
|
|
57
|
-
|
|
57
|
+
variableKey,
|
|
58
58
|
idempotencyKey,
|
|
59
59
|
options,
|
|
60
60
|
));
|
|
@@ -62,7 +62,7 @@ export function environmentVariablesDelete(
|
|
|
62
62
|
|
|
63
63
|
async function $do(
|
|
64
64
|
client: NovuCore,
|
|
65
|
-
|
|
65
|
+
variableKey: string,
|
|
66
66
|
idempotencyKey?: string | undefined,
|
|
67
67
|
options?: RequestOptions,
|
|
68
68
|
): Promise<
|
|
@@ -87,7 +87,7 @@ async function $do(
|
|
|
87
87
|
const input:
|
|
88
88
|
operations.EnvironmentVariablesControllerDeleteEnvironmentVariableRequest =
|
|
89
89
|
{
|
|
90
|
-
|
|
90
|
+
variableKey: variableKey,
|
|
91
91
|
idempotencyKey: idempotencyKey,
|
|
92
92
|
};
|
|
93
93
|
|
|
@@ -106,12 +106,14 @@ async function $do(
|
|
|
106
106
|
const body = null;
|
|
107
107
|
|
|
108
108
|
const pathParams = {
|
|
109
|
-
|
|
109
|
+
variableKey: encodeSimple("variableKey", payload.variableKey, {
|
|
110
110
|
explode: false,
|
|
111
111
|
charEncoding: "percent",
|
|
112
112
|
}),
|
|
113
113
|
};
|
|
114
|
-
const path = pathToFunc("/v1/environment-variables/{
|
|
114
|
+
const path = pathToFunc("/v1/environment-variables/{variableKey}")(
|
|
115
|
+
pathParams,
|
|
116
|
+
);
|
|
115
117
|
|
|
116
118
|
const headers = new Headers(compactMap({
|
|
117
119
|
Accept: "application/json",
|
|
@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
|
|
|
26
26
|
import { Result } from "../types/fp.js";
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* List
|
|
29
|
+
* List all variables
|
|
30
30
|
*
|
|
31
31
|
* @remarks
|
|
32
32
|
* Returns all environment variables for the current organization. Secret values are masked.
|