mangopay4-nodejs-sdk/typings/models/hook.d.ts

Mangopay Node.js SDK

import { event } from "./event";
import { entityBase } from "./entityBase";
import { PickPartialRequired } from "../types";

export namespace hook {
    type HookValidity = "UNKNOWN" | "VALID" | "INVALID";

    type HookStatus = "DISABLED" | "ENABLED";

    interface HookData extends entityBase.EntityBaseData {
        /**
         * This is the URL where your receive notification for each EventType
         */
        Url: string;

        /**
         * Whether the hook is enabled or not
         */
        Status: HookStatus;

        /**
         * Whether the hook is valid or not
         */
        Validity: HookValidity;

        /**
         * The event type
         */
        EventType: event.EventType;

        /**
         * Email
         */
        Email: string;
    }

    interface CreateHook extends PickPartialRequired<HookData, "Tag" | "Email", "EventType" | "Url"> {
    }

    interface UpdateHook extends PickPartialRequired<HookData,
        "EventType" | "Url" | "Tag" | "Status" | "Email",
        "Id"> {
    }
}