box-node-sdk 10.5.0 → 10.6.0

package/src/schemas/v2025R0/hubDocumentPageV2025R0.ts

@@ -0,0 +1,92 @@
+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 interface HubDocumentPageV2025R0 {
+  /**
+   * The unique identifier for this page. */
+  readonly id: string;
+  /**
+   * The type of this resource. The value is always `page`. */
+  readonly type: string;
+  /**
+   * The unique identifier of the parent page. Null for root-level pages. */
+  readonly parentId?: string | null;
+  /**
+   * The title text of the page. Includes rich text formatting. */
+  readonly titleFragment: string;
+  readonly rawData?: SerializedData;
+}
+export function serializeHubDocumentPageV2025R0(
+  val: HubDocumentPageV2025R0,
+): SerializedData {
+  return {
+    ['id']: val.id,
+    ['type']: val.type,
+    ['parent_id']: val.parentId,
+    ['title_fragment']: val.titleFragment,
+  };
+}
+export function deserializeHubDocumentPageV2025R0(
+  val: SerializedData,
+): HubDocumentPageV2025R0 {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubDocumentPageV2025R0"',
+    });
+  }
+  if (val.id == void 0) {
+    throw new BoxSdkError({
+      message: 'Expecting "id" of type "HubDocumentPageV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "id" of type "HubDocumentPageV2025R0"',
+    });
+  }
+  const id: string = val.id;
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "type" of type "HubDocumentPageV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.type)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "type" of type "HubDocumentPageV2025R0"',
+    });
+  }
+  const type: string = val.type;
+  if (!(val.parent_id == void 0) && !sdIsString(val.parent_id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "parent_id" of type "HubDocumentPageV2025R0"',
+    });
+  }
+  const parentId: undefined | string =
+    val.parent_id == void 0 ? void 0 : val.parent_id;
+  if (val.title_fragment == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "title_fragment" of type "HubDocumentPageV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.title_fragment)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "title_fragment" of type "HubDocumentPageV2025R0"',
+    });
+  }
+  const titleFragment: string = val.title_fragment;
+  return {
+    id: id,
+    type: type,
+    parentId: parentId,
+    titleFragment: titleFragment,
+  } satisfies HubDocumentPageV2025R0;
+}

package/src/schemas/v2025R0/hubDocumentPagesV2025R0.ts

