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

package/src/models/PlaceholderImportRequestDocument.ts

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

package/src/models/PlaceholderImportRequestType.ts

@@ -0,0 +1,6 @@
+export type PlaceholderImportRequestType = {
+  container?: string;
+  video?: Array<string>;
+  audio?: Array<string>;
+  binary?: Array<string>;
+};

package/src/models/PluginType.ts

@@ -0,0 +1,4 @@
+export type PluginType = {
+  alias: string;
+  fileName: string;
+};

package/src/models/ProjectDocument.ts

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

package/src/models/ProjectFileDocument.ts

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

package/src/models/ProjectFileType.ts

@@ -0,0 +1,20 @@
+import type { FileReferenceType } from './FileReferenceType';
+import type { SiteIdType } from './SiteIdType';
+
+export type ProjectFileType = {
+  location: string;
+  type?: string;
+  asset?: Array<{
+    id: string;
+    name: string;
+    type: string;
+    status?: string;
+    item?: Array<{
+      id?: SiteIdType;
+      shape?: SiteIdType;
+      match?: string;
+      permission?: string;
+    }>;
+    file?: Array<FileReferenceType>;
+  }>;
+};

package/src/models/ProjectType.ts

@@ -0,0 +1,6 @@
+import type { MetadataType } from './MetadataType';
+
+export type ProjectType = {
+  name?: string;
+  metadata?: MetadataType;
+};

package/src/models/ProjectVersionDocument.ts

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

package/src/models/ProjectVersionType.ts

@@ -0,0 +1,14 @@
+import type { MetadataType } from './MetadataType';
+import type { SequenceType } from './SequenceType';
+import type { SiteIdType } from './SiteIdType';
+
+export type ProjectVersionType = {
+  id?: SiteIdType;
+  item?: Array<{
+    id?: SiteIdType;
+    externalId?: string;
+    uri?: string;
+  }>;
+  sequence?: Array<SequenceType>;
+  metadata?: MetadataType;
+};

package/src/models/QueueJobDocument.ts

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

package/src/models/QueueJobType.ts

@@ -0,0 +1,5 @@
+import type { JobRequestChoiceType } from './JobRequestChoiceType';
+
+export type QueueJobType = {
+  job?: Array<JobRequestChoiceType>;
+};

package/src/models/QuotaFilterType.ts

@@ -0,0 +1,5 @@
+export type QuotaFilterType = {
+  username?: Array<string>;
+  groupname?: Array<string>;
+  exceeded?: boolean;
+};

package/src/models/QuotaResourceType.ts

@@ -0,0 +1 @@
+export type QuotaResourceType = 'item' | 'storage';

package/src/models/QuotaRuleDocument.ts

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

package/src/models/QuotaRuleListDocument.ts

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

package/src/models/QuotaRuleListType.ts

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

package/src/models/QuotaRuleType.ts

@@ -0,0 +1,19 @@
+import type { ExternalIdentifierType } from './ExternalIdentifierType';
+import type { QuotaResourceType } from './QuotaResourceType';
+import type { SiteIdType } from './SiteIdType';
+
+export type QuotaRuleType = {
+  id?: SiteIdType;
+  description?: string;
+  tag?: string;
+  resource: Array<{
+    name: QuotaResourceType;
+    limit: number;
+    usage?: number;
+  }>;
+  updateFrequency?: number;
+  lastUpdate?: string;
+  externalId?: Array<ExternalIdentifierType>;
+  user?: string;
+  group?: string;
+};

package/src/models/REDDecoderType.ts

@@ -0,0 +1 @@
+export type REDDecoderType = 'CPU' | 'CUDA' | 'OPENCL';

package/src/models/RationalType.ts

@@ -0,0 +1,4 @@
+export type RationalType = {
+  numerator: number;
+  denominator: number;
+};

package/src/models/ReindexRequestDocument.ts

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

package/src/models/ReindexRequestType.ts

@@ -0,0 +1,9 @@
+export type ReindexRequestType = {
+  index: string;
+  priority: number;
+  status: string;
+  start?: string;
+  finish?: string;
+  indexesDone?: number;
+  indexesTotal?: number;
+};

package/src/models/RelationType.ts

@@ -0,0 +1 @@
+export type RelationType = 'child' | 'parent' | 'descendant' | 'ancestor';

package/src/models/Reply.ts

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

package/src/models/ResolutionType.ts

@@ -0,0 +1,4 @@
+export type ResolutionType = {
+  width: number;
+  height: number;
+};

package/src/models/ResourceDocument.ts

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

package/src/models/ResourceListDocument.ts

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

package/src/models/ResourceListType.ts

