@shipengine/connect-order-source-api/lib/models/store-setting.d.ts

This is the typescript/javascript definitions for the order source api

import Joi from 'joi';
export type SettingType = 'checkbox' | 'text';
/**
 * @description A StoreSetting is a configuration option that sellers can set after connecting their store.
 * These fields should be considered optional, but if a seller provides a value it will come in the connection_context.
 */
export declare class StoreSetting {
    /** @description This field defines the key used in connection_context to send the value of this setting */
    SettingName: string;
    /** @description The name of this option to use in the UI */
    DisplayName: string;
    /** @description A description of what this setting does for tooltips */
    Description: string;
    /** @description Set to true if this option must be enabled by support */
    IsAdmin?: boolean;
    /**
     * @description Set to true if this option shouldn't be shown in the UI.
     * This does not prevent the option from being sent to the API for stores which have already chosen it
     */
    IsDeprecated?: boolean;
    /** @description The data type of the input field for the setting; must be "checkbox" or "text" */
    Type: SettingType;
}
export declare const StoreSettingSchema: Joi.ObjectSchema<any>;