@@ -0,0 +1,218 @@
+import { serializeHubDocumentPageV2025R0 } from './hubDocumentPageV2025R0';
+import { deserializeHubDocumentPageV2025R0 } from './hubDocumentPageV2025R0';
+import { HubDocumentPageV2025R0 } from './hubDocumentPageV2025R0';
+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 HubDocumentPagesV2025R0TypeField = 'document_pages';
+export class HubDocumentPagesV2025R0 {
+  /**
+   * Ordered list of pages. */
+  readonly entries!: readonly HubDocumentPageV2025R0[];
+  /**
+   * The value will always be `document_pages`. */
+  readonly type: HubDocumentPagesV2025R0TypeField =
+    'document_pages' as HubDocumentPagesV2025R0TypeField;
+  /**
+   * 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 marker for the start of the next page of results. */
+  readonly nextMarker?: string | null;
+  readonly rawData?: SerializedData;
+  constructor(
+    fields: Omit<HubDocumentPagesV2025R0, 'type'> &
+      Partial<Pick<HubDocumentPagesV2025R0, 'type'>>,
+  ) {
+    if (fields.entries !== undefined) {
+      this.entries = fields.entries;
+    }
+    if (fields.type !== undefined) {
+      this.type = fields.type;
+    }
+    if (fields.limit !== undefined) {
+      this.limit = fields.limit;
+    }
+    if (fields.nextMarker !== undefined) {
+      this.nextMarker = fields.nextMarker;
+    }
+    if (fields.rawData !== undefined) {
+      this.rawData = fields.rawData;
+    }
+  }
+}
+export interface HubDocumentPagesV2025R0Input {
+  /**
+   * Ordered list of pages. */
+  readonly entries: readonly HubDocumentPageV2025R0[];
+  /**
+   * The value will always be `document_pages`. */
+  readonly type?: HubDocumentPagesV2025R0TypeField;
+  /**
+   * 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 marker for the start of the next page of results. */
+  readonly nextMarker?: string | null;
+  readonly rawData?: SerializedData;
+}
+export function serializeHubDocumentPagesV2025R0TypeField(
+  val: HubDocumentPagesV2025R0TypeField,
+): SerializedData {
+  return val;
+}
+export function deserializeHubDocumentPagesV2025R0TypeField(
+  val: SerializedData,
+): HubDocumentPagesV2025R0TypeField {
+  if (val == 'document_pages') {
+    return val;
+  }
+  throw new BoxSdkError({
+    message: "Can't deserialize HubDocumentPagesV2025R0TypeField",
+  });
+}
+export function serializeHubDocumentPagesV2025R0(
+  val: HubDocumentPagesV2025R0,
+): SerializedData {
+  return {
+    ['entries']: val.entries.map(function (
+      item: HubDocumentPageV2025R0,
+    ): SerializedData {
+      return serializeHubDocumentPageV2025R0(item);
+    }) as readonly any[],
+    ['type']: serializeHubDocumentPagesV2025R0TypeField(val.type),
+    ['limit']: val.limit,
+    ['next_marker']: val.nextMarker,
+  };
+}
+export function deserializeHubDocumentPagesV2025R0(
+  val: SerializedData,
+): HubDocumentPagesV2025R0 {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubDocumentPagesV2025R0"',
+    });
+  }
+  if (val.entries == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "entries" of type "HubDocumentPagesV2025R0" to be defined',
+    });
+  }
+  if (!sdIsList(val.entries)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting array for "entries" of type "HubDocumentPagesV2025R0"',
+    });
+  }
+  const entries: readonly HubDocumentPageV2025R0[] = sdIsList(val.entries)
+    ? (val.entries.map(function (itm: SerializedData): HubDocumentPageV2025R0 {
+        return deserializeHubDocumentPageV2025R0(itm);
+      }) as readonly any[])
+    : [];
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "type" of type "HubDocumentPagesV2025R0" to be defined',
+    });
+  }
+  const type: HubDocumentPagesV2025R0TypeField =
+    deserializeHubDocumentPagesV2025R0TypeField(val.type);
+  if (!(val.limit == void 0) && !sdIsNumber(val.limit)) {
+    throw new BoxSdkError({
+      message: 'Expecting number for "limit" of type "HubDocumentPagesV2025R0"',
+    });
+  }
+  const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit;
+  if (!(val.next_marker == void 0) && !sdIsString(val.next_marker)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "next_marker" of type "HubDocumentPagesV2025R0"',
+    });
+  }
+  const nextMarker: undefined | string =
+    val.next_marker == void 0 ? void 0 : val.next_marker;
+  return {
+    entries: entries,
+    type: type,
+    limit: limit,
+    nextMarker: nextMarker,
+  } satisfies HubDocumentPagesV2025R0;
+}
+export function serializeHubDocumentPagesV2025R0Input(
+  val: HubDocumentPagesV2025R0Input,
+): SerializedData {
+  return {
+    ['entries']: val.entries.map(function (
+      item: HubDocumentPageV2025R0,
+    ): SerializedData {
+      return serializeHubDocumentPageV2025R0(item);
+    }) as readonly any[],
+    ['type']:
+      val.type == void 0
+        ? val.type
+        : serializeHubDocumentPagesV2025R0TypeField(val.type),
+    ['limit']: val.limit,
+    ['next_marker']: val.nextMarker,
+  };
+}
+export function deserializeHubDocumentPagesV2025R0Input(
+  val: SerializedData,
+): HubDocumentPagesV2025R0Input {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubDocumentPagesV2025R0Input"',
+    });
+  }
+  if (val.entries == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "entries" of type "HubDocumentPagesV2025R0Input" to be defined',
+    });
+  }
+  if (!sdIsList(val.entries)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting array for "entries" of type "HubDocumentPagesV2025R0Input"',
+    });
+  }
+  const entries: readonly HubDocumentPageV2025R0[] = sdIsList(val.entries)
+    ? (val.entries.map(function (itm: SerializedData): HubDocumentPageV2025R0 {
+        return deserializeHubDocumentPageV2025R0(itm);
+      }) as readonly any[])
+    : [];
+  const type: undefined | HubDocumentPagesV2025R0TypeField =
+    val.type == void 0
+      ? void 0
+      : deserializeHubDocumentPagesV2025R0TypeField(val.type);
+  if (!(val.limit == void 0) && !sdIsNumber(val.limit)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting number for "limit" of type "HubDocumentPagesV2025R0Input"',
+    });
+  }
+  const limit: undefined | number = val.limit == void 0 ? void 0 : val.limit;
+  if (!(val.next_marker == void 0) && !sdIsString(val.next_marker)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "next_marker" of type "HubDocumentPagesV2025R0Input"',
+    });
+  }
+  const nextMarker: undefined | string =
+    val.next_marker == void 0 ? void 0 : val.next_marker;
+  return {
+    entries: entries,
+    type: type,
+    limit: limit,
+    nextMarker: nextMarker,
+  } satisfies HubDocumentPagesV2025R0Input;
+}

