wallee/dist/models/SubscriptionSuspension.d.ts

TypeScript/JavaScript client for wallee

import type { SubscriptionSuspensionReason } from './SubscriptionSuspensionReason';
import type { SubscriptionSuspensionAction } from './SubscriptionSuspensionAction';
import type { Subscription } from './Subscription';
import type { SubscriptionSuspensionState } from './SubscriptionSuspensionState';
/**
 *
 * @export
 * @interface SubscriptionSuspension
 */
export interface SubscriptionSuspension {
    /**
     * The date and time when the suspension ended.
     * @type {Date}
     * @memberof SubscriptionSuspension
     */
    readonly effectiveEndDate?: Date;
    /**
     * A note that contains details about the suspension. It is not disclosed to the subscriber.
     * @type {string}
     * @memberof SubscriptionSuspension
     */
    readonly note?: string;
    /**
     *
     * @type {SubscriptionSuspensionReason}
     * @memberof SubscriptionSuspension
     */
    reason?: SubscriptionSuspensionReason;
    /**
     * The period bill that led to the suspension of the subscription.
     * @type {number}
     * @memberof SubscriptionSuspension
     */
    readonly periodBill?: number;
    /**
     * 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 SubscriptionSuspension
     */
    readonly plannedPurgeDate?: Date;
    /**
     * The language that is linked to the object.
     * @type {string}
     * @memberof SubscriptionSuspension
     */
    readonly language?: string;
    /**
     *
     * @type {Subscription}
     * @memberof SubscriptionSuspension
     */
    subscription?: Subscription;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof SubscriptionSuspension
     */
    readonly createdOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof SubscriptionSuspension
     */
    readonly version?: number;
    /**
     * The date and time when the suspension is planned to end.
     * @type {Date}
     * @memberof SubscriptionSuspension
     */
    readonly plannedEndDate?: Date;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof SubscriptionSuspension
     */
    readonly linkedSpaceId?: number;
    /**
     *
     * @type {SubscriptionSuspensionAction}
     * @memberof SubscriptionSuspension
     */
    endAction?: SubscriptionSuspensionAction;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof SubscriptionSuspension
     */
    readonly id?: number;
    /**
     *
     * @type {SubscriptionSuspensionState}
     * @memberof SubscriptionSuspension
     */
    state?: SubscriptionSuspensionState;
}
/**
 * Check if a given object implements the SubscriptionSuspension interface.
 */
export declare function instanceOfSubscriptionSuspension(value: object): value is SubscriptionSuspension;
export declare function SubscriptionSuspensionFromJSON(json: any): SubscriptionSuspension;
export declare function SubscriptionSuspensionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionSuspension;
export declare function SubscriptionSuspensionToJSON(json: any): SubscriptionSuspension;
export declare function SubscriptionSuspensionToJSONTyped(value?: Omit<SubscriptionSuspension, 'effectiveEndDate' | 'note' | 'periodBill' | 'plannedPurgeDate' | 'language' | 'createdOn' | 'version' | 'plannedEndDate' | 'linkedSpaceId' | 'id'> | null, ignoreDiscriminator?: boolean): any;