whalecloud-dxp-api-react-native/src/models/offer-spec-for-query.ts

This section explains how to use the SDK and illustrates it with an example: - This chapter is essential to learn - For specific business development, see [Bussiness Scenario](https://www.digchan.info/en-US/dxp/user-sso/sign-up) - The Business Scenario pr

/* tslint:disable */
/* eslint-disable */
/**
 * DXP API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 
 * 
 *
 * 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 OfferSpecForQuery
 */
export interface OfferSpecForQuery {
    /**
     * A unique identifier for an offer.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'offerNbr': string;
    /**
     * The type of offer. Possible values are: / 1-Bundle; / 2-Main Offer; / 3-Function Offer; /4-Additional Offer; /5-Goods Offer
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'offerType': OfferSpecForQueryOfferTypeEnum;
    /**
     * The name of the offer .
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'offerName': string;
    /**
     * A brief description.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'brief'?: string;
    /**
     * A detailed description.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'description'?: string;
    /**
     * The URL of the thumbnail image for the offer associated with the offer.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'thumbImageUrl'?: string;
    /**
     * The URL of the image.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'imageUrl'?: string;
    /**
     * The current state or status of the offer associated with the main offer. Possible values are: / A-Active; / D-Draft; / P-Retired; / E-Pause
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'state'?: OfferSpecForQueryStateEnum;
    /**
     * The guiding price of the offer.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'guidingPrice'?: string;
    /**
     * The guiding price of the offer as an integer.
     * @type {number}
     * @memberof OfferSpecForQuery
     */
    'guidingPriceInt'?: number;
    /**
     * Sales price
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'salesPrice'?: string;
    /**
     * The sales price as an integer.
     * @type {number}
     * @memberof OfferSpecForQuery
     */
    'salesPriceInt'?: number;
    /**
     * The rental price of the offer.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'rentPrice'?: string;
    /**
     * The rental price as an integer.
     * @type {number}
     * @memberof OfferSpecForQuery
     */
    'rentPriceInt'?: number;
    /**
     * The duration of the rental period.
     * @type {number}
     * @memberof OfferSpecForQuery
     */
    'rentDuration'?: number;
    /**
     * The unit of measurement for the rental duration. Possible values are: / Y-Year/ M-Month/ D-Day/ W-Week
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'rentUnitType'?: OfferSpecForQueryRentUnitTypeEnum;
    /**
     * The symbol of the currency.
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'currencySymbol'?: string;
    /**
     * A flag indicating whether the offer can be reordered.
     * @type {boolean}
     * @memberof OfferSpecForQuery
     */
    'reorderable'?: boolean;
    /**
     * The validity period.
     * @type {number}
     * @memberof OfferSpecForQuery
     */
    'validityPeriod'?: number;
    /**
     * The unit type for the validity period. Possible values are: / Y-Year/ M-Month/ D-Day/ W-Week/ H-Hour/ B-Billing Cycle
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'validityPeriodUnitType'?: OfferSpecForQueryValidityPeriodUnitTypeEnum;
    /**
     * The expiration date. Use ISO 8601 standard, YYYY-MM-DDTHH:MM:SS
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'expDate'?: string;
    /**
     * The payment flag indicating the type of payment. Possible values are: / 0-Prepaid; / 1-PostPaid; / 2-Hybrid
     * @type {string}
     * @memberof OfferSpecForQuery
     */
    'paidFlag'?: OfferSpecForQueryPaidFlagEnum;
}

export const OfferSpecForQueryOfferTypeEnum = {
    _1: '1',
    _2: '2',
    _3: '3',
    _4: '4',
    _5: '5'
} as const;

export type OfferSpecForQueryOfferTypeEnum = typeof OfferSpecForQueryOfferTypeEnum[keyof typeof OfferSpecForQueryOfferTypeEnum];
export const OfferSpecForQueryStateEnum = {
    A: 'A',
    D: 'D',
    P: 'P',
    E: 'E'
} as const;

export type OfferSpecForQueryStateEnum = typeof OfferSpecForQueryStateEnum[keyof typeof OfferSpecForQueryStateEnum];
export const OfferSpecForQueryRentUnitTypeEnum = {
    D: 'D',
    W: 'W',
    M: 'M',
    Y: 'Y'
} as const;

export type OfferSpecForQueryRentUnitTypeEnum = typeof OfferSpecForQueryRentUnitTypeEnum[keyof typeof OfferSpecForQueryRentUnitTypeEnum];
export const OfferSpecForQueryValidityPeriodUnitTypeEnum = {
    M: 'M',
    Y: 'Y',
    W: 'W',
    D: 'D',
    H: 'H',
    B: 'B'
} as const;

export type OfferSpecForQueryValidityPeriodUnitTypeEnum = typeof OfferSpecForQueryValidityPeriodUnitTypeEnum[keyof typeof OfferSpecForQueryValidityPeriodUnitTypeEnum];
export const OfferSpecForQueryPaidFlagEnum = {
    _0: '0',
    _1: '1',
    _2: '2'
} as const;

export type OfferSpecForQueryPaidFlagEnum = typeof OfferSpecForQueryPaidFlagEnum[keyof typeof OfferSpecForQueryPaidFlagEnum];