box-typescript-sdk-gen/src/schemas/itemsOffsetPaginated.generated.ts

Official Box TypeScript Generated SDK

import { serializeFileFullOrFolderMiniOrWebLink } from './fileFullOrFolderMiniOrWebLink.generated.js';
import { deserializeFileFullOrFolderMiniOrWebLink } from './fileFullOrFolderMiniOrWebLink.generated.js';
import { FileFullOrFolderMiniOrWebLink } from './fileFullOrFolderMiniOrWebLink.generated.js';
import { BoxSdkError } from '../box/errors.js';
import { SerializedData } from '../serialization/json.js';
import { sdIsEmpty } from '../serialization/json.js';
import { sdIsBoolean } from '../serialization/json.js';
import { sdIsNumber } from '../serialization/json.js';
import { sdIsString } from '../serialization/json.js';
import { sdIsList } from '../serialization/json.js';
import { sdIsMap } from '../serialization/json.js';
export type ItemsOffsetPaginatedOrderDirectionField = 'ASC' | 'DESC' | string;
export interface ItemsOffsetPaginatedOrderField {
  /**
   * The field to order by */
  readonly by?: string;
  /**
   * The direction to order by, either ascending or descending */
  readonly direction?: ItemsOffsetPaginatedOrderDirectionField;
  readonly rawData?: SerializedData;
}
export interface ItemsOffsetPaginated {
  /**
   * One greater than the offset of the last entry in the entire collection.
   * The total number of entries in the collection may be less than
   * `total_count`.
   *
   * This field is only returned for calls that use offset-based pagination.
   * For marker-based paginated APIs, this field will be omitted. */
  readonly totalCount?: number;
  /**
   * The limit that was used for these entries. This will be the same as the
   * `limit` query parameter unless that value exceeded the maximum value
   * allowed. The maximum value varies by API. */
  readonly limit?: number;
  /**
   * The 0-based offset of the first entry in this set. This will be the same
   * as the `offset` query parameter.
   *
   * This field is only returned for calls that use offset-based pagination.
   * For marker-based paginated APIs, this field will be omitted. */
  readonly offset?: number;
  /**
   * The order by which items are returned.
   *
   * This field is only returned for calls that use offset-based pagination.
   * For marker-based paginated APIs, this field will be omitted. */
  readonly order?: readonly ItemsOffsetPaginatedOrderField[];
  /**
   * The items in this collection. */
  readonly entries?: readonly FileFullOrFolderMiniOrWebLink[];
  readonly rawData?: SerializedData;
}
export function serializeItemsOffsetPaginatedOrderDirectionField(
  val: ItemsOffsetPaginatedOrderDirectionField,
): SerializedData {
  return val;
}
export function deserializeItemsOffsetPaginatedOrderDirectionField(
  val: SerializedData,
): ItemsOffsetPaginatedOrderDirectionField {
  if (val == 'ASC') {
    return val;
  }
  if (val == 'DESC') {
    return val;
  }
  if (sdIsString(val)) {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize ItemsOffsetPaginatedOrderDirectionField",
  });
}
export function serializeItemsOffsetPaginatedOrderField(
  val: ItemsOffsetPaginatedOrderField,
): SerializedData {
  return {
    ['by']: val.by,
    ['direction']:
      val.direction == void 0
        ? val.direction
        : serializeItemsOffsetPaginatedOrderDirectionField(val.direction),
  };
}
export function deserializeItemsOffsetPaginatedOrderField(
  val: SerializedData,
): ItemsOffsetPaginatedOrderField {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "ItemsOffsetPaginatedOrderField"',
    });
  }
  if (!(val.by == void 0) && !sdIsString(val.by)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "by" of type "ItemsOffsetPaginatedOrderField"',
    });
  }
  const by: undefined | string = val.by == void 0 ? void 0 : val.by;
  const direction: undefined | ItemsOffsetPaginatedOrderDirectionField =
    val.direction == void 0
      ? void 0
      : deserializeItemsOffsetPaginatedOrderDirectionField(val.direction);
  return {
    by: by,
    direction: direction,
  } satisfies ItemsOffsetPaginatedOrderField;
}
export function serializeItemsOffsetPaginated(
  val: ItemsOffsetPaginated,
): SerializedData {
  return {
    ['total_count']: val.totalCount,
    ['limit']: val.limit,
    ['offset']: val.offset,
    ['order']:
      val.order == void 0
        ? val.order
        : (val.order.map(function (
            item: ItemsOffsetPaginatedOrderField,
          ): SerializedData {
            return serializeItemsOffsetPaginatedOrderField(item);
          }) as readonly any[]),
    ['entries']:
      val.entries == void 0
        ? val.entries
        : (val.entries.map(function (
            item: FileFullOrFolderMiniOrWebLink,
          ): SerializedData {
            return serializeFileFullOrFolderMiniOrWebLink(item);
          }) as readonly any[]),
  };
}
export function deserializeItemsOffsetPaginated(
  val: SerializedData,
): ItemsOffsetPaginated {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "ItemsOffsetPaginated"',
    });
  }
  if (!(val.total_count == void 0) && !sdIsNumber(val.total_count)) {
    throw new BoxSdkError({
      message:
        'Expecting number for "total_count" of type "ItemsOffsetPaginated"',
    });
  }
  const totalCount: undefined | number =
    val.total_count == void 0 ? void 0 : val.total_count;
  if (!(val.limit == void 0) && !sdIsNumber(val.limit)) {
    throw new BoxSdkError({
      message: 'Expecting number for "limit" of type "ItemsOffsetPaginated"',
    });
  }
  const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit;
  if (!(val.offset == void 0) && !sdIsNumber(val.offset)) {
    throw new BoxSdkError({
      message: 'Expecting number for "offset" of type "ItemsOffsetPaginated"',
    });
  }
  const offset: undefined | number = val.offset == void 0 ? void 0 : val.offset;
  if (!(val.order == void 0) && !sdIsList(val.order)) {
    throw new BoxSdkError({
      message: 'Expecting array for "order" of type "ItemsOffsetPaginated"',
    });
  }
  const order: undefined | readonly ItemsOffsetPaginatedOrderField[] =
    val.order == void 0
      ? void 0
      : sdIsList(val.order)
        ? (val.order.map(function (
            itm: SerializedData,
          ): ItemsOffsetPaginatedOrderField {
            return deserializeItemsOffsetPaginatedOrderField(itm);
          }) as readonly any[])
        : [];
  if (!(val.entries == void 0) && !sdIsList(val.entries)) {
    throw new BoxSdkError({
      message: 'Expecting array for "entries" of type "ItemsOffsetPaginated"',
    });
  }
  const entries: undefined | readonly FileFullOrFolderMiniOrWebLink[] =
    val.entries == void 0
      ? void 0
      : sdIsList(val.entries)
        ? (val.entries.map(function (
            itm: SerializedData,
          ): FileFullOrFolderMiniOrWebLink {
            return deserializeFileFullOrFolderMiniOrWebLink(itm);
          }) as readonly any[])
        : [];
  return {
    totalCount: totalCount,
    limit: limit,
    offset: offset,
    order: order,
    entries: entries,
  } satisfies ItemsOffsetPaginated;
}