box-node-sdk/src/schemas/v2025R0/hubItemOperationV2025R0.ts

Official SDK for Box Platform APIs

import { serializeFileReferenceV2025R0 } from './fileReferenceV2025R0';
import { deserializeFileReferenceV2025R0 } from './fileReferenceV2025R0';
import { serializeFolderReferenceV2025R0 } from './folderReferenceV2025R0';
import { deserializeFolderReferenceV2025R0 } from './folderReferenceV2025R0';
import { serializeWeblinkReferenceV2025R0 } from './weblinkReferenceV2025R0';
import { deserializeWeblinkReferenceV2025R0 } from './weblinkReferenceV2025R0';
import { serializeHubItemReferenceV2025R0 } from './hubItemReferenceV2025R0';
import { deserializeHubItemReferenceV2025R0 } from './hubItemReferenceV2025R0';
import { FileReferenceV2025R0 } from './fileReferenceV2025R0';
import { FolderReferenceV2025R0 } from './folderReferenceV2025R0';
import { WeblinkReferenceV2025R0 } from './weblinkReferenceV2025R0';
import { HubItemReferenceV2025R0 } from './hubItemReferenceV2025R0';
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 HubItemOperationV2025R0ActionField = 'add' | 'remove' | string;
export interface HubItemOperationV2025R0 {
  /**
   * The action to perform on a Box Hub item. */
  readonly action: HubItemOperationV2025R0ActionField;
  readonly item: HubItemReferenceV2025R0;
  /**
   * The ID of the parent block to add the item to. Must be an Item List block. If not provided, the item will be added to the first page's first Item List block. */
  readonly parentId?: string;
  readonly rawData?: SerializedData;
}
export function serializeHubItemOperationV2025R0ActionField(
  val: HubItemOperationV2025R0ActionField,
): SerializedData {
  return val;
}
export function deserializeHubItemOperationV2025R0ActionField(
  val: SerializedData,
): HubItemOperationV2025R0ActionField {
  if (val == 'add') {
    return val;
  }
  if (val == 'remove') {
    return val;
  }
  if (sdIsString(val)) {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize HubItemOperationV2025R0ActionField",
  });
}
export function serializeHubItemOperationV2025R0(
  val: HubItemOperationV2025R0,
): SerializedData {
  return {
    ['action']: serializeHubItemOperationV2025R0ActionField(val.action),
    ['item']: serializeHubItemReferenceV2025R0(val.item),
    ['parent_id']: val.parentId,
  };
}
export function deserializeHubItemOperationV2025R0(
  val: SerializedData,
): HubItemOperationV2025R0 {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "HubItemOperationV2025R0"',
    });
  }
  if (val.action == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "action" of type "HubItemOperationV2025R0" to be defined',
    });
  }
  const action: HubItemOperationV2025R0ActionField =
    deserializeHubItemOperationV2025R0ActionField(val.action);
  if (val.item == void 0) {
    throw new BoxSdkError({
      message:
        'Expecting "item" of type "HubItemOperationV2025R0" to be defined',
    });
  }
  const item: HubItemReferenceV2025R0 = deserializeHubItemReferenceV2025R0(
    val.item,
  );
  if (!(val.parent_id == void 0) && !sdIsString(val.parent_id)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "parent_id" of type "HubItemOperationV2025R0"',
    });
  }
  const parentId: undefined | string =
    val.parent_id == void 0 ? void 0 : val.parent_id;
  return {
    action: action,
    item: item,
    parentId: parentId,
  } satisfies HubItemOperationV2025R0;
}