epicenter-libs 3.33.0 → 3.34.1

package/dist/test/adapters/vault.js

@@ -1,403 +0,0 @@
-import { SCOPE_BOUNDARY, ROLE } from '../utils/constants.js';
-import '../utils/helpers.js';
-import { parseFilterInput } from '../utils/filter-parser.js';
-import '../utils/config.js';
-import identification from '../utils/identification.js';
-import '../utils/error-manager.js';
-import Router from '../utils/router.js';
-
-// Generic type parameter for vault items structure
-
-/**
- * Updates a vault's items
- * Base URL: PUT `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/{VAULT_KEY}`
- *
- * @example
- * import { vaultAdapter } from 'epicenter-libs';
- * // Change the name of the first student object in the list of students in the vault to "Bob"
- * await vaultAdapter.update('00000166d59adcb0f497ddc1aad0270c0a62', { set: { 'students.0.name': 'Bob' } });
- *
- * @param vaultKey                  Vault key
- * @param items                     Object with a set/push/pop field to update the vault items with
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.mutationKey]   Mutation key for optimistic concurrency control
- * @returns promise that resolves to the vault
- */
-async function update(vaultKey, items, optionals = {}) {
-  var _items$set, _items$push, _items$pop;
-  const {
-    mutationKey,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    mutationKey: mutationKey
-  }).put(`/vault/${vaultKey}`, {
-    body: {
-      set: (_items$set = items.set) !== null && _items$set !== void 0 ? _items$set : {},
-      push: (_items$push = items.push) !== null && _items$push !== void 0 ? _items$push : {},
-      pop: (_items$pop = items.pop) !== null && _items$pop !== void 0 ? _items$pop : {}
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Updates a vault's properties
- * Base URL: PATCH `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/{VAULT_KEY}`
- *
- * @example
- * import { vaultAdapter, ROLE } from 'epicenter-libs';
- * await vaultAdapter.updateProperties('00000166d59adcb0f497ddc1aad0270c0a62', {
- *     allowChannel: true,
- *     permit: {
- *         readLock: ROLE.FACILITATOR,
- *         writeLock: ROLE.FACILITATOR,
- *     },
- *     ttlSeconds: 3600,
- * });
- * });
- *
- * @param vaultKey                      Vault key
- * @param update                        Object with properties to update
- * @param [update.mutationKey]          Mutation key for optimistic concurrency control
- * @param [update.allowChannel]         Opt into push notifications for this resource
- * @param [update.permit]               Permission settings for the vault
- * @param [update.ttlSeconds]           Time to live in seconds
- * @param [optionals]                   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the vault
- */
-async function updateProperties(vaultKey, update, optionals = {}) {
-  return await new Router().patch(`/vault/${vaultKey}`, {
-    body: {
-      ...update
-    },
-    ...optionals
-  }).then(({
-    body
-  }) => body);
-}
-const NOT_FOUND = 404;
-
-/**
- * Retrieves a vault by its vault key
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/{VAULT_KEY}`
- *
- * @example
- * import { vaultAdapter } from 'epicenter-libs';
- * const vault = await vaultAdapter.get('00000166d59adcb0f497ddc1aad0270c0a62');
- *
- * @param vaultKey      Vault key
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the vault, or undefined if not found
- */
-async function get(vaultKey, optionals = {}) {
-  return await new Router().get(`/vault/${vaultKey}`, optionals).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves a vault by name within a specific scope
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{VAULT_NAME}`
- *
- * @example
- * import { vaultAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * const vault = await vaultAdapter.withScope('my-vault-name', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param name                      Name of the vault
- * @param scope                     Scope associated with the vault
- * @param scope.scopeBoundary       Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey            Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [scope.userKey]           Optional key to scope the vault to a user
- * @param [optionals]               Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to the vault, or undefined if not found
- */
-async function withScope(name, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const uriComponent = userKey ? `/${userKey}` : '';
-  return await new Router().get(`/vault/with/${scopeBoundary}/${scopeKey}${uriComponent}/${name}`, optionals).catch(error => {
-    if (error.status === NOT_FOUND) return {
-      body: undefined
-    };
-    return Promise.reject(error);
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Retrieves all vaults with a specific name within a group or episode
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/in/{GROUP_NAME}/{VAULT_NAME}`
- *
- * @example
- * import { vaultAdapter } from 'epicenter-libs';
- * const vaults = await vaultAdapter.byName('my-vault-name', {
- *     groupName: 'my-group',
- *     episodeName: 'my-episode',
- *     includeEpisodes: true,
- * });
- *
- * @param name                          Name of the vault
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupName]         Name of the group to search within. Defaults to the session user's group.
- * @param [optionals.episodeName]       Name of the episode to search within
- * @param [optionals.userKey]           Optional user key to filter vaults by user
- * @param [optionals.includeEpisodes]   Whether to include vaults from episodes within the group
- * @returns promise that resolves to an array of vaults with the specified name
- */
-async function byName(name, optionals = {}) {
-  const {
-    groupName,
-    episodeName,
-    userKey,
-    includeEpisodes,
-    ...routingOptions
-  } = optionals;
-  const session = identification.session;
-  const searchParams = {
-    userKey,
-    includeEpisodes
-  };
-  return await new Router().withSearchParams(searchParams).get(`/vault/in/${groupName !== null && groupName !== void 0 ? groupName : session === null || session === void 0 ? void 0 : session.groupName}${episodeName ? `/${episodeName}` : ''}/${name}`, {
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * Deletes a vault
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/{VAULT_KEY}`
- *
- * @example
- * import { vaultAdapter } from 'epicenter-libs';
- * await vaultAdapter.remove('00000166d59adcb0f497ddc1aad0270c0a62');
- *
- * @param vaultKey                  Vault key
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.mutationKey]   Mutation key for optimistic concurrency control
- * @returns promise that resolves to undefined when successful
- */
-async function remove(vaultKey, optionals = {}) {
-  const {
-    mutationKey,
-    ...routingOptions
-  } = optionals;
-  return await new Router().withSearchParams({
-    mutationKey: mutationKey
-  }).delete(`/vault/${vaultKey}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Defines vault properties, used to create or modify a vault. Vault names are unique within their scope.
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/{COLLECTION_NAME}`
- *
- * @example
- * import { vaultAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * vaultAdapter.define('my-vault-name', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * });
- *
- * @param name                          Name of the vault
- * @param scope                         Scope associated with your vault
- * @param scope.scopeBoundary           Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey                Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [scope.userKey]               Optional key to scope the vault to a user
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.items]             Optional items parameter for updating vault contents
- * @param [optionals.items.set]         Sets a field in the vault, where `[name]: [value]`, send `[name]: null` to delete
- * @param [optionals.items.push]        Adds an item to a list in the vault; if the list does not exist it will create one
- * @param [optionals.items.pop]         Use to remove items from lists in a vault
- * @param [optionals.readLock]          Role allowed to read
- * @param [optionals.writeLock]         Role allowed to write
- * @param [optionals.ttlSeconds]        Life span of the vault (defaults to null, minimum value of 1800 seconds / 30 minutes)
- * @param [optionals.mutationStrategy]  Setting a mutation strategy allows for the following behaviors: ALLOW - Is an upsert which means if the entry exists it will be updated with the items in the POST. DISALLOW - Is an insert which means that if the entry exists no changes will be made (the 'changed' flag will be false). ERROR - Is an insert and, if the entry exists, a conflict exception will be thrown. If the mutationStrategy is omitted, it will simply search by scope and name; updating if it exists, creating if not.
- * @param [optionals.allowChannel]      Opt into push notifications for this resource. Applicable to projects with phylogeny >= SILENT
- * @returns promise that resolves to the vault (created or modified)
- */
-async function define(name, scope, optionals = {}) {
-  const {
-    scopeBoundary,
-    scopeKey,
-    userKey
-  } = scope;
-  const {
-    readLock,
-    writeLock,
-    items,
-    ttlSeconds,
-    mutationStrategy = 'ERROR',
-    allowChannel,
-    ...routingOptions
-  } = optionals;
-  const {
-    WORLD
-  } = SCOPE_BOUNDARY;
-  const {
-    PARTICIPANT,
-    USER
-  } = ROLE;
-  const defaultLock = scopeBoundary === WORLD ? PARTICIPANT : USER;
-  const searchParams = {
-    mutationStrategy
-  };
-  return await new Router().withSearchParams(searchParams).post(`/vault/${name}`, {
-    body: {
-      scope: {
-        scopeBoundary,
-        scopeKey,
-        userKey
-      },
-      permit: {
-        readLock: readLock || defaultLock,
-        writeLock: writeLock || defaultLock
-      },
-      ttlSeconds,
-      items,
-      allowChannel
-    },
-    ...routingOptions
-  }).then(({
-    body
-  }) => body);
-}
-
-/**
- * @deprecated Use vaultAdapter.define instead. This method will be removed in the next release.
- *
- * Creates a new vault with the specified name, scope, and items
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/{COLLECTION_NAME}`
- *
- * @example
- * import { vaultAdapter, SCOPE_BOUNDARY } from 'epicenter-libs';
- * await vaultAdapter.create('my-vault-name', {
- *     scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *     scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- * }, {
- *     set: { foo: 'bar' }
- * });
- *
- * @param name                          Name of the vault
- * @param scope                         Scope associated with your vault
- * @param scope.scopeBoundary           Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param scope.scopeKey                Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [scope.userKey]               Optional key to scope the vault to a user
- * @param items                         Items to set, push, or pop in the vault
- * @param [optionals]                   Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.readLock]          Role allowed to read
- * @param [optionals.writeLock]         Role allowed to write
- * @param [optionals.ttlSeconds]        Life span of the vault -- default to null, minimum value of 1800 (30 minutes)
- * @param [optionals.mutationStrategy]  Mutation strategy: ALLOW (upsert), DISALLOW (insert without update), ERROR (insert with conflict exception if exists)
- * @returns promise that resolves to the created vault
- */
-async function create(name, scope, items, optionals = {}) {
-  console.warn('DEPRECATION WARNING: vaultAdapter.create is deprecated and will be removed with the next release. Use vaultAdapter.define instead.');
-  return await define(name, scope, {
-    items,
-    ...optionals
-  });
-}
-
-/**
- * Searches for vaults that match the search options; not paginable (hence named 'list' and not 'query')
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/search`
- *
- * @example
- * import { vaultAdapter } from 'epicenter-libs';
- * vaultAdapter.list({
- *     filter: [
- *         'name|=vault-one|vault-two',                        // looks for any vaults with the names provided
- *         'scopeBoundary=WORLD',                              // looks for vaults scoped to a world
- *         'scopeKey=00000165ad4e6a3cd22b993340b963820239',    // used in conjunction with the scopeBoundary
- *     ],
- *     sort: ['+vault.created'],                               // sort all findings by the 'created' field (ascending)
- *     first: 3,                                               // page should start with the 4th item found (defaults to 0)
- *     max: 10,                                                // page should only include the first 10 items
- * }, {
- *     groupName: 'my-group-name',                             // search within a group
- * });
- *
- * @param searchOptions             Search options
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupName]     Name of the group
- * @returns promise that resolves to an array of vaults that match the search options
- */
-async function list(searchOptions, optionals = {}) {
-  const {
-    first,
-    filter,
-    max
-  } = searchOptions;
-  const searchParams = {
-    filter: parseFilterInput(filter),
-    first,
-    max
-  };
-  const {
-    groupName,
-    ...routingOptions
-  } = optionals;
-  return new Router().withSearchParams(searchParams).get(`/vault/search${groupName ? `/${groupName}` : ''}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-/**
- * Counts the number of vaults that match the search options
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/vault/count`
- *
- * @example
- * import { vaultAdapter } from 'epicenter-libs';
- * vaultAdapter.count({
- *     filter: [
- *         'name|=vault-one|vault-two',                        // looks for any vaults with the names provided
- *         'scopeBoundary=WORLD',                              // looks for vaults scoped to a world
- *         'scopeKey=00000165ad4e6a3cd22b993340b963820239',    // used in conjunction with the scopeBoundary
- *     ],
- * }, {
- *     groupName: 'my-group-name',                             // search within a group
- * });
- *
- * @param searchOptions             Search options
- * @param [optionals]               Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.groupName]     Name of the group
- * @returns promise that resolves to the number of vaults that match the search options
- */
-async function count(searchOptions, optionals = {}) {
-  const {
-    first,
-    filter,
-    max
-  } = searchOptions;
-  const searchParams = {
-    filter: parseFilterInput(filter),
-    first,
-    max
-  };
-  const {
-    groupName,
-    ...routingOptions
-  } = optionals;
-  return new Router().withSearchParams(searchParams).get(`/vault/count${groupName ? `/${groupName}` : ''}`, routingOptions).then(({
-    body
-  }) => body);
-}
-
-export { byName, count, create, define, get, list, remove, update, updateProperties, withScope };

package/dist/test/adapters/video.js

@@ -1,249 +0,0 @@
-import EpicenterError from '../utils/error.js';
-import { parseFilterInput } from '../utils/filter-parser.js';
-import { deleteVideoByKey, getVideoSearch, getVideoURLWith, getVideoURLByKey, getVideoDirectoryWith, getVideoDirectoryByKey, postVideoProcessor, downloadVideoWith, downloadVideoByKey } from '../apis/video.js';
-
-/**
- * Deletes a video (and its associated files)
- * Base URL: DELETE `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/{VIDEO_KEY}`
- *
- * @example
- * import { videoAdapter } from 'epicenter-libs';
- * await videoAdapter.remove(videoKey);
- *
- * @param videoKey      Video key
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to undefined when successful
- */
-async function remove(videoKey, optionals = {}) {
-  return deleteVideoByKey(videoKey, optionals);
-}
-
-/**
- * Open search for video objects
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/search`
- *
- * @example
- * import { videoAdapter } from 'epicenter-libs';
- * const videos = await videoAdapter.query({
- *     filter: [
- *         'affiliate=VONAGE',                     // searches for videos provided by the Vonage affiliate
- *         'episodeName=myEpisode',                // searches for videos tied to the episode with name 'myEpisode'
- *         'created>=2022-01-03T20:30:53.054Z',    // searches for videos created after Jan 3rd 2022
- *     ],
- *     sort: ['+video.created'],                   // sort all findings by the 'created' field (ascending)
- *     first: 0,
- *     max: 25,
- * });
- *
- * @param searchOptions Search options
- * @param [optionals]   Optional arguments; pass network call options overrides here.
- * @returns promise that resolves to a page of video objects
- */
-async function query(searchOptions, optionals = {}) {
-  const {
-    filter,
-    sort = [],
-    first,
-    max
-  } = searchOptions;
-  const searchParams = {
-    filter: parseFilterInput(filter),
-    sort: sort.join(';') || undefined,
-    first,
-    max
-  };
-  return getVideoSearch({
-    query: searchParams,
-    paginated: true,
-    ...optionals
-  });
-}
-
-/**
- * Gets a URL for a video file
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/url/{VIDEO_KEY}/{FILE}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/url/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{AFFILIATE}/{FAMILY}/{FILE}`
- *
- * @example
- * import { videoAdapter } from 'epicenter-libs';
- *
- * // get using video key
- * videoAdapter.getURL('archive.mp4', {
- *     videoKey: '0000017e31bb902cfe17615867d5005c5d5f',
- * });
- *
- * // get using scope/affiliate/family
- * videoAdapter.getURL('archive.mp4', {
- *     scope: {
- *         scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *         scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- *     },
- *     affiliate: 'VONAGE',
- *     family: 'archiveName'
- * });
- *
- * @param file                              Name of the file
- * @param [optionals]                       Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.scope]                 Scope object
- * @param [optionals.scope.scopeBoundary]   Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param [optionals.scope.scopeKey]        Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [optionals.scope.userKey]         User attached to scope if necessary
- * @param [optionals.affiliate]             Affiliate -- only support for one for now: Vonage
- * @param [optionals.family]                Identifier for the resourced provided by the affiliate (in the case of Vonage, this is the archive name).
- * @param [optionals.videoKey]              Key for the video object
- * @returns promise that resolves to the URL string for the video file
- */
-async function getURL(file, optionals = {}) {
-  const {
-    scope,
-    affiliate,
-    family,
-    videoKey,
-    ...routingOptions
-  } = optionals;
-  if (scope && family && affiliate) {
-    return getVideoURLWith(file, family, affiliate, scope, routingOptions);
-  }
-  if (videoKey) {
-    return getVideoURLByKey(file, videoKey, routingOptions);
-  }
-  throw new EpicenterError('Cannot get video URL -- either a video key or scope/affiliate/family specification is required.');
-}
-
-/**
- * Gets a directory URL for a video file
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/dir/{VIDEO_KEY}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/dir/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{AFFILIATE}/{FAMILY}`
- *
- * @example
- * import { videoAdapter } from 'epicenter-libs';
- *
- * // get using video key
- * videoAdapter.getDirectoryURL({
- *     videoKey: '0000017e31bb902cfe17615867d5005c5d5f',
- * });
- *
- * // get using scope/affiliate/family
- * videoAdapter.getDirectoryURL({
- *     scope: {
- *         scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *         scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- *     },
- *     affiliate: 'VONAGE',
- *     family: 'archiveName'
- * });
- *
- * @param [optionals]                       Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.scope]                 Scope object
- * @param [optionals.scope.scopeBoundary]   Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param [optionals.scope.scopeKey]        Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [optionals.scope.userKey]         User attached to scope if necessary
- * @param [optionals.affiliate]             Affiliate -- only support for one for now: Vonage
- * @param [optionals.family]                Identifier for the resourced provided by the affiliate (in the case of Vonage, this is the archive name).
- * @param [optionals.videoKey]              Key for the video object
- * @returns promise that resolves to a video directory object containing file list and metadata
- */
-async function getDirectoryURL(optionals = {}) {
-  const {
-    scope,
-    affiliate,
-    family,
-    videoKey,
-    ...routingOptions
-  } = optionals;
-  if (scope && family && affiliate) {
-    return getVideoDirectoryWith(family, affiliate, scope, routingOptions);
-  }
-  if (videoKey) {
-    return getVideoDirectoryByKey(videoKey, routingOptions);
-  }
-  throw new EpicenterError('Cannot get video URL -- either a video key or scope/affiliate/family specification is required.');
-}
-
-/**
- * Processes a video (one example of this is transcribing a video)
- * Base URL: POST `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/execute/{VIDEO_KEY}`
- *
- * @example
- *  const processors = [
- *     {
- *         mediaFormat: 'mp4',
- *         languageCode: 'en-US',
- *         objectType: 'transcription',
- *         mediaFile: 'archive.mp4',
- *         jobName: 'test-transcription',
- *     },
- *  ];
- *  await videoAdapter.processVideo(videoKey, processors);
- *
- * @param videoKey                              Video key
- * @param [processors[]]                        List of processes to complete
- * @param [processors[].jobName]                A string to specify the title of the newly file
- * @param [processors[].mediaFormat]            The format of the file you are processing
- * @param [processors[].languageCode]           The language which the video is recorded in
- * @param [processors[].timeoutMinutes]         Optional- how long to wait before the call cancels out; defaults to 3 minutes
- * @param [processors[].mediaFile]              The name of the media file to perform the process on
- * @param [processors[].objectType]             The type of processing job to perform (currently limited to transcribe)
- * @param [optionals]                           Optional arguments; pass network call options overrides here.
- * @param [optionals.log]                       Name for log file
- * @returns promise that resolves to a boolean indicating success
- */
-async function processVideo(videoKey, processors, optionals = {}) {
-  const {
-    log,
-    ...routingOptions
-  } = optionals;
-  const body = {
-    processors,
-    log
-  };
-  return postVideoProcessor(videoKey, body, routingOptions);
-}
-
-/**
- * Downloads a video file
- * Base URL: GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/download/{VIDEO_KEY}/{FILE}` or GET `https://forio.com/api/v3/{ACCOUNT}/{PROJECT}/video/download/with/{SCOPE_BOUNDARY}/{SCOPE_KEY}/{AFFILIATE}/{FAMILY}/{FILE}`
- *
- * @example
- * import { videoAdapter } from 'epicenter-libs';
- * // download using video key
- * await videoAdapter.download('archive.mp4', {
- *     videoKey: '0000017e31bb902cfe17615867d5005c5d5f',
- * });
- * // download using scope/affiliate/family
- * await videoAdapter.download('archive.mp4', {
- *     scope: {
- *         scopeBoundary: SCOPE_BOUNDARY.GROUP,
- *         scopeKey: '0000017dd3bf540e5ada5b1e058f08f20461',
- *     },
- *     affiliate: 'VONAGE',
- *     family: 'archiveName'
- * });
- *
- * @param file                              Name of the file
- * @param [optionals]                       Optional arguments; pass network call options overrides here. Special arguments specific to this method are listed below if they exist.
- * @param [optionals.scope]                 Scope object
- * @param [optionals.scope.scopeBoundary]   Scope boundary, defines the type of scope; See [scope boundary](#SCOPE_BOUNDARY) for all types
- * @param [optionals.scope.scopeKey]        Scope key, a unique identifier tied to the scope. E.g., if your `scopeBoundary` is `GROUP`, your `scopeKey` will be your `groupKey`; for `EPISODE`, `episodeKey`, etc.
- * @param [optionals.scope.userKey]         User attached to scope if necessary
- * @param [optionals.affiliate]             Affiliate -- only support for one for now: Vonage
- * @param [optionals.family]                Identifier for the resourced provided by the affiliate (in the case of Vonage, this is the archive name).
- * @param [optionals.videoKey]              Key for the video object
- * @returns promise that resolves to undefined when download is complete
- */
-async function download(file, optionals = {}) {
-  const {
-    scope,
-    affiliate,
-    family,
-    videoKey,
-    ...routingOptions
-  } = optionals;
-  if (scope && family && affiliate) {
-    return downloadVideoWith(file, family, affiliate, scope, routingOptions);
-  }
-  if (videoKey) {
-    return downloadVideoByKey(file, videoKey, routingOptions);
-  }
-  throw new EpicenterError('Cannot download video -- either a video key or scope/affiliate/family specification is required.');
-}
-
-export { download, getDirectoryURL, getURL, processVideo, query, remove };