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

package/src/models/AAFGeneratorJobDocument.ts

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

package/src/models/AAFGeneratorJobType.ts

@@ -0,0 +1,6 @@
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type AAFGeneratorJobType = TranscoderJobType & {
+  aaf?: string;
+  xml?: string;
+};

package/src/models/AAFGeneratorResponse.ts

@@ -0,0 +1,4 @@
+export type AAFGeneratorResponse = {
+  aaf?: string;
+  xml?: string;
+};

package/src/models/AccessControlDocument.ts

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

package/src/models/AccessControlListDocument.ts

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

package/src/models/AccessControlListType.ts

@@ -0,0 +1,5 @@
+import type { AccessControlType } from './AccessControlType';
+
+export type AccessControlListType = {
+  access?: Array<AccessControlType>;
+};

package/src/models/AccessControlMergedDocument.ts

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

package/src/models/AccessControlMergedGroupDocument.ts

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

package/src/models/AccessControlMergedGroupType.ts

@@ -0,0 +1,17 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type AccessControlMergedGroupType = {
+  access?: Array<{
+    group: string;
+    grantor?: string;
+    permission: string;
+    type: string;
+    extradata?: string;
+    collection?: SiteIdType;
+    library?: SiteIdType;
+    originalDisabledGrantor?: Array<string>;
+    rank?: number;
+    id?: SiteIdType;
+    effectivePermission?: string;
+  }>;
+};

package/src/models/AccessControlMergedType.ts

@@ -0,0 +1,31 @@
+import type { MetadataFieldGroupPermissionType } from './MetadataFieldGroupPermissionType';
+import type { MetadataFieldPermissionType } from './MetadataFieldPermissionType';
+import type { SiteIdType } from './SiteIdType';
+
+export type AccessControlMergedType = {
+  query?: {
+    username: string;
+    permission: string;
+    type: string;
+    extradata?: string;
+    item: SiteIdType;
+  };
+  access?: Array<{
+    grantor?: string;
+    permission: string;
+    type: string;
+    extradata?: string;
+    group?: string;
+    collection?: SiteIdType;
+    library?: SiteIdType;
+    originalDisabledGrantor?: Array<string>;
+    superUser?: boolean;
+    rank: number;
+    matches?: boolean;
+    id?: SiteIdType;
+    username?: string;
+    effectivePermission?: string;
+  }>;
+  fieldGroup?: Array<MetadataFieldGroupPermissionType>;
+  field?: Array<MetadataFieldPermissionType>;
+};

package/src/models/AccessControlMetadataType.ts

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

package/src/models/AccessControlShapeType.ts

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

package/src/models/AccessControlSynchronizeType.ts

@@ -0,0 +1,7 @@
+import type { AccessControlType } from './AccessControlType';
+
+export type AccessControlSynchronizeType = {
+  delete: boolean;
+  create: boolean;
+  document: AccessControlType;
+};

package/src/models/AccessControlType.ts

@@ -0,0 +1,26 @@
+import type { AccessControlMetadataType } from './AccessControlMetadataType';
+import type { AccessControlShapeType } from './AccessControlShapeType';
+import type { AccessControlUriType } from './AccessControlUriType';
+import type { AppliesToType } from './AppliesToType';
+import type { GroupType } from './GroupType';
+import type { SiteIdType } from './SiteIdType';
+import type { UserType } from './UserType';
+
+export type AccessControlType = {
+  loc?: string;
+  grantor?: string;
+  recursive?: boolean;
+  appliesTo?: Array<AppliesToType>;
+  permission: string;
+  priority?: number;
+  operation?: {
+    metadata?: AccessControlMetadataType;
+    shape?: AccessControlShapeType;
+    uri?: AccessControlUriType;
+  };
+  group?: string;
+  groupType?: GroupType;
+  user?: string;
+  userType?: UserType;
+  id?: SiteIdType;
+};

package/src/models/AccessControlUriType.ts

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

package/src/models/AccessKeyDocument.ts

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

package/src/models/AccessKeyListDocument.ts

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

package/src/models/AccessKeyListType.ts

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

package/src/models/AccessKeyType.ts

@@ -0,0 +1,7 @@
+export type AccessKeyType = {
+  id?: string;
+  name?: string;
+  secret?: string;
+  status: 'ACTIVE' | 'INACTIVE';
+  created: string;
+};

package/src/models/AddressPortType.ts

