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

package/src/models/ShapeDeductionJobType.ts

@@ -0,0 +1,18 @@
+import type { ClosedCaptionsExtraction } from './ClosedCaptionsExtraction';
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { SequenceRangeType } from './SequenceRangeType';
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type ShapeDeductionJobType = TranscoderJobType & {
+  input?: Array<{
+    id?: string;
+    uri?: string;
+    range?: Array<SequenceRangeType>;
+    image?: boolean;
+    useMediaInfo?: boolean;
+    verbose?: boolean;
+    setting?: Array<KeyValuePairType>;
+    pageno?: number;
+    closedCaptionsExtraction?: ClosedCaptionsExtraction;
+  }>;
+};

package/src/models/ShapeDeductionResponse.ts

@@ -0,0 +1,9 @@
+import type { SequenceRangeType } from './SequenceRangeType';
+import type { ShapeType } from './ShapeType';
+
+export type ShapeDeductionResponse = {
+  id: string;
+  uri?: string;
+  range?: Array<SequenceRangeType>;
+  shape: ShapeType;
+};

package/src/models/ShapeDocument.ts

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

package/src/models/ShapeListDocument.ts

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

package/src/models/ShapeListType.ts

@@ -0,0 +1,10 @@
+import type { FacetType } from './FacetType';
+import type { ShapeType } from './ShapeType';
+import type { SuggestionResultType } from './SuggestionResultType';
+
+export type ShapeListType = {
+  hits?: number;
+  shape?: Array<ShapeType>;
+  facet?: Array<FacetType>;
+  suggestion?: Array<SuggestionResultType>;
+};

package/src/models/ShapeSearchDocument.ts

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

package/src/models/ShapeSearchType.ts

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

package/src/models/ShapeSynchronizeType.ts

@@ -0,0 +1,13 @@
+import type { ComponentSynchronizeType } from './ComponentSynchronizeType';
+import type { ShapeTagSynchronizeType } from './ShapeTagSynchronizeType';
+import type { SiteIdType } from './SiteIdType';
+
+export type ShapeSynchronizeType = {
+  delete: boolean;
+  create: boolean;
+  essenceVersion?: number;
+  id: SiteIdType;
+  component?: Array<ComponentSynchronizeType>;
+  tag?: Array<ShapeTagSynchronizeType>;
+  mimeType?: Array<string>;
+};

package/src/models/ShapeTagSynchronizeType.ts

@@ -0,0 +1,6 @@
+import type { TranscodePresetType } from './TranscodePresetType';
+
+export type ShapeTagSynchronizeType = {
+  name: string;
+  preset: TranscodePresetType;
+};

package/src/models/ShapeType.ts

@@ -0,0 +1,28 @@
+import type { AudioComponentType } from './AudioComponentType';
+import type { BinaryComponentType } from './BinaryComponentType';
+import type { ContainerComponentType } from './ContainerComponentType';
+import type { DescriptorComponentType } from './DescriptorComponentType';
+import type { SimpleMetadataType } from './SimpleMetadataType';
+import type { SiteIdType } from './SiteIdType';
+import type { SubtitleComponentType } from './SubtitleComponentType';
+import type { UUIDType } from './UUIDType';
+import type { VideoComponentType } from './VideoComponentType';
+
+export type ShapeType = {
+  id?: SiteIdType;
+  created?: string;
+  essenceVersion?: number;
+  tag?: Array<string>;
+  mimeType?: Array<string>;
+  uuid?: UUIDType;
+  binaryComponent?: Array<BinaryComponentType>;
+  containerComponent?: ContainerComponentType;
+  descriptorComponent?: Array<DescriptorComponentType>;
+  audioComponent?: Array<AudioComponentType>;
+  videoComponent?: Array<VideoComponentType>;
+  subtitleComponent?: Array<SubtitleComponentType>;
+  metadata?: SimpleMetadataType;
+  item?: Array<{
+    id?: SiteIdType;
+  }>;
+};

package/src/models/SigniantType.ts

@@ -0,0 +1,7 @@
+export type SigniantType = {
+  tag: string;
+  url: string;
+  username: string;
+  password: string;
+  description?: string;
+};

package/src/models/SimpleMetadataDocument.ts

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

package/src/models/SimpleMetadataType.ts

@@ -0,0 +1,6 @@
+export type SimpleMetadataType = {
+  field?: Array<{
+    key: string;
+    value: string;
+  }>;
+};

