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

package/src/models/BulkyMetadataConfigurationDocument.ts

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

package/src/models/BulkyMetadataConfigurationType.ts

@@ -0,0 +1,9 @@
+export type BulkyMetadataConfigurationType = {
+  uri?: string;
+  storageDisabled?: boolean;
+  status?: {
+    metadataInDatabase: number;
+    metadataOnStorage: number;
+    storageStatus: string;
+  };
+};

package/src/models/BulkyMetadataDocument.ts

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

package/src/models/BulkyMetadataPairType.ts

@@ -0,0 +1,12 @@
+import type { BulkyMapListType } from './BulkyMapListType';
+
+export type BulkyMetadataPairType = {
+  key: string;
+  value?: string;
+  maps?: BulkyMapListType;
+  start?: string;
+  end?: string;
+  stream?: number;
+  channel?: number;
+  itemTrack?: string;
+};

package/src/models/BulkyMetadataType.ts

@@ -0,0 +1,7 @@
+import type { BulkyMetadataPairType } from './BulkyMetadataPairType';
+import type { SiteIdType } from './SiteIdType';
+
+export type BulkyMetadataType = {
+  field?: Array<BulkyMetadataPairType>;
+  id?: SiteIdType;
+};

package/src/models/ByteRangeRequestDocument.ts

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

package/src/models/ByteRangeRequestType.ts

@@ -0,0 +1,7 @@
+import type { PartialFileDescriptorType } from './PartialFileDescriptorType';
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type ByteRangeRequestType = {
+  interval: TimeIntervalType;
+  descriptor: PartialFileDescriptorType;
+};

package/src/models/ByteRangeResponseDocument.ts

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

package/src/models/ByteRangeResponseType.ts

@@ -0,0 +1,4 @@
+export type ByteRangeResponseType = {
+  start: number;
+  end: number;
+};

package/src/models/CORSConfigurationDocument.ts

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

package/src/models/CORSConfigurationEntry.ts

@@ -0,0 +1,7 @@
+import type { CORSConfigurationEntryRequest } from './CORSConfigurationEntryRequest';
+import type { CORSConfigurationEntryResponse } from './CORSConfigurationEntryResponse';
+
+export type CORSConfigurationEntry = {
+  request: Array<CORSConfigurationEntryRequest>;
+  response: CORSConfigurationEntryResponse;
+};

package/src/models/CORSConfigurationEntryRequest.ts

@@ -0,0 +1,9 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+
+export type CORSConfigurationEntryRequest = {
+  method?: Array<string>;
+  origin?: Array<string>;
+  originRegex?: Array<string>;
+  pathRegex?: Array<string>;
+  headerRegex?: Array<KeyValuePairType>;
+};

package/src/models/CORSConfigurationEntryResponse.ts

@@ -0,0 +1,9 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+
+export type CORSConfigurationEntryResponse = {
+  allowOrigin: string;
+  allowMethods?: Array<string>;
+  allowHeaders?: Array<string>;
+  allowMaxAge?: number;
+  allowOtherHeader?: Array<KeyValuePairType>;
+};

package/src/models/CORSConfigurationType.ts

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

package/src/models/CallbackDocument.ts

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

package/src/models/CallbackDocumentType.ts

@@ -0,0 +1,5 @@
+export type CallbackDocumentType = {
+  name: string;
+  description: string;
+  script: string;
+};

package/src/models/CallbackLocationResourceType.ts

@@ -0,0 +1,3 @@
+export type CallbackLocationResourceType = {
+  uri: string;
+};

package/src/models/CarbonJobInfoType.ts

@@ -0,0 +1,33 @@
+import type { GUIDType } from './GUIDType';
+
+export type CarbonJobInfoType = {
+  Failures?: {
+    Warnings?: string;
+    Errors?: string;
+  };
+  Name: string;
+  GUID: GUIDType;
+  State: string;
+  Status: string;
+  'Progress.DWD': number;
+  'Speed.DBL'?: number;
+  Description: string;
+  User: string;
+  SourceDescription: string;
+  AgentIP: string;
+  'Priority.DWD': number;
+  'Capabilities.DWD'?: number;
+  'DeleteProcessedSource.DWD'?: number;
+  'DeleteRealAsset.DWD'?: number;
+  CheckInTime: string;
+  CheckInTime_CNLT: string;
+  CheckInTime_SCM: string;
+  'CheckInTimePrecise.QWD'?: number;
+  StartTime?: string;
+  StartTime_CNLT?: string;
+  StartTime_SCM?: string;
+  CompletedTime?: string;
+  CompletedTime_CNLT?: string;
+  CompletedTime_SCM?: string;
+  Error?: string;
+};

