@vidispine/types 22.4.0-pre.3 → 22.4.0-pre.5

package/src/models/JobRequestChoiceType.ts

@@ -0,0 +1,31 @@
+import type { AAFGeneratorJobType } from './AAFGeneratorJobType';
+import type { ComplexJobType } from './ComplexJobType';
+import type { DurationJobType } from './DurationJobType';
+import type { HashJobType } from './HashJobType';
+import type { MOVIndexJobType } from './MOVIndexJobType';
+import type { MXFOp1bJobType } from './MXFOp1bJobType';
+import type { MXFTimecodeExtractionJobType } from './MXFTimecodeExtractionJobType';
+import type { NLEJobType } from './NLEJobType';
+import type { QueueJobType } from './QueueJobType';
+import type { SegmentationJobType } from './SegmentationJobType';
+import type { ShapeDeductionJobType } from './ShapeDeductionJobType';
+import type { TimelineJobRequestType } from './TimelineJobRequestType';
+import type { TransferJobType } from './TransferJobType';
+import type { XMPJobType } from './XMPJobType';
+
+export type JobRequestChoiceType = {
+  timelineRequest?: TimelineJobRequestType;
+  complexRequest?: ComplexJobType;
+  movIndexRequest?: MOVIndexJobType;
+  mxfTimecodeExtractionRequest?: MXFTimecodeExtractionJobType;
+  mxfOp1bRequest?: MXFOp1bJobType;
+  segmentationRequest?: SegmentationJobType;
+  nleRequest?: NLEJobType;
+  queueRequest?: QueueJobType;
+  durationRequest?: DurationJobType;
+  shapeDeductionRequest?: ShapeDeductionJobType;
+  xmpRequest?: XMPJobType;
+  hashRequest?: HashJobType;
+  transferRequest?: TransferJobType;
+  aafGeneratorRequest?: AAFGeneratorJobType;
+};

package/src/models/JobSearchDocument.ts

@@ -0,0 +1,3 @@
+import type { JobSearchType } from './JobSearchType';
+
+export type JobSearchDocument = JobSearchType;

package/src/models/JobSearchType.ts

@@ -0,0 +1,18 @@
+import type { FacetRangeType } from './FacetRangeType';
+
+export type JobSearchType = {
+  facetFilter?: Array<{
+    field: string;
+    range?: FacetRangeType;
+    value?: string;
+  }>;
+  facet?: Array<{
+    field: string;
+    exclude?: Array<string>;
+    count?: boolean;
+    minCount?: number;
+    maxCount?: number;
+    maxResults?: number;
+    name?: string;
+  }>;
+};

package/src/models/JobStatusDocument.ts

@@ -0,0 +1,3 @@
+import type { JobStatusType } from './JobStatusType';
+
+export type JobStatusDocument = JobStatusType;

package/src/models/JobStatusListDocument.ts

@@ -0,0 +1,3 @@
+import type { JobStatusListType } from './JobStatusListType';
+
+export type JobStatusListDocument = JobStatusListType;

package/src/models/JobStatusListType.ts

@@ -0,0 +1,6 @@
+import type { JobStatusType } from './JobStatusType';
+
+export type JobStatusListType = {
+  hits?: number;
+  job?: Array<JobStatusType>;
+};

package/src/models/JobStatusType.ts

