@waldur/notifications 1.0.1-dev.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.
@@ -0,0 +1,1264 @@
1
+ // This file is auto-generated by split-sdk script
2
+
3
+
4
+
5
+ export type BroadcastMessage = {
6
+ readonly uuid?: string;
7
+ readonly created?: string;
8
+ subject?: string;
9
+ body?: string;
10
+ query?: unknown;
11
+ readonly author_full_name?: string;
12
+ readonly emails?: unknown;
13
+ state?: BroadcastMessageStateEnum;
14
+ send_at?: string | null;
15
+ };
16
+
17
+ export type BroadcastMessageRequest = {
18
+ subject: string;
19
+ body: string;
20
+ query: unknown;
21
+ send_at?: string | null;
22
+ };
23
+
24
+ export type BroadcastMessageStateEnum = 'DRAFT' | 'SCHEDULED' | 'SENT';
25
+
26
+ export type EmailHook = {
27
+ readonly url: string;
28
+ readonly uuid: string;
29
+ is_active?: boolean;
30
+ readonly author_uuid: string;
31
+ event_types?: Array<EventTypesEnum>;
32
+ event_groups?: Array<EventGroupsEnum>;
33
+ readonly created: string;
34
+ readonly modified: string;
35
+ readonly hook_type: string;
36
+ readonly author_fullname: string;
37
+ readonly author_username: string;
38
+ readonly author_email: string;
39
+ email: string;
40
+ };
41
+
42
+ export type EmailHookRequest = {
43
+ is_active?: boolean;
44
+ event_types?: Array<EventTypesEnum>;
45
+ event_groups?: Array<EventGroupsEnum>;
46
+ email: string;
47
+ };
48
+
49
+ export type EmailLog = {
50
+ readonly uuid: string;
51
+ readonly url: string;
52
+ readonly sent_at: string;
53
+ subject: string;
54
+ body: string;
55
+ emails: Array<string>;
56
+ };
57
+
58
+ export type EventGroupsEnum = 'access_subnets' | 'auth' | 'call' | 'chat' | 'credits' | 'customers' | 'invoices' | 'offering_accounting' | 'onboarding' | 'permissions' | 'projects' | 'proposal' | 'providers' | 'resources' | 'review' | 'ssh' | 'support' | 'users' | 'terms_of_service';
59
+
60
+ export type EventTypesEnum = 'access_subnet_creation_succeeded' | 'access_subnet_deletion_succeeded' | 'access_subnet_update_succeeded' | 'allowed_offerings_have_been_updated' | 'attachment_created' | 'attachment_deleted' | 'attachment_updated' | 'auth_logged_in_with_saml2' | 'auth_logged_in_with_username' | 'auth_logged_in_with_oauth' | 'auth_logged_out' | 'auth_logged_out_with_saml2' | 'auth_login_failed_with_username' | 'block_creation_of_new_resources' | 'block_modification_of_existing_resources' | 'call_document_added' | 'call_document_removed' | 'create_of_credit_by_staff' | 'create_of_project_credit_by_staff' | 'custom_notification' | 'customer_creation_succeeded' | 'customer_deletion_succeeded' | 'customer_update_succeeded' | 'customer_permission_review_created' | 'customer_permission_review_closed' | 'droplet_resize_scheduled' | 'droplet_resize_succeeded' | 'freeipa_profile_created' | 'freeipa_profile_deleted' | 'freeipa_profile_disabled' | 'freeipa_profile_enabled' | 'invoice_canceled' | 'invoice_created' | 'invoice_item_created' | 'invoice_item_deleted' | 'invoice_item_updated' | 'invoice_paid' | 'issue_creation_succeeded' | 'issue_deletion_succeeded' | 'issue_update_succeeded' | 'marketplace_offering_component_created' | 'marketplace_offering_component_deleted' | 'marketplace_offering_component_updated' | 'marketplace_offering_created' | 'marketplace_offering_role_created' | 'marketplace_offering_role_deleted' | 'marketplace_offering_role_updated' | 'marketplace_offering_updated' | 'marketplace_offering_user_created' | 'marketplace_offering_user_updated' | 'marketplace_offering_user_deleted' | 'marketplace_offering_user_restriction_updated' | 'marketplace_order_approved' | 'marketplace_order_completed' | 'marketplace_order_created' | 'marketplace_order_failed' | 'marketplace_order_rejected' | 'marketplace_order_terminated' | 'marketplace_order_unlinked' | 'marketplace_plan_archived' | 'marketplace_plan_component_current_price_updated' | 'marketplace_plan_component_future_price_updated' | 'marketplace_plan_component_quota_updated' | 'marketplace_plan_created' | 'marketplace_plan_updated' | 'marketplace_plan_deleted' | 'marketplace_resource_create_canceled' | 'marketplace_resource_create_failed' | 'marketplace_resource_create_requested' | 'marketplace_resource_create_succeeded' | 'marketplace_resource_downscaled' | 'marketplace_resource_erred_on_backend' | 'marketplace_resource_paused' | 'marketplace_resource_terminate_canceled' | 'marketplace_resource_terminate_failed' | 'marketplace_resource_terminate_requested' | 'marketplace_resource_terminate_succeeded' | 'marketplace_resource_unlinked' | 'marketplace_resource_update_canceled' | 'marketplace_resource_update_end_date_succeeded' | 'marketplace_resource_update_failed' | 'marketplace_resource_update_limits_failed' | 'marketplace_resource_update_limits_succeeded' | 'marketplace_resource_update_requested' | 'marketplace_resource_update_succeeded' | 'marketplace_resource_user_created' | 'marketplace_resource_user_deleted' | 'notify_external_user' | 'notify_organization_owners' | 'notify_project_team' | 'openstack_floating_ip_attached' | 'openstack_floating_ip_connected' | 'openstack_floating_ip_description_updated' | 'openstack_floating_ip_detached' | 'openstack_floating_ip_disconnected' | 'openstack_network_cleaned' | 'openstack_network_created' | 'openstack_network_deleted' | 'openstack_network_imported' | 'openstack_network_pulled' | 'openstack_network_updated' | 'openstack_port_cleaned' | 'openstack_port_created' | 'openstack_port_deleted' | 'openstack_port_imported' | 'openstack_port_pulled' | 'openstack_port_updated' | 'openstack_router_updated' | 'openstack_security_group_cleaned' | 'openstack_security_group_created' | 'openstack_security_group_deleted' | 'openstack_security_group_imported' | 'openstack_security_group_pulled' | 'openstack_security_group_rule_cleaned' | 'openstack_security_group_rule_created' | 'openstack_security_group_rule_deleted' | 'openstack_security_group_rule_imported' | 'openstack_security_group_rule_updated' | 'openstack_security_group_updated' | 'openstack_security_group_added_remotely' | 'openstack_security_group_removed_remotely' | 'openstack_security_group_added_locally' | 'openstack_security_group_removed_locally' | 'openstack_server_group_cleaned' | 'openstack_server_group_created' | 'openstack_server_group_deleted' | 'openstack_server_group_imported' | 'openstack_server_group_pulled' | 'openstack_subnet_cleaned' | 'openstack_subnet_created' | 'openstack_subnet_deleted' | 'openstack_subnet_imported' | 'openstack_subnet_pulled' | 'openstack_subnet_updated' | 'openstack_tenant_quota_limit_updated' | 'payment_added' | 'payment_created' | 'payment_removed' | 'policy_notification' | 'project_creation_succeeded' | 'project_deletion_succeeded' | 'project_deletion_triggered' | 'project_update_request_approved' | 'project_update_request_created' | 'project_update_request_rejected' | 'project_end_date_change_request_approved' | 'project_end_date_change_request_created' | 'project_end_date_change_request_rejected' | 'project_update_succeeded' | 'project_permission_review_created' | 'project_permission_review_closed' | 'proposal_canceled' | 'proposal_document_added' | 'proposal_document_removed' | 'query_executed' | 'reduction_of_customer_credit' | 'reduction_of_customer_credit_due_to_minimal_consumption' | 'reduction_of_customer_expected_consumption' | 'reduction_of_project_credit' | 'reduction_of_project_credit_due_to_minimal_consumption' | 'reduction_of_project_expected_consumption' | 'request_downscaling' | 'request_pausing' | 'request_slurm_resource_downscaling' | 'request_slurm_resource_pausing' | 'reset_downscaling' | 'reset_member_restriction' | 'reset_pausing' | 'resource_assign_floating_ip_failed' | 'resource_assign_floating_ip_scheduled' | 'resource_assign_floating_ip_succeeded' | 'resource_attach_failed' | 'resource_attach_scheduled' | 'resource_attach_succeeded' | 'resource_backup_creation_failed' | 'resource_backup_creation_scheduled' | 'resource_backup_creation_succeeded' | 'resource_backup_deletion_failed' | 'resource_backup_deletion_scheduled' | 'resource_backup_deletion_succeeded' | 'resource_backup_restoration_failed' | 'resource_backup_restoration_scheduled' | 'resource_backup_restoration_succeeded' | 'resource_change_flavor_failed' | 'resource_change_flavor_scheduled' | 'resource_change_flavor_succeeded' | 'resource_creation_failed' | 'resource_creation_scheduled' | 'resource_creation_succeeded' | 'resource_deletion_failed' | 'resource_deletion_scheduled' | 'resource_deletion_succeeded' | 'resource_detach_failed' | 'resource_detach_scheduled' | 'resource_detach_succeeded' | 'resource_extend_failed' | 'resource_extend_scheduled' | 'resource_extend_succeeded' | 'resource_extend_volume_failed' | 'resource_extend_volume_scheduled' | 'resource_extend_volume_succeeded' | 'resource_import_succeeded' | 'resource_pull_failed' | 'resource_pull_scheduled' | 'resource_pull_succeeded' | 'resource_restart_failed' | 'resource_restart_scheduled' | 'resource_restart_succeeded' | 'resource_retype_failed' | 'resource_retype_scheduled' | 'resource_retype_succeeded' | 'resource_robot_account_created' | 'resource_robot_account_deleted' | 'resource_robot_account_state_changed' | 'resource_robot_account_updated' | 'resource_start_failed' | 'resource_start_scheduled' | 'resource_start_succeeded' | 'resource_stop_failed' | 'resource_stop_scheduled' | 'resource_stop_succeeded' | 'resource_unassign_floating_ip_failed' | 'resource_unassign_floating_ip_scheduled' | 'resource_unassign_floating_ip_succeeded' | 'resource_update_allowed_address_pairs_failed' | 'resource_update_allowed_address_pairs_scheduled' | 'resource_update_allowed_address_pairs_succeeded' | 'resource_update_floating_ips_failed' | 'resource_update_floating_ips_scheduled' | 'resource_update_floating_ips_succeeded' | 'resource_update_ports_failed' | 'resource_update_ports_scheduled' | 'resource_update_ports_succeeded' | 'resource_update_security_groups_failed' | 'resource_update_security_groups_scheduled' | 'resource_update_security_groups_succeeded' | 'resource_update_succeeded' | 'restrict_members' | 'review_canceled' | 'role_granted' | 'role_revoked' | 'role_updated' | 'roll_back_customer_credit' | 'roll_back_project_credit' | 'service_account_created' | 'service_account_deleted' | 'service_account_updated' | 'set_to_zero_overdue_credit' | 'slurm_policy_evaluation' | 'ssh_key_creation_succeeded' | 'ssh_key_deletion_succeeded' | 'terminate_resources' | 'token_created' | 'token_lifetime_updated' | 'update_of_credit_by_staff' | 'update_of_project_credit_by_staff' | 'automatic_credit_adjustment' | 'user_activated' | 'user_creation_succeeded' | 'user_data_accessed' | 'user_deactivated' | 'user_deactivated_no_roles' | 'user_deletion_succeeded' | 'user_details_update_succeeded' | 'user_has_been_created_by_staff' | 'user_password_updated' | 'user_password_updated_by_staff' | 'user_password_removed_by_staff' | 'user_update_succeeded' | 'user_group_invitation_updated' | 'user_invitation_updated' | 'user_invitation_deleted' | 'terms_of_service_consent_granted' | 'terms_of_service_consent_revoked' | 'chat_session_accessed' | 'chat_thread_accessed' | 'chat_injection_detected' | 'chat_pii_detected' | 'chat_feedback_submitted' | 'onboarding_verification_deleted' | 'onboarding_verification_deleted_by_task' | 'pat_created' | 'pat_revoked' | 'pat_rotated' | 'pat_expired' | 'pat_used_from_new_ip';
61
+
62
+ export type MessageTemplate = {
63
+ readonly url: string;
64
+ readonly uuid: string;
65
+ name: string;
66
+ subject: string;
67
+ body: string;
68
+ };
69
+
70
+ export type MessageTemplateRequest = {
71
+ name: string;
72
+ subject: string;
73
+ body: string;
74
+ };
75
+
76
+ export type Notification = {
77
+ readonly uuid: string;
78
+ readonly url: string;
79
+ key: string;
80
+ description?: string;
81
+ /**
82
+ * Indicates if notification is enabled or disabled
83
+ */
84
+ readonly enabled: boolean;
85
+ readonly created: string;
86
+ readonly templates: Array<NotificationTemplateDetailSerializers>;
87
+ /**
88
+ * Finds the notification definition in the global NOTIFICATIONS
89
+ * dictionary and returns its 'context' schema.
90
+ */
91
+ readonly context_schema: {
92
+ [key: string]: unknown;
93
+ };
94
+ };
95
+
96
+ export type NotificationRequest = {
97
+ key: string;
98
+ description?: string;
99
+ };
100
+
101
+ export type NotificationTemplateDetailSerializers = {
102
+ readonly uuid: string;
103
+ readonly url: string;
104
+ /**
105
+ * Example: 'flatpages/default.html'
106
+ */
107
+ path: string;
108
+ name: string;
109
+ readonly content: string | null;
110
+ readonly original_content: string | null;
111
+ readonly is_content_overridden: boolean;
112
+ };
113
+
114
+ export type NotificationTemplateDetailSerializersRequest = {
115
+ /**
116
+ * Example: 'flatpages/default.html'
117
+ */
118
+ path: string;
119
+ name: string;
120
+ };
121
+
122
+ export type NotificationTemplateUpdateSerializersRequest = {
123
+ content: string;
124
+ };
125
+
126
+ export type PatchedBroadcastMessageRequest = {
127
+ subject?: string;
128
+ body?: string;
129
+ query?: unknown;
130
+ send_at?: string | null;
131
+ };
132
+
133
+ export type PatchedEmailHookRequest = {
134
+ is_active?: boolean;
135
+ event_types?: Array<EventTypesEnum>;
136
+ event_groups?: Array<EventGroupsEnum>;
137
+ email?: string;
138
+ };
139
+
140
+ export type PatchedMessageTemplateRequest = {
141
+ name?: string;
142
+ subject?: string;
143
+ body?: string;
144
+ };
145
+
146
+ export type PatchedNotificationRequest = {
147
+ key?: string;
148
+ description?: string;
149
+ };
150
+
151
+ export type PatchedNotificationTemplateDetailSerializersRequest = {
152
+ /**
153
+ * Example: 'flatpages/default.html'
154
+ */
155
+ path?: string;
156
+ name?: string;
157
+ };
158
+
159
+ export type PatchedWebHookRequest = {
160
+ is_active?: boolean;
161
+ event_types?: Array<EventTypesEnum>;
162
+ event_groups?: Array<EventGroupsEnum>;
163
+ destination_url?: string;
164
+ content_type?: WebHookContentTypeEnum;
165
+ };
166
+
167
+ export type WebHook = {
168
+ readonly url: string;
169
+ readonly uuid: string;
170
+ is_active?: boolean;
171
+ readonly author_uuid: string;
172
+ event_types?: Array<EventTypesEnum>;
173
+ event_groups?: Array<EventGroupsEnum>;
174
+ readonly created: string;
175
+ readonly modified: string;
176
+ readonly hook_type: string;
177
+ readonly author_fullname: string;
178
+ readonly author_username: string;
179
+ readonly author_email: string;
180
+ destination_url: string;
181
+ content_type?: WebHookContentTypeEnum;
182
+ };
183
+
184
+ export type WebHookContentTypeEnum = 'json' | 'form';
185
+
186
+ export type WebHookRequest = {
187
+ is_active?: boolean;
188
+ event_types?: Array<EventTypesEnum>;
189
+ event_groups?: Array<EventGroupsEnum>;
190
+ destination_url: string;
191
+ content_type?: WebHookContentTypeEnum;
192
+ };
193
+
194
+ export type BroadcastMessageFieldEnum = 'author_full_name' | 'body' | 'created' | 'emails' | 'query' | 'send_at' | 'state' | 'subject' | 'uuid';
195
+
196
+ export type BroadcastMessageOEnum = '-author_full_name' | '-created' | '-subject' | 'author_full_name' | 'created' | 'subject';
197
+
198
+ export type EmailLogOEnum = '-sent_at' | '-subject' | 'sent_at' | 'subject';
199
+
200
+ export type WebHookContentTypeEnum1 = 1 | 2;
201
+
202
+ export type BroadcastMessageTemplatesListData = {
203
+ body?: never;
204
+ path?: never;
205
+ query?: {
206
+ name?: string;
207
+ /**
208
+ * A page number within the paginated result set.
209
+ */
210
+ page?: number;
211
+ /**
212
+ * Number of results to return per page.
213
+ */
214
+ page_size?: number;
215
+ };
216
+ url: '/api/broadcast-message-templates/';
217
+ };
218
+
219
+ export type BroadcastMessageTemplatesListResponses = {
220
+ 200: Array<MessageTemplate>;
221
+ };
222
+
223
+ export type BroadcastMessageTemplatesCountData = {
224
+ body?: never;
225
+ path?: never;
226
+ query?: {
227
+ name?: string;
228
+ /**
229
+ * A page number within the paginated result set.
230
+ */
231
+ page?: number;
232
+ /**
233
+ * Number of results to return per page.
234
+ */
235
+ page_size?: number;
236
+ };
237
+ url: '/api/broadcast-message-templates/';
238
+ };
239
+
240
+ export type BroadcastMessageTemplatesCountResponses = {
241
+ /**
242
+ * No response body
243
+ */
244
+ 200: unknown;
245
+ };
246
+
247
+ export type BroadcastMessageTemplatesCreateData = {
248
+ body: MessageTemplateRequest;
249
+ path?: never;
250
+ query?: never;
251
+ url: '/api/broadcast-message-templates/';
252
+ };
253
+
254
+ export type BroadcastMessageTemplatesCreateResponses = {
255
+ 201: MessageTemplate;
256
+ };
257
+
258
+ export type BroadcastMessageTemplatesDestroyData = {
259
+ body?: never;
260
+ path: {
261
+ uuid: string;
262
+ };
263
+ query?: never;
264
+ url: '/api/broadcast-message-templates/{uuid}/';
265
+ };
266
+
267
+ export type BroadcastMessageTemplatesDestroyResponses = {
268
+ /**
269
+ * No response body
270
+ */
271
+ 204: void;
272
+ };
273
+
274
+ export type BroadcastMessageTemplatesRetrieveData = {
275
+ body?: never;
276
+ path: {
277
+ uuid: string;
278
+ };
279
+ query?: never;
280
+ url: '/api/broadcast-message-templates/{uuid}/';
281
+ };
282
+
283
+ export type BroadcastMessageTemplatesRetrieveResponses = {
284
+ 200: MessageTemplate;
285
+ };
286
+
287
+ export type BroadcastMessageTemplatesPartialUpdateData = {
288
+ body?: PatchedMessageTemplateRequest;
289
+ path: {
290
+ uuid: string;
291
+ };
292
+ query?: never;
293
+ url: '/api/broadcast-message-templates/{uuid}/';
294
+ };
295
+
296
+ export type BroadcastMessageTemplatesPartialUpdateResponses = {
297
+ 200: MessageTemplate;
298
+ };
299
+
300
+ export type BroadcastMessageTemplatesUpdateData = {
301
+ body: MessageTemplateRequest;
302
+ path: {
303
+ uuid: string;
304
+ };
305
+ query?: never;
306
+ url: '/api/broadcast-message-templates/{uuid}/';
307
+ };
308
+
309
+ export type BroadcastMessageTemplatesUpdateResponses = {
310
+ 200: MessageTemplate;
311
+ };
312
+
313
+ export type BroadcastMessagesListData = {
314
+ body?: never;
315
+ path?: never;
316
+ query?: {
317
+ field?: Array<BroadcastMessageFieldEnum>;
318
+ /**
319
+ * Ordering
320
+ *
321
+ *
322
+ */
323
+ o?: Array<BroadcastMessageOEnum>;
324
+ /**
325
+ * A page number within the paginated result set.
326
+ */
327
+ page?: number;
328
+ /**
329
+ * Number of results to return per page.
330
+ */
331
+ page_size?: number;
332
+ state?: BroadcastMessageStateEnum;
333
+ subject?: string;
334
+ };
335
+ url: '/api/broadcast-messages/';
336
+ };
337
+
338
+ export type BroadcastMessagesListResponses = {
339
+ 200: Array<BroadcastMessage>;
340
+ };
341
+
342
+ export type BroadcastMessagesCountData = {
343
+ body?: never;
344
+ path?: never;
345
+ query?: {
346
+ /**
347
+ * Ordering
348
+ *
349
+ *
350
+ */
351
+ o?: Array<BroadcastMessageOEnum>;
352
+ /**
353
+ * A page number within the paginated result set.
354
+ */
355
+ page?: number;
356
+ /**
357
+ * Number of results to return per page.
358
+ */
359
+ page_size?: number;
360
+ state?: BroadcastMessageStateEnum;
361
+ subject?: string;
362
+ };
363
+ url: '/api/broadcast-messages/';
364
+ };
365
+
366
+ export type BroadcastMessagesCountResponses = {
367
+ /**
368
+ * No response body
369
+ */
370
+ 200: unknown;
371
+ };
372
+
373
+ export type BroadcastMessagesCreateData = {
374
+ body: BroadcastMessageRequest;
375
+ path?: never;
376
+ query?: never;
377
+ url: '/api/broadcast-messages/';
378
+ };
379
+
380
+ export type BroadcastMessagesCreateResponses = {
381
+ 201: BroadcastMessage;
382
+ };
383
+
384
+ export type BroadcastMessagesDestroyData = {
385
+ body?: never;
386
+ path: {
387
+ uuid: string;
388
+ };
389
+ query?: never;
390
+ url: '/api/broadcast-messages/{uuid}/';
391
+ };
392
+
393
+ export type BroadcastMessagesDestroyResponses = {
394
+ /**
395
+ * No response body
396
+ */
397
+ 204: void;
398
+ };
399
+
400
+ export type BroadcastMessagesRetrieveData = {
401
+ body?: never;
402
+ path: {
403
+ uuid: string;
404
+ };
405
+ query?: {
406
+ field?: Array<BroadcastMessageFieldEnum>;
407
+ };
408
+ url: '/api/broadcast-messages/{uuid}/';
409
+ };
410
+
411
+ export type BroadcastMessagesRetrieveResponses = {
412
+ 200: BroadcastMessage;
413
+ };
414
+
415
+ export type BroadcastMessagesPartialUpdateData = {
416
+ body?: PatchedBroadcastMessageRequest;
417
+ path: {
418
+ uuid: string;
419
+ };
420
+ query?: never;
421
+ url: '/api/broadcast-messages/{uuid}/';
422
+ };
423
+
424
+ export type BroadcastMessagesPartialUpdateResponses = {
425
+ 200: BroadcastMessage;
426
+ };
427
+
428
+ export type BroadcastMessagesUpdateData = {
429
+ body: BroadcastMessageRequest;
430
+ path: {
431
+ uuid: string;
432
+ };
433
+ query?: never;
434
+ url: '/api/broadcast-messages/{uuid}/';
435
+ };
436
+
437
+ export type BroadcastMessagesUpdateResponses = {
438
+ 200: BroadcastMessage;
439
+ };
440
+
441
+ export type BroadcastMessagesScheduleData = {
442
+ body?: never;
443
+ path: {
444
+ uuid: string;
445
+ };
446
+ query?: never;
447
+ url: '/api/broadcast-messages/{uuid}/schedule/';
448
+ };
449
+
450
+ export type BroadcastMessagesScheduleResponses = {
451
+ /**
452
+ * No response body
453
+ */
454
+ 200: unknown;
455
+ };
456
+
457
+ export type BroadcastMessagesSendData = {
458
+ body?: never;
459
+ path: {
460
+ uuid: string;
461
+ };
462
+ query?: never;
463
+ url: '/api/broadcast-messages/{uuid}/send/';
464
+ };
465
+
466
+ export type BroadcastMessagesSendResponses = {
467
+ /**
468
+ * No response body
469
+ */
470
+ 200: unknown;
471
+ };
472
+
473
+ export type BroadcastMessagesRecipientsRetrieveData = {
474
+ body?: never;
475
+ path?: never;
476
+ query?: {
477
+ field?: Array<BroadcastMessageFieldEnum>;
478
+ };
479
+ url: '/api/broadcast-messages/recipients/';
480
+ };
481
+
482
+ export type BroadcastMessagesRecipientsRetrieveResponses = {
483
+ 200: BroadcastMessage;
484
+ };
485
+
486
+ export type BroadcastMessagesRecipientsCountData = {
487
+ body?: never;
488
+ path?: never;
489
+ query?: never;
490
+ url: '/api/broadcast-messages/recipients/';
491
+ };
492
+
493
+ export type BroadcastMessagesRecipientsCountResponses = {
494
+ /**
495
+ * No response body
496
+ */
497
+ 200: unknown;
498
+ };
499
+
500
+ export type EmailLogsListData = {
501
+ body?: never;
502
+ path?: never;
503
+ query?: {
504
+ body?: string;
505
+ emails?: string;
506
+ /**
507
+ * Ordering
508
+ *
509
+ *
510
+ */
511
+ o?: Array<EmailLogOEnum>;
512
+ /**
513
+ * A page number within the paginated result set.
514
+ */
515
+ page?: number;
516
+ /**
517
+ * Number of results to return per page.
518
+ */
519
+ page_size?: number;
520
+ sent_at?: string;
521
+ subject?: string;
522
+ };
523
+ url: '/api/email-logs/';
524
+ };
525
+
526
+ export type EmailLogsListResponses = {
527
+ 200: Array<EmailLog>;
528
+ };
529
+
530
+ export type EmailLogsCountData = {
531
+ body?: never;
532
+ path?: never;
533
+ query?: {
534
+ body?: string;
535
+ emails?: string;
536
+ /**
537
+ * Ordering
538
+ *
539
+ *
540
+ */
541
+ o?: Array<EmailLogOEnum>;
542
+ /**
543
+ * A page number within the paginated result set.
544
+ */
545
+ page?: number;
546
+ /**
547
+ * Number of results to return per page.
548
+ */
549
+ page_size?: number;
550
+ sent_at?: string;
551
+ subject?: string;
552
+ };
553
+ url: '/api/email-logs/';
554
+ };
555
+
556
+ export type EmailLogsCountResponses = {
557
+ /**
558
+ * No response body
559
+ */
560
+ 200: unknown;
561
+ };
562
+
563
+ export type EmailLogsRetrieveData = {
564
+ body?: never;
565
+ path: {
566
+ uuid: string;
567
+ };
568
+ query?: never;
569
+ url: '/api/email-logs/{uuid}/';
570
+ };
571
+
572
+ export type EmailLogsRetrieveResponses = {
573
+ 200: EmailLog;
574
+ };
575
+
576
+ export type HooksListData = {
577
+ body?: never;
578
+ path?: never;
579
+ query?: {
580
+ author_email?: string;
581
+ /**
582
+ * User full name contains
583
+ */
584
+ author_fullname?: string;
585
+ author_username?: string;
586
+ author_uuid?: string;
587
+ is_active?: boolean;
588
+ last_published?: string;
589
+ /**
590
+ * A page number within the paginated result set.
591
+ */
592
+ page?: number;
593
+ /**
594
+ * Number of results to return per page.
595
+ */
596
+ page_size?: number;
597
+ /**
598
+ * Filter by author name, username and email
599
+ */
600
+ query?: string;
601
+ };
602
+ url: '/api/hooks/';
603
+ };
604
+
605
+ export type HooksListResponses = {
606
+ /**
607
+ * No response body
608
+ */
609
+ 200: unknown;
610
+ };
611
+
612
+ export type HooksCountData = {
613
+ body?: never;
614
+ path?: never;
615
+ query?: {
616
+ author_email?: string;
617
+ /**
618
+ * User full name contains
619
+ */
620
+ author_fullname?: string;
621
+ author_username?: string;
622
+ author_uuid?: string;
623
+ is_active?: boolean;
624
+ last_published?: string;
625
+ /**
626
+ * A page number within the paginated result set.
627
+ */
628
+ page?: number;
629
+ /**
630
+ * Number of results to return per page.
631
+ */
632
+ page_size?: number;
633
+ /**
634
+ * Filter by author name, username and email
635
+ */
636
+ query?: string;
637
+ };
638
+ url: '/api/hooks/';
639
+ };
640
+
641
+ export type HooksCountResponses = {
642
+ /**
643
+ * No response body
644
+ */
645
+ 200: unknown;
646
+ };
647
+
648
+ export type HooksEmailListData = {
649
+ body?: never;
650
+ path?: never;
651
+ query?: {
652
+ author_email?: string;
653
+ /**
654
+ * User full name contains
655
+ */
656
+ author_fullname?: string;
657
+ author_username?: string;
658
+ author_uuid?: string;
659
+ email?: string;
660
+ is_active?: boolean;
661
+ last_published?: string;
662
+ /**
663
+ * A page number within the paginated result set.
664
+ */
665
+ page?: number;
666
+ /**
667
+ * Number of results to return per page.
668
+ */
669
+ page_size?: number;
670
+ /**
671
+ * Filter by author name, username and email
672
+ */
673
+ query?: string;
674
+ };
675
+ url: '/api/hooks-email/';
676
+ };
677
+
678
+ export type HooksEmailListResponses = {
679
+ 200: Array<EmailHook>;
680
+ };
681
+
682
+ export type HooksEmailCountData = {
683
+ body?: never;
684
+ path?: never;
685
+ query?: {
686
+ author_email?: string;
687
+ /**
688
+ * User full name contains
689
+ */
690
+ author_fullname?: string;
691
+ author_username?: string;
692
+ author_uuid?: string;
693
+ email?: string;
694
+ is_active?: boolean;
695
+ last_published?: string;
696
+ /**
697
+ * A page number within the paginated result set.
698
+ */
699
+ page?: number;
700
+ /**
701
+ * Number of results to return per page.
702
+ */
703
+ page_size?: number;
704
+ /**
705
+ * Filter by author name, username and email
706
+ */
707
+ query?: string;
708
+ };
709
+ url: '/api/hooks-email/';
710
+ };
711
+
712
+ export type HooksEmailCountResponses = {
713
+ /**
714
+ * No response body
715
+ */
716
+ 200: unknown;
717
+ };
718
+
719
+ export type HooksEmailCreateData = {
720
+ body: EmailHookRequest;
721
+ path?: never;
722
+ query?: never;
723
+ url: '/api/hooks-email/';
724
+ };
725
+
726
+ export type HooksEmailCreateResponses = {
727
+ 201: EmailHook;
728
+ };
729
+
730
+ export type HooksEmailDestroyData = {
731
+ body?: never;
732
+ path: {
733
+ uuid: string;
734
+ };
735
+ query?: never;
736
+ url: '/api/hooks-email/{uuid}/';
737
+ };
738
+
739
+ export type HooksEmailDestroyResponses = {
740
+ /**
741
+ * No response body
742
+ */
743
+ 204: void;
744
+ };
745
+
746
+ export type HooksEmailRetrieveData = {
747
+ body?: never;
748
+ path: {
749
+ uuid: string;
750
+ };
751
+ query?: never;
752
+ url: '/api/hooks-email/{uuid}/';
753
+ };
754
+
755
+ export type HooksEmailRetrieveResponses = {
756
+ 200: EmailHook;
757
+ };
758
+
759
+ export type HooksEmailPartialUpdateData = {
760
+ body?: PatchedEmailHookRequest;
761
+ path: {
762
+ uuid: string;
763
+ };
764
+ query?: never;
765
+ url: '/api/hooks-email/{uuid}/';
766
+ };
767
+
768
+ export type HooksEmailPartialUpdateResponses = {
769
+ 200: EmailHook;
770
+ };
771
+
772
+ export type HooksEmailUpdateData = {
773
+ body: EmailHookRequest;
774
+ path: {
775
+ uuid: string;
776
+ };
777
+ query?: never;
778
+ url: '/api/hooks-email/{uuid}/';
779
+ };
780
+
781
+ export type HooksEmailUpdateResponses = {
782
+ 200: EmailHook;
783
+ };
784
+
785
+ export type HooksWebListData = {
786
+ body?: never;
787
+ path?: never;
788
+ query?: {
789
+ author_email?: string;
790
+ /**
791
+ * User full name contains
792
+ */
793
+ author_fullname?: string;
794
+ author_username?: string;
795
+ author_uuid?: string;
796
+ content_type?: WebHookContentTypeEnum1;
797
+ destination_url?: string;
798
+ is_active?: boolean;
799
+ last_published?: string;
800
+ /**
801
+ * A page number within the paginated result set.
802
+ */
803
+ page?: number;
804
+ /**
805
+ * Number of results to return per page.
806
+ */
807
+ page_size?: number;
808
+ /**
809
+ * Filter by author name, username and email
810
+ */
811
+ query?: string;
812
+ };
813
+ url: '/api/hooks-web/';
814
+ };
815
+
816
+ export type HooksWebListResponses = {
817
+ 200: Array<WebHook>;
818
+ };
819
+
820
+ export type HooksWebCountData = {
821
+ body?: never;
822
+ path?: never;
823
+ query?: {
824
+ author_email?: string;
825
+ /**
826
+ * User full name contains
827
+ */
828
+ author_fullname?: string;
829
+ author_username?: string;
830
+ author_uuid?: string;
831
+ content_type?: WebHookContentTypeEnum1;
832
+ destination_url?: string;
833
+ is_active?: boolean;
834
+ last_published?: string;
835
+ /**
836
+ * A page number within the paginated result set.
837
+ */
838
+ page?: number;
839
+ /**
840
+ * Number of results to return per page.
841
+ */
842
+ page_size?: number;
843
+ /**
844
+ * Filter by author name, username and email
845
+ */
846
+ query?: string;
847
+ };
848
+ url: '/api/hooks-web/';
849
+ };
850
+
851
+ export type HooksWebCountResponses = {
852
+ /**
853
+ * No response body
854
+ */
855
+ 200: unknown;
856
+ };
857
+
858
+ export type HooksWebCreateData = {
859
+ body: WebHookRequest;
860
+ path?: never;
861
+ query?: never;
862
+ url: '/api/hooks-web/';
863
+ };
864
+
865
+ export type HooksWebCreateResponses = {
866
+ 201: WebHook;
867
+ };
868
+
869
+ export type HooksWebDestroyData = {
870
+ body?: never;
871
+ path: {
872
+ uuid: string;
873
+ };
874
+ query?: never;
875
+ url: '/api/hooks-web/{uuid}/';
876
+ };
877
+
878
+ export type HooksWebDestroyResponses = {
879
+ /**
880
+ * No response body
881
+ */
882
+ 204: void;
883
+ };
884
+
885
+ export type HooksWebRetrieveData = {
886
+ body?: never;
887
+ path: {
888
+ uuid: string;
889
+ };
890
+ query?: never;
891
+ url: '/api/hooks-web/{uuid}/';
892
+ };
893
+
894
+ export type HooksWebRetrieveResponses = {
895
+ 200: WebHook;
896
+ };
897
+
898
+ export type HooksWebPartialUpdateData = {
899
+ body?: PatchedWebHookRequest;
900
+ path: {
901
+ uuid: string;
902
+ };
903
+ query?: never;
904
+ url: '/api/hooks-web/{uuid}/';
905
+ };
906
+
907
+ export type HooksWebPartialUpdateResponses = {
908
+ 200: WebHook;
909
+ };
910
+
911
+ export type HooksWebUpdateData = {
912
+ body: WebHookRequest;
913
+ path: {
914
+ uuid: string;
915
+ };
916
+ query?: never;
917
+ url: '/api/hooks-web/{uuid}/';
918
+ };
919
+
920
+ export type HooksWebUpdateResponses = {
921
+ 200: WebHook;
922
+ };
923
+
924
+ export type NotificationMessagesListData = {
925
+ body?: never;
926
+ path?: never;
927
+ query?: {
928
+ description?: string;
929
+ /**
930
+ * Is overridden
931
+ */
932
+ is_overridden?: boolean;
933
+ key?: string;
934
+ /**
935
+ * Name
936
+ */
937
+ name?: string;
938
+ /**
939
+ * Name (exact)
940
+ */
941
+ name_exact?: string;
942
+ /**
943
+ * A page number within the paginated result set.
944
+ */
945
+ page?: number;
946
+ /**
947
+ * Number of results to return per page.
948
+ */
949
+ page_size?: number;
950
+ /**
951
+ * Filter by key or description
952
+ */
953
+ query?: string;
954
+ };
955
+ url: '/api/notification-messages/';
956
+ };
957
+
958
+ export type NotificationMessagesListResponses = {
959
+ 200: Array<Notification>;
960
+ };
961
+
962
+ export type NotificationMessagesCountData = {
963
+ body?: never;
964
+ path?: never;
965
+ query?: {
966
+ description?: string;
967
+ /**
968
+ * Is overridden
969
+ */
970
+ is_overridden?: boolean;
971
+ key?: string;
972
+ /**
973
+ * Name
974
+ */
975
+ name?: string;
976
+ /**
977
+ * Name (exact)
978
+ */
979
+ name_exact?: string;
980
+ /**
981
+ * A page number within the paginated result set.
982
+ */
983
+ page?: number;
984
+ /**
985
+ * Number of results to return per page.
986
+ */
987
+ page_size?: number;
988
+ /**
989
+ * Filter by key or description
990
+ */
991
+ query?: string;
992
+ };
993
+ url: '/api/notification-messages/';
994
+ };
995
+
996
+ export type NotificationMessagesCountResponses = {
997
+ /**
998
+ * No response body
999
+ */
1000
+ 200: unknown;
1001
+ };
1002
+
1003
+ export type NotificationMessagesCreateData = {
1004
+ body: NotificationRequest;
1005
+ path?: never;
1006
+ query?: never;
1007
+ url: '/api/notification-messages/';
1008
+ };
1009
+
1010
+ export type NotificationMessagesCreateResponses = {
1011
+ 201: Notification;
1012
+ };
1013
+
1014
+ export type NotificationMessagesTemplatesListData = {
1015
+ body?: never;
1016
+ path?: never;
1017
+ query?: {
1018
+ /**
1019
+ * Is overridden
1020
+ */
1021
+ is_overridden?: boolean;
1022
+ /**
1023
+ * Name
1024
+ */
1025
+ name?: string;
1026
+ /**
1027
+ * Name (exact)
1028
+ */
1029
+ name_exact?: string;
1030
+ /**
1031
+ * A page number within the paginated result set.
1032
+ */
1033
+ page?: number;
1034
+ /**
1035
+ * Number of results to return per page.
1036
+ */
1037
+ page_size?: number;
1038
+ /**
1039
+ * Path
1040
+ */
1041
+ path?: string;
1042
+ /**
1043
+ * Path (exact)
1044
+ */
1045
+ path_exact?: string;
1046
+ };
1047
+ url: '/api/notification-messages-templates/';
1048
+ };
1049
+
1050
+ export type NotificationMessagesTemplatesListResponses = {
1051
+ 200: Array<NotificationTemplateDetailSerializers>;
1052
+ };
1053
+
1054
+ export type NotificationMessagesTemplatesCountData = {
1055
+ body?: never;
1056
+ path?: never;
1057
+ query?: {
1058
+ /**
1059
+ * Is overridden
1060
+ */
1061
+ is_overridden?: boolean;
1062
+ /**
1063
+ * Name
1064
+ */
1065
+ name?: string;
1066
+ /**
1067
+ * Name (exact)
1068
+ */
1069
+ name_exact?: string;
1070
+ /**
1071
+ * A page number within the paginated result set.
1072
+ */
1073
+ page?: number;
1074
+ /**
1075
+ * Number of results to return per page.
1076
+ */
1077
+ page_size?: number;
1078
+ /**
1079
+ * Path
1080
+ */
1081
+ path?: string;
1082
+ /**
1083
+ * Path (exact)
1084
+ */
1085
+ path_exact?: string;
1086
+ };
1087
+ url: '/api/notification-messages-templates/';
1088
+ };
1089
+
1090
+ export type NotificationMessagesTemplatesCountResponses = {
1091
+ /**
1092
+ * No response body
1093
+ */
1094
+ 200: unknown;
1095
+ };
1096
+
1097
+ export type NotificationMessagesTemplatesCreateData = {
1098
+ body: NotificationTemplateDetailSerializersRequest;
1099
+ path?: never;
1100
+ query?: never;
1101
+ url: '/api/notification-messages-templates/';
1102
+ };
1103
+
1104
+ export type NotificationMessagesTemplatesCreateResponses = {
1105
+ 201: NotificationTemplateDetailSerializers;
1106
+ };
1107
+
1108
+ export type NotificationMessagesTemplatesDestroyData = {
1109
+ body?: never;
1110
+ path: {
1111
+ uuid: string;
1112
+ };
1113
+ query?: never;
1114
+ url: '/api/notification-messages-templates/{uuid}/';
1115
+ };
1116
+
1117
+ export type NotificationMessagesTemplatesDestroyResponses = {
1118
+ /**
1119
+ * No response body
1120
+ */
1121
+ 204: void;
1122
+ };
1123
+
1124
+ export type NotificationMessagesTemplatesRetrieveData = {
1125
+ body?: never;
1126
+ path: {
1127
+ uuid: string;
1128
+ };
1129
+ query?: never;
1130
+ url: '/api/notification-messages-templates/{uuid}/';
1131
+ };
1132
+
1133
+ export type NotificationMessagesTemplatesRetrieveResponses = {
1134
+ 200: NotificationTemplateDetailSerializers;
1135
+ };
1136
+
1137
+ export type NotificationMessagesTemplatesPartialUpdateData = {
1138
+ body?: PatchedNotificationTemplateDetailSerializersRequest;
1139
+ path: {
1140
+ uuid: string;
1141
+ };
1142
+ query?: never;
1143
+ url: '/api/notification-messages-templates/{uuid}/';
1144
+ };
1145
+
1146
+ export type NotificationMessagesTemplatesPartialUpdateResponses = {
1147
+ 200: NotificationTemplateDetailSerializers;
1148
+ };
1149
+
1150
+ export type NotificationMessagesTemplatesUpdateData = {
1151
+ body: NotificationTemplateDetailSerializersRequest;
1152
+ path: {
1153
+ uuid: string;
1154
+ };
1155
+ query?: never;
1156
+ url: '/api/notification-messages-templates/{uuid}/';
1157
+ };
1158
+
1159
+ export type NotificationMessagesTemplatesUpdateResponses = {
1160
+ 200: NotificationTemplateDetailSerializers;
1161
+ };
1162
+
1163
+ export type NotificationMessagesTemplatesOverrideData = {
1164
+ body: NotificationTemplateUpdateSerializersRequest;
1165
+ path: {
1166
+ uuid: string;
1167
+ };
1168
+ query?: never;
1169
+ url: '/api/notification-messages-templates/{uuid}/override/';
1170
+ };
1171
+
1172
+ export type NotificationMessagesTemplatesOverrideResponses = {
1173
+ /**
1174
+ * No response body
1175
+ */
1176
+ 200: unknown;
1177
+ };
1178
+
1179
+ export type NotificationMessagesDestroyData = {
1180
+ body?: never;
1181
+ path: {
1182
+ uuid: string;
1183
+ };
1184
+ query?: never;
1185
+ url: '/api/notification-messages/{uuid}/';
1186
+ };
1187
+
1188
+ export type NotificationMessagesDestroyResponses = {
1189
+ /**
1190
+ * No response body
1191
+ */
1192
+ 204: void;
1193
+ };
1194
+
1195
+ export type NotificationMessagesRetrieveData = {
1196
+ body?: never;
1197
+ path: {
1198
+ uuid: string;
1199
+ };
1200
+ query?: never;
1201
+ url: '/api/notification-messages/{uuid}/';
1202
+ };
1203
+
1204
+ export type NotificationMessagesRetrieveResponses = {
1205
+ 200: Notification;
1206
+ };
1207
+
1208
+ export type NotificationMessagesPartialUpdateData = {
1209
+ body?: PatchedNotificationRequest;
1210
+ path: {
1211
+ uuid: string;
1212
+ };
1213
+ query?: never;
1214
+ url: '/api/notification-messages/{uuid}/';
1215
+ };
1216
+
1217
+ export type NotificationMessagesPartialUpdateResponses = {
1218
+ 200: Notification;
1219
+ };
1220
+
1221
+ export type NotificationMessagesUpdateData = {
1222
+ body: NotificationRequest;
1223
+ path: {
1224
+ uuid: string;
1225
+ };
1226
+ query?: never;
1227
+ url: '/api/notification-messages/{uuid}/';
1228
+ };
1229
+
1230
+ export type NotificationMessagesUpdateResponses = {
1231
+ 200: Notification;
1232
+ };
1233
+
1234
+ export type NotificationMessagesDisableData = {
1235
+ body?: never;
1236
+ path: {
1237
+ uuid: string;
1238
+ };
1239
+ query?: never;
1240
+ url: '/api/notification-messages/{uuid}/disable/';
1241
+ };
1242
+
1243
+ export type NotificationMessagesDisableResponses = {
1244
+ /**
1245
+ * No response body
1246
+ */
1247
+ 200: unknown;
1248
+ };
1249
+
1250
+ export type NotificationMessagesEnableData = {
1251
+ body?: never;
1252
+ path: {
1253
+ uuid: string;
1254
+ };
1255
+ query?: never;
1256
+ url: '/api/notification-messages/{uuid}/enable/';
1257
+ };
1258
+
1259
+ export type NotificationMessagesEnableResponses = {
1260
+ /**
1261
+ * No response body
1262
+ */
1263
+ 200: unknown;
1264
+ };