package/src/models/CarbonPreset.ts

@@ -0,0 +1,12 @@
+import type { AspectRatioType } from './AspectRatioType';
+import type { GUIDType } from './GUIDType';
+
+export type CarbonPreset = {
+  name: string;
+  description: string;
+  containerFormat: string;
+  videoCodec: string;
+  audioCodec: string;
+  displayAspectRatio: AspectRatioType;
+  GUID: GUIDType;
+};

package/src/models/CerifyType.ts

@@ -0,0 +1,10 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type CerifyType = {
+  address: string;
+  mediaLocation: Array<{
+    name: string;
+    storageMethod: Array<SiteIdType>;
+  }>;
+  cleanup?: boolean;
+};

package/src/models/ChangesetUUIDDocument.ts

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

package/src/models/ChangesetUUIDListDocument.ts

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

package/src/models/ChangesetUUIDListType.ts

@@ -0,0 +1,5 @@
+import type { ChangesetUUIDType } from './ChangesetUUIDType';
+
+export type ChangesetUUIDListType = {
+  changeset?: Array<ChangesetUUIDType>;
+};

package/src/models/ChangesetUUIDType.ts

@@ -0,0 +1,7 @@
+export type ChangesetUUIDType = {
+  uuid: string;
+  type: string;
+  id: string;
+  origin: string;
+  timestamp: string;
+};

package/src/models/ClipType.ts

@@ -0,0 +1,11 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { SubClipType } from './SubClipType';
+
+export type ClipType = {
+  subClip?: Array<SubClipType>;
+  setting?: Array<KeyValuePairType>;
+  uri?: string;
+  stream?: number;
+  id?: string;
+  track?: number;
+};

package/src/models/ClosedCaptionsExtraction.ts

@@ -0,0 +1,4 @@
+export type ClosedCaptionsExtraction = {
+  extract_closed_captions: string;
+  extract_from_video?: boolean;
+};

package/src/models/CloudConvertType.ts

@@ -0,0 +1,9 @@
+export type CloudConvertType = {
+  apiKey: string;
+  isSandbox: boolean;
+  apiHost: string;
+  script: string;
+  inputMethod: string;
+  publicAddress: string;
+  version?: string;
+};

package/src/models/CodecStatusType.ts

@@ -0,0 +1,6 @@
+import type { CodecType } from './CodecType';
+
+export type CodecStatusType = {
+  codec?: Array<CodecType>;
+  codecExtraTags?: string;
+};

package/src/models/CodecType.ts

@@ -0,0 +1,5 @@
+export type CodecType = {
+  encode?: boolean;
+  decode?: boolean;
+  name?: string;
+};

package/src/models/CollectionContentEntityTypeType.ts

@@ -0,0 +1 @@
+export type CollectionContentEntityTypeType = 'item' | 'library' | 'collection';

package/src/models/CollectionContentModeType.ts

@@ -0,0 +1 @@
+export type CollectionContentModeType = 'add' | 'remove' | 'move' | 'update';

package/src/models/CollectionContentType.ts

@@ -0,0 +1,15 @@
+import type { CollectionContentEntityTypeType } from './CollectionContentEntityTypeType';
+import type { CollectionContentModeType } from './CollectionContentModeType';
+import type { SimpleMetadataType } from './SimpleMetadataType';
+
+export type CollectionContentType = {
+  id?: string;
+  uri?: string;
+  type?: CollectionContentEntityTypeType;
+  reference?: string;
+  metadata?: SimpleMetadataType;
+  mode?: CollectionContentModeType;
+  before?: string;
+  after?: string;
+  addItems?: boolean;
+};

package/src/models/CollectionCriterionType.ts

