@maxio-com/advanced-billing-sdk/src/models/allocationPreviewItem.ts

Ultimate billing and pricing flexibility for B2B SaaS. Maxio integrates directly into your product, so you can seamlessly manage your product catalog, bill customers, and collect payments.

/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import {
  boolean,
  expandoObject,
  lazy,
  nullable,
  number,
  optional,
  Schema,
  string,
} from '../schema.js';
import {
  AllocationPreviewItemPreviousQuantity,
  allocationPreviewItemPreviousQuantitySchema,
} from './containers/allocationPreviewItemPreviousQuantity.js';
import {
  AllocationPreviewItemQuantity,
  allocationPreviewItemQuantitySchema,
} from './containers/allocationPreviewItemQuantity.js';
import { CreditType, creditTypeSchema } from './creditType.js';
import { IntervalUnit, intervalUnitSchema } from './intervalUnit.js';

export interface AllocationPreviewItem {
  componentId?: number;
  subscriptionId?: number;
  quantity?: AllocationPreviewItemQuantity;
  previousQuantity?: AllocationPreviewItemPreviousQuantity;
  memo?: string | null;
  timestamp?: string | null;
  prorationUpgradeScheme?: string;
  prorationDowngradeScheme?: string;
  accrueCharge?: boolean;
  /**
   * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
   * Available values: `full`, `prorated`, `none`.
   */
  upgradeCharge?: CreditType | null;
  /**
   * The type of credit to be created when upgrading/downgrading. Defaults to the component and then site setting if one is not provided.
   * Available values: `full`, `prorated`, `none`.
   */
  downgradeCredit?: CreditType | null;
  pricePointId?: number;
  /** The numerical interval. i.e. an interval of ‘30’ coupled with an interval_unit of day would mean this component price point would renew every 30 days. This property is only available for sites with Multifrequency enabled. */
  interval?: number;
  /** A string representing the interval unit for this component price point, either month or day. This property is only available for sites with Multifrequency enabled. */
  intervalUnit?: IntervalUnit | null;
  previousPricePointId?: number;
  pricePointHandle?: string;
  pricePointName?: string;
  componentHandle?: string | null;
  [key: string]: unknown;
}

export const allocationPreviewItemSchema: Schema<AllocationPreviewItem> = lazy(
  () =>
    expandoObject({
      componentId: ['component_id', optional(number())],
      subscriptionId: ['subscription_id', optional(number())],
      quantity: ['quantity', optional(allocationPreviewItemQuantitySchema)],
      previousQuantity: [
        'previous_quantity',
        optional(allocationPreviewItemPreviousQuantitySchema),
      ],
      memo: ['memo', optional(nullable(string()))],
      timestamp: ['timestamp', optional(nullable(string()))],
      prorationUpgradeScheme: ['proration_upgrade_scheme', optional(string())],
      prorationDowngradeScheme: [
        'proration_downgrade_scheme',
        optional(string()),
      ],
      accrueCharge: ['accrue_charge', optional(boolean())],
      upgradeCharge: ['upgrade_charge', optional(nullable(creditTypeSchema))],
      downgradeCredit: [
        'downgrade_credit',
        optional(nullable(creditTypeSchema)),
      ],
      pricePointId: ['price_point_id', optional(number())],
      interval: ['interval', optional(number())],
      intervalUnit: ['interval_unit', optional(nullable(intervalUnitSchema))],
      previousPricePointId: ['previous_price_point_id', optional(number())],
      pricePointHandle: ['price_point_handle', optional(string())],
      pricePointName: ['price_point_name', optional(string())],
      componentHandle: ['component_handle', optional(nullable(string()))],
    })
);