@@ -0,0 +1,5 @@
+import type { ResourceType } from './ResourceType';
+
+export type ResourceListType = {
+  resource?: Array<ResourceType>;
+};

package/src/models/ResourceType.ts

@@ -0,0 +1,33 @@
+import type { CallbackLocationResourceType } from './CallbackLocationResourceType';
+import type { CerifyType } from './CerifyType';
+import type { CloudConvertType } from './CloudConvertType';
+import type { EidrType } from './EidrType';
+import type { ExternalTranscoderType } from './ExternalTranscoderType';
+import type { FinalCutServerType } from './FinalCutServerType';
+import type { LDAPResourceType } from './LDAPResourceType';
+import type { MXFServerResourceType } from './MXFServerResourceType';
+import type { NetworkType } from './NetworkType';
+import type { SigniantType } from './SigniantType';
+import type { SiteIdType } from './SiteIdType';
+import type { ThumbnailServiceType } from './ThumbnailServiceType';
+import type { TranscoderType } from './TranscoderType';
+import type { VidinetServiceType } from './VidinetServiceType';
+
+export type ResourceType = {
+  id?: SiteIdType;
+  state?: string;
+  network?: NetworkType;
+  transcoder?: TranscoderType;
+  externalTranscoder?: ExternalTranscoderType;
+  cerify?: CerifyType;
+  thumbnail?: ThumbnailServiceType;
+  finalcutserver?: FinalCutServerType;
+  mxfserver?: MXFServerResourceType;
+  signiant?: SigniantType;
+  ldap?: LDAPResourceType;
+  unknown?: string;
+  cloudconvert?: CloudConvertType;
+  vidinet?: VidinetServiceType;
+  eidr?: EidrType;
+  callback?: CallbackLocationResourceType;
+};

package/src/models/ResourceTypeListDocument.ts

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

package/src/models/ResourceTypeListType.ts

@@ -0,0 +1,6 @@
+export type ResourceTypeListType = {
+  resourcetype?: Array<{
+    type: string;
+    url?: string;
+  }>;
+};

package/src/models/S3CredentialType.ts

@@ -0,0 +1 @@
+export type S3CredentialType = 'none' | 'temporary' | 'secretkey';

package/src/models/ScalingType.ts

@@ -0,0 +1,14 @@
+import type { AspectRatioType } from './AspectRatioType';
+
+export type ScalingType = {
+  width?: number;
+  height?: number;
+  top?: number;
+  bottom?: number;
+  left?: number;
+  right?: number;
+  padColor?: string;
+  rotate?: string;
+  pixelAspectRatio?: AspectRatioType;
+  targetDAR?: AspectRatioType;
+};

package/src/models/ScheduledRequestDocument.ts

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

package/src/models/ScheduledRequestListDocument.ts

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

package/src/models/ScheduledRequestListType.ts

@@ -0,0 +1,5 @@
+import type { ScheduledRequestType } from './ScheduledRequestType';
+
+export type ScheduledRequestListType = {
+  scheduledRequest?: Array<ScheduledRequestType>;
+};

package/src/models/ScheduledRequestType.ts

@@ -0,0 +1,18 @@
+export type ScheduledRequestType = {
+  id: number;
+  user: string;
+  state: string;
+  date: string;
+  created: string;
+  executed?: string;
+  request: {
+    uri: string;
+    method: string;
+    body?: string;
+  };
+  response?: {
+    statusCode: number;
+    hasBody: boolean;
+    contentType?: string;
+  };
+};

package/src/models/SearchAclType.ts

@@ -0,0 +1,7 @@
+import type { SearchPermissionType } from './SearchPermissionType';
+
+export type SearchAclType = {
+  username?: string;
+  groupname?: string;
+  permission: SearchPermissionType;
+};

package/src/models/SearchFieldType.ts

@@ -0,0 +1,13 @@
+import type { ItemSearchValueType } from './ItemSearchValueType';
+import type { SearchTargetType } from './SearchTargetType';
+
+export type SearchFieldType = {
+  name: string;
+  value?: Array<ItemSearchValueType>;
+  range?: Array<{
+    value: Array<ItemSearchValueType>;
+    exclusiveMinimum?: boolean;
+    exclusiveMaximum?: boolean;
+  }>;
+  target?: SearchTargetType;
+};

package/src/models/SearchFilterType.ts

