@maxio-com/advanced-billing-sdk/src/models/createSegment.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 { array, expandoObject, lazy, optional, Schema } from '../schema.js';
import {
  CreateSegmentSegmentProperty1Value,
  createSegmentSegmentProperty1ValueSchema,
} from './containers/createSegmentSegmentProperty1Value.js';
import {
  CreateSegmentSegmentProperty2Value,
  createSegmentSegmentProperty2ValueSchema,
} from './containers/createSegmentSegmentProperty2Value.js';
import {
  CreateSegmentSegmentProperty3Value,
  createSegmentSegmentProperty3ValueSchema,
} from './containers/createSegmentSegmentProperty3Value.js';
import {
  CreateSegmentSegmentProperty4Value,
  createSegmentSegmentProperty4ValueSchema,
} from './containers/createSegmentSegmentProperty4Value.js';
import {
  CreateOrUpdateSegmentPrice,
  createOrUpdateSegmentPriceSchema,
} from './createOrUpdateSegmentPrice.js';
import { PricingScheme, pricingSchemeSchema } from './pricingScheme.js';

export interface CreateSegment {
  /** A value that will occur in your events that you want to bill upon. The type of the value depends on the property type in the related event based billing metric. */
  segmentProperty1Value?: CreateSegmentSegmentProperty1Value;
  /** A value that will occur in your events that you want to bill upon. The type of the value depends on the property type in the related event based billing metric. */
  segmentProperty2Value?: CreateSegmentSegmentProperty2Value;
  /** A value that will occur in your events that you want to bill upon. The type of the value depends on the property type in the related event based billing metric. */
  segmentProperty3Value?: CreateSegmentSegmentProperty3Value;
  /** A value that will occur in your events that you want to bill upon. The type of the value depends on the property type in the related event based billing metric. */
  segmentProperty4Value?: CreateSegmentSegmentProperty4Value;
  /** The identifier for the pricing scheme. See [Product Components](https://help.chargify.com/products/product-components.html) for an overview of pricing schemes. */
  pricingScheme: PricingScheme;
  prices?: CreateOrUpdateSegmentPrice[];
  [key: string]: unknown;
}

export const createSegmentSchema: Schema<CreateSegment> = lazy(() =>
  expandoObject({
    segmentProperty1Value: [
      'segment_property_1_value',
      optional(createSegmentSegmentProperty1ValueSchema),
    ],
    segmentProperty2Value: [
      'segment_property_2_value',
      optional(createSegmentSegmentProperty2ValueSchema),
    ],
    segmentProperty3Value: [
      'segment_property_3_value',
      optional(createSegmentSegmentProperty3ValueSchema),
    ],
    segmentProperty4Value: [
      'segment_property_4_value',
      optional(createSegmentSegmentProperty4ValueSchema),
    ],
    pricingScheme: ['pricing_scheme', pricingSchemeSchema],
    prices: ['prices', optional(array(createOrUpdateSegmentPriceSchema))],
  })
);