package/src/schemas/v2025R0/hubItemListBlockV2025R0.ts

@@ -0,0 +1,108 @@
+import { serializeHubDocumentBlockV2025R0 } from './hubDocumentBlockV2025R0';
+import { deserializeHubDocumentBlockV2025R0 } from './hubDocumentBlockV2025R0';
+import { HubDocumentBlockV2025R0 } from './hubDocumentBlockV2025R0';
+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 HubItemListBlockV2025R0TypeField = 'item_list';
+export class HubItemListBlockV2025R0 implements HubDocumentBlockV2025R0 {
+  readonly id!: string;
+  readonly parentId?: string | null;
+  readonly rawData?: SerializedData;
+  /**
+   * The type of this block. The value is always `item_list`. */
+  readonly type: HubItemListBlockV2025R0TypeField =
+    'item_list' as HubItemListBlockV2025R0TypeField;
+  constructor(
+    fields: Omit<HubItemListBlockV2025R0, 'type'> &
+      Partial<Pick<HubItemListBlockV2025R0, 'type'>>,
+  ) {
+    if (fields.id !== undefined) {
+      this.id = fields.id;
+    }
+    if (fields.parentId !== undefined) {
+      this.parentId = fields.parentId;
+    }
+    if (fields.rawData !== undefined) {
+      this.rawData = fields.rawData;
+    }
+    if (fields.type !== undefined) {
+      this.type = fields.type;
+    }
+  }
+}
+export function serializeHubItemListBlockV2025R0TypeField(
+  val: HubItemListBlockV2025R0TypeField,
+): SerializedData {
+  return val;
+}
+export function deserializeHubItemListBlockV2025R0TypeField(
+  val: SerializedData,
+): HubItemListBlockV2025R0TypeField {
+  if (val == 'item_list') {
+    return val;
+  }
+  throw new BoxSdkError({
+    message: "Can't deserialize HubItemListBlockV2025R0TypeField",
+  });
+}
+export function serializeHubItemListBlockV2025R0(
+  val: HubItemListBlockV2025R0,
+): SerializedData {
+  const base: any = serializeHubDocumentBlockV2025R0(val);
+  if (!sdIsMap(base)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubItemListBlockV2025R0"',
+    });
+  }
+  return {
+    ...base,
+    ...{ ['type']: serializeHubItemListBlockV2025R0TypeField(val.type) },
+  };
+}
+export function deserializeHubItemListBlockV2025R0(
+  val: SerializedData,
+): HubItemListBlockV2025R0 {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubItemListBlockV2025R0"',
+    });
+  }
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "type" of type "HubItemListBlockV2025R0" to be defined',
+    });
+  }
+  const type: HubItemListBlockV2025R0TypeField =
+    deserializeHubItemListBlockV2025R0TypeField(val.type);
+  if (val.id == void 0) {
+    throw new BoxSdkError({
+      message: 'Expecting "id" of type "HubItemListBlockV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message: 'Expecting string for "id" of type "HubItemListBlockV2025R0"',
+    });
+  }
+  const id: string = val.id;
+  if (!(val.parent_id == void 0) && !sdIsString(val.parent_id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "parent_id" of type "HubItemListBlockV2025R0"',
+    });
+  }
+  const parentId: undefined | string =
+    val.parent_id == void 0 ? void 0 : val.parent_id;
+  return {
+    type: type,
+    id: id,
+    parentId: parentId,
+  } satisfies HubItemListBlockV2025R0;
+}