package/src/models/SimpleSearchFieldType.ts

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

package/src/models/SimpleSearchOperationType.ts

@@ -0,0 +1 @@
+export type SimpleSearchOperationType = 'AND' | 'OR' | 'NOT';

package/src/models/SimpleSearchOperatorType.ts

@@ -0,0 +1,7 @@
+import type { SimpleSearchFieldType } from './SimpleSearchFieldType';
+import type { SimpleSearchOperationType } from './SimpleSearchOperationType';
+
+export type SimpleSearchOperatorType = {
+  field?: Array<SimpleSearchFieldType>;
+  operation: SimpleSearchOperationType;
+};

package/src/models/SimpleSearchType.ts

@@ -0,0 +1,12 @@
+import type { SimpleSearchFieldType } from './SimpleSearchFieldType';
+import type { SimpleSearchOperatorType } from './SimpleSearchOperatorType';
+import type { SortingOrderType } from './SortingOrderType';
+
+export type SimpleSearchType = {
+  sort?: Array<{
+    field: string;
+    order: SortingOrderType;
+  }>;
+  field?: Array<SimpleSearchFieldType>;
+  operator?: SimpleSearchOperatorType;
+};

package/src/models/SimpleTimelineDocument.ts

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

package/src/models/SimpleTimelineType.ts

@@ -0,0 +1,12 @@
+import type { SiteIdType } from './SiteIdType';
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type SimpleTimelineType = {
+  destinationURI: string;
+  source?: Array<{
+    sequence: number;
+    interval: TimeIntervalType;
+    uri?: string;
+    siteId?: SiteIdType;
+  }>;
+};

package/src/models/SiteDefinitionDocument.ts

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

package/src/models/SiteDefinitionType.ts

@@ -0,0 +1,8 @@
+import type { SyncPolicyType } from './SyncPolicyType';
+
+export type SiteDefinitionType = {
+  url: string;
+  username: string;
+  password: string;
+  syncPolicy: SyncPolicyType;
+};

package/src/models/SiteIdType.ts

@@ -0,0 +1 @@
+export type SiteIdType = string;

package/src/models/SiteInitializationStatusDocument.ts

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

package/src/models/SiteInitializationStatusType.ts

@@ -0,0 +1,8 @@
+export type SiteInitializationStatusType = {
+  started: string;
+  itemsProcessed: number;
+  collectionsProcessed: number;
+  librariesProcessed: number;
+  usersProcessed: number;
+  groupsProcessed: number;
+};

package/src/models/SiteRuleDocument.ts

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

package/src/models/SiteRuleListDocument.ts

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

package/src/models/SiteRuleListType.ts

@@ -0,0 +1,5 @@
+import type { SiteRuleType } from './SiteRuleType';
+
+export type SiteRuleListType = {
+  siteRule?: Array<SiteRuleType>;
+};

package/src/models/SiteRuleType.ts

@@ -0,0 +1,14 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type SiteRuleType = {
+  id?: SiteIdType;
+  site?: string;
+  metadata?: boolean;
+  shape?: Array<string>;
+  groups?: boolean;
+  access?: boolean;
+  files?: boolean;
+  targetStorage?: string;
+  localTargetStorage?: string;
+  deleted?: boolean;
+};

package/src/models/SlaveAuthDocument.ts

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

package/src/models/SlaveAuthInfoDocument.ts

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

package/src/models/SlaveAuthInfoType.ts

@@ -0,0 +1,4 @@
+export type SlaveAuthInfoType = {
+  masterHost: Array<string>;
+  slaveId: string;
+};

package/src/models/SlaveAuthType.ts

@@ -0,0 +1,11 @@
+import type { VersionType } from './VersionType';
+
+export type SlaveAuthType = {
+  slaveId: string;
+  slaveIp: string;
+  slaveMac: string;
+  requestSourceIp?: string;
+  slaveInstanceName?: string;
+  hostname?: string;
+  licenseStatus?: VersionType;
+};

package/src/models/SlaveLicenseDocument.ts

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

package/src/models/SlaveLicenseListDocument.ts

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

package/src/models/SlaveLicenseListType.ts

@@ -0,0 +1,5 @@
+import type { SlaveLicenseType } from './SlaveLicenseType';
+
+export type SlaveLicenseListType = {
+  slaveLicense?: Array<SlaveLicenseType>;
+};

