/**
 * Shell Data & Reporting APIsLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import {
  nullable,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema.js';

export interface PricingCurrentVolume {
  /** Bonus or association bonus configuration identifier  that is associated to the payer. */
  feeRuleId?: number | null;
  /** Bonus or association bonus configuration description that is associated to the payer */
  feeRuleDescription?: string | null;
  /** Pricing current period Pricing Price Rule ID that is associated to the payer. */
  priceRuleID?: number | null;
  /** Pricing current period pricing rule description that is associated to the payer */
  priceRuleDescription?: string | null;
  /** Total volume consumption for the current period. */
  totalVolume?: number | null;
  /**
   * Next Fee Rule Creation Date for that is associated to the payer.
   * Format: YYYYMMDD
   */
  nextFeeCreationDate?: string | null;
}

export const pricingCurrentVolumeSchema: Schema<PricingCurrentVolume> = object({
  feeRuleId: ['FeeRuleId', optional(nullable(number()))],
  feeRuleDescription: ['FeeRuleDescription', optional(nullable(string()))],
  priceRuleID: ['PriceRuleID', optional(nullable(number()))],
  priceRuleDescription: ['PriceRuleDescription', optional(nullable(string()))],
  totalVolume: ['TotalVolume', optional(nullable(number()))],
  nextFeeCreationDate: ['NextFeeCreationDate', optional(nullable(string()))],
});