box-node-sdk 10.5.0 → 10.6.0

package/src/schemas/v2025R0/hubSectionTitleTextBlockV2025R0.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 HubSectionTitleTextBlockV2025R0TypeField = 'section_title';
+export class HubSectionTitleTextBlockV2025R0 implements HubDocumentBlockV2025R0 {
+  readonly id!: string;
+  readonly parentId?: string | null;
+  readonly rawData?: SerializedData;
+  /**
+   * The type of this block. The value is always `section_title`. */
+  readonly type: HubSectionTitleTextBlockV2025R0TypeField =
+    'section_title' as HubSectionTitleTextBlockV2025R0TypeField;
+  /**
+   * Text content of the block. Includes rich text formatting. */
+  readonly fragment!: string;
+  constructor(
+    fields: Omit<HubSectionTitleTextBlockV2025R0, 'type'> &
+      Partial<Pick<HubSectionTitleTextBlockV2025R0, '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 serializeHubSectionTitleTextBlockV2025R0TypeField(
+  val: HubSectionTitleTextBlockV2025R0TypeField,
+): SerializedData {
+  return val;
+}
+export function deserializeHubSectionTitleTextBlockV2025R0TypeField(
+  val: SerializedData,
+): HubSectionTitleTextBlockV2025R0TypeField {
+  if (val == 'section_title') {
+    return val;
+  }
+  throw new BoxSdkError({
+    message: "Can't deserialize HubSectionTitleTextBlockV2025R0TypeField",
+  });
+}
+export function serializeHubSectionTitleTextBlockV2025R0(
+  val: HubSectionTitleTextBlockV2025R0,
+): SerializedData {
+  const base: any = serializeHubDocumentBlockV2025R0(val);
+  if (!sdIsMap(base)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubSectionTitleTextBlockV2025R0"',
+    });
+  }
+  return {
+    ...base,
+    ...{
+      ['type']: serializeHubSectionTitleTextBlockV2025R0TypeField(val.type),
+      ['fragment']: val.fragment,
+    },
+  };
+}
+export function deserializeHubSectionTitleTextBlockV2025R0(
+  val: SerializedData,
+): HubSectionTitleTextBlockV2025R0 {
+  if (!sdIsMap(val)) {
+    throw new BoxSdkError({
+      message: 'Expecting a map for "HubSectionTitleTextBlockV2025R0"',
+    });
+  }
+  if (val.type == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "type" of type "HubSectionTitleTextBlockV2025R0" to be defined',
+    });
+  }
+  const type: HubSectionTitleTextBlockV2025R0TypeField =
+    deserializeHubSectionTitleTextBlockV2025R0TypeField(val.type);
+  if (val.fragment == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "fragment" of type "HubSectionTitleTextBlockV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.fragment)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "fragment" of type "HubSectionTitleTextBlockV2025R0"',
+    });
+  }
+  const fragment: string = val.fragment;
+  if (val.id == void 0) {
+    throw new BoxSdkError({
+      message:
+        'Expecting "id" of type "HubSectionTitleTextBlockV2025R0" to be defined',
+    });
+  }
+  if (!sdIsString(val.id)) {
+    throw new BoxSdkError({
+      message:
+        'Expecting string for "id" of type "HubSectionTitleTextBlockV2025R0"',
+    });
+  }
+  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 "HubSectionTitleTextBlockV2025R0"',
+    });
+  }
+  const parentId: undefined | string =
+    val.parent_id == void 0 ? void 0 : val.parent_id;
+  return {
+    type: type,
+    fragment: fragment,
+    id: id,
+    parentId: parentId,
+  } satisfies HubSectionTitleTextBlockV2025R0;
+}

package/src/schemas/v2025R0/index.ts

@@ -34,6 +34,16 @@ export * from './hubCollaborationCreateRequestV2025R0';
 export * from './hubCollaborationUpdateRequestV2025R0';
 export * from './hubCopyRequestV2025R0';
 export * from './hubCreateRequestV2025R0';