@@ -0,0 +1,5 @@
+export type AddressPortType = {
+  port: number;
+  host?: string;
+  address?: string;
+};

package/src/models/AmountType.ts

@@ -0,0 +1,4 @@
+export type AmountType = {
+  unit?: string;
+  value?: number;
+};

package/src/models/AnalyzeAudioChannelType.ts

@@ -0,0 +1,6 @@
+export type AnalyzeAudioChannelType = {
+  tone?: Array<number>;
+  stream?: number;
+  channel?: number;
+  thresh?: number;
+};

package/src/models/AnalyzeAudioJobType.ts

@@ -0,0 +1,5 @@
+import type { OtifPresetType } from './OtifPresetType';
+
+export type AnalyzeAudioJobType = {
+  otif?: Array<OtifPresetType>;
+};

package/src/models/AnalyzeAudioType.ts

@@ -0,0 +1,5 @@
+import type { ComplexJobOTIFType } from './ComplexJobOTIFType';
+
+export type AnalyzeAudioType = {
+  otif?: Array<ComplexJobOTIFType>;
+};

package/src/models/AnalyzeJobDocument.ts

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

package/src/models/AnalyzeJobType.ts

@@ -0,0 +1,25 @@
+import type { AnalyzeAudioChannelType } from './AnalyzeAudioChannelType';
+import type { AnalyzeAudioJobType } from './AnalyzeAudioJobType';
+import type { AnalyzeVideoJobType } from './AnalyzeVideoJobType';
+import type { HighlighterType } from './HighlighterType';
+import type { SmartCropType } from './SmartCropType';
+
+export type AnalyzeJobType = {
+  black?: {
+    threshold?: number;
+    percentage?: number;
+  };
+  bars?: {
+    threshold?: number;
+    percentage?: number;
+  };
+  freeze?: {
+    threshold?: number;
+    time?: number;
+  };
+  channel?: Array<AnalyzeAudioChannelType>;
+  audio?: AnalyzeAudioJobType;
+  video?: AnalyzeVideoJobType;
+  highlighter?: HighlighterType;
+  smartcrop?: SmartCropType;
+};

package/src/models/AnalyzePresetDocument.ts

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

package/src/models/AnalyzePresetListDocument.ts

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

package/src/models/AnalyzePresetListType.ts

@@ -0,0 +1,5 @@
+import type { AnalyzePresetType } from './AnalyzePresetType';
+
+export type AnalyzePresetListType = {
+  preset?: Array<AnalyzePresetType>;
+};

package/src/models/AnalyzePresetType.ts

@@ -0,0 +1,8 @@
+import type { AnalyzeJobType } from './AnalyzeJobType';
+import type { KeyValueType } from './KeyValueType';
+
+export type AnalyzePresetType = {
+  name?: string;
+  vidispine: AnalyzeJobType;
+  data?: Array<KeyValueType>;
+};

package/src/models/AnalyzeVideoJobType.ts

@@ -0,0 +1,5 @@
+import type { OtifPresetType } from './OtifPresetType';
+
+export type AnalyzeVideoJobType = {
+  otif?: Array<OtifPresetType>;
+};

package/src/models/AnalyzeVideoType.ts

@@ -0,0 +1,5 @@
+import type { ComplexJobOTIFType } from './ComplexJobOTIFType';
+
+export type AnalyzeVideoType = {
+  otif?: Array<ComplexJobOTIFType>;
+};

package/src/models/AppliesToType.ts

@@ -0,0 +1 @@
+export type AppliesToType = {};

package/src/models/AppliesToValueType.ts

@@ -0,0 +1,4 @@
+export type AppliesToValueType = {
+  recursive?: boolean;
+  value?: string;
+};

package/src/models/AspectRatioType.ts

@@ -0,0 +1,4 @@
+export type AspectRatioType = {
+  horizontal: number;
+  vertical: number;
+};

package/src/models/AssetMappingType.ts

@@ -0,0 +1,7 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type AssetMappingType = {
+  id: string;
+  item: SiteIdType;
+  shape?: SiteIdType;
+};

package/src/models/AudioClipType.ts

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

package/src/models/AudioComponentDocument.ts

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

package/src/models/AudioComponentType.ts

