box-node-sdk/src/schemas/searchResultsWithSharedLinks.ts

Official SDK for Box Platform APIs

import { serializeSearchResultWithSharedLink } from './searchResultWithSharedLink';
import { deserializeSearchResultWithSharedLink } from './searchResultWithSharedLink';
import { SearchResultWithSharedLink } from './searchResultWithSharedLink';
import { BoxSdkError } from '../box/errors';
import { SerializedData } from '../serialization/json';
import { sdIsEmpty } from '../serialization/json';
import { sdIsBoolean } from '../serialization/json';
import { sdIsNumber } from '../serialization/json';
import { sdIsString } from '../serialization/json';
import { sdIsList } from '../serialization/json';
import { sdIsMap } from '../serialization/json';
export type SearchResultsWithSharedLinksTypeField =
  'search_results_with_shared_links';
export class SearchResultsWithSharedLinks {
  /**
   * One greater than the offset of the last entry in the search results.
   * The total number of entries in the collection may be less than
   * `total_count`. */
  readonly totalCount?: number;
  /**
   * The limit that was used for this search. This will be the same as the
   * `limit` query parameter unless that value exceeded the maximum value
   * allowed. */
  readonly limit?: number;
  /**
   * The 0-based offset of the first entry in this set. This will be the same
   * as the `offset` query parameter used. */
  readonly offset?: number;
  /**
   * Specifies the response as search result items with shared links. */
  readonly type: SearchResultsWithSharedLinksTypeField =
    'search_results_with_shared_links' as SearchResultsWithSharedLinksTypeField;
  /**
   * The search results for the query provided, including the
   * additional information about any shared links through
   * which the item has been shared with the user. */
  readonly entries?: readonly SearchResultWithSharedLink[];
  readonly rawData?: SerializedData;
  constructor(
    fields: Omit<SearchResultsWithSharedLinks, 'type'> &
      Partial<Pick<SearchResultsWithSharedLinks, 'type'>>,
  ) {
    if (fields.totalCount !== undefined) {
      this.totalCount = fields.totalCount;
    }
    if (fields.limit !== undefined) {
      this.limit = fields.limit;
    }
    if (fields.offset !== undefined) {
      this.offset = fields.offset;
    }
    if (fields.type !== undefined) {
      this.type = fields.type;
    }
    if (fields.entries !== undefined) {
      this.entries = fields.entries;
    }
    if (fields.rawData !== undefined) {
      this.rawData = fields.rawData;
    }
  }
}
export interface SearchResultsWithSharedLinksInput {
  /**
   * One greater than the offset of the last entry in the search results.
   * The total number of entries in the collection may be less than
   * `total_count`. */
  readonly totalCount?: number;
  /**
   * The limit that was used for this search. This will be the same as the
   * `limit` query parameter unless that value exceeded the maximum value
   * allowed. */
  readonly limit?: number;
  /**
   * The 0-based offset of the first entry in this set. This will be the same
   * as the `offset` query parameter used. */
  readonly offset?: number;
  /**
   * Specifies the response as search result items with shared links. */
  readonly type?: SearchResultsWithSharedLinksTypeField;
  /**
   * The search results for the query provided, including the
   * additional information about any shared links through
   * which the item has been shared with the user. */
  readonly entries?: readonly SearchResultWithSharedLink[];
  readonly rawData?: SerializedData;
}
export function serializeSearchResultsWithSharedLinksTypeField(
  val: SearchResultsWithSharedLinksTypeField,
): SerializedData {
  return val;
}
export function deserializeSearchResultsWithSharedLinksTypeField(
  val: SerializedData,
): SearchResultsWithSharedLinksTypeField {
  if (val == 'search_results_with_shared_links') {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize SearchResultsWithSharedLinksTypeField",
  });
}
export function serializeSearchResultsWithSharedLinks(
  val: SearchResultsWithSharedLinks,
): SerializedData {
  return {
    ['total_count']: val.totalCount,
    ['limit']: val.limit,
    ['offset']: val.offset,
    ['type']: serializeSearchResultsWithSharedLinksTypeField(val.type),
    ['entries']:
      val.entries == void 0
        ? val.entries
        : (val.entries.map(function (
            item: SearchResultWithSharedLink,
          ): SerializedData {
            return serializeSearchResultWithSharedLink(item);
          }) as readonly any[]),
  };
}
export function deserializeSearchResultsWithSharedLinks(
  val: SerializedData,
): SearchResultsWithSharedLinks {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "SearchResultsWithSharedLinks"',
    });
  }
  if (!(val.total_count == void 0) && !sdIsNumber(val.total_count)) {
    throw new BoxSdkError({
      message:
        'Expecting number for "total_count" of type "SearchResultsWithSharedLinks"',
    });
  }
  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 "SearchResultsWithSharedLinks"',
    });
  }
  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 "SearchResultsWithSharedLinks"',
    });
  }
  const offset: undefined | number = val.offset == void 0 ? void 0 : val.offset;
  if (val.type == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "type" of type "SearchResultsWithSharedLinks" to be defined',
    });
  }
  const type: SearchResultsWithSharedLinksTypeField =
    deserializeSearchResultsWithSharedLinksTypeField(val.type);
  if (!(val.entries == void 0) && !sdIsList(val.entries)) {
    throw new BoxSdkError({
      message:
        'Expecting array for "entries" of type "SearchResultsWithSharedLinks"',
    });
  }
  const entries: undefined | readonly SearchResultWithSharedLink[] =
    val.entries == void 0
      ? void 0
      : sdIsList(val.entries)
        ? (val.entries.map(function (
            itm: SerializedData,
          ): SearchResultWithSharedLink {
            return deserializeSearchResultWithSharedLink(itm);
          }) as readonly any[])
        : [];
  return {
    totalCount: totalCount,
    limit: limit,
    offset: offset,
    type: type,
    entries: entries,
  } satisfies SearchResultsWithSharedLinks;
}
export function serializeSearchResultsWithSharedLinksInput(
  val: SearchResultsWithSharedLinksInput,
): SerializedData {
  return {
    ['total_count']: val.totalCount,
    ['limit']: val.limit,
    ['offset']: val.offset,
    ['type']:
      val.type == void 0
        ? val.type
        : serializeSearchResultsWithSharedLinksTypeField(val.type),
    ['entries']:
      val.entries == void 0
        ? val.entries
        : (val.entries.map(function (
            item: SearchResultWithSharedLink,
          ): SerializedData {
            return serializeSearchResultWithSharedLink(item);
          }) as readonly any[]),
  };
}
export function deserializeSearchResultsWithSharedLinksInput(
  val: SerializedData,
): SearchResultsWithSharedLinksInput {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "SearchResultsWithSharedLinksInput"',
    });
  }
  if (!(val.total_count == void 0) && !sdIsNumber(val.total_count)) {
    throw new BoxSdkError({
      message:
        'Expecting number for "total_count" of type "SearchResultsWithSharedLinksInput"',
    });
  }
  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 "SearchResultsWithSharedLinksInput"',
    });
  }
  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 "SearchResultsWithSharedLinksInput"',
    });
  }
  const offset: undefined | number = val.offset == void 0 ? void 0 : val.offset;
  const type: undefined | SearchResultsWithSharedLinksTypeField =
    val.type == void 0
      ? void 0
      : deserializeSearchResultsWithSharedLinksTypeField(val.type);
  if (!(val.entries == void 0) && !sdIsList(val.entries)) {
    throw new BoxSdkError({
      message:
        'Expecting array for "entries" of type "SearchResultsWithSharedLinksInput"',
    });
  }
  const entries: undefined | readonly SearchResultWithSharedLink[] =
    val.entries == void 0
      ? void 0
      : sdIsList(val.entries)
        ? (val.entries.map(function (
            itm: SerializedData,
          ): SearchResultWithSharedLink {
            return deserializeSearchResultWithSharedLink(itm);
          }) as readonly any[])
        : [];
  return {
    totalCount: totalCount,
    limit: limit,
    offset: offset,
    type: type,
    entries: entries,
  } satisfies SearchResultsWithSharedLinksInput;
}