@ringer-tel/ivy/models/ItemCore.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Ringer Business API
 * This API provides comprehensive endpoints for the Ringer Business system. It includes functionality for managing customer accounts, addresses, sites,  phone numbers, payments, users, and other business resources.  Operations typically require authentication and appropriate permissions. 
 *
 * The version of the OpenAPI document: 1.0.5
 * Contact: support@ringer.tel
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { mapValues } from '../runtime';
/**
 * 
 * @export
 * @interface ItemCore
 */
export interface ItemCore {
    /**
     * Unique identifier for the item.
     * @type {number}
     * @memberof ItemCore
     */
    id: number;
    /**
     * The human-readable name of the item or feature.
     * @type {string}
     * @memberof ItemCore
     */
    name: string;
    /**
     * The general category or type of the item (e.g., cdr, service_fee, feature_license).
     * @type {string}
     * @memberof ItemCore
     */
    itemType: string;
    /**
     * Specific rules or sub-classification for the item type that might affect rating or behavior.
     * @type {string}
     * @memberof ItemCore
     */
    itemRules?: string | null;
    /**
     * The price of this individual item (e.g., per unit, per month).
     * @type {string}
     * @memberof ItemCore
     */
    itemPrice: string;
    /**
     * Three-letter ISO currency code for the item price.
     * @type {string}
     * @memberof ItemCore
     */
    currency: string;
    /**
     * Identifier of the price deck this item pricing might belong to.
     * @type {number}
     * @memberof ItemCore
     */
    priceDeckId?: number | null;
    /**
     * Identifier for the tax category applicable to this item.
     * @type {number}
     * @memberof ItemCore
     */
    taxCategory?: number | null;
    /**
     * Specific tax code applicable to this item.
     * @type {number}
     * @memberof ItemCore
     */
    taxCode?: number | null;
}

/**
 * Check if a given object implements the ItemCore interface.
 */
export function instanceOfItemCore(value: object): value is ItemCore {
    if (!('id' in value) || value['id'] === undefined) return false;
    if (!('name' in value) || value['name'] === undefined) return false;
    if (!('itemType' in value) || value['itemType'] === undefined) return false;
    if (!('itemPrice' in value) || value['itemPrice'] === undefined) return false;
    if (!('currency' in value) || value['currency'] === undefined) return false;
    return true;
}

export function ItemCoreFromJSON(json: any): ItemCore {
    return ItemCoreFromJSONTyped(json, false);
}

export function ItemCoreFromJSONTyped(json: any, ignoreDiscriminator: boolean): ItemCore {
    if (json == null) {
        return json;
    }
    return {
        
        'id': json['id'],
        'name': json['name'],
        'itemType': json['item_type'],
        'itemRules': json['item_rules'] == null ? undefined : json['item_rules'],
        'itemPrice': json['item_price'],
        'currency': json['currency'],
        'priceDeckId': json['price_deck_id'] == null ? undefined : json['price_deck_id'],
        'taxCategory': json['tax_category'] == null ? undefined : json['tax_category'],
        'taxCode': json['tax_code'] == null ? undefined : json['tax_code'],
    };
}

export function ItemCoreToJSON(json: any): ItemCore {
    return ItemCoreToJSONTyped(json, false);
}

export function ItemCoreToJSONTyped(value?: ItemCore | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'id': value['id'],
        'name': value['name'],
        'item_type': value['itemType'],
        'item_rules': value['itemRules'],
        'item_price': value['itemPrice'],
        'currency': value['currency'],
        'price_deck_id': value['priceDeckId'],
        'tax_category': value['taxCategory'],
        'tax_code': value['taxCode'],
    };
}