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

Official Box TypeScript Generated SDK

import { serializeDateTime } from '../internal/utils.js';
import { deserializeDateTime } from '../internal/utils.js';
import { BoxSdkError } from '../box/errors.js';
import { DateTime } from '../internal/utils.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 UploadSessionTypeField = 'upload_session';
export interface UploadSessionSessionEndpointsField {
  /**
   * The URL to upload parts to */
  readonly uploadPart?: string;
  /**
   * The URL used to commit the file */
  readonly commit?: string;
  /**
   * The URL for used to abort the session. */
  readonly abort?: string;
  /**
   * The URL users to list all parts. */
  readonly listParts?: string;
  /**
   * The URL used to get the status of the upload. */
  readonly status?: string;
  /**
   * The URL used to get the upload log from. */
  readonly logEvent?: string;
  readonly rawData?: SerializedData;
}
export interface UploadSession {
  /**
   * The unique identifier for this session */
  readonly id?: string;
  /**
   * `upload_session` */
  readonly type?: UploadSessionTypeField;
  /**
   * The date and time when this session expires. */
  readonly sessionExpiresAt?: DateTime;
  /**
   * The  size in bytes that must be used for all parts of of the
   * upload.
   *
   * Only the last part is allowed to be of a smaller size. */
  readonly partSize?: number;
  /**
   * The total number of parts expected in this upload session,
   * as determined by the file size and part size. */
  readonly totalParts?: number;
  /**
   * The number of parts that have been uploaded and processed
   * by the server. This starts at `0`.
   *
   * When committing a file files, inspecting this property can
   * provide insight if all parts have been uploaded correctly. */
  readonly numPartsProcessed?: number;
  readonly sessionEndpoints?: UploadSessionSessionEndpointsField;
  readonly rawData?: SerializedData;
}
export function serializeUploadSessionTypeField(
  val: UploadSessionTypeField,
): SerializedData {
  return val;
}
export function deserializeUploadSessionTypeField(
  val: SerializedData,
): UploadSessionTypeField {
  if (val == 'upload_session') {
    return val;
  }
  throw new BoxSdkError({
    message: "Can't deserialize UploadSessionTypeField",
  });
}
export function serializeUploadSessionSessionEndpointsField(
  val: UploadSessionSessionEndpointsField,
): SerializedData {
  return {
    ['upload_part']: val.uploadPart,
    ['commit']: val.commit,
    ['abort']: val.abort,
    ['list_parts']: val.listParts,
    ['status']: val.status,
    ['log_event']: val.logEvent,
  };
}
export function deserializeUploadSessionSessionEndpointsField(
  val: SerializedData,
): UploadSessionSessionEndpointsField {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({
      message: 'Expecting a map for "UploadSessionSessionEndpointsField"',
    });
  }
  if (!(val.upload_part == void 0) && !sdIsString(val.upload_part)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "upload_part" of type "UploadSessionSessionEndpointsField"',
    });
  }
  const uploadPart: undefined | string =
    val.upload_part == void 0 ? void 0 : val.upload_part;
  if (!(val.commit == void 0) && !sdIsString(val.commit)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "commit" of type "UploadSessionSessionEndpointsField"',
    });
  }
  const commit: undefined | string = val.commit == void 0 ? void 0 : val.commit;
  if (!(val.abort == void 0) && !sdIsString(val.abort)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "abort" of type "UploadSessionSessionEndpointsField"',
    });
  }
  const abort: undefined | string = val.abort == void 0 ? void 0 : val.abort;
  if (!(val.list_parts == void 0) && !sdIsString(val.list_parts)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "list_parts" of type "UploadSessionSessionEndpointsField"',
    });
  }
  const listParts: undefined | string =
    val.list_parts == void 0 ? void 0 : val.list_parts;
  if (!(val.status == void 0) && !sdIsString(val.status)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "status" of type "UploadSessionSessionEndpointsField"',
    });
  }
  const status: undefined | string = val.status == void 0 ? void 0 : val.status;
  if (!(val.log_event == void 0) && !sdIsString(val.log_event)) {
    throw new BoxSdkError({
      message:
        'Expecting string for "log_event" of type "UploadSessionSessionEndpointsField"',
    });
  }
  const logEvent: undefined | string =
    val.log_event == void 0 ? void 0 : val.log_event;
  return {
    uploadPart: uploadPart,
    commit: commit,
    abort: abort,
    listParts: listParts,
    status: status,
    logEvent: logEvent,
  } satisfies UploadSessionSessionEndpointsField;
}
export function serializeUploadSession(val: UploadSession): SerializedData {
  return {
    ['id']: val.id,
    ['type']:
      val.type == void 0 ? val.type : serializeUploadSessionTypeField(val.type),
    ['session_expires_at']:
      val.sessionExpiresAt == void 0
        ? val.sessionExpiresAt
        : serializeDateTime(val.sessionExpiresAt),
    ['part_size']: val.partSize,
    ['total_parts']: val.totalParts,
    ['num_parts_processed']: val.numPartsProcessed,
    ['session_endpoints']:
      val.sessionEndpoints == void 0
        ? val.sessionEndpoints
        : serializeUploadSessionSessionEndpointsField(val.sessionEndpoints),
  };
}
export function deserializeUploadSession(val: SerializedData): UploadSession {
  if (!sdIsMap(val)) {
    throw new BoxSdkError({ message: 'Expecting a map for "UploadSession"' });
  }
  if (!(val.id == void 0) && !sdIsString(val.id)) {
    throw new BoxSdkError({
      message: 'Expecting string for "id" of type "UploadSession"',
    });
  }
  const id: undefined | string = val.id == void 0 ? void 0 : val.id;
  const type: undefined | UploadSessionTypeField =
    val.type == void 0 ? void 0 : deserializeUploadSessionTypeField(val.type);
  if (
    !(val.session_expires_at == void 0) &&
    !sdIsString(val.session_expires_at)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting string for "session_expires_at" of type "UploadSession"',
    });
  }
  const sessionExpiresAt: undefined | DateTime =
    val.session_expires_at == void 0
      ? void 0
      : deserializeDateTime(val.session_expires_at);
  if (!(val.part_size == void 0) && !sdIsNumber(val.part_size)) {
    throw new BoxSdkError({
      message: 'Expecting number for "part_size" of type "UploadSession"',
    });
  }
  const partSize: undefined | number =
    val.part_size == void 0 ? void 0 : val.part_size;
  if (!(val.total_parts == void 0) && !sdIsNumber(val.total_parts)) {
    throw new BoxSdkError({
      message: 'Expecting number for "total_parts" of type "UploadSession"',
    });
  }
  const totalParts: undefined | number =
    val.total_parts == void 0 ? void 0 : val.total_parts;
  if (
    !(val.num_parts_processed == void 0) &&
    !sdIsNumber(val.num_parts_processed)
  ) {
    throw new BoxSdkError({
      message:
        'Expecting number for "num_parts_processed" of type "UploadSession"',
    });
  }
  const numPartsProcessed: undefined | number =
    val.num_parts_processed == void 0 ? void 0 : val.num_parts_processed;
  const sessionEndpoints: undefined | UploadSessionSessionEndpointsField =
    val.session_endpoints == void 0
      ? void 0
      : deserializeUploadSessionSessionEndpointsField(val.session_endpoints);
  return {
    id: id,
    type: type,
    sessionExpiresAt: sessionExpiresAt,
    partSize: partSize,
    totalParts: totalParts,
    numPartsProcessed: numPartsProcessed,
    sessionEndpoints: sessionEndpoints,
  } satisfies UploadSession;
}