rehive 3.1.4 → 4.0.0

package/src/extensions/notifications/openapi-ts/types.gen.ts

@@ -0,0 +1,1732 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ClientOptions = {
+    baseUrl: 'https://notification.services.rehive.com/api/' | (string & {});
+};
+
+/**
+ * This serializer can be used if only a `status` is required in the response.
+ */
+export type ActionResponse = {
+    status?: string;
+};
+
+/**
+ * Serialize the activation data, should be a token that represents an admin
+ * user.
+ */
+export type Activate = {
+    token: string;
+    readonly id: string;
+    readonly name: string;
+    readonly system_email: string;
+    readonly secret: string;
+    readonly push_enabled: boolean;
+};
+
+/**
+ * Serialize company, update and delete.
+ */
+export type AdminCompany = {
+    readonly id: string;
+    readonly secret: string;
+    push_enabled?: boolean;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    mode: 'test' | 'production';
+    quotas: Quotas;
+    bimi_selector_header?: string | null;
+    name?: string | null;
+    website?: string | null;
+    system_email?: string | null;
+    support_email?: string | null;
+    contact_email?: string | null;
+    logo?: string | null;
+    icon?: string | null;
+};
+
+export type AdminCompanyResponse = {
+    status?: string;
+    data?: AdminCompany;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type AdminCreateUpdateNotification = {
+    readonly id: number;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system' | '' | null;
+    name: string;
+    subject?: string | null;
+    description?: string | null;
+    readonly company: string;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    event?: string | null;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    from_email?: string | null;
+    system_enabled?: boolean;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type AdminCredential = {
+    readonly id: number;
+    /**
+     * * `twilio` - twilio
+     * * `sendgrid` - sendgrid
+     */
+    credential_type: 'twilio' | 'sendgrid';
+    credentials?: {
+        [key: string]: unknown;
+    };
+    readonly created: number;
+    readonly updated: number;
+};
+
+export type AdminCredentialResponse = {
+    status?: string;
+    data?: AdminCredential;
+};
+
+/**
+ * Serialize notification logs.
+ */
+export type AdminLog = {
+    readonly id: number;
+    readonly notification: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    readonly user: string | null;
+    recipient: string;
+    readonly text_message: string | null;
+    readonly html_message: string | null;
+    readonly sms_message: string | null;
+    readonly push_message: string | null;
+    sent?: boolean;
+    received?: boolean | null;
+    error_message?: string | null;
+    readonly created: number;
+};
+
+export type AdminLogResponse = {
+    status?: string;
+    data?: AdminLog;
+};
+
+/**
+ * Serialize log sending.
+ */
+export type AdminLogSend = {
+    recipient?: string;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type AdminNotification = {
+    readonly id: number;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    template?: AdminReducedTemplate | null;
+    name: string;
+    subject?: string | null;
+    description?: string | null;
+    readonly company: string;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    readonly event: string;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    from_email?: string | null;
+    layout?: ReducedNotificationLayout;
+    system_enabled?: boolean;
+};
+
+export type AdminNotificationResponse = {
+    status?: string;
+    data?: AdminNotification;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type AdminReducedTemplate = {
+    id: string;
+    default?: boolean;
+    deletable?: boolean;
+};
+
+/**
+ * Serialize templates.
+ */
+export type AdminTemplate = {
+    id: string;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    name: string;
+    subject: string;
+    description?: string | null;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    readonly event: string;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    layout: ReducedLayoutTemplate;
+    default?: boolean;
+    deletable?: boolean;
+    readonly created: number;
+    readonly updated: number;
+};
+
+export type AdminTemplateResponse = {
+    status?: string;
+    data?: AdminTemplate;
+};
+
+/**
+ * Trigger a notification.
+ */
+export type AdminTriggerNotification = {
+    data?: {
+        [key: string]: unknown;
+    } | null;
+    users?: Array<string> | null;
+    groups?: Array<string> | null;
+    readonly id: string;
+    /**
+     * * `pending` - pending
+     * * `processing` - processing
+     * * `completed` - completed
+     * * `failed` - failed
+     */
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+};
+
+/**
+ * Serialize the deactivation data, should be a token that represents an admin
+ * user.
+ */
+export type Deactivate = {
+    token: string;
+    purge?: boolean;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type LayoutTemplate = {
+    readonly id: string;
+    readonly name: string;
+    readonly description: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    readonly html_layout: string | null;
+    readonly text_layout: string | null;
+    readonly sms_layout: string | null;
+    readonly push_layout: string | null;
+    readonly created: number;
+    readonly updated: number;
+};
+
+export type LayoutTemplateResponse = {
+    status?: string;
+    data?: LayoutTemplate;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type NotificationLayout = {
+    readonly id: string;
+    name: string;
+    description?: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    html_layout?: string | null;
+    text_layout?: string | null;
+    sms_layout?: string | null;
+    push_layout?: string | null;
+    readonly created: number;
+    readonly updated: number;
+};
+
+export type NotificationLayoutResponse = {
+    status?: string;
+    data?: NotificationLayout;
+};
+
+export type PaginatedAdminCredentialList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminCredential>;
+};
+
+export type PaginatedAdminCredentialListResponse = {
+    status?: string;
+    data?: PaginatedAdminCredentialList;
+};
+
+export type PaginatedAdminLogList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminLog>;
+};
+
+export type PaginatedAdminLogListResponse = {
+    status?: string;
+    data?: PaginatedAdminLogList;
+};
+
+export type PaginatedAdminNotificationList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminNotification>;
+};
+
+export type PaginatedAdminNotificationListResponse = {
+    status?: string;
+    data?: PaginatedAdminNotificationList;
+};
+
+export type PaginatedAdminTemplateList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminTemplate>;
+};
+
+export type PaginatedAdminTemplateListResponse = {
+    status?: string;
+    data?: PaginatedAdminTemplateList;
+};
+
+export type PaginatedLayoutTemplateList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<LayoutTemplate>;
+};
+
+export type PaginatedLayoutTemplateListResponse = {
+    status?: string;
+    data?: PaginatedLayoutTemplateList;
+};
+
+export type PaginatedNotificationLayoutList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<NotificationLayout>;
+};
+
+export type PaginatedNotificationLayoutListResponse = {
+    status?: string;
+    data?: PaginatedNotificationLayoutList;
+};
+
+export type PaginatedUserLogList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserLog>;
+};
+
+export type PaginatedUserLogListResponse = {
+    status?: string;
+    data?: PaginatedUserLogList;
+};
+
+export type PaginatedUserNotificationList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserNotification>;
+};
+
+export type PaginatedUserNotificationListResponse = {
+    status?: string;
+    data?: PaginatedUserNotificationList;
+};
+
+/**
+ * Serialize company, update and delete.
+ */
+export type PatchedAdminCompany = {
+    readonly id?: string;
+    readonly secret?: string;
+    push_enabled?: boolean;
+    /**
+     * * `test` - Test
+     * * `production` - Production
+     */
+    mode?: 'test' | 'production';
+    quotas?: Quotas;
+    bimi_selector_header?: string | null;
+    name?: string | null;
+    website?: string | null;
+    system_email?: string | null;
+    support_email?: string | null;
+    contact_email?: string | null;
+    logo?: string | null;
+    icon?: string | null;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type PatchedAdminCreateUpdateNotification = {
+    readonly id?: number;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system' | '' | null;
+    name?: string;
+    subject?: string | null;
+    description?: string | null;
+    readonly company?: string;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    event?: string | null;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    from_email?: string | null;
+    system_enabled?: boolean;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type PatchedAdminCredential = {
+    readonly id?: number;
+    /**
+     * * `twilio` - twilio
+     * * `sendgrid` - sendgrid
+     */
+    credential_type?: 'twilio' | 'sendgrid';
+    credentials?: {
+        [key: string]: unknown;
+    };
+    readonly created?: number;
+    readonly updated?: number;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedNotificationLayout = {
+    readonly id?: string;
+    name?: string;
+    description?: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system';
+    html_layout?: string | null;
+    text_layout?: string | null;
+    sms_layout?: string | null;
+    push_layout?: string | null;
+    readonly created?: number;
+    readonly updated?: number;
+};
+
+/**
+ * Serialize notification logs for users (masked values only).
+ */
+export type PatchedUserLog = {
+    readonly id?: number;
+    readonly notification?: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system';
+    readonly subject?: string | null;
+    readonly text_message?: string | null;
+    readonly html_message?: string | null;
+    readonly sms_message?: string | null;
+    readonly push_message?: string | null;
+    readonly created?: number;
+    readonly updated?: string;
+    received?: boolean;
+};
+
+/**
+ * Serialize notifications update. Actually updates the notification
+ * preference instead.
+ */
+export type PatchedUserUpdateNotification = {
+    enabled?: boolean;
+};
+
+export type Quotas = {
+    readonly sms: number;
+    readonly email: number;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type ReducedLayoutTemplate = {
+    readonly id: string;
+    name: string;
+    description?: string | null;
+    readonly created: number;
+    readonly updated: number;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type ReducedNotificationLayout = {
+    readonly id: string;
+    name: string;
+    description?: string | null;
+    readonly created: number;
+    readonly updated: number;
+};
+
+/**
+ * Serialize notification logs for users (masked values only).
+ */
+export type UserLog = {
+    readonly id: number;
+    readonly notification: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    readonly subject: string | null;
+    readonly text_message: string | null;
+    readonly html_message: string | null;
+    readonly sms_message: string | null;
+    readonly push_message: string | null;
+    readonly created: number;
+    readonly updated: string;
+    received: boolean;
+};
+
+export type UserLogResponse = {
+    status?: string;
+    data?: UserLog;
+};
+
+/**
+ * Serialize notifications.
+ */
+export type UserNotification = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    readonly event: string;
+    readonly type: string;
+    readonly enabled: boolean;
+};
+
+export type UserNotificationResponse = {
+    status?: string;
+    data?: UserNotification;
+};
+
+/**
+ * Serialize notifications update. Actually updates the notification
+ * preference instead.
+ */
+export type UserUpdateNotification = {
+    enabled: boolean;
+};
+
+/**
+ * Validate and serialize the webhook data. The secret key and company are
+ * used to identify a specific company.
+ */
+export type Webhook = {
+    id: string;
+    event: string;
+    company: string;
+    data: {
+        [key: string]: unknown;
+    };
+};
+
+/**
+ * Serialize company, update and delete.
+ */
+export type AdminCompanyWritable = {
+    push_enabled?: boolean;
+    bimi_selector_header?: string | null;
+    name?: string | null;
+    website?: string | null;
+    system_email?: string | null;
+    support_email?: string | null;
+    contact_email?: string | null;
+    logo?: string | null;
+    icon?: string | null;
+};
+
+export type AdminCompanyResponseWritable = {
+    status?: string;
+    data?: AdminCompanyWritable;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type AdminCreateUpdateNotificationWritable = {
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system' | '' | null;
+    template?: string | null;
+    name: string;
+    subject?: string | null;
+    description?: string | null;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    event?: string | null;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    from_email?: string | null;
+    layout?: string | null;
+    system_enabled?: boolean;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type AdminCredentialWritable = {
+    /**
+     * * `twilio` - twilio
+     * * `sendgrid` - sendgrid
+     */
+    credential_type: 'twilio' | 'sendgrid';
+    credentials?: {
+        [key: string]: unknown;
+    };
+};
+
+export type AdminCredentialResponseWritable = {
+    status?: string;
+    data?: AdminCredentialWritable;
+};
+
+/**
+ * Serialize notification logs.
+ */
+export type AdminLogWritable = {
+    recipient: string;
+    sent?: boolean;
+    received?: boolean | null;
+    error_message?: string | null;
+};
+
+export type AdminLogResponseWritable = {
+    status?: string;
+    data?: AdminLogWritable;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type AdminNotificationWritable = {
+    template?: AdminReducedTemplate | null;
+    name: string;
+    subject?: string | null;
+    description?: string | null;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    from_email?: string | null;
+    layout?: ReducedNotificationLayoutWritable;
+    system_enabled?: boolean;
+};
+
+export type AdminNotificationResponseWritable = {
+    status?: string;
+    data?: AdminNotificationWritable;
+};
+
+/**
+ * Serialize templates.
+ */
+export type AdminTemplateWritable = {
+    id: string;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    name: string;
+    subject: string;
+    description?: string | null;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    default?: boolean;
+    deletable?: boolean;
+};
+
+export type AdminTemplateResponseWritable = {
+    status?: string;
+    data?: AdminTemplateWritable;
+};
+
+export type LayoutTemplateResponseWritable = {
+    status?: string;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type NotificationLayoutWritable = {
+    name: string;
+    description?: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type: 'email' | 'sms' | 'push' | 'system';
+    html_layout?: string | null;
+    text_layout?: string | null;
+    sms_layout?: string | null;
+    push_layout?: string | null;
+};
+
+export type NotificationLayoutResponseWritable = {
+    status?: string;
+    data?: NotificationLayoutWritable;
+};
+
+export type PaginatedAdminCredentialListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminCredentialWritable>;
+};
+
+export type PaginatedAdminCredentialListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminCredentialListWritable;
+};
+
+export type PaginatedAdminLogListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminLogWritable>;
+};
+
+export type PaginatedAdminLogListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminLogListWritable;
+};
+
+export type PaginatedAdminNotificationListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminNotificationWritable>;
+};
+
+export type PaginatedAdminNotificationListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminNotificationListWritable;
+};
+
+export type PaginatedAdminTemplateListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<AdminTemplateWritable>;
+};
+
+export type PaginatedAdminTemplateListResponseWritable = {
+    status?: string;
+    data?: PaginatedAdminTemplateListWritable;
+};
+
+export type PaginatedLayoutTemplateListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<unknown>;
+};
+
+export type PaginatedLayoutTemplateListResponseWritable = {
+    status?: string;
+    data?: PaginatedLayoutTemplateListWritable;
+};
+
+export type PaginatedNotificationLayoutListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<NotificationLayoutWritable>;
+};
+
+export type PaginatedNotificationLayoutListResponseWritable = {
+    status?: string;
+    data?: PaginatedNotificationLayoutListWritable;
+};
+
+export type PaginatedUserLogListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserLogWritable>;
+};
+
+export type PaginatedUserLogListResponseWritable = {
+    status?: string;
+    data?: PaginatedUserLogListWritable;
+};
+
+export type PaginatedUserNotificationListWritable = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<UserNotificationWritable>;
+};
+
+export type PaginatedUserNotificationListResponseWritable = {
+    status?: string;
+    data?: PaginatedUserNotificationListWritable;
+};
+
+/**
+ * Serialize company, update and delete.
+ */
+export type PatchedAdminCompanyWritable = {
+    push_enabled?: boolean;
+    bimi_selector_header?: string | null;
+    name?: string | null;
+    website?: string | null;
+    system_email?: string | null;
+    support_email?: string | null;
+    contact_email?: string | null;
+    logo?: string | null;
+    icon?: string | null;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type PatchedAdminCreateUpdateNotificationWritable = {
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system' | '' | null;
+    template?: string | null;
+    name?: string;
+    subject?: string | null;
+    description?: string | null;
+    html_message?: string | null;
+    text_message?: string | null;
+    sms_message?: string | null;
+    push_message?: string | null;
+    enabled?: boolean;
+    preference_enabled?: boolean;
+    event?: string | null;
+    to_email?: string | null;
+    to_mobile?: string | null;
+    to_user?: string | null;
+    expression?: string | null;
+    from_email?: string | null;
+    layout?: string | null;
+    system_enabled?: boolean;
+};
+
+/**
+ * Serialize notifications, create, update and delete.
+ */
+export type PatchedAdminCredentialWritable = {
+    /**
+     * * `twilio` - twilio
+     * * `sendgrid` - sendgrid
+     */
+    credential_type?: 'twilio' | 'sendgrid';
+    credentials?: {
+        [key: string]: unknown;
+    };
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type PatchedNotificationLayoutWritable = {
+    name?: string;
+    description?: string | null;
+    /**
+     * * `email` - email
+     * * `sms` - sms
+     * * `push` - push
+     * * `system` - system
+     */
+    type?: 'email' | 'sms' | 'push' | 'system';
+    html_layout?: string | null;
+    text_layout?: string | null;
+    sms_layout?: string | null;
+    push_layout?: string | null;
+};
+
+/**
+ * Serialize notification logs for users (masked values only).
+ */
+export type PatchedUserLogWritable = {
+    received?: boolean;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type ReducedLayoutTemplateWritable = {
+    name: string;
+    description?: string | null;
+};
+
+/**
+ * A ModelSerializer that takes additional arguments for
+ * "fields", "omit" and "expand" in order to
+ * control which fields are displayed, and whether to replace simple
+ * values with complex, nested serializations
+ */
+export type ReducedNotificationLayoutWritable = {
+    name: string;
+    description?: string | null;
+};
+
+/**
+ * Serialize notification logs for users (masked values only).
+ */
+export type UserLogWritable = {
+    received: boolean;
+};
+
+export type UserLogResponseWritable = {
+    status?: string;
+    data?: UserLogWritable;
+};
+
+/**
+ * Serialize notifications.
+ */
+export type UserNotificationWritable = {
+    name: string;
+    description?: string | null;
+};
+
+export type UserNotificationResponseWritable = {
+    status?: string;
+    data?: UserNotificationWritable;
+};
+
+export type ActivateCreateData = {
+    body: Activate;
+    path?: never;
+    query?: never;
+    url: '/activate/';
+};
+
+export type ActivateCreateResponses = {
+    200: ActionResponse;
+};
+
+export type ActivateCreateResponse = ActivateCreateResponses[keyof ActivateCreateResponses];
+
+export type AdminCompanyRetrieveData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyRetrieveResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyRetrieveResponse = AdminCompanyRetrieveResponses[keyof AdminCompanyRetrieveResponses];
+
+export type AdminCompanyPartialUpdateData = {
+    body?: PatchedAdminCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyPartialUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyPartialUpdateResponse = AdminCompanyPartialUpdateResponses[keyof AdminCompanyPartialUpdateResponses];
+
+export type AdminCompanyUpdateData = {
+    body?: AdminCompanyWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/company/';
+};
+
+export type AdminCompanyUpdateResponses = {
+    200: AdminCompanyResponse;
+};
+
+export type AdminCompanyUpdateResponse = AdminCompanyUpdateResponses[keyof AdminCompanyUpdateResponses];
+
+export type AdminCredentialsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+    };
+    url: '/admin/credentials/';
+};
+
+export type AdminCredentialsListResponses = {
+    200: PaginatedAdminCredentialListResponse;
+};
+
+export type AdminCredentialsListResponse = AdminCredentialsListResponses[keyof AdminCredentialsListResponses];
+
+export type AdminCredentialsCreateData = {
+    body: AdminCredentialWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/credentials/';
+};
+
+export type AdminCredentialsCreateResponses = {
+    201: AdminCredentialResponse;
+};
+
+export type AdminCredentialsCreateResponse = AdminCredentialsCreateResponses[keyof AdminCredentialsCreateResponses];
+
+export type AdminCredentialsDestroyData = {
+    body?: never;
+    path: {
+        credential_id: string;
+    };
+    query?: never;
+    url: '/admin/credentials/{credential_id}/';
+};
+
+export type AdminCredentialsDestroyResponses = {
+    200: AdminCredentialResponse;
+};
+
+export type AdminCredentialsDestroyResponse = AdminCredentialsDestroyResponses[keyof AdminCredentialsDestroyResponses];
+
+export type AdminCredentialsRetrieveData = {
+    body?: never;
+    path: {
+        credential_id: string;
+    };
+    query?: never;
+    url: '/admin/credentials/{credential_id}/';
+};
+
+export type AdminCredentialsRetrieveResponses = {
+    200: AdminCredentialResponse;
+};
+
+export type AdminCredentialsRetrieveResponse = AdminCredentialsRetrieveResponses[keyof AdminCredentialsRetrieveResponses];
+
+export type AdminCredentialsPartialUpdateData = {
+    body?: PatchedAdminCredentialWritable;
+    path: {
+        credential_id: string;
+    };
+    query?: never;
+    url: '/admin/credentials/{credential_id}/';
+};
+
+export type AdminCredentialsPartialUpdateResponses = {
+    200: AdminCredentialResponse;
+};
+
+export type AdminCredentialsPartialUpdateResponse = AdminCredentialsPartialUpdateResponses[keyof AdminCredentialsPartialUpdateResponses];
+
+export type AdminCredentialsUpdateData = {
+    body: AdminCredentialWritable;
+    path: {
+        credential_id: string;
+    };
+    query?: never;
+    url: '/admin/credentials/{credential_id}/';
+};
+
+export type AdminCredentialsUpdateResponses = {
+    200: AdminCredentialResponse;
+};
+
+export type AdminCredentialsUpdateResponse = AdminCredentialsUpdateResponses[keyof AdminCredentialsUpdateResponses];
+
+export type AdminLayoutTemplatesListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        name?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        type?: string;
+    };
+    url: '/admin/layout-templates/';
+};
+
+export type AdminLayoutTemplatesListResponses = {
+    200: PaginatedLayoutTemplateListResponse;
+};
+
+export type AdminLayoutTemplatesListResponse = AdminLayoutTemplatesListResponses[keyof AdminLayoutTemplatesListResponses];
+
+export type AdminLayoutTemplatesRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/layout-templates/{id}/';
+};
+
+export type AdminLayoutTemplatesRetrieveResponses = {
+    200: LayoutTemplateResponse;
+};
+
+export type AdminLayoutTemplatesRetrieveResponse = AdminLayoutTemplatesRetrieveResponses[keyof AdminLayoutTemplatesRetrieveResponses];
+
+export type AdminLayoutsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        name?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        type?: string;
+    };
+    url: '/admin/layouts/';
+};
+
+export type AdminLayoutsListResponses = {
+    200: PaginatedNotificationLayoutListResponse;
+};
+
+export type AdminLayoutsListResponse = AdminLayoutsListResponses[keyof AdminLayoutsListResponses];
+
+export type AdminLayoutsCreateData = {
+    body: NotificationLayoutWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/layouts/';
+};
+
+export type AdminLayoutsCreateResponses = {
+    201: NotificationLayoutResponse;
+};
+
+export type AdminLayoutsCreateResponse = AdminLayoutsCreateResponses[keyof AdminLayoutsCreateResponses];
+
+export type AdminLayoutsDestroyData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/layouts/{id}/';
+};
+
+export type AdminLayoutsDestroyResponses = {
+    200: NotificationLayoutResponse;
+};
+
+export type AdminLayoutsDestroyResponse = AdminLayoutsDestroyResponses[keyof AdminLayoutsDestroyResponses];
+
+export type AdminLayoutsRetrieveData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/layouts/{id}/';
+};
+
+export type AdminLayoutsRetrieveResponses = {
+    200: NotificationLayoutResponse;
+};
+
+export type AdminLayoutsRetrieveResponse = AdminLayoutsRetrieveResponses[keyof AdminLayoutsRetrieveResponses];
+
+export type AdminLayoutsPartialUpdateData = {
+    body?: PatchedNotificationLayoutWritable;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/layouts/{id}/';
+};
+
+export type AdminLayoutsPartialUpdateResponses = {
+    200: NotificationLayoutResponse;
+};
+
+export type AdminLayoutsPartialUpdateResponse = AdminLayoutsPartialUpdateResponses[keyof AdminLayoutsPartialUpdateResponses];
+
+export type AdminLayoutsUpdateData = {
+    body: NotificationLayoutWritable;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/admin/layouts/{id}/';
+};
+
+export type AdminLayoutsUpdateResponses = {
+    200: NotificationLayoutResponse;
+};
+
+export type AdminLayoutsUpdateResponse = AdminLayoutsUpdateResponses[keyof AdminLayoutsUpdateResponses];
+
+export type AdminLogsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        created__gt?: string;
+        created__lt?: string;
+        notification?: string;
+        notification__name?: string;
+        notification__name__contains?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        received?: boolean;
+        recipient?: string;
+        recipient__contains?: string;
+        sent?: boolean;
+        type?: string;
+        type__in?: string;
+    };
+    url: '/admin/logs/';
+};
+
+export type AdminLogsListResponses = {
+    200: PaginatedAdminLogListResponse;
+};
+
+export type AdminLogsListResponse = AdminLogsListResponses[keyof AdminLogsListResponses];
+
+export type AdminLogsRetrieveData = {
+    body?: never;
+    path: {
+        log_id: string;
+    };
+    query?: never;
+    url: '/admin/logs/{log_id}/';
+};
+
+export type AdminLogsRetrieveResponses = {
+    200: AdminLogResponse;
+};
+
+export type AdminLogsRetrieveResponse = AdminLogsRetrieveResponses[keyof AdminLogsRetrieveResponses];
+
+export type AdminLogsSendCreateData = {
+    body?: AdminLogSend;
+    path: {
+        log_id: string;
+    };
+    query?: never;
+    url: '/admin/logs/{log_id}/send/';
+};
+
+export type AdminLogsSendCreateResponses = {
+    200: ActionResponse;
+};
+
+export type AdminLogsSendCreateResponse = AdminLogsSendCreateResponses[keyof AdminLogsSendCreateResponses];
+
+export type AdminNotificationsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        event?: string;
+        layout?: string;
+        name?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        type?: string;
+    };
+    url: '/admin/notifications/';
+};
+
+export type AdminNotificationsListResponses = {
+    200: PaginatedAdminNotificationListResponse;
+};
+
+export type AdminNotificationsListResponse = AdminNotificationsListResponses[keyof AdminNotificationsListResponses];
+
+export type AdminNotificationsCreateData = {
+    body: AdminCreateUpdateNotificationWritable;
+    path?: never;
+    query?: never;
+    url: '/admin/notifications/';
+};
+
+export type AdminNotificationsCreateResponses = {
+    201: AdminNotificationResponse;
+};
+
+export type AdminNotificationsCreateResponse = AdminNotificationsCreateResponses[keyof AdminNotificationsCreateResponses];
+
+export type AdminNotificationsDestroyData = {
+    body?: never;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/admin/notifications/{notification_id}/';
+};
+
+export type AdminNotificationsDestroyResponses = {
+    200: AdminNotificationResponse;
+};
+
+export type AdminNotificationsDestroyResponse = AdminNotificationsDestroyResponses[keyof AdminNotificationsDestroyResponses];
+
+export type AdminNotificationsRetrieveData = {
+    body?: never;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/admin/notifications/{notification_id}/';
+};
+
+export type AdminNotificationsRetrieveResponses = {
+    200: AdminNotificationResponse;
+};
+
+export type AdminNotificationsRetrieveResponse = AdminNotificationsRetrieveResponses[keyof AdminNotificationsRetrieveResponses];
+
+export type AdminNotificationsPartialUpdateData = {
+    body?: PatchedAdminCreateUpdateNotificationWritable;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/admin/notifications/{notification_id}/';
+};
+
+export type AdminNotificationsPartialUpdateResponses = {
+    200: AdminNotificationResponse;
+};
+
+export type AdminNotificationsPartialUpdateResponse = AdminNotificationsPartialUpdateResponses[keyof AdminNotificationsPartialUpdateResponses];
+
+export type AdminNotificationsUpdateData = {
+    body: AdminCreateUpdateNotificationWritable;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/admin/notifications/{notification_id}/';
+};
+
+export type AdminNotificationsUpdateResponses = {
+    200: AdminNotificationResponse;
+};
+
+export type AdminNotificationsUpdateResponse = AdminNotificationsUpdateResponses[keyof AdminNotificationsUpdateResponses];
+
+export type AdminNotificationsTriggerCreateData = {
+    body?: AdminTriggerNotification;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/admin/notifications/{notification_id}/trigger/';
+};
+
+export type AdminNotificationsTriggerCreateResponses = {
+    200: ActionResponse;
+};
+
+export type AdminNotificationsTriggerCreateResponse = AdminNotificationsTriggerCreateResponses[keyof AdminNotificationsTriggerCreateResponses];
+
+export type AdminTemplatesListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        event?: string;
+        layout?: string;
+        name?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        type?: string;
+    };
+    url: '/admin/templates/';
+};
+
+export type AdminTemplatesListResponses = {
+    200: PaginatedAdminTemplateListResponse;
+};
+
+export type AdminTemplatesListResponse = AdminTemplatesListResponses[keyof AdminTemplatesListResponses];
+
+export type AdminTemplatesRetrieveData = {
+    body?: never;
+    path: {
+        template_id: string;
+    };
+    query?: never;
+    url: '/admin/templates/{template_id}/';
+};
+
+export type AdminTemplatesRetrieveResponses = {
+    200: AdminTemplateResponse;
+};
+
+export type AdminTemplatesRetrieveResponse = AdminTemplatesRetrieveResponses[keyof AdminTemplatesRetrieveResponses];
+
+export type AdminWebhookCreateData = {
+    body: Webhook;
+    path?: never;
+    query?: never;
+    url: '/admin/webhook/';
+};
+
+export type AdminWebhookCreateResponses = {
+    200: ActionResponse;
+};
+
+export type AdminWebhookCreateResponse = AdminWebhookCreateResponses[keyof AdminWebhookCreateResponses];
+
+export type DeactivateCreateData = {
+    body: Deactivate;
+    path?: never;
+    query?: never;
+    url: '/deactivate/';
+};
+
+export type DeactivateCreateResponses = {
+    200: ActionResponse;
+};
+
+export type DeactivateCreateResponse = DeactivateCreateResponses[keyof DeactivateCreateResponses];
+
+export type UserLogsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        created__gt?: string;
+        created__lt?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        received?: boolean;
+    };
+    url: '/user/logs/';
+};
+
+export type UserLogsListResponses = {
+    200: PaginatedUserLogListResponse;
+};
+
+export type UserLogsListResponse = UserLogsListResponses[keyof UserLogsListResponses];
+
+export type UserLogsRetrieveData = {
+    body?: never;
+    path: {
+        log_id: string;
+    };
+    query?: never;
+    url: '/user/logs/{log_id}/';
+};
+
+export type UserLogsRetrieveResponses = {
+    200: UserLogResponse;
+};
+
+export type UserLogsRetrieveResponse = UserLogsRetrieveResponses[keyof UserLogsRetrieveResponses];
+
+export type UserLogsPartialUpdateData = {
+    body?: PatchedUserLogWritable;
+    path: {
+        log_id: string;
+    };
+    query?: never;
+    url: '/user/logs/{log_id}/';
+};
+
+export type UserLogsPartialUpdateResponses = {
+    200: UserLogResponse;
+};
+
+export type UserLogsPartialUpdateResponse = UserLogsPartialUpdateResponses[keyof UserLogsPartialUpdateResponses];
+
+export type UserLogsUpdateData = {
+    body: UserLogWritable;
+    path: {
+        log_id: string;
+    };
+    query?: never;
+    url: '/user/logs/{log_id}/';
+};
+
+export type UserLogsUpdateResponses = {
+    200: UserLogResponse;
+};
+
+export type UserLogsUpdateResponse = UserLogsUpdateResponses[keyof UserLogsUpdateResponses];
+
+export type UserNotificationsListData = {
+    body?: never;
+    path?: never;
+    query?: {
+        event?: string;
+        layout?: string;
+        name?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        page_size?: number;
+        type?: string;
+    };
+    url: '/user/notifications/';
+};
+
+export type UserNotificationsListResponses = {
+    200: PaginatedUserNotificationListResponse;
+};
+
+export type UserNotificationsListResponse = UserNotificationsListResponses[keyof UserNotificationsListResponses];
+
+export type UserNotificationsRetrieveData = {
+    body?: never;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/user/notifications/{notification_id}/';
+};
+
+export type UserNotificationsRetrieveResponses = {
+    200: UserNotificationResponse;
+};
+
+export type UserNotificationsRetrieveResponse = UserNotificationsRetrieveResponses[keyof UserNotificationsRetrieveResponses];
+
+export type UserNotificationsPartialUpdateData = {
+    body?: PatchedUserUpdateNotification;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/user/notifications/{notification_id}/';
+};
+
+export type UserNotificationsPartialUpdateResponses = {
+    200: UserNotificationResponse;
+};
+
+export type UserNotificationsPartialUpdateResponse = UserNotificationsPartialUpdateResponses[keyof UserNotificationsPartialUpdateResponses];
+
+export type UserNotificationsUpdateData = {
+    body: UserUpdateNotification;
+    path: {
+        notification_id: string;
+    };
+    query?: never;
+    url: '/user/notifications/{notification_id}/';
+};
+
+export type UserNotificationsUpdateResponses = {
+    200: UserNotificationResponse;
+};
+
+export type UserNotificationsUpdateResponse = UserNotificationsUpdateResponses[keyof UserNotificationsUpdateResponses];
+
+export type WebhookCreateData = {
+    body: Webhook;
+    path?: never;
+    query?: never;
+    url: '/webhook/';
+};
+
+export type WebhookCreateResponses = {
+    200: ActionResponse;
+};
+
+export type WebhookCreateResponse = WebhookCreateResponses[keyof WebhookCreateResponses];