@@ -0,0 +1,19 @@
+import type { CriterionType } from './CriterionType';
+import type { ItemCriterionType } from './ItemCriterionType';
+import type { SearchFieldType } from './SearchFieldType';
+import type { SearchGroupType } from './SearchGroupType';
+import type { SearchOperationType } from './SearchOperationType';
+import type { SearchOperatorType } from './SearchOperatorType';
+import type { ShapeCriterionType } from './ShapeCriterionType';
+
+export type SearchFilterType = {
+  operator?: Array<SearchOperatorType>;
+  field?: Array<SearchFieldType>;
+  group?: Array<SearchGroupType>;
+  reference?: Array<string>;
+  item?: ItemCriterionType;
+  shape?: ShapeCriterionType;
+  file?: CriterionType;
+  operation?: SearchOperationType;
+  name?: string;
+};

package/src/models/SearchGroupType.ts

@@ -0,0 +1,6 @@
+import type { SearchOperatorType } from './SearchOperatorType';
+
+export type SearchGroupType = {
+  name?: string;
+  operator?: SearchOperatorType;
+};

package/src/models/SearchHistoryDocument.ts

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

package/src/models/SearchHistoryListType.ts

@@ -0,0 +1,5 @@
+import type { SearchHistoryType } from './SearchHistoryType';
+
+export type SearchHistoryListType = {
+  search?: Array<SearchHistoryType>;
+};

package/src/models/SearchHistoryType.ts

@@ -0,0 +1,7 @@
+import type { ItemSearchType } from './ItemSearchType';
+
+export type SearchHistoryType = {
+  timestamp: string;
+  user: string;
+  query: ItemSearchType;
+};

package/src/models/SearchIntervalsType.ts

@@ -0,0 +1 @@
+export type SearchIntervalsType = 'all' | 'generic' | 'timed';

package/src/models/SearchOperationType.ts

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

package/src/models/SearchOperatorType.ts

@@ -0,0 +1,23 @@
+import type { CollectionCriterionType } from './CollectionCriterionType';
+import type { CriterionType } from './CriterionType';
+import type { ItemCriterionType } from './ItemCriterionType';
+import type { ItemSearchTextValueType } from './ItemSearchTextValueType';
+import type { SearchAclType } from './SearchAclType';
+import type { SearchFieldType } from './SearchFieldType';
+import type { SearchGroupType } from './SearchGroupType';
+import type { SearchOperationType } from './SearchOperationType';
+import type { ShapeCriterionType } from './ShapeCriterionType';
+
+export type SearchOperatorType = {
+  text?: Array<ItemSearchTextValueType>;
+  operator?: Array<SearchOperatorType>;
+  field?: Array<SearchFieldType>;
+  group?: Array<SearchGroupType>;
+  reference?: Array<string>;
+  item?: ItemCriterionType;
+  shape?: ShapeCriterionType;
+  file?: CriterionType;
+  collection?: Array<CollectionCriterionType>;
+  acl?: SearchAclType;
+  operation: SearchOperationType;
+};

package/src/models/SearchPermissionType.ts

@@ -0,0 +1 @@
+export type SearchPermissionType = 'WRITE' | 'READ';

package/src/models/SearchResultDocument.ts

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

package/src/models/SearchResultEntryTimespanType.ts

@@ -0,0 +1,8 @@
+export type SearchResultEntryTimespanType = {
+  field?: Array<{
+    name: string;
+    value?: Array<string>;
+  }>;
+  start: string;
+  end: string;
+};

package/src/models/SearchResultEntryType.ts

@@ -0,0 +1,20 @@
+import type { CollectionType } from './CollectionType';
+import type { FileType } from './FileType';
+import type { ItemType } from './ItemType';
+import type { SearchResultEntryTimespanType } from './SearchResultEntryTimespanType';
+import type { ShapeType } from './ShapeType';
+
+export type SearchResultEntryType = {
+  timespan?: Array<SearchResultEntryTimespanType>;
+  item?: ItemType;
+  collection?: CollectionType;
+  shape?: ShapeType;
+  file?: FileType;
+  start?: string;
+  end?: string;
+  type?: string;
+  id?: string;
+  parent_type?: string;
+  parent_id?: string;
+  base?: string;
+};

package/src/models/SearchResultType.ts

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

package/src/models/SearchTargetType.ts

@@ -0,0 +1 @@
+export type SearchTargetType = 'item' | 'shape' | 'file';

package/src/models/SegmentationJobDocument.ts

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

package/src/models/SegmentationJobType.ts

@@ -0,0 +1,11 @@
+import type { TimeCodeType } from './TimeCodeType';
+import type { TranscoderJobType } from './TranscoderJobType';
+
+export type SegmentationJobType = TranscoderJobType & {
+  input: string;
+  playlistOutput: string;
+  segmentUriPrefix: string;
+  segmentUriPostfix: string;
+  containerFormat: string;
+  segmentLength: TimeCodeType;
+};