@@ -0,0 +1,33 @@
+import type { AAFGeneratorResponse } from './AAFGeneratorResponse';
+import type { DurationResponse } from './DurationResponse';
+import type { HashResponse } from './HashResponse';
+import type { JobInputProgressType } from './JobInputProgressType';
+import type { JobLogEntryType } from './JobLogEntryType';
+import type { JobRequestChoiceType } from './JobRequestChoiceType';
+import type { ShapeDeductionResponse } from './ShapeDeductionResponse';
+import type { SiteIdType } from './SiteIdType';
+import type { ThumbnailInfoType } from './ThumbnailInfoType';
+import type { TransferResponse } from './TransferResponse';
+import type { XMPResponse } from './XMPResponse';
+
+export type JobStatusType = {
+  statusUri: string;
+  id: SiteIdType;
+  isRunning: boolean;
+  isPaused: boolean;
+  walltime: number;
+  exitcode?: number;
+  message?: string;
+  log?: Array<JobLogEntryType>;
+  request?: JobRequestChoiceType;
+  inputProgress?: Array<JobInputProgressType>;
+  progress?: number;
+  estimatedTimeLeft?: number;
+  thumbnail?: Array<ThumbnailInfoType>;
+  shapeDeductionResponse?: Array<ShapeDeductionResponse>;
+  durationResponse?: Array<DurationResponse>;
+  xmpResponse?: Array<XMPResponse>;
+  hashResponse?: Array<HashResponse>;
+  transferResponse?: Array<TransferResponse>;
+  aafGeneratorResponse?: Array<AAFGeneratorResponse>;
+};

package/src/models/JobTaskProgressType.ts

@@ -0,0 +1,7 @@
+import type { JobTaskProgressType_unit } from './JobTaskProgressType_unit';
+
+export type JobTaskProgressType = {
+  total?: number;
+  unit?: JobTaskProgressType_unit;
+  value?: number;
+};

package/src/models/JobTaskProgressType_unit.ts

@@ -0,0 +1 @@
+export type JobTaskProgressType_unit = 'bytes' | 'percent';

package/src/models/JobTaskType.ts

@@ -0,0 +1,18 @@
+import type { JobTaskProgressType } from './JobTaskProgressType';
+
+export type JobTaskType = {
+  step: number;
+  attempts: number;
+  status: string;
+  timestamp: string;
+  description?: string;
+  progress?: JobTaskProgressType;
+  subStep?: Array<{
+    timestamp: string;
+    description: string;
+  }>;
+  errorMessage?: string;
+  totalSubTasks?: number;
+  subTask?: Array<JobTaskType>;
+  id?: number;
+};

package/src/models/JobType.ts

@@ -0,0 +1,31 @@
+import type { JobTaskType } from './JobTaskType';
+import type { SiteIdType } from './SiteIdType';
+
+export type JobType = {
+  jobId: SiteIdType;
+  user?: string;
+  started?: string;
+  finished?: string;
+  status: string;
+  type: string;
+  subJob?: Array<JobType>;
+  priority: string;
+  waiting?: {
+    resourceId?: SiteIdType;
+    resourceType?: string;
+    requirement?: string;
+  };
+  currentStep?: {
+    description: string;
+    number: number;
+    status: string;
+  };
+  data?: Array<{
+    key: string;
+    value: string;
+  }>;
+  totalSteps?: number;
+  log?: {
+    task?: Array<JobTaskType>;
+  };
+};

package/src/models/KeyValuePairType.ts

@@ -0,0 +1,4 @@
+export type KeyValuePairType = {
+  key: string;
+  value: string;
+};

package/src/models/KeyValueType.ts

@@ -0,0 +1,4 @@
+export type KeyValueType = {
+  key: string;
+  value: string;
+};

package/src/models/LDAPImportType.ts

@@ -0,0 +1,4 @@
+export type LDAPImportType = {
+  interval?: number;
+  importOrganizationalUnits?: boolean;
+};

package/src/models/LDAPResourceType.ts

@@ -0,0 +1,22 @@
+import type { LDAPImportType } from './LDAPImportType';
+import type { LDAPSyncType } from './LDAPSyncType';
+
+export type LDAPResourceType = {
+  url: Array<string>;
+  useStartTLS: boolean;
+  userDN: string;
+  usernameAttribute: string;
+  userSearchFilter?: string;
+  bindDN?: string;
+  bindPassword?: string;
+  cacheLifetime?: number;
+  groupDN?: string;
+  groupSearchFilter?: string;
+  realNameAttribute?: string;
+  groupnameAttribute?: string;
+  usernameFormat?: string;
+  secureProtocol?: string;
+  serverCertificate?: Array<string>;
+  sync?: LDAPSyncType;
+  import?: LDAPImportType;
+};

