# All files / codegen/models AddOnInputArgs.ts

73.82% Statements 110/149
100% Branches 1/1
0% Functions 0/3
73.82% Lines 110/149

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    1511x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x

    1x
    1x

    1x
    1x

     /* tslint:disable */
    /* eslint-disable */
    /**
     * Octane API
     * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
     *
     * The version of the OpenAPI document: 1.0.0
     *
     *
     * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
     * https://openapi-generator.tech
     * Do not edit the class manually.
     */

    import { exists, mapValues } from '../runtime';
    import {
        FeatureInputArgs,
        FeatureInputArgsFromJSON,
        FeatureInputArgsFromJSONTyped,
        FeatureInputArgsToJSON,
    } from './FeatureInputArgs';
    import {
        PriceInputArgs,
        PriceInputArgsFromJSON,
        PriceInputArgsFromJSONTyped,
        PriceInputArgsToJSON,
    } from './PriceInputArgs';

    /**
     *
     * @export
     * @interface AddOnInputArgs
     */
    export interface AddOnInputArgs {
        /**
         * This field indicates whether or not we should cut an invoice immediately upon attaching this add on to a price plan.
         * @type {boolean}
         * @memberof AddOnInputArgs
         */
        immediatelyCharge?: boolean;
        /**
         * DEPRECATED. Use price_scheme_type and prices instead.
         * @type {number}
         * @memberof AddOnInputArgs
         */
        price?: number;
        /**
         * Array of price tiers, each of which consists of `price` and `cap` key:value pairs
         * @type {Array<PriceInputArgs>}
         * @memberof AddOnInputArgs
         */
        prices?: Array<PriceInputArgs>;
        /**
         * The frequency at which to charge this add on. Currently the only values supported are price_frequency or 1.
         * @type {number}
         * @memberof AddOnInputArgs
         */
        chargeFrequency?: number;
        /**
         *
         * @type {number}
         * @memberof AddOnInputArgs
         */
        limit?: number;
        /**
         * Whether this add on can only be used & charged once.
         * @type {boolean}
         * @memberof AddOnInputArgs
         */
        singleUse?: boolean;
        /**
         *
         * @type {FeatureInputArgs}
         * @memberof AddOnInputArgs
         */
        feature: FeatureInputArgs;
        /**
         *
         * @type {boolean}
         * @memberof AddOnInputArgs
         */
        quantityEnabled?: boolean;
        /**
         * The frequency at which to price this add on.
         * @type {number}
         * @memberof AddOnInputArgs
         */
        priceFrequency?: number;
        /**
         * One of 'FLAT', 'TIERED'
         * @type {string}
         * @memberof AddOnInputArgs
         */
        priceSchemeType?: AddOnInputArgsPriceSchemeTypeEnum;
    }

    /**
    * @export
    * @enum {string}
    */
    export enum AddOnInputArgsPriceSchemeTypeEnum {
        Flat = 'FLAT',
        Tiered = 'TIERED'
    }

    export function AddOnInputArgsFromJSON(json: any): AddOnInputArgs {
        return AddOnInputArgsFromJSONTyped(json, false);
    }

    export function AddOnInputArgsFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddOnInputArgs {
        if ((json === undefined) || (json === null)) {
            return json;
        }
        return {

            'immediatelyCharge': !exists(json, 'immediately_charge') ? undefined : json['immediately_charge'],
            'price': !exists(json, 'price') ? undefined : json['price'],
            'prices': !exists(json, 'prices') ? undefined : ((json['prices'] as Array<any>).map(PriceInputArgsFromJSON)),
            'chargeFrequency': !exists(json, 'charge_frequency') ? undefined : json['charge_frequency'],
            'limit': !exists(json, 'limit') ? undefined : json['limit'],
            'singleUse': !exists(json, 'single_use') ? undefined : json['single_use'],
            'feature': FeatureInputArgsFromJSON(json['feature']),
            'quantityEnabled': !exists(json, 'quantity_enabled') ? undefined : json['quantity_enabled'],
            'priceFrequency': !exists(json, 'price_frequency') ? undefined : json['price_frequency'],
            'priceSchemeType': !exists(json, 'price_scheme_type') ? undefined : json['price_scheme_type'],
        };
    }

    export function AddOnInputArgsToJSON(value?: AddOnInputArgs | null): any {
        if (value === undefined) {
            return undefined;
        }
        if (value === null) {
            return null;
        }
        return {

            'immediately_charge': value.immediatelyCharge,
            'price': value.price,
            'prices': value.prices === undefined ? undefined : ((value.prices as Array<any>).map(PriceInputArgsToJSON)),
            'charge_frequency': value.chargeFrequency,
            'limit': value.limit,
            'single_use': value.singleUse,
            'feature': FeatureInputArgsToJSON(value.feature),
            'quantity_enabled': value.quantityEnabled,
            'price_frequency': value.priceFrequency,
            'price_scheme_type': value.priceSchemeType,
        };
    }