@@ -0,0 +1,11 @@
+import type { AudioMediaInfoType } from './AudioMediaInfoType';
+import type { MediaComponentType } from './MediaComponentType';
+
+export type AudioComponentType = MediaComponentType & {
+  channelCount: number;
+  channelLayout?: number;
+  sampleFormat?: string;
+  frameSize?: number;
+  blockAlign?: number;
+  mediaInfo?: AudioMediaInfoType;
+};

package/src/models/AudioMediaInfoType.ts

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

package/src/models/AudioOutputType.ts

@@ -0,0 +1,10 @@
+import type { TimeBaseType } from './TimeBaseType';
+
+export type AudioOutputType = {
+  format?: string;
+  codec?: string;
+  bitrate?: number;
+  framerate?: TimeBaseType;
+  channel?: Array<number>;
+  stream?: Array<number>;
+};

package/src/models/AudioTrackTranscodePresetType.ts

@@ -0,0 +1,13 @@
+import type { AudioTranscodePresetMixType } from './AudioTranscodePresetMixType';
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { TimeBaseType } from './TimeBaseType';
+
+export type AudioTrackTranscodePresetType = {
+  codec?: string;
+  bitrate?: number;
+  framerate?: TimeBaseType;
+  channel?: Array<number>;
+  preset?: Array<string>;
+  setting?: Array<KeyValuePairType>;
+  mix?: Array<AudioTranscodePresetMixType>;
+};

package/src/models/AudioTranscodePresetChannelMixType.ts

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

package/src/models/AudioTranscodePresetMixType.ts

@@ -0,0 +1,6 @@
+import type { AudioTranscodePresetChannelMixType } from './AudioTranscodePresetChannelMixType';
+
+export type AudioTranscodePresetMixType = {
+  input?: Array<AudioTranscodePresetChannelMixType>;
+  silence?: boolean;
+};

package/src/models/AudioTranscodePresetType.ts

@@ -0,0 +1,21 @@
+import type { AudioOutputType } from './AudioOutputType';
+import type { AudioTranscodePresetMixType } from './AudioTranscodePresetMixType';
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { OtifPresetType } from './OtifPresetType';
+import type { TimeBaseType } from './TimeBaseType';
+
+export type AudioTranscodePresetType = {
+  codec?: string;
+  bitrate?: number;
+  framerate?: TimeBaseType;
+  channel?: Array<number>;
+  stream?: Array<number>;
+  preset?: Array<string>;
+  noAudio?: boolean;
+  setting?: Array<KeyValuePairType>;
+  mix?: Array<AudioTranscodePresetMixType>;
+  otif?: OtifPresetType;
+  monoFile?: boolean;
+  allChannel?: boolean;
+  output?: Array<AudioOutputType>;
+};

package/src/models/AuditLogDocument.ts

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

package/src/models/AuditLogEntryType.ts

@@ -0,0 +1,13 @@
+export type AuditLogEntryType = {
+  username: string;
+  method: string;
+  path: string;
+  queryParameters: string;
+  matrixParameters: string;
+  runAs?: string;
+  contentType?: string;
+  contentLength?: string;
+  body?: string;
+  responseCode?: number;
+  timestamp: string;
+};

package/src/models/AuditLogType.ts

@@ -0,0 +1,6 @@
+import type { AuditLogEntryType } from './AuditLogEntryType';
+
+export type AuditLogType = {
+  count?: number;
+  entry?: Array<AuditLogEntryType>;
+};

package/src/models/AuthenticationTokenDocument.ts

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

package/src/models/AuthenticationTokenType.ts

@@ -0,0 +1,4 @@
+export type AuthenticationTokenType = {
+  token: string;
+  user: string;
+};

package/src/models/AutoImportRuleDocument.ts

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

package/src/models/AutoImportRuleListDocument.ts

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

package/src/models/AutoImportRuleListType.ts

@@ -0,0 +1,5 @@
+import type { AutoImportRuleType } from './AutoImportRuleType';
+
+export type AutoImportRuleListType = {
+  rule?: Array<AutoImportRuleType>;
+};

package/src/models/AutoImportRuleType.ts