package/src/models/SelfTestDocument.ts

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

package/src/models/SelfTestType.ts

@@ -0,0 +1,8 @@
+export type SelfTestType = {
+  message?: Array<string>;
+  test?: Array<SelfTestType>;
+  name?: string;
+  description?: string;
+  status: string;
+  took?: string;
+};

package/src/models/SequenceDocument.ts

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

package/src/models/SequenceListDocument.ts

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

package/src/models/SequenceListType.ts

@@ -0,0 +1,8 @@
+import type { SiteIdType } from './SiteIdType';
+
+export type SequenceListType = {
+  sequence?: Array<{
+    id: SiteIdType;
+    type: string;
+  }>;
+};

package/src/models/SequenceMediaType.ts

@@ -0,0 +1,16 @@
+import type { EffectType } from './EffectType';
+import type { ExternalVideoMediaType } from './ExternalVideoMediaType';
+import type { SiteIdType } from './SiteIdType';
+import type { TimeCodeType } from './TimeCodeType';
+
+export type SequenceMediaType = {
+  sourceTrack: number;
+  in?: TimeCodeType;
+  out?: TimeCodeType;
+  sourceIn?: TimeCodeType;
+  sourceOut?: TimeCodeType;
+  effect?: Array<EffectType>;
+  reference?: string;
+  externalVideoMedia?: ExternalVideoMediaType;
+  item?: SiteIdType;
+};

package/src/models/SequenceMetaDataType.ts

@@ -0,0 +1,4 @@
+export type SequenceMetaDataType = {
+  regex: string;
+  idGroup: number;
+};

package/src/models/SequenceRangeType.ts

@@ -0,0 +1,7 @@
+export type SequenceRangeType = {
+  start: number;
+  width?: number;
+  count?: number;
+  wildcard: string;
+  value?: string;
+};

package/src/models/SequenceRenderRequestDocument.ts

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

package/src/models/SequenceRenderRequestType.ts

@@ -0,0 +1,9 @@
+import type { MetadataType } from './MetadataType';
+import type { SequenceType } from './SequenceType';
+import type { TimeIntervalType } from './TimeIntervalType';
+
+export type SequenceRenderRequestType = {
+  sequence: SequenceType;
+  interval?: TimeIntervalType;
+  metadata?: MetadataType;
+};

package/src/models/SequenceTrackType.ts

@@ -0,0 +1,8 @@
+import type { SequenceMediaType } from './SequenceMediaType';
+import type { SequenceTransitionType } from './SequenceTransitionType';
+
+export type SequenceTrackType = {
+  audio?: boolean;
+  segment?: Array<SequenceMediaType>;
+  transition?: Array<SequenceTransitionType>;
+};

package/src/models/SequenceTransitionType.ts

@@ -0,0 +1,16 @@
+import type { TimeCodeType } from './TimeCodeType';
+
+export type SequenceTransitionType = {
+  in: TimeCodeType;
+  out: TimeCodeType;
+  wipe?: number;
+  transition: string;
+  horizRepeat?: number;
+  vertRepeat?: number;
+  startPercentage?: number;
+  endPercentage?: number;
+  reverse?: boolean;
+  borderWidth?: number;
+  borderColor?: string;
+  color?: string;
+};

package/src/models/SequenceType.ts

@@ -0,0 +1,11 @@
+import type { KeyValuePairType } from './KeyValuePairType';
+import type { SequenceTrackType } from './SequenceTrackType';
+import type { SiteIdType } from './SiteIdType';
+import type { TranscodePresetType } from './TranscodePresetType';
+
+export type SequenceType = {
+  id?: SiteIdType;
+  track?: Array<SequenceTrackType>;
+  override?: TranscodePresetType;
+  setting?: Array<KeyValuePairType>;
+};

package/src/models/ServiceConfigurationResultDocument.ts

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

package/src/models/ServiceConfigurationResultType.ts

@@ -0,0 +1,16 @@
+export type ServiceConfigurationResultType = {
+  serviceName: string;
+  serviceId: string;
+  configurationVersion: string;
+  preCheck: boolean;
+  success: boolean;
+  message?: string;
+  executedSteps?: Array<{
+    order: number;
+    description: string;
+    resource: string;
+    result: string;
+    success?: boolean;
+    data?: string;
+  }>;
+};

package/src/models/ShapeCriterionType.ts

@@ -0,0 +1,5 @@
+import type { CriterionType } from './CriterionType';
+
+export type ShapeCriterionType = CriterionType & {
+  file?: CriterionType;
+};

package/src/models/ShapeDeductionJobDocument.ts

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