/**
 * PayPal Server SDKLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { array, lazy, number, object, optional, Schema } from '../schema.js';
import { LinkDescription, linkDescriptionSchema } from './linkDescription.js';
import {
  SubscriptionTransactionDetails,
  subscriptionTransactionDetailsSchema,
} from './subscriptionTransactionDetails.js';

/** The list transactions for a subscription request details. */
export interface TransactionsList {
  /** An array of transactions. */
  transactions?: SubscriptionTransactionDetails[];
  /** The total number of items. */
  totalItems?: number;
  /** The total number of pages. */
  totalPages?: number;
  /** An array of request-related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links). */
  links?: LinkDescription[];
}

export const transactionsListSchema: Schema<TransactionsList> = lazy(() =>
  object({
    transactions: [
      'transactions',
      optional(array(subscriptionTransactionDetailsSchema)),
    ],
    totalItems: ['total_items', optional(number())],
    totalPages: ['total_pages', optional(number())],
    links: ['links', optional(array(linkDescriptionSchema))],
  })
);