@@ -0,0 +1,24 @@
+import type { FilenameFilterType } from './FilenameFilterType';
+import type { MetadataType } from './MetadataType';
+import type { sequenceDefinitionType } from './sequenceDefinitionType';
+import type { SimpleMetadataType } from './SimpleMetadataType';
+import type { SiteIdType } from './SiteIdType';
+
+export type AutoImportRuleType = {
+  fileNameAsTitle?: boolean;
+  storage?: SiteIdType;
+  tag?: Array<string>;
+  metadata?: MetadataType;
+  jobmetadata?: SimpleMetadataType;
+  settingsId?: SiteIdType;
+  projection?: string;
+  excludeFilter?: Array<FilenameFilterType>;
+  shapeTagFilter?: Array<FilenameFilterType>;
+  sequenceDefinition?: sequenceDefinitionType;
+  priority?: string;
+  user?: string;
+  ignoreSidecarImport?: boolean;
+  disabledSidecarExtensions?: Array<string>;
+  enabled?: boolean;
+  resourceId?: SiteIdType;
+};

package/src/models/AutoProjectionInputFilterType.ts

@@ -0,0 +1 @@
+export type AutoProjectionInputFilterType = 'oldMetadata' | 'shapeDocument';

package/src/models/AutoProjectionRuleDocument.ts

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

package/src/models/AutoProjectionRuleType.ts

@@ -0,0 +1,16 @@
+import type { AutoProjectionInputFilterType } from './AutoProjectionInputFilterType';
+import type { AutoProjectionStepType } from './AutoProjectionStepType';
+import type { AutoProjectionTriggerType } from './AutoProjectionTriggerType';
+
+export type AutoProjectionRuleType = {
+  step?: Array<AutoProjectionStepType>;
+  name?: string;
+  description?: string;
+  inputFilters?: {
+    inputFilter?: Array<AutoProjectionInputFilterType>;
+    bulkyMetadataKeysRegex?: string;
+  };
+  triggers?: {
+    trigger?: Array<AutoProjectionTriggerType>;
+  };
+};

package/src/models/AutoProjectionStepType.ts

@@ -0,0 +1,4 @@
+export type AutoProjectionStepType = {
+  order?: number;
+  description?: string;
+};

package/src/models/AutoProjectionTriggerType.ts

@@ -0,0 +1 @@
+export type AutoProjectionTriggerType = 'shapeMetadata' | 'itemMetadata' | 'bulkyMetadata';

package/src/models/AutocompleteRequestDocument.ts

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

package/src/models/AutocompleteRequestType.ts

@@ -0,0 +1,5 @@
+export type AutocompleteRequestType = {
+  text: string;
+  field?: string;
+  maximumSuggestions?: number;
+};

package/src/models/AutocompleteResponseDocument.ts

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

package/src/models/AutocompleteResponseType.ts

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

package/src/models/BaseMediaInfoType.ts

@@ -0,0 +1,7 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+
+export type BaseMediaInfoType = {
+  Bit_rate_mode?: string;
+  Source?: string;
+  property?: Array<KeyValuePairType>;
+};

package/src/models/BeanCallbackDocument.ts

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

package/src/models/BeanCallbackListDocument.ts

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

package/src/models/BeanCallbackListType.ts

@@ -0,0 +1,5 @@
+import type { BeanCallbackType } from './BeanCallbackType';
+
+export type BeanCallbackListType = {
+  callback?: Array<BeanCallbackType>;
+};

package/src/models/BeanCallbackType.ts

@@ -0,0 +1,9 @@
+export type BeanCallbackType = {
+  sourceBean: string;
+  sourceMethod: string;
+  destinationBean: string;
+  destinationMethod: string;
+  lastSuccess?: string;
+  lastFailure?: string;
+  errorMessage?: string;
+};

package/src/models/BinaryComponentDocument.ts

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

package/src/models/BinaryComponentType.ts

@@ -0,0 +1,10 @@
+import type { BaseMediaInfoType } from './BaseMediaInfoType';
+import type { ComponentType } from './ComponentType';
+
+export type BinaryComponentType = ComponentType & {
+  format?: string;
+  encoding?: string;
+  offset?: number;
+  length?: number;
+  mediaInfo?: BaseMediaInfoType;
+};

package/src/models/BorderType.ts

@@ -0,0 +1,7 @@
+export type BorderType = {
+  a: number;
+  r: number;
+  g: number;
+  b: number;
+  width: number;
+};

package/src/models/BulkyMapEntryType.ts

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

package/src/models/BulkyMapListDocument.ts

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

package/src/models/BulkyMapListType.ts

@@ -0,0 +1,5 @@
+import type { BulkyMapType } from './BulkyMapType';
+
+export type BulkyMapListType = {
+  map: Array<BulkyMapType>;
+};

package/src/models/BulkyMapType.ts

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