@@ -0,0 +1,9 @@
+import type { CriterionType } from './CriterionType';
+import type { ItemCriterionType } from './ItemCriterionType';
+import type { RelationType } from './RelationType';
+
+export type CollectionCriterionType = CriterionType & {
+  relation?: RelationType;
+  collection?: Array<CollectionCriterionType>;
+  item?: ItemCriterionType;
+};

package/src/models/CollectionDocument.ts

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

package/src/models/CollectionListDocument.ts

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

package/src/models/CollectionListType.ts

@@ -0,0 +1,13 @@
+import type { AutocompleteResponseType } from './AutocompleteResponseType';
+import type { CollectionType } from './CollectionType';
+import type { FacetType } from './FacetType';
+import type { SuggestionResultType } from './SuggestionResultType';
+
+export type CollectionListType = {
+  hits?: number;
+  collection?: Array<CollectionType>;
+  facet?: Array<FacetType>;
+  suggestion?: Array<SuggestionResultType>;
+  autocomplete?: Array<AutocompleteResponseType>;
+  nextCursor?: string;
+};

package/src/models/CollectionReorderDocument.ts

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

package/src/models/CollectionReorderEntryType.ts

@@ -0,0 +1,6 @@
+export type CollectionReorderEntryType = {
+  id?: string;
+  reference?: string;
+  before?: string;
+  after?: string;
+};

package/src/models/CollectionReorderType.ts

@@ -0,0 +1,7 @@
+import type { CollectionReorderEntryType } from './CollectionReorderEntryType';
+
+export type CollectionReorderType = {
+  item?: CollectionReorderEntryType;
+  collection?: CollectionReorderEntryType;
+  library?: CollectionReorderEntryType;
+};

package/src/models/CollectionSynchronizeType.ts

@@ -0,0 +1,23 @@
+import type { AccessControlSynchronizeType } from './AccessControlSynchronizeType';
+import type { HasSubEntityType } from './HasSubEntityType';
+import type { MetadataFieldGroupType } from './MetadataFieldGroupType';
+import type { MetadataSynchronizeType } from './MetadataSynchronizeType';
+import type { SiteIdType } from './SiteIdType';
+
+export type CollectionSynchronizeType = {
+  delete: boolean;
+  create: boolean;
+  id: SiteIdType;
+  name?: string;
+  complete?: boolean;
+  metadata?: MetadataSynchronizeType;
+  access?: Array<AccessControlSynchronizeType>;
+  hasItem?: Array<HasSubEntityType>;
+  hasLibrary?: Array<SiteIdType>;
+  hasCollection?: Array<HasSubEntityType>;
+  partOfCollection?: Array<SiteIdType>;
+  deletedHasItem?: Array<SiteIdType>;
+  deletedHasLibrary?: Array<SiteIdType>;
+  deletedHasCollection?: Array<SiteIdType>;
+  metadataGroup?: Array<MetadataFieldGroupType>;
+};

package/src/models/CollectionType.ts

@@ -0,0 +1,22 @@
+import type { AccessControlMergedType } from './AccessControlMergedType';
+import type { CollectionContentType } from './CollectionContentType';
+import type { ExternalIdentifierType } from './ExternalIdentifierType';
+import type { GenericType } from './GenericType';
+import type { MetadataType } from './MetadataType';
+import type { ProjectType } from './ProjectType';
+import type { SequenceType } from './SequenceType';
+import type { SiteIdType } from './SiteIdType';
+
+export type CollectionType = {
+  loc?: string;
+  id?: SiteIdType;
+  name?: string;
+  content?: Array<CollectionContentType>;
+  project?: ProjectType;
+  sequence?: Array<SequenceType>;
+  metadata?: MetadataType;
+  terse?: GenericType;
+  'merged-access'?: AccessControlMergedType;
+  externalId?: Array<ExternalIdentifierType>;
+  absoluteTime?: boolean;
+};

package/src/models/CompType.ts

@@ -0,0 +1,5 @@
+export type CompType = {
+  name: string;
+  siteId?: string;
+  version: string;
+};

package/src/models/ComplexJobAnalyzeType.ts

