@waldur/notifications 1.0.1-dev.0 → 8.0.8-dev.29

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.
@@ -0,0 +1,2 @@
1
+ export * from './types.gen';
2
+ export * from './sdk.gen';
package/dist/index.js ADDED
@@ -0,0 +1,2 @@
1
+ export * from './types.gen';
2
+ export * from './sdk.gen';
@@ -0,0 +1,117 @@
1
+ import type { Options } from '@waldur/core';
2
+ import type { BroadcastMessageTemplatesCountData, BroadcastMessageTemplatesCountResponses, BroadcastMessageTemplatesCreateData, BroadcastMessageTemplatesCreateResponses, BroadcastMessageTemplatesDestroyData, BroadcastMessageTemplatesDestroyResponses, BroadcastMessageTemplatesListData, BroadcastMessageTemplatesListResponses, BroadcastMessageTemplatesPartialUpdateData, BroadcastMessageTemplatesPartialUpdateResponses, BroadcastMessageTemplatesRetrieveData, BroadcastMessageTemplatesRetrieveResponses, BroadcastMessageTemplatesUpdateData, BroadcastMessageTemplatesUpdateResponses, BroadcastMessagesCountData, BroadcastMessagesCountResponses, BroadcastMessagesCreateData, BroadcastMessagesCreateResponses, BroadcastMessagesDestroyData, BroadcastMessagesDestroyResponses, BroadcastMessagesListData, BroadcastMessagesListResponses, BroadcastMessagesPartialUpdateData, BroadcastMessagesPartialUpdateResponses, BroadcastMessagesRecipientsCountData, BroadcastMessagesRecipientsCountResponses, BroadcastMessagesRecipientsRetrieveData, BroadcastMessagesRecipientsRetrieveResponses, BroadcastMessagesRetrieveData, BroadcastMessagesRetrieveResponses, BroadcastMessagesScheduleData, BroadcastMessagesScheduleResponses, BroadcastMessagesSendData, BroadcastMessagesSendResponses, BroadcastMessagesUpdateData, BroadcastMessagesUpdateResponses, EmailLogsCountData, EmailLogsCountResponses, EmailLogsListData, EmailLogsListResponses, EmailLogsRetrieveData, EmailLogsRetrieveResponses, HooksCountData, HooksCountResponses, HooksEmailCountData, HooksEmailCountResponses, HooksEmailCreateData, HooksEmailCreateResponses, HooksEmailDestroyData, HooksEmailDestroyResponses, HooksEmailListData, HooksEmailListResponses, HooksEmailPartialUpdateData, HooksEmailPartialUpdateResponses, HooksEmailRetrieveData, HooksEmailRetrieveResponses, HooksEmailUpdateData, HooksEmailUpdateResponses, HooksListData, HooksListResponses, HooksWebCountData, HooksWebCountResponses, HooksWebCreateData, HooksWebCreateResponses, HooksWebDestroyData, HooksWebDestroyResponses, HooksWebListData, HooksWebListResponses, HooksWebPartialUpdateData, HooksWebPartialUpdateResponses, HooksWebRetrieveData, HooksWebRetrieveResponses, HooksWebUpdateData, HooksWebUpdateResponses, NotificationMessagesCountData, NotificationMessagesCountResponses, NotificationMessagesCreateData, NotificationMessagesCreateResponses, NotificationMessagesDestroyData, NotificationMessagesDestroyResponses, NotificationMessagesDisableData, NotificationMessagesDisableResponses, NotificationMessagesEnableData, NotificationMessagesEnableResponses, NotificationMessagesListData, NotificationMessagesListResponses, NotificationMessagesPartialUpdateData, NotificationMessagesPartialUpdateResponses, NotificationMessagesRetrieveData, NotificationMessagesRetrieveResponses, NotificationMessagesTemplatesCountData, NotificationMessagesTemplatesCountResponses, NotificationMessagesTemplatesCreateData, NotificationMessagesTemplatesCreateResponses, NotificationMessagesTemplatesDestroyData, NotificationMessagesTemplatesDestroyResponses, NotificationMessagesTemplatesListData, NotificationMessagesTemplatesListResponses, NotificationMessagesTemplatesOverrideData, NotificationMessagesTemplatesOverrideResponses, NotificationMessagesTemplatesPartialUpdateData, NotificationMessagesTemplatesPartialUpdateResponses, NotificationMessagesTemplatesRetrieveData, NotificationMessagesTemplatesRetrieveResponses, NotificationMessagesTemplatesUpdateData, NotificationMessagesTemplatesUpdateResponses, NotificationMessagesUpdateData, NotificationMessagesUpdateResponses } from './types.gen';
3
+ export declare const broadcastMessageTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<BroadcastMessageTemplatesListData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesListResponses, unknown, ThrowOnError, "fields">;
4
+ /**
5
+ * Get number of items in the collection matching the request parameters.
6
+ */
7
+ export declare const broadcastMessageTemplatesCount: <ThrowOnError extends boolean = false>(options?: Options<BroadcastMessageTemplatesCountData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesCountResponses, unknown, ThrowOnError, "fields">;
8
+ export declare const broadcastMessageTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessageTemplatesCreateData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesCreateResponses, unknown, ThrowOnError, "fields">;
9
+ export declare const broadcastMessageTemplatesDestroy: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessageTemplatesDestroyData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesDestroyResponses, unknown, ThrowOnError, "fields">;
10
+ export declare const broadcastMessageTemplatesRetrieve: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessageTemplatesRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesRetrieveResponses, unknown, ThrowOnError, "fields">;
11
+ export declare const broadcastMessageTemplatesPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessageTemplatesPartialUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesPartialUpdateResponses, unknown, ThrowOnError, "fields">;
12
+ export declare const broadcastMessageTemplatesUpdate: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessageTemplatesUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessageTemplatesUpdateResponses, unknown, ThrowOnError, "fields">;
13
+ export declare const broadcastMessagesList: <ThrowOnError extends boolean = false>(options?: Options<BroadcastMessagesListData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesListResponses, unknown, ThrowOnError, "fields">;
14
+ /**
15
+ * Get number of items in the collection matching the request parameters.
16
+ */
17
+ export declare const broadcastMessagesCount: <ThrowOnError extends boolean = false>(options?: Options<BroadcastMessagesCountData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesCountResponses, unknown, ThrowOnError, "fields">;
18
+ export declare const broadcastMessagesCreate: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesCreateData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesCreateResponses, unknown, ThrowOnError, "fields">;
19
+ export declare const broadcastMessagesDestroy: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesDestroyData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesDestroyResponses, unknown, ThrowOnError, "fields">;
20
+ export declare const broadcastMessagesRetrieve: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesRetrieveResponses, unknown, ThrowOnError, "fields">;
21
+ export declare const broadcastMessagesPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesPartialUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesPartialUpdateResponses, unknown, ThrowOnError, "fields">;
22
+ export declare const broadcastMessagesUpdate: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesUpdateResponses, unknown, ThrowOnError, "fields">;
23
+ export declare const broadcastMessagesSchedule: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesScheduleData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesScheduleResponses, unknown, ThrowOnError, "fields">;
24
+ export declare const broadcastMessagesSend: <ThrowOnError extends boolean = false>(options: Options<BroadcastMessagesSendData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesSendResponses, unknown, ThrowOnError, "fields">;
25
+ export declare const broadcastMessagesRecipientsRetrieve: <ThrowOnError extends boolean = false>(options?: Options<BroadcastMessagesRecipientsRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesRecipientsRetrieveResponses, unknown, ThrowOnError, "fields">;
26
+ /**
27
+ * Get number of items in the collection matching the request parameters.
28
+ */
29
+ export declare const broadcastMessagesRecipientsCount: <ThrowOnError extends boolean = false>(options?: Options<BroadcastMessagesRecipientsCountData, ThrowOnError>) => import("@waldur/core").RequestResult<BroadcastMessagesRecipientsCountResponses, unknown, ThrowOnError, "fields">;
30
+ export declare const emailLogsList: <ThrowOnError extends boolean = false>(options?: Options<EmailLogsListData, ThrowOnError>) => import("@waldur/core").RequestResult<EmailLogsListResponses, unknown, ThrowOnError, "fields">;
31
+ /**
32
+ * Get number of items in the collection matching the request parameters.
33
+ */
34
+ export declare const emailLogsCount: <ThrowOnError extends boolean = false>(options?: Options<EmailLogsCountData, ThrowOnError>) => import("@waldur/core").RequestResult<EmailLogsCountResponses, unknown, ThrowOnError, "fields">;
35
+ export declare const emailLogsRetrieve: <ThrowOnError extends boolean = false>(options: Options<EmailLogsRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<EmailLogsRetrieveResponses, unknown, ThrowOnError, "fields">;
36
+ export declare const hooksList: <ThrowOnError extends boolean = false>(options?: Options<HooksListData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksListResponses, unknown, ThrowOnError, "fields">;
37
+ /**
38
+ * Get number of items in the collection matching the request parameters.
39
+ */
40
+ export declare const hooksCount: <ThrowOnError extends boolean = false>(options?: Options<HooksCountData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksCountResponses, unknown, ThrowOnError, "fields">;
41
+ export declare const hooksEmailList: <ThrowOnError extends boolean = false>(options?: Options<HooksEmailListData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailListResponses, unknown, ThrowOnError, "fields">;
42
+ /**
43
+ * Get number of items in the collection matching the request parameters.
44
+ */
45
+ export declare const hooksEmailCount: <ThrowOnError extends boolean = false>(options?: Options<HooksEmailCountData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailCountResponses, unknown, ThrowOnError, "fields">;
46
+ export declare const hooksEmailCreate: <ThrowOnError extends boolean = false>(options: Options<HooksEmailCreateData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailCreateResponses, unknown, ThrowOnError, "fields">;
47
+ export declare const hooksEmailDestroy: <ThrowOnError extends boolean = false>(options: Options<HooksEmailDestroyData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailDestroyResponses, unknown, ThrowOnError, "fields">;
48
+ export declare const hooksEmailRetrieve: <ThrowOnError extends boolean = false>(options: Options<HooksEmailRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailRetrieveResponses, unknown, ThrowOnError, "fields">;
49
+ export declare const hooksEmailPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<HooksEmailPartialUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailPartialUpdateResponses, unknown, ThrowOnError, "fields">;
50
+ export declare const hooksEmailUpdate: <ThrowOnError extends boolean = false>(options: Options<HooksEmailUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksEmailUpdateResponses, unknown, ThrowOnError, "fields">;
51
+ export declare const hooksWebList: <ThrowOnError extends boolean = false>(options?: Options<HooksWebListData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebListResponses, unknown, ThrowOnError, "fields">;
52
+ /**
53
+ * Get number of items in the collection matching the request parameters.
54
+ */
55
+ export declare const hooksWebCount: <ThrowOnError extends boolean = false>(options?: Options<HooksWebCountData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebCountResponses, unknown, ThrowOnError, "fields">;
56
+ /**
57
+ * When hook is activated, POST request is issued against destination URL with the following data:
58
+ *
59
+ * .. code-block:: javascript
60
+ *
61
+ * {
62
+ * "timestamp": "2015-07-14T12:12:56.000000",
63
+ * "message": "Customer ABC LLC has been updated.",
64
+ * "type": "customer_update_succeeded",
65
+ * "context": {
66
+ * "user_native_name": "Walter Lebrowski",
67
+ * "customer_contact_details": "",
68
+ * "user_username": "Walter",
69
+ * "user_uuid": "1c3323fc4ae44120b57ec40dea1be6e6",
70
+ * "customer_uuid": "4633bbbb0b3a4b91bffc0e18f853de85",
71
+ * "ip_address": "8.8.8.8",
72
+ * "user_full_name": "Walter Lebrowski",
73
+ * "customer_abbreviation": "ABC LLC",
74
+ * "customer_name": "ABC LLC"
75
+ * },
76
+ * "levelname": "INFO"
77
+ * }
78
+ *
79
+ * Note that context depends on event type.
80
+ */
81
+ export declare const hooksWebCreate: <ThrowOnError extends boolean = false>(options: Options<HooksWebCreateData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebCreateResponses, unknown, ThrowOnError, "fields">;
82
+ export declare const hooksWebDestroy: <ThrowOnError extends boolean = false>(options: Options<HooksWebDestroyData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebDestroyResponses, unknown, ThrowOnError, "fields">;
83
+ export declare const hooksWebRetrieve: <ThrowOnError extends boolean = false>(options: Options<HooksWebRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebRetrieveResponses, unknown, ThrowOnError, "fields">;
84
+ export declare const hooksWebPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<HooksWebPartialUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebPartialUpdateResponses, unknown, ThrowOnError, "fields">;
85
+ export declare const hooksWebUpdate: <ThrowOnError extends boolean = false>(options: Options<HooksWebUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<HooksWebUpdateResponses, unknown, ThrowOnError, "fields">;
86
+ export declare const notificationMessagesList: <ThrowOnError extends boolean = false>(options?: Options<NotificationMessagesListData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesListResponses, unknown, ThrowOnError, "fields">;
87
+ /**
88
+ * Get number of items in the collection matching the request parameters.
89
+ */
90
+ export declare const notificationMessagesCount: <ThrowOnError extends boolean = false>(options?: Options<NotificationMessagesCountData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesCountResponses, unknown, ThrowOnError, "fields">;
91
+ export declare const notificationMessagesCreate: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesCreateData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesCreateResponses, unknown, ThrowOnError, "fields">;
92
+ export declare const notificationMessagesTemplatesList: <ThrowOnError extends boolean = false>(options?: Options<NotificationMessagesTemplatesListData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesListResponses, unknown, ThrowOnError, "fields">;
93
+ /**
94
+ * Get number of items in the collection matching the request parameters.
95
+ */
96
+ export declare const notificationMessagesTemplatesCount: <ThrowOnError extends boolean = false>(options?: Options<NotificationMessagesTemplatesCountData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesCountResponses, unknown, ThrowOnError, "fields">;
97
+ export declare const notificationMessagesTemplatesCreate: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesTemplatesCreateData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesCreateResponses, unknown, ThrowOnError, "fields">;
98
+ export declare const notificationMessagesTemplatesDestroy: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesTemplatesDestroyData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesDestroyResponses, unknown, ThrowOnError, "fields">;
99
+ export declare const notificationMessagesTemplatesRetrieve: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesTemplatesRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesRetrieveResponses, unknown, ThrowOnError, "fields">;
100
+ export declare const notificationMessagesTemplatesPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesTemplatesPartialUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesPartialUpdateResponses, unknown, ThrowOnError, "fields">;
101
+ export declare const notificationMessagesTemplatesUpdate: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesTemplatesUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesUpdateResponses, unknown, ThrowOnError, "fields">;
102
+ /**
103
+ * Override notification template content
104
+ */
105
+ export declare const notificationMessagesTemplatesOverride: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesTemplatesOverrideData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesTemplatesOverrideResponses, unknown, ThrowOnError, "fields">;
106
+ export declare const notificationMessagesDestroy: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesDestroyData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesDestroyResponses, unknown, ThrowOnError, "fields">;
107
+ export declare const notificationMessagesRetrieve: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesRetrieveData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesRetrieveResponses, unknown, ThrowOnError, "fields">;
108
+ export declare const notificationMessagesPartialUpdate: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesPartialUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesPartialUpdateResponses, unknown, ThrowOnError, "fields">;
109
+ export declare const notificationMessagesUpdate: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesUpdateData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesUpdateResponses, unknown, ThrowOnError, "fields">;
110
+ /**
111
+ * Disable a notification
112
+ */
113
+ export declare const notificationMessagesDisable: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesDisableData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesDisableResponses, unknown, ThrowOnError, "fields">;
114
+ /**
115
+ * Enable a notification
116
+ */
117
+ export declare const notificationMessagesEnable: <ThrowOnError extends boolean = false>(options: Options<NotificationMessagesEnableData, ThrowOnError>) => import("@waldur/core").RequestResult<NotificationMessagesEnableResponses, unknown, ThrowOnError, "fields">;