@getopenpay/client/models/EnumConfigField.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 *
 * @export
 * @interface EnumConfigField
 */
export interface EnumConfigField {
    /**
     *
     * @type {string}
     * @memberof EnumConfigField
     */
    defaultValue?: string | null;
    /**
     *
     * @type {string}
     * @memberof EnumConfigField
     */
    description?: string | null;
    /**
     * The key of the field in the config.
     * @type {string}
     * @memberof EnumConfigField
     */
    key: string;
    /**
     * The name of the field.
     * @type {string}
     * @memberof EnumConfigField
     */
    name: string;
    /**
     * The options for the enum.
     * @type {Array<string>}
     * @memberof EnumConfigField
     */
    options: Array<string>;
    /**
     *
     * @type {string}
     * @memberof EnumConfigField
     */
    type?: EnumConfigFieldTypeEnum;
    /**
     *
     * @type {string}
     * @memberof EnumConfigField
     */
    value: string | null;
}
/**
 * @export
 */
export declare const EnumConfigFieldTypeEnum: {
    readonly Enum: "enum";
};
export type EnumConfigFieldTypeEnum = typeof EnumConfigFieldTypeEnum[keyof typeof EnumConfigFieldTypeEnum];
/**
 * Check if a given object implements the EnumConfigField interface.
 */
export declare function instanceOfEnumConfigField(value: object): value is EnumConfigField;
export declare function EnumConfigFieldFromJSON(json: any): EnumConfigField;
export declare function EnumConfigFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): EnumConfigField;
export declare function EnumConfigFieldToJSON(json: any): EnumConfigField;
export declare function EnumConfigFieldToJSONTyped(value?: EnumConfigField | null, ignoreDiscriminator?: boolean): any;