@@ -0,0 +1,20 @@
+import type { AnalyzeAudioChannelType } from './AnalyzeAudioChannelType';
+import type { AnalyzeAudioType } from './AnalyzeAudioType';
+import type { AnalyzeVideoType } from './AnalyzeVideoType';
+import type { HighlighterType } from './HighlighterType';
+import type { SmartCropType } from './SmartCropType';
+
+export type ComplexJobAnalyzeType = {
+  channel?: Array<AnalyzeAudioChannelType>;
+  audio?: AnalyzeAudioType;
+  video?: AnalyzeVideoType;
+  highlighter?: HighlighterType;
+  smartcrop?: SmartCropType;
+  metadataUri: string;
+  blackThresh?: number;
+  blackPercentage?: number;
+  barsThresh?: number;
+  barsPercentage?: number;
+  freezeThresh?: number;
+  freezeTime?: number;
+};

package/src/models/ComplexJobAtomType.ts

@@ -0,0 +1,6 @@
+import type { UMIDType } from './UMIDType';
+
+export type ComplexJobAtomType = {
+  uri: string;
+  sourcePackageID?: UMIDType;
+};

package/src/models/ComplexJobAudioChannelMapInputType.ts

@@ -0,0 +1,5 @@
+import type { ComplexJobInputType } from './ComplexJobInputType';
+
+export type ComplexJobAudioChannelMapInputType = ComplexJobInputType & {
+  channel: number;
+};

package/src/models/ComplexJobAudioChannelSequenceInputType.ts

@@ -0,0 +1,5 @@
+import type { ComplexJobAudioChannelMapInputType } from './ComplexJobAudioChannelMapInputType';
+
+export type ComplexJobAudioChannelSequenceInputType = {
+  input: Array<ComplexJobAudioChannelMapInputType>;
+};

package/src/models/ComplexJobAudioOutputType.ts

@@ -0,0 +1,7 @@
+import type { ComplexJobOutputType } from './ComplexJobOutputType';
+
+export type ComplexJobAudioOutputType = ComplexJobOutputType & {
+  thumbnailUri?: Array<string>;
+  channelLayout?: number;
+  channelLayoutName?: string;
+};

package/src/models/ComplexJobBulkyMetadataRequestType.ts

@@ -0,0 +1,4 @@
+export type ComplexJobBulkyMetadataRequestType = {
+  targetUri: string;
+  failIfTimecodeNotPresent?: boolean;
+};

package/src/models/ComplexJobDocument.ts

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

package/src/models/ComplexJobInputType.ts

@@ -0,0 +1,9 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { TransitionType } from './TransitionType';
+
+export type ComplexJobInputType = {
+  id: number;
+  stream: number;
+  transition?: TransitionType;
+  setting?: Array<KeyValuePairType>;
+};

package/src/models/ComplexJobMixInputType.ts

@@ -0,0 +1,5 @@
+import type { ComplexJobMixType } from './ComplexJobMixType';
+
+export type ComplexJobMixInputType = {
+  mix: Array<ComplexJobMixType>;
+};

package/src/models/ComplexJobMixType.ts

@@ -0,0 +1,9 @@
+import type { EffectType } from './EffectType';
+
+export type ComplexJobMixType = {
+  effect?: Array<EffectType>;
+  id: number;
+  stream: number;
+  channel: number;
+  gain: number;
+};

package/src/models/ComplexJobOTIFType.ts

@@ -0,0 +1,12 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { NameURIPairType } from './NameURIPairType';
+
+export type ComplexJobOTIFType = {
+  trackerPlugin: string;
+  versionMajor: number;
+  versionMinor: number;
+  versionPatch: number;
+  bulkyMetadataURI?: string;
+  configuration?: Array<KeyValuePairType>;
+  resource?: Array<NameURIPairType>;
+};

package/src/models/ComplexJobOutputFormatType.ts

