wallee/dist/models/WebhookListener.d.ts

TypeScript/JavaScript client for wallee

import type { WebhookUrl } from './WebhookUrl';
import type { WebhookIdentity } from './WebhookIdentity';
import type { CreationEntityState } from './CreationEntityState';
/**
 *
 * @export
 * @interface WebhookListener
 */
export interface WebhookListener {
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof WebhookListener
     */
    readonly linkedSpaceId?: number;
    /**
     * The entity's target states that are to be monitored.
     * @type {Set<string>}
     * @memberof WebhookListener
     */
    readonly entityStates?: Set<string>;
    /**
     *
     * @type {WebhookIdentity}
     * @memberof WebhookListener
     */
    identity?: WebhookIdentity;
    /**
     * The name used to identify the webhook listener.
     * @type {string}
     * @memberof WebhookListener
     */
    readonly name?: string;
    /**
     * The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     * @type {Date}
     * @memberof WebhookListener
     */
    readonly plannedPurgeDate?: Date;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof WebhookListener
     */
    readonly id?: number;
    /**
     *
     * @type {CreationEntityState}
     * @memberof WebhookListener
     */
    state?: CreationEntityState;
    /**
     * Whether every update of the entity or only state changes are to be monitored.
     * @type {boolean}
     * @memberof WebhookListener
     */
    readonly notifyEveryChange?: boolean;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof WebhookListener
     */
    readonly version?: number;
    /**
     * Whether signature header and 'state' property are enabled in webhook payload.
     * @type {boolean}
     * @memberof WebhookListener
     */
    readonly enablePayloadSignatureAndState?: boolean;
    /**
     * The entity that is to be monitored.
     * @type {number}
     * @memberof WebhookListener
     */
    readonly entity?: number;
    /**
     *
     * @type {WebhookUrl}
     * @memberof WebhookListener
     */
    url?: WebhookUrl;
}
/**
 * Check if a given object implements the WebhookListener interface.
 */
export declare function instanceOfWebhookListener(value: object): value is WebhookListener;
export declare function WebhookListenerFromJSON(json: any): WebhookListener;
export declare function WebhookListenerFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebhookListener;
export declare function WebhookListenerToJSON(json: any): WebhookListener;
export declare function WebhookListenerToJSONTyped(value?: Omit<WebhookListener, 'linkedSpaceId' | 'entityStates' | 'name' | 'plannedPurgeDate' | 'id' | 'notifyEveryChange' | 'version' | 'enablePayloadSignatureAndState' | 'entity'> | null, ignoreDiscriminator?: boolean): any;