package/src/schemas/v2025R0/hubItemOperationResultV2025R0.ts

@@ -23,6 +23,9 @@ export interface HubItemOperationResultV2025R0 {
    * The action performed on the item. */
   readonly action?: string;
   readonly item?: HubItemReferenceV2025R0;
+  /**
+   * The ID of the parent block the item was added to. */
+  readonly parentId?: string;
   /**
    * The HTTP status code of the operation. */
   readonly status?: number;
@@ -40,6 +43,7 @@ export function serializeHubItemOperationResultV2025R0(
       val.item == void 0
         ? val.item
         : serializeHubItemReferenceV2025R0(val.item),
+    ['parent_id']: val.parentId,
     ['status']: val.status,
     ['error']: val.error,
   };
@@ -61,6 +65,14 @@ export function deserializeHubItemOperationResultV2025R0(
   const action: undefined | string = val.action == void 0 ? void 0 : val.action;
   const item: undefined | HubItemReferenceV2025R0 =
     val.item == void 0 ? void 0 : deserializeHubItemReferenceV2025R0(val.item);
+  if (!(val.parent_id == void 0) && !sdIsString(val.parent_id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "parent_id" of type "HubItemOperationResultV2025R0"',
+    });
+  }
+  const parentId: undefined | string =
+    val.parent_id == void 0 ? void 0 : val.parent_id;
   if (!(val.status == void 0) && !sdIsNumber(val.status)) {
     throw new BoxSdkError({
       message:
@@ -78,6 +90,7 @@ export function deserializeHubItemOperationResultV2025R0(
   return {
     action: action,
     item: item,
+    parentId: parentId,
     status: status,
     error: error,
   } satisfies HubItemOperationResultV2025R0;

package/src/schemas/v2025R0/hubItemOperationV2025R0.ts

@@ -24,6 +24,9 @@ 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(
@@ -53,6 +56,7 @@ export function serializeHubItemOperationV2025R0(
   return {
     ['action']: serializeHubItemOperationV2025R0ActionField(val.action),
     ['item']: serializeHubItemReferenceV2025R0(val.item),
+    ['parent_id']: val.parentId,
   };
 }
 export function deserializeHubItemOperationV2025R0(
@@ -80,5 +84,17 @@ export function deserializeHubItemOperationV2025R0(
   const item: HubItemReferenceV2025R0 = deserializeHubItemReferenceV2025R0(
     val.item,
   );
-  return { action: action, item: item } satisfies HubItemOperationV2025R0;
+  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;
 }

package/src/schemas/v2025R0/hubParagraphTextBlockV2025R0.ts

@@ -0,0 +1,133 @@
+import { serializeHubDocumentBlockV2025R0 } from './hubDocumentBlockV2025R0';
+import { deserializeHubDocumentBlockV2025R0 } from './hubDocumentBlockV2025R0';
+import { HubDocumentBlockV2025R0 } from './hubDocumentBlockV2025R0';
+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 HubParagraphTextBlockV2025R0TypeField = 'paragraph';
+export class HubParagraphTextBlockV2025R0 implements HubDocumentBlockV2025R0 {
+  readonly id!: string;
+  readonly parentId?: string | null;
+  readonly rawData?: SerializedData;
+  /**
+   * The type of this block. The value is always `paragraph`. */
+  readonly type: HubParagraphTextBlockV2025R0TypeField =
+    'paragraph' as HubParagraphTextBlockV2025R0TypeField;
+  /**
+   * Text content of the block. Includes rich text formatting. */
+  readonly fragment!: string;
+  constructor(
+    fields: Omit<HubParagraphTextBlockV2025R0, 'type'> &
+      Partial<Pick<HubParagraphTextBlockV2025R0, 'type'>>,
+  ) {
+    if (fields.id !== undefined) {
+      this.id = fields.id;
+    }
+    if (fields.parentId !== undefined) {
+      this.parentId = fields.parentId;
+    }
+    if (fields.rawData !== undefined) {
+      this.rawData = fields.rawData;
+    }
+    if (fields.type !== undefined) {
+      this.type = fields.type;
+    }
+    if (fields.fragment !== undefined) {
+      this.fragment = fields.fragment;
+    }
+  }
+}
+export function serializeHubParagraphTextBlockV2025R0TypeField(
+  val: HubParagraphTextBlockV2025R0TypeField,
+): SerializedData {
+  return val;
+}
+export function deserializeHubParagraphTextBlockV2025R0TypeField(
+  val: SerializedData,
+): HubParagraphTextBlockV2025R0TypeField {
+  if (val == 'paragraph') {
+    return val;
+  }
+  throw new BoxSdkError({
+    message: "Can't deserialize HubParagraphTextBlockV2025R0TypeField",
+  });
+}
+export function serializeHubParagraphTextBlockV2025R0(
+  val: HubParagraphTextBlockV2025R0,
+): SerializedData {
+  const base: any = serializeHubDocumentBlockV2025R0(val);
+  if (!sdIsMap(base)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubParagraphTextBlockV2025R0"',
+    });
+  }
+  return {
+    ...base,
+    ...{
+      ['type']: serializeHubParagraphTextBlockV2025R0TypeField(val.type),
+      ['fragment']: val.fragment,
+    },
+  };
+}
+export function deserializeHubParagraphTextBlockV2025R0(
+  val: SerializedData,
+): HubParagraphTextBlockV2025R0 {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubParagraphTextBlockV2025R0"',
+    });
+  }
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "type" of type "HubParagraphTextBlockV2025R0" to be defined',
+    });
+  }
+  const type: HubParagraphTextBlockV2025R0TypeField =
+    deserializeHubParagraphTextBlockV2025R0TypeField(val.type);
+  if (val.fragment == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "fragment" of type "HubParagraphTextBlockV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.fragment)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "fragment" of type "HubParagraphTextBlockV2025R0"',
+    });
+  }
+  const fragment: string = val.fragment;
+  if (val.id == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "id" of type "HubParagraphTextBlockV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "id" of type "HubParagraphTextBlockV2025R0"',
+    });
+  }
+  const id: string = val.id;
+  if (!(val.parent_id == void 0) && !sdIsString(val.parent_id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "parent_id" of type "HubParagraphTextBlockV2025R0"',
+    });
+  }
+  const parentId: undefined | string =
+    val.parent_id == void 0 ? void 0 : val.parent_id;
+  return {
+    type: type,
+    fragment: fragment,
+    id: id,
+    parentId: parentId,
+  } satisfies HubParagraphTextBlockV2025R0;
+}