@@ -0,0 +1,34 @@
+import type { ComplexJobAtomType } from './ComplexJobAtomType';
+import type { DMS1Type } from './DMS1Type';
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { MXFPackagesType } from './MXFPackagesType';
+import type { OverlayType } from './OverlayType';
+import type { SequenceRangeType } from './SequenceRangeType';
+import type { TextOverlayType } from './TextOverlayType';
+import type { TimeCodeType } from './TimeCodeType';
+
+export type ComplexJobOutputFormatType = {
+  id: number;
+  containerFormat: string;
+  overlay?: Array<OverlayType>;
+  textOverlay?: Array<TextOverlayType>;
+  dms1Source?: {
+    demuxerId?: number;
+    metadata?: DMS1Type;
+  };
+  initialSMPTETimecode?: string;
+  startTimecode?: number;
+  roundedTimeBase?: number;
+  dropFrame?: boolean;
+  requireFaststart?: boolean;
+  muxrate?: number;
+  pfdTargetUri?: string;
+  mxfPackages?: MXFPackagesType;
+  metadata?: Array<KeyValuePairType>;
+  clipName?: string;
+  maxChunkDuration?: TimeCodeType;
+  setting?: Array<KeyValuePairType>;
+  uri?: string;
+  range?: SequenceRangeType;
+  atom?: Array<ComplexJobAtomType>;
+};

package/src/models/ComplexJobOutputType.ts

@@ -0,0 +1,21 @@
+import type { ComplexJobOTIFType } from './ComplexJobOTIFType';
+import type { EDLType } from './EDLType';
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { TimeBaseType } from './TimeBaseType';
+import type { TimeCodeType } from './TimeCodeType';
+
+export type ComplexJobOutputType = {
+  id?: Array<number>;
+  start?: TimeCodeType;
+  codec?: string;
+  codecTag?: number;
+  codecTagString?: string;
+  codecName?: string;
+  bitrate?: number;
+  timeBase?: TimeBaseType;
+  preset?: Array<string>;
+  edl?: EDLType;
+  setting?: Array<KeyValuePairType>;
+  objectTracking?: ComplexJobOTIFType;
+  metadata?: Array<KeyValuePairType>;
+};

package/src/models/ComplexJobSubtitleOutputType.ts

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

package/src/models/ComplexJobType.ts

@@ -0,0 +1,42 @@
+import type { ComplexJobAnalyzeType } from './ComplexJobAnalyzeType';
+import type { ComplexJobAudioChannelMapInputType } from './ComplexJobAudioChannelMapInputType';
+import type { ComplexJobAudioChannelSequenceInputType } from './ComplexJobAudioChannelSequenceInputType';
+import type { ComplexJobBulkyMetadataRequestType } from './ComplexJobBulkyMetadataRequestType';
+import type { ComplexJobInputType } from './ComplexJobInputType';
+import type { ComplexJobMixInputType } from './ComplexJobMixInputType';
+import type { ComplexJobOutputFormatType } from './ComplexJobOutputFormatType';
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { PartialFileDemuxerInfoType } from './PartialFileDemuxerInfoType';
+import type { SequenceRangeType } from './SequenceRangeType';
+import type { TimeCodeType } from './TimeCodeType';
+import type { TimeIntervalType } from './TimeIntervalType';
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type ComplexJobType = TranscoderJobType & {
+  input?: Array<{
+    id: number;
+    uri?: Array<string>;
+    range?: Array<SequenceRangeType>;
+    partialFile?: PartialFileDemuxerInfoType;
+    interval?: TimeIntervalType;
+    intervalIsDts?: boolean;
+    dms1TargetUri?: string;
+    faststartDuration?: TimeCodeType & {
+      override: boolean;
+    };
+    bulkyMetadataRequest?: ComplexJobBulkyMetadataRequestType;
+    scanForStartPTS?: number;
+    doubleDurationHack?: number;
+    demuxerSetting?: Array<KeyValuePairType>;
+    analyze?: ComplexJobAnalyzeType;
+    pageno?: number;
+  }>;
+  output?: Array<ComplexJobOutputFormatType>;
+  connection?: Array<{
+    pid?: number;
+    input?: Array<ComplexJobInputType>;
+    audioChannelMapInput?: Array<ComplexJobAudioChannelMapInputType>;
+    audioChannelSequenceInput?: Array<ComplexJobAudioChannelSequenceInputType>;
+    audioMixInput?: Array<ComplexJobMixInputType>;
+  }>;
+};