+export * from './hubDocumentBlockV2025R0';
+export * from './hubSectionTitleTextBlockV2025R0';
+export * from './hubParagraphTextBlockV2025R0';
+export * from './hubItemListBlockV2025R0';
+export * from './hubDividerBlockV2025R0';
+export * from './hubCalloutBoxTextBlockV2025R0';
+export * from './hubDocumentBlockEntryV2025R0';
+export * from './hubDocumentBlocksV2025R0';
+export * from './hubDocumentPageV2025R0';
+export * from './hubDocumentPagesV2025R0';
 export * from './hubItemV2025R0';
 export * from './hubItemsV2025R0';
 export * from './hubUpdateRequestV2025R0';

package/src/test/hubDocument.test.ts

@@ -0,0 +1,91 @@
+import { serializeHubV2025R0 } from '@/schemas/v2025R0/hubV2025R0';
+import { deserializeHubV2025R0 } from '@/schemas/v2025R0/hubV2025R0';
+import { serializeHubCreateRequestV2025R0 } from '@/schemas/v2025R0/hubCreateRequestV2025R0';
+import { deserializeHubCreateRequestV2025R0 } from '@/schemas/v2025R0/hubCreateRequestV2025R0';
+import { serializeHubDocumentPagesV2025R0 } from '@/schemas/v2025R0/hubDocumentPagesV2025R0';
+import { deserializeHubDocumentPagesV2025R0 } from '@/schemas/v2025R0/hubDocumentPagesV2025R0';
+import { serializeHubDocumentPageV2025R0 } from '@/schemas/v2025R0/hubDocumentPageV2025R0';
+import { deserializeHubDocumentPageV2025R0 } from '@/schemas/v2025R0/hubDocumentPageV2025R0';
+import { serializeHubDocumentBlocksV2025R0 } from '@/schemas/v2025R0/hubDocumentBlocksV2025R0';
+import { deserializeHubDocumentBlocksV2025R0 } from '@/schemas/v2025R0/hubDocumentBlocksV2025R0';
+import { serializeHubParagraphTextBlockV2025R0 } from '@/schemas/v2025R0/hubParagraphTextBlockV2025R0';
+import { deserializeHubParagraphTextBlockV2025R0 } from '@/schemas/v2025R0/hubParagraphTextBlockV2025R0';
+import { serializeHubSectionTitleTextBlockV2025R0 } from '@/schemas/v2025R0/hubSectionTitleTextBlockV2025R0';
+import { deserializeHubSectionTitleTextBlockV2025R0 } from '@/schemas/v2025R0/hubSectionTitleTextBlockV2025R0';
+import { serializeHubCalloutBoxTextBlockV2025R0 } from '@/schemas/v2025R0/hubCalloutBoxTextBlockV2025R0';
+import { deserializeHubCalloutBoxTextBlockV2025R0 } from '@/schemas/v2025R0/hubCalloutBoxTextBlockV2025R0';
+import { serializeHubItemListBlockV2025R0 } from '@/schemas/v2025R0/hubItemListBlockV2025R0';
+import { deserializeHubItemListBlockV2025R0 } from '@/schemas/v2025R0/hubItemListBlockV2025R0';
+import { serializeHubDividerBlockV2025R0 } from '@/schemas/v2025R0/hubDividerBlockV2025R0';
+import { deserializeHubDividerBlockV2025R0 } from '@/schemas/v2025R0/hubDividerBlockV2025R0';
+import { serializeHubDocumentBlockEntryV2025R0 } from '@/schemas/v2025R0/hubDocumentBlockEntryV2025R0';
+import { deserializeHubDocumentBlockEntryV2025R0 } from '@/schemas/v2025R0/hubDocumentBlockEntryV2025R0';
+import { BoxClient } from '@/client';
+import { HubV2025R0 } from '@/schemas/v2025R0/hubV2025R0';
+import { HubCreateRequestV2025R0 } from '@/schemas/v2025R0/hubCreateRequestV2025R0';
+import { HubDocumentPagesV2025R0 } from '@/schemas/v2025R0/hubDocumentPagesV2025R0';
+import { GetHubDocumentPagesV2025R0QueryParams } from '@/managers/hubDocument';
+import { HubDocumentPageV2025R0 } from '@/schemas/v2025R0/hubDocumentPageV2025R0';
+import { HubDocumentBlocksV2025R0 } from '@/schemas/v2025R0/hubDocumentBlocksV2025R0';
+import { GetHubDocumentBlocksV2025R0QueryParams } from '@/managers/hubDocument';
+import { HubParagraphTextBlockV2025R0 } from '@/schemas/v2025R0/hubParagraphTextBlockV2025R0';
+import { HubSectionTitleTextBlockV2025R0 } from '@/schemas/v2025R0/hubSectionTitleTextBlockV2025R0';
+import { HubCalloutBoxTextBlockV2025R0 } from '@/schemas/v2025R0/hubCalloutBoxTextBlockV2025R0';
+import { HubItemListBlockV2025R0 } from '@/schemas/v2025R0/hubItemListBlockV2025R0';
+import { HubDividerBlockV2025R0 } from '@/schemas/v2025R0/hubDividerBlockV2025R0';
+import { HubDocumentBlockEntryV2025R0 } from '@/schemas/v2025R0/hubDocumentBlockEntryV2025R0';
+import { getDefaultClientWithUserSubject } from './commons';
+import { getEnvVar } from '@/internal/utils';
+import { getUuid } from '@/internal/utils';
+import { toString } from '@/internal/utils';
+import { sdToJson } from '@/serialization/json';
+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 const client: BoxClient = getDefaultClientWithUserSubject(
+  getEnvVar('USER_ID'),
+);
+test('testGetHubDocumentPagesAndBlocks', async function testGetHubDocumentPagesAndBlocks(): Promise<any> {
+  const hubTitle: string = getUuid();
+  const createdHub: HubV2025R0 = await client.hubs.createHubV2025R0({
+    title: hubTitle,
+  } satisfies HubCreateRequestV2025R0);
+  const hubId: string = createdHub.id;
+  const pages: HubDocumentPagesV2025R0 =
+    await client.hubDocument.getHubDocumentPagesV2025R0({
+      hubId: hubId,
+    } satisfies GetHubDocumentPagesV2025R0QueryParams);
+  if (!(pages.entries.length > 0)) {
+    throw new Error('Assertion failed');
+  }
+  if (!((toString(pages.type) as string) == 'document_pages')) {
+    throw new Error('Assertion failed');
+  }
+  const firstPage: HubDocumentPageV2025R0 = pages.entries[0];
+  if (!((toString(firstPage.type) as string) == 'page')) {
+    throw new Error('Assertion failed');
+  }
+  const pageId: string = firstPage.id;
+  const blocks: HubDocumentBlocksV2025R0 =
+    await client.hubDocument.getHubDocumentBlocksV2025R0({
+      hubId: hubId,
+      pageId: pageId,
+    } satisfies GetHubDocumentBlocksV2025R0QueryParams);
+  if (!((toString(blocks.type) as string) == 'document_blocks')) {
+    throw new Error('Assertion failed');
+  }
+  if (!(blocks.entries.length > 0)) {
+    throw new Error('Assertion failed');
+  }
+  const firstBlock: HubDocumentBlockEntryV2025R0 = blocks
+    .entries![0] as HubDocumentBlockEntryV2025R0;
+  if (!((toString(firstBlock.type!) as string) == 'item_list')) {
+    throw new Error('Assertion failed');
+  }
+  await client.hubs.deleteHubByIdV2025R0(hubId);
+});
+export {};