package/src/models/SlaveLicenseType.ts

@@ -0,0 +1,10 @@
+import type { LicenseType } from './LicenseType';
+
+export type SlaveLicenseType = LicenseType & {
+  masterIdentifier?: string;
+  slaveIdentifier?: string;
+  slaveInstances?: number;
+  validityTime?: string;
+  validityPeriod?: number;
+  id?: string;
+};

package/src/models/SlaveListDocument.ts

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

package/src/models/SlaveListType.ts

@@ -0,0 +1,5 @@
+import type { SlaveType } from './SlaveType';
+
+export type SlaveListType = {
+  slave?: Array<SlaveType>;
+};

package/src/models/SlaveType.ts

@@ -0,0 +1,10 @@
+export type SlaveType = {
+  Id: string;
+  slaveId: string;
+  slaveIp: string;
+  slaveMac: string;
+  requestSourceIp?: string;
+  slaveInstanceName?: string;
+  hostname?: string;
+  lastUpdated: string;
+};

package/src/models/SmartCropType.ts

@@ -0,0 +1,3 @@
+export type SmartCropType = {
+  aspect: string;
+};

package/src/models/SolrAddType.ts

@@ -0,0 +1,5 @@
+import type { SolrDocumentType } from './SolrDocumentType';
+
+export type SolrAddType = {
+  doc?: Array<SolrDocumentType>;
+};

package/src/models/SolrDocumentType.ts

@@ -0,0 +1,6 @@
+export type SolrDocumentType = {
+  field?: Array<{
+    name: string;
+    value?: string;
+  }>;
+};

package/src/models/SortingOrderType.ts

@@ -0,0 +1 @@
+export type SortingOrderType = 'ascending' | 'descending';

package/src/models/StatsDRecieverType.ts

@@ -0,0 +1,6 @@
+import type { AddressPortType } from './AddressPortType';
+
+export type StatsDRecieverType = {
+  destination: AddressPortType;
+  prefix?: string;
+};

package/src/models/StatsdReporterType.ts

@@ -0,0 +1,8 @@
+import type { MetricsReporterType } from './MetricsReporterType';
+
+export type StatsdReporterType = MetricsReporterType & {
+  host?: string;
+  port?: number;
+  prefix?: string;
+  tags?: boolean;
+};

package/src/models/StorageCriteriaType.ts

@@ -0,0 +1 @@
+export type StorageCriteriaType = 'bandwidth' | 'capacity';

package/src/models/StorageDocument.ts

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

package/src/models/StorageFileSequenceType.ts

@@ -0,0 +1,4 @@
+export type StorageFileSequenceType = {
+  regex: string;
+  numGroup?: number;
+};

package/src/models/StorageFilterType.ts

@@ -0,0 +1,4 @@
+export type StorageFilterType = {
+  id?: Array<string>;
+  vxaId?: Array<string>;
+};

package/src/models/StorageGroupDocument.ts

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

package/src/models/StorageGroupListDocument.ts

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

package/src/models/StorageGroupListType.ts

@@ -0,0 +1,5 @@
+import type { StorageGroupType } from './StorageGroupType';
+
+export type StorageGroupListType = {
+  group?: Array<StorageGroupType>;
+};

package/src/models/StorageGroupType.ts

@@ -0,0 +1,12 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { StorageType } from './StorageType';
+
+export type StorageGroupType = {
+  name?: string;
+  data?: Array<{
+    key: string;
+    value: string;
+  }>;
+  storage?: Array<StorageType>;
+  resourceTag?: Array<KeyValuePairType>;
+};

package/src/models/StorageImportDocument.ts

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

package/src/models/StorageImportType.ts

@@ -0,0 +1,5 @@
+import type { FileImportDefType } from './FileImportDefType';
+
+export type StorageImportType = {
+  file?: Array<FileImportDefType>;
+};

package/src/models/StorageListDocument.ts

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

package/src/models/StorageListType.ts

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

package/src/models/StorageMappingType.ts

@@ -0,0 +1,6 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type StorageMappingType = {
+  path: string;
+  id: SiteIdType;
+};

package/src/models/StorageMethodListDocument.ts

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

package/src/models/StorageMethodListType.ts

@@ -0,0 +1,5 @@
+import type { StorageMethodType } from './StorageMethodType';
+
+export type StorageMethodListType = {
+  method?: Array<StorageMethodType>;
+};