package/src/models/LDAPSyncType.ts

@@ -0,0 +1,6 @@
+import type { LDAPImportType } from './LDAPImportType';
+
+export type LDAPSyncType = LDAPImportType & {
+  createUsers?: boolean;
+  createGroups?: boolean;
+};

package/src/models/LibrarySettingsDocument.ts

@@ -0,0 +1,3 @@
+import type { LibrarySettingsType } from './LibrarySettingsType';
+
+export type LibrarySettingsDocument = LibrarySettingsType;

package/src/models/LibrarySettingsType.ts

@@ -0,0 +1,12 @@
+import type { ItemSearchType } from './ItemSearchType';
+import type { SiteIdType } from './SiteIdType';
+
+export type LibrarySettingsType = {
+  id?: SiteIdType;
+  username?: string;
+  updateMode?: string;
+  autoRefresh?: boolean;
+  updateFrequency?: number;
+  lastUpdate?: string;
+  query?: ItemSearchType;
+};

package/src/models/LibrarySynchronizeType.ts

@@ -0,0 +1,16 @@
+import type { AccessControlSynchronizeType } from './AccessControlSynchronizeType';
+import type { HasSubEntityType } from './HasSubEntityType';
+import type { SiteIdType } from './SiteIdType';
+
+export type LibrarySynchronizeType = {
+  delete: boolean;
+  create: boolean;
+  id: SiteIdType;
+  complete?: boolean;
+  access?: Array<AccessControlSynchronizeType>;
+  updateMode: string;
+  updateFrequency?: string;
+  searchXML?: string;
+  hasItem?: Array<HasSubEntityType>;
+  partOfCollection?: Array<SiteIdType>;
+};

package/src/models/LicenseErrorType.ts

@@ -0,0 +1,3 @@
+export type LicenseErrorType = {
+  licenseError?: string;
+};

package/src/models/LicenseExceptionType.ts

@@ -0,0 +1,3 @@
+export type LicenseExceptionType = {
+  message?: string;
+};

package/src/models/LicenseNumberType.ts

@@ -0,0 +1,4 @@
+export type LicenseNumberType = {
+  allowed?: string;
+  current?: string;
+};

package/src/models/LicenseType.ts

@@ -0,0 +1,23 @@
+import type { CodecStatusType } from './CodecStatusType';
+import type { LicenseErrorType } from './LicenseErrorType';
+import type { LicenseNumberType } from './LicenseNumberType';
+import type { SystemInfoType } from './SystemInfoType';
+
+export type LicenseType = {
+  expiryDate?: string;
+  macaddresses?: SystemInfoType;
+  fileStatus?: string;
+  storageNumber?: LicenseNumberType;
+  userNumber?: LicenseNumberType;
+  itemNumber?: LicenseNumberType;
+  transcoderNumber?: LicenseNumberType;
+  databaseSizeLimit?: LicenseNumberType;
+  endCustomerCompanyname?: string;
+  endCustomerCompanyContactEmail?: string;
+  resellerCompanyName?: string;
+  resellerCompanyContactEmail?: string;
+  licenseStatus?: string;
+  codecStatus?: CodecStatusType;
+  licenseErrorStatus?: LicenseErrorType;
+  licenseType?: string;
+};

package/src/models/LockDocument.ts

@@ -0,0 +1,3 @@
+import type { LockType } from './LockType';
+
+export type LockDocument = LockType;

package/src/models/LockType.ts

@@ -0,0 +1,7 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type LockType = {
+  id: SiteIdType;
+  user: string;
+  expires: string;
+};

package/src/models/LogReportConfigurationDocument.ts