package/src/models/StorageMethodType.ts

@@ -0,0 +1,23 @@
+import type { SimpleMetadataType } from './SimpleMetadataType';
+import type { SiteIdType } from './SiteIdType';
+
+export type StorageMethodType = {
+  loc?: string;
+  id?: SiteIdType;
+  uri: string;
+  bandwidth?: number;
+  read: boolean;
+  write: boolean;
+  browse: boolean;
+  lastSuccess?: string;
+  lastFailure?: string;
+  failureMessage?: string;
+  type?: string;
+  metadata?: SimpleMetadataType;
+  resourceTag?: Array<{
+    key: string;
+    value: string;
+    sourceName?: string;
+    sourceType?: string;
+  }>;
+};

package/src/models/StorageRuleDocument.ts

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

package/src/models/StorageRuleType.ts

@@ -0,0 +1,30 @@
+import type { EmptyString } from './EmptyString';
+import type { SiteIdType } from './SiteIdType';
+import type { StorageCriteriaType } from './StorageCriteriaType';
+
+export type StorageRuleType = {
+  storageCount?: number;
+  priority?: Array<
+    StorageCriteriaType & {
+      level: number;
+    }
+  >;
+  inherited?: boolean;
+  storage?: Array<SiteIdType>;
+  group?: Array<string>;
+  not?: {
+    storage?: Array<SiteIdType>;
+    group?: Array<string>;
+    any?: EmptyString;
+  };
+  pool?: {
+    storage?: Array<SiteIdType>;
+    group?: Array<string>;
+  };
+  appliesTo?: {
+    id?: string;
+    type?: string;
+  };
+  precedence?: string;
+  id?: string;
+};

package/src/models/StorageRulesDocument.ts

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

package/src/models/StorageRulesType.ts

@@ -0,0 +1,6 @@
+import type { StorageRuleType } from './StorageRuleType';
+
+export type StorageRulesType = {
+  default?: StorageRuleType;
+  tag?: Array<StorageRuleType>;
+};

package/src/models/StorageType.ts

@@ -0,0 +1,35 @@
+import type { SimpleMetadataType } from './SimpleMetadataType';
+import type { SiteIdType } from './SiteIdType';
+import type { StorageFileSequenceType } from './StorageFileSequenceType';
+import type { StorageMethodType } from './StorageMethodType';
+
+export type StorageType = {
+  id?: SiteIdType;
+  state?: string;
+  priority?: string;
+  type?: string;
+  capacity?: number;
+  freeCapacity?: number;
+  bandwidth?: number;
+  timestamp?: string;
+  method?: Array<StorageMethodType>;
+  metadata?: SimpleMetadataType;
+  lowWatermark?: number;
+  highWatermark?: number;
+  lowWatermarkPercentage?: number;
+  highWatermarkPercentage?: number;
+  autoDetect?: boolean;
+  bean?: string;
+  showImportables?: boolean;
+  projection?: string;
+  scanInterval?: number;
+  archiveScript?: string;
+  sequence?: Array<StorageFileSequenceType>;
+  sequenceTimeout?: number;
+  resourceTag?: Array<{
+    key: string;
+    value: string;
+    sourceName?: string;
+    sourceType?: string;
+  }>;
+};

package/src/models/StreamIntervalType.ts

@@ -0,0 +1,6 @@
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type StreamIntervalType = TimeIntervalType & {
+  index: number;
+  numberOfFrames: number;
+};

package/src/models/SubClipType.ts

@@ -0,0 +1,5 @@
+export type SubClipType = {
+  id: number;
+  start: number;
+  length: number;
+};

package/src/models/SubtitleClipType.ts

@@ -0,0 +1,6 @@
+import type { TextRenditionType } from './TextRenditionType';
+
+export type SubtitleClipType = TextRenditionType & {
+  id: number;
+  length: number;
+};

package/src/models/SubtitleComponentDocument.ts

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

package/src/models/SubtitleComponentType.ts

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

package/src/models/SuggestionResultType.ts

@@ -0,0 +1,4 @@
+export type SuggestionResultType = {
+  term: string;
+  suggestion?: Array<string>;
+};

package/src/models/SuggestionSearchType.ts

@@ -0,0 +1,4 @@
+export type SuggestionSearchType = {
+  maximumSuggestions?: number;
+  accuracy?: number;
+};

package/src/models/SupportedProtocolsDocument.ts

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