@@ -0,0 +1,3 @@
+import type { LogReportConfigurationType } from './LogReportConfigurationType';
+
+export type LogReportConfigurationDocument = LogReportConfigurationType;

package/src/models/LogReportConfigurationType.ts

@@ -0,0 +1,8 @@
+export type LogReportConfigurationType = {
+  path?: string;
+  expiryTime?: number;
+  uploadUri?: string;
+  certificate?: string;
+  clientKey?: string;
+  clientCertificate?: Array<string>;
+};

package/src/models/LoudnessDocument.ts

@@ -0,0 +1,3 @@
+import type { LoudnessType } from './LoudnessType';
+
+export type LoudnessDocument = LoudnessType;

package/src/models/LoudnessMixType.ts

@@ -0,0 +1,7 @@
+export type LoudnessMixType = {
+  name?: string;
+  weightdB?: number;
+  sourceItemTrack?: string;
+  sourceStream?: number;
+  sourceChannel?: number;
+};

package/src/models/LoudnessType.ts

@@ -0,0 +1,17 @@
+import type { LoudnessMixType } from './LoudnessMixType';
+import type { SiteIdType } from './SiteIdType';
+
+export type LoudnessType = {
+  id?: SiteIdType;
+  shape?: SiteIdType;
+  shapeTag?: string;
+  mix?: Array<LoudnessMixType>;
+  start?: string;
+  end?: string;
+  startLoudness?: string;
+  endLoudness?: string;
+  startRange?: string;
+  endRange?: string;
+  loudnessLU?: number;
+  loudnessRangeLU?: number;
+};

package/src/models/MDObjectBase.ts

@@ -0,0 +1,6 @@
+import type { ULType } from './ULType';
+
+export type MDObjectBase = {
+  name?: string;
+  ul: ULType;
+};

package/src/models/MDObjectLeaf.ts

@@ -0,0 +1,6 @@
+import type { MDObjectBase } from './MDObjectBase';
+
+export type MDObjectLeaf = MDObjectBase & {
+  hexValue?: string;
+  stringValue?: string;
+};

package/src/models/MDObjectNode.ts

@@ -0,0 +1,13 @@
+import type { InstanceUID } from './InstanceUID';
+import type { MDObjectBase } from './MDObjectBase';
+import type { MDObjectLeaf } from './MDObjectLeaf';
+import type { MDObjectStrongReference } from './MDObjectStrongReference';
+import type { MDObjectWeakReference } from './MDObjectWeakReference';
+
+export type MDObjectNode = MDObjectBase & {
+  instanceUid?: InstanceUID;
+  leaf?: Array<MDObjectLeaf>;
+  child?: Array<MDObjectNode>;
+  strongReference?: Array<MDObjectStrongReference>;
+  weakReference?: Array<MDObjectWeakReference>;
+};

package/src/models/MDObjectStrongReference.ts

@@ -0,0 +1,6 @@
+import type { MDObjectNode } from './MDObjectNode';
+import type { ULType } from './ULType';
+
+export type MDObjectStrongReference = MDObjectNode & {
+  referenceUl: ULType;
+};

package/src/models/MDObjectWeakReference.ts

@@ -0,0 +1,6 @@
+import type { InstanceUID } from './InstanceUID';
+import type { MDObjectBase } from './MDObjectBase';
+
+export type MDObjectWeakReference = MDObjectBase & {
+  target: InstanceUID;
+};

package/src/models/MDSegment.ts

@@ -0,0 +1,7 @@
+import type { MDObjectNode } from './MDObjectNode';
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type MDSegment = {
+  interval: TimeIntervalType;
+  dms1Framework: MDObjectNode;
+};

package/src/models/MOVIndexJobDocument.ts

@@ -0,0 +1,3 @@
+import type { MOVIndexJobType } from './MOVIndexJobType';
+
+export type MOVIndexJobDocument = MOVIndexJobType;

package/src/models/MOVIndexJobType.ts

@@ -0,0 +1,12 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type MOVIndexJobType = TranscoderJobType & {
+  targetUri: string;
+  source?: Array<{
+    uri: string;
+    alias?: string;
+    absoluteAlias?: string;
+    setting?: Array<KeyValuePairType>;
+  }>;
+};

package/src/models/MXFOp1bJobDocument.ts

@@ -0,0 +1,3 @@
+import type { MXFOp1bJobType } from './MXFOp1bJobType';
+
+export type MXFOp1bJobDocument = MXFOp1bJobType;

package/src/models/MXFOp1bJobType.ts

@@ -0,0 +1,10 @@
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type MXFOp1bJobType = TranscoderJobType & {
+  output: string;
+  reference?: Array<{
+    source: string;
+    stream?: Array<number>;
+    locator?: Array<string>;
+  }>;
+};

package/src/models/MXFPackagesType.ts

@@ -0,0 +1,11 @@
+import type { FrameRateType } from './FrameRateType';
+import type { MaterialPackageType } from './MaterialPackageType';
+import type { TapePackageType } from './TapePackageType';
+
+export type MXFPackagesType = {
+  materialPackage: MaterialPackageType;
+  tapePackage?: TapePackageType;
+  materialTrackName: string;
+  tapeTrackName?: string;
+  projectEditRate?: FrameRateType;
+};

package/src/models/MXFServerResourceType.ts

@@ -0,0 +1,20 @@
+import type { SimpleMetadataType } from './SimpleMetadataType';
+import type { SiteIdType } from './SiteIdType';
+
+export type MXFServerResourceType = {
+  url: string;
+  workspaceUrl: string;
+  userWorkspaceUrl: string;
+  mxfServerWorkspacePath: string;
+  mxfServerUserId: number;
+  mxfServerPathToStorage: string;
+  databaseName: string;
+  storageId: SiteIdType;
+  metadata?: SimpleMetadataType;
+  description?: string;
+  atomShapes?: string;
+  importShapes?: string;
+  detectAtom?: boolean;
+  enforceQuota?: boolean;
+  fileImportPattern?: string;
+};

package/src/models/MXFTimecodeExtractionJobDocument.ts

@@ -0,0 +1,3 @@
+import type { MXFTimecodeExtractionJobType } from './MXFTimecodeExtractionJobType';
+
+export type MXFTimecodeExtractionJobDocument = MXFTimecodeExtractionJobType;

package/src/models/MXFTimecodeExtractionJobType.ts

@@ -0,0 +1,6 @@
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type MXFTimecodeExtractionJobType = TranscoderJobType & {
+  sourceUri: string;
+  targetUri: string;
+};

package/src/models/MXFTimestampType.ts

@@ -0,0 +1,9 @@
+export type MXFTimestampType = {
+  year: number;
+  month: number;
+  day: number;
+  hour: number;
+  min: number;
+  sec: number;
+  qmsec: number;
+};

package/src/models/MasterLicenseDocument.ts

@@ -0,0 +1,3 @@
+import type { MasterLicenseType } from './MasterLicenseType';
+
+export type MasterLicenseDocument = MasterLicenseType;

package/src/models/MasterLicenseType.ts

@@ -0,0 +1,5 @@
+import type { LicenseType } from './LicenseType';
+
+export type MasterLicenseType = LicenseType & {
+  masterIdentifier: string;
+};

package/src/models/MaterialPackageTrackType.ts

@@ -0,0 +1,6 @@
+import type { PackageTrackType } from './PackageTrackType';
+import type { UMIDType } from './UMIDType';
+
+export type MaterialPackageTrackType = PackageTrackType & {
+  sourcePackageID: UMIDType;
+};

package/src/models/MaterialPackageType.ts

@@ -0,0 +1,6 @@
+import type { MaterialPackageTrackType } from './MaterialPackageTrackType';
+import type { PackageType } from './PackageType';
+
+export type MaterialPackageType = PackageType & {
+  track: Array<MaterialPackageTrackType>;
+};

package/src/models/MediaComponentType.ts

@@ -0,0 +1,25 @@
+import type { ComponentType } from './ComponentType';
+import type { EDLType } from './EDLType';
+import type { TimeBaseType } from './TimeBaseType';
+import type { TimeCodeType } from './TimeCodeType';
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type MediaComponentType = ComponentType & {
+  codec?: string;
+  timeBase?: TimeBaseType;
+  itemTrack?: string;
+  essenceStreamId?: number;
+  interval?: TimeIntervalType;
+  bitrate?: number;
+  numberOfPackets?: number;
+  extradata?: string;
+  pid?: number;
+  duration?: TimeCodeType;
+  profile?: number;
+  level?: number;
+  edl?: EDLType;
+  startTimestamp?: TimeCodeType;
+  repeatCount?: number;
+  trackOrder?: number;
+  segment?: number;
+};

package/src/models/MetadataChangeSetDocument.ts

@@ -0,0 +1,3 @@
+import type { MetadataChangeSetType } from './MetadataChangeSetType';
+
+export type MetadataChangeSetDocument = MetadataChangeSetType;

package/src/models/MetadataChangeSetType.ts

@@ -0,0 +1,9 @@
+import type { MetadataType } from './MetadataType';
+import type { SiteIdType } from './SiteIdType';
+
+export type MetadataChangeSetType = {
+  changeSet?: Array<{
+    id: SiteIdType;
+    metadata: MetadataType;
+  }>;
+};

package/src/models/MetadataDatasetListDocument.ts

@@ -0,0 +1,3 @@
+import type { MetadataDatasetListType } from './MetadataDatasetListType';
+
+export type MetadataDatasetListDocument = MetadataDatasetListType;

package/src/models/MetadataDatasetListType.ts

@@ -0,0 +1,7 @@
+export type MetadataDatasetListType = {
+  hits?: number;
+  dataset?: Array<{
+    name: string;
+    uri: string;
+  }>;
+};

package/src/models/MetadataDocument.ts

@@ -0,0 +1,3 @@
+import type { MetadataType } from './MetadataType';
+
+export type MetadataDocument = MetadataType;

package/src/models/MetadataEntryDocument.ts

@@ -0,0 +1,3 @@
+import type { MetadataEntryType } from './MetadataEntryType';
+
+export type MetadataEntryDocument = MetadataEntryType;

package/src/models/MetadataEntryListDocument.ts

@@ -0,0 +1,3 @@
+import type { MetadataEntryListType2 } from './MetadataEntryListType2';
+
+export type MetadataEntryListDocument = MetadataEntryListType2;

package/src/models/MetadataEntryListType.ts

@@ -0,0 +1,5 @@
+import type { MetadataEntrySyncType } from './MetadataEntrySyncType';
+
+export type MetadataEntryListType = {
+  entry?: Array<MetadataEntrySyncType>;
+};

package/src/models/MetadataEntryListType2.ts

@@ -0,0 +1,9 @@
+import type { MetadataEntryType } from './MetadataEntryType';
+
+export type MetadataEntryListType2 = {
+  entry?: Array<
+    MetadataEntryType & {
+      uuid?: string;
+    }
+  >;
+};

package/src/models/MetadataEntrySyncType.ts

@@ -0,0 +1,21 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type MetadataEntrySyncType = {
+  value: string;
+  id?: SiteIdType;
+  start?: string;
+  end?: string;
+  name?: string;
+  parentUuid?: string;
+  reference?: boolean;
+  removed?: boolean;
+  timestamp?: number;
+  type?: string;
+  user?: string;
+  valueUuid?: string;
+  version?: number;
+  metadataId?: SiteIdType;
+  metadataLeafId?: SiteIdType;
+  track?: string;
+  language?: string;
+};