Source: rest/video/v1/compositionHook.js

  1. 'use strict';
  3. /* jshint ignore:start */
  4. /**
  5.  * This code was generated by
  6.  * \ / _    _  _|   _  _
  7.  *  | (_)\/(_)(_|\/| |(/_  v1.0.0
  8.  *       /       /
  9.  */
  10. /* jshint ignore:end */
  12. var Q = require('q');  /* jshint ignore:line */
  13. var _ = require('lodash');  /* jshint ignore:line */
  14. var util = require('util');  /* jshint ignore:line */
  15. var Page = require('../../../base/Page');  /* jshint ignore:line */
  16. var deserialize = require(
  17.     '../../../base/deserialize');  /* jshint ignore:line */
  18. var serialize = require('../../../base/serialize');  /* jshint ignore:line */
  19. var values = require('../../../base/values');  /* jshint ignore:line */
  21. var CompositionHookList;
  22. var CompositionHookPage;
  23. var CompositionHookInstance;
  24. var CompositionHookContext;
  26. /* jshint ignore:start */
  27. /**
  28.  * Initialize the CompositionHookList
  29.  *
  30.  * @constructor Twilio.Video.V1.CompositionHookList
  31.  *
  32.  * @param {Twilio.Video.V1} version - Version of the resource
  33.  */
  34. /* jshint ignore:end */
  35. CompositionHookList = function CompositionHookList(version) {
  36.   /* jshint ignore:start */
  37.   /**
  38.    * @function compositionHooks
  39.    * @memberof Twilio.Video.V1#
  40.    *
  41.    * @param {string} sid - sid of instance
  42.    *
  43.    * @returns {Twilio.Video.V1.CompositionHookContext}
  44.    */
  45.   /* jshint ignore:end */
  46.   function CompositionHookListInstance(sid) {
  47.     return CompositionHookListInstance.get(sid);
  48.   }
  50.   CompositionHookListInstance._version = version;
  51.   // Path Solution
  52.   CompositionHookListInstance._solution = {};
  53.   CompositionHookListInstance._uri = `/CompositionHooks`;
  54.   /* jshint ignore:start */
  55.   /**
  56.    * Streams CompositionHookInstance records from the API.
  57.    *
  58.    * This operation lazily loads records as efficiently as possible until the limit
  59.    * is reached.
  60.    *
  61.    * The results are passed into the callback function, so this operation is memory
  62.    * efficient.
  63.    *
  64.    * If a function is passed as the first argument, it will be used as the callback
  65.    * function.
  66.    *
  67.    * @function each
  68.    * @memberof Twilio.Video.V1.CompositionHookList#
  69.    *
  70.    * @param {object} [opts] - Options for request
  71.    * @param {boolean} [opts.enabled] -
  72.    *          Read only CompositionHook resources with an enabled value that matches this parameter
  73.    * @param {Date} [opts.dateCreatedAfter] -
  74.    *          Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone
  75.    * @param {Date} [opts.dateCreatedBefore] -
  76.    *          Read only CompositionHook resources created before this ISO 8601 datetime with time zone
  77.    * @param {string} [opts.friendlyName] -
  78.    *          Read only CompositionHook resources with friendly names that match this string
  79.    * @param {number} [opts.limit] -
  80.    *         Upper limit for the number of records to return.
  81.    *         each() guarantees never to return more than limit.
  82.    *         Default is no limit
  83.    * @param {number} [opts.pageSize] -
  84.    *         Number of records to fetch per request,
  85.    *         when not set will use the default value of 50 records.
  86.    *         If no pageSize is defined but a limit is defined,
  87.    *         each() will attempt to read the limit with the most efficient
  88.    *         page size, i.e. min(limit, 1000)
  89.    * @param {Function} [opts.callback] -
  90.    *         Function to process each record. If this and a positional
  91.    *         callback are passed, this one will be used
  92.    * @param {Function} [opts.done] -
  93.    *          Function to be called upon completion of streaming
  94.    * @param {Function} [callback] - Function to process each record
  95.    */
  96.   /* jshint ignore:end */
  97.   CompositionHookListInstance.each = function each(opts, callback) {
  98.     if (_.isFunction(opts)) {
  99.       callback = opts;
  100.       opts = {};
  101.     }
  102.     opts = opts || {};
  103.     if (opts.callback) {
  104.       callback = opts.callback;
  105.     }
  106.     if (_.isUndefined(callback)) {
  107.       throw new Error('Callback function must be provided');
  108.     }
  110.     var done = false;
  111.     var currentPage = 1;
  112.     var currentResource = 0;
  113.     var limits = this._version.readLimits({
  114.       limit: opts.limit,
  115.       pageSize: opts.pageSize
  116.     });
  118.     function onComplete(error) {
  119.       done = true;
  120.       if (_.isFunction(opts.done)) {
  121.         opts.done(error);
  122.       }
  123.     }
  125.     function fetchNextPage(fn) {
  126.       var promise = fn();
  127.       if (_.isUndefined(promise)) {
  128.         onComplete();
  129.         return;
  130.       }
  132.       promise.then(function(page) {
  133.         _.each(page.instances, function(instance) {
  134.           if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
  135.             done = true;
  136.             return false;
  137.           }
  139.           currentResource++;
  140.           callback(instance, onComplete);
  141.         });
  143.         if (!done) {
  144.           currentPage++;
  145.           fetchNextPage(_.bind(page.nextPage, page));
  146.         }
  147.       });
  149.       promise.catch(onComplete);
  150.     }
  152.     fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
  153.   };
  155.   /* jshint ignore:start */
  156.   /**
  157.    * Lists CompositionHookInstance records from the API as a list.
  158.    *
  159.    * If a function is passed as the first argument, it will be used as the callback
  160.    * function.
  161.    *
  162.    * @function list
  163.    * @memberof Twilio.Video.V1.CompositionHookList#
  164.    *
  165.    * @param {object} [opts] - Options for request
  166.    * @param {boolean} [opts.enabled] -
  167.    *          Read only CompositionHook resources with an enabled value that matches this parameter
  168.    * @param {Date} [opts.dateCreatedAfter] -
  169.    *          Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone
  170.    * @param {Date} [opts.dateCreatedBefore] -
  171.    *          Read only CompositionHook resources created before this ISO 8601 datetime with time zone
  172.    * @param {string} [opts.friendlyName] -
  173.    *          Read only CompositionHook resources with friendly names that match this string
  174.    * @param {number} [opts.limit] -
  175.    *         Upper limit for the number of records to return.
  176.    *         list() guarantees never to return more than limit.
  177.    *         Default is no limit
  178.    * @param {number} [opts.pageSize] -
  179.    *         Number of records to fetch per request,
  180.    *         when not set will use the default value of 50 records.
  181.    *         If no page_size is defined but a limit is defined,
  182.    *         list() will attempt to read the limit with the most
  183.    *         efficient page size, i.e. min(limit, 1000)
  184.    * @param {function} [callback] - Callback to handle list of records
  185.    *
  186.    * @returns {Promise} Resolves to a list of records
  187.    */
  188.   /* jshint ignore:end */
  189.   CompositionHookListInstance.list = function list(opts, callback) {
  190.     if (_.isFunction(opts)) {
  191.       callback = opts;
  192.       opts = {};
  193.     }
  194.     opts = opts || {};
  195.     var deferred = Q.defer();
  196.     var allResources = [];
  197.     opts.callback = function(resource, done) {
  198.       allResources.push(resource);
  200.       if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
  201.         done();
  202.       }
  203.     };
  205.     opts.done = function(error) {
  206.       if (_.isUndefined(error)) {
  207.         deferred.resolve(allResources);
  208.       } else {
  209.         deferred.reject(error);
  210.       }
  211.     };
  213.     if (_.isFunction(callback)) {
  214.       deferred.promise.nodeify(callback);
  215.     }
  217.     this.each(opts);
  218.     return deferred.promise;
  219.   };
  221.   /* jshint ignore:start */
  222.   /**
  223.    * Retrieve a single page of CompositionHookInstance records from the API.
  224.    *
  225.    * The request is executed immediately.
  226.    *
  227.    * If a function is passed as the first argument, it will be used as the callback
  228.    * function.
  229.    *
  230.    * @function page
  231.    * @memberof Twilio.Video.V1.CompositionHookList#
  232.    *
  233.    * @param {object} [opts] - Options for request
  234.    * @param {boolean} [opts.enabled] -
  235.    *          Read only CompositionHook resources with an enabled value that matches this parameter
  236.    * @param {Date} [opts.dateCreatedAfter] -
  237.    *          Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone
  238.    * @param {Date} [opts.dateCreatedBefore] -
  239.    *          Read only CompositionHook resources created before this ISO 8601 datetime with time zone
  240.    * @param {string} [opts.friendlyName] -
  241.    *          Read only CompositionHook resources with friendly names that match this string
  242.    * @param {string} [opts.pageToken] - PageToken provided by the API
  243.    * @param {number} [opts.pageNumber] -
  244.    *          Page Number, this value is simply for client state
  245.    * @param {number} [opts.pageSize] - Number of records to return, defaults to 50
  246.    * @param {function} [callback] - Callback to handle list of records
  247.    *
  248.    * @returns {Promise} Resolves to a list of records
  249.    */
  250.   /* jshint ignore:end */
  251.   CompositionHookListInstance.page = function page(opts, callback) {
  252.     if (_.isFunction(opts)) {
  253.       callback = opts;
  254.       opts = {};
  255.     }
  256.     opts = opts || {};
  258.     var deferred = Q.defer();
  259.     var data = values.of({
  260.       'Enabled': serialize.bool(_.get(opts, 'enabled')),
  261.       'DateCreatedAfter': serialize.iso8601DateTime(_.get(opts, 'dateCreatedAfter')),
  262.       'DateCreatedBefore': serialize.iso8601DateTime(_.get(opts, 'dateCreatedBefore')),
  263.       'FriendlyName': _.get(opts, 'friendlyName'),
  264.       'PageToken': opts.pageToken,
  265.       'Page': opts.pageNumber,
  266.       'PageSize': opts.pageSize
  267.     });
  269.     var promise = this._version.page({uri: this._uri, method: 'GET', params: data});
  271.     promise = promise.then(function(payload) {
  272.       deferred.resolve(new CompositionHookPage(this._version, payload, this._solution));
  273.     }.bind(this));
  275.     promise.catch(function(error) {
  276.       deferred.reject(error);
  277.     });
  279.     if (_.isFunction(callback)) {
  280.       deferred.promise.nodeify(callback);
  281.     }
  283.     return deferred.promise;
  284.   };
  286.   /* jshint ignore:start */
  287.   /**
  288.    * Retrieve a single target page of CompositionHookInstance records from the API.
  289.    *
  290.    * The request is executed immediately.
  291.    *
  292.    * If a function is passed as the first argument, it will be used as the callback
  293.    * function.
  294.    *
  295.    * @function getPage
  296.    * @memberof Twilio.Video.V1.CompositionHookList#
  297.    *
  298.    * @param {string} [targetUrl] - API-generated URL for the requested results page
  299.    * @param {function} [callback] - Callback to handle list of records
  300.    *
  301.    * @returns {Promise} Resolves to a list of records
  302.    */
  303.   /* jshint ignore:end */
  304.   CompositionHookListInstance.getPage = function getPage(targetUrl, callback) {
  305.     var deferred = Q.defer();
  307.     var promise = this._version._domain.twilio.request({method: 'GET', uri: targetUrl});
  309.     promise = promise.then(function(payload) {
  310.       deferred.resolve(new CompositionHookPage(this._version, payload, this._solution));
  311.     }.bind(this));
  313.     promise.catch(function(error) {
  314.       deferred.reject(error);
  315.     });
  317.     if (_.isFunction(callback)) {
  318.       deferred.promise.nodeify(callback);
  319.     }
  321.     return deferred.promise;
  322.   };
  324.   /* jshint ignore:start */
  325.   /**
  326.    * create a CompositionHookInstance
  327.    *
  328.    * @function create
  329.    * @memberof Twilio.Video.V1.CompositionHookList#
  330.    *
  331.    * @param {object} opts - Options for request
  332.    * @param {string} opts.friendlyName - A unique string to describe the resource
  333.    * @param {boolean} [opts.enabled] - Whether the composition hook is active
  334.    * @param {object} [opts.videoLayout] -
  335.    *          An object that describes the video layout of the composition hook
  336.    * @param {string|list} [opts.audioSources] -
  337.    *          An array of track names from the same group room to merge
  338.    * @param {string|list} [opts.audioSourcesExcluded] -
  339.    *          An array of track names to exclude
  340.    * @param {string} [opts.resolution] -
  341.    *          A string that describes the rows (width) and columns (height) of the generated composed video in pixels
  342.    * @param {composition_hook.format} [opts.format] -
  343.    *          The container format of the media files used by the compositions created by the composition hook
  344.    * @param {string} [opts.statusCallback] -
  345.    *          The URL we should call to send status information to your application
  346.    * @param {string} [opts.statusCallbackMethod] -
  347.    *          The HTTP method we should use to call status_callback
  348.    * @param {boolean} [opts.trim] -
  349.    *          Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook
  350.    * @param {function} [callback] - Callback to handle processed record
  351.    *
  352.    * @returns {Promise} Resolves to processed CompositionHookInstance
  353.    */
  354.   /* jshint ignore:end */
  355.   CompositionHookListInstance.create = function create(opts, callback) {
  356.     if (_.isUndefined(opts)) {
  357.       throw new Error('Required parameter "opts" missing.');
  358.     }
  359.     if (_.isUndefined(opts.friendlyName)) {
  360.       throw new Error('Required parameter "opts.friendlyName" missing.');
  361.     }
  363.     var deferred = Q.defer();
  364.     var data = values.of({
  365.       'FriendlyName': _.get(opts, 'friendlyName'),
  366.       'Enabled': serialize.bool(_.get(opts, 'enabled')),
  367.       'VideoLayout': serialize.object(_.get(opts, 'videoLayout')),
  368.       'AudioSources': serialize.map(_.get(opts, 'audioSources'), function(e) { return e; }),
  369.       'AudioSourcesExcluded': serialize.map(_.get(opts, 'audioSourcesExcluded'), function(e) { return e; }),
  370.       'Resolution': _.get(opts, 'resolution'),
  371.       'Format': _.get(opts, 'format'),
  372.       'StatusCallback': _.get(opts, 'statusCallback'),
  373.       'StatusCallbackMethod': _.get(opts, 'statusCallbackMethod'),
  374.       'Trim': serialize.bool(_.get(opts, 'trim'))
  375.     });
  377.     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
  379.     promise = promise.then(function(payload) {
  380.       deferred.resolve(new CompositionHookInstance(this._version, payload, this._solution.sid));
  381.     }.bind(this));
  383.     promise.catch(function(error) {
  384.       deferred.reject(error);
  385.     });
  387.     if (_.isFunction(callback)) {
  388.       deferred.promise.nodeify(callback);
  389.     }
  391.     return deferred.promise;
  392.   };
  394.   /* jshint ignore:start */
  395.   /**
  396.    * Constructs a composition_hook
  397.    *
  398.    * @function get
  399.    * @memberof Twilio.Video.V1.CompositionHookList#
  400.    *
  401.    * @param {string} sid - The SID that identifies the resource to fetch
  402.    *
  403.    * @returns {Twilio.Video.V1.CompositionHookContext}
  404.    */
  405.   /* jshint ignore:end */
  406.   CompositionHookListInstance.get = function get(sid) {
  407.     return new CompositionHookContext(this._version, sid);
  408.   };
  410.   /* jshint ignore:start */
  411.   /**
  412.    * Provide a user-friendly representation
  413.    *
  414.    * @function toJSON
  415.    * @memberof Twilio.Video.V1.CompositionHookList#
  416.    *
  417.    * @returns Object
  418.    */
  419.   /* jshint ignore:end */
  420.   CompositionHookListInstance.toJSON = function toJSON() {
  421.     return this._solution;
  422.   };
  424.   CompositionHookListInstance[util.inspect.custom] = function inspect(depth,
  425.       options) {
  426.     return util.inspect(this.toJSON(), options);
  427.   };
  429.   return CompositionHookListInstance;
  430. };
  433. /* jshint ignore:start */
  434. /**
  435.  * Initialize the CompositionHookPage
  436.  *
  437.  * @constructor Twilio.Video.V1.CompositionHookPage
  438.  *
  439.  * @param {V1} version - Version of the resource
  440.  * @param {Response<string>} response - Response from the API
  441.  * @param {CompositionHookSolution} solution - Path solution
  442.  *
  443.  * @returns CompositionHookPage
  444.  */
  445. /* jshint ignore:end */
  446. CompositionHookPage = function CompositionHookPage(version, response, solution)
  447.                                                     {
  448.   // Path Solution
  449.   this._solution = solution;
  451.   Page.prototype.constructor.call(this, version, response, this._solution);
  452. };
  454. _.extend(CompositionHookPage.prototype, Page.prototype);
  455. CompositionHookPage.prototype.constructor = CompositionHookPage;
  457. /* jshint ignore:start */
  458. /**
  459.  * Build an instance of CompositionHookInstance
  460.  *
  461.  * @function getInstance
  462.  * @memberof Twilio.Video.V1.CompositionHookPage#
  463.  *
  464.  * @param {CompositionHookPayload} payload - Payload response from the API
  465.  *
  466.  * @returns CompositionHookInstance
  467.  */
  468. /* jshint ignore:end */
  469. CompositionHookPage.prototype.getInstance = function getInstance(payload) {
  470.   return new CompositionHookInstance(this._version, payload);
  471. };
  473. /* jshint ignore:start */
  474. /**
  475.  * Provide a user-friendly representation
  476.  *
  477.  * @function toJSON
  478.  * @memberof Twilio.Video.V1.CompositionHookPage#
  479.  *
  480.  * @returns Object
  481.  */
  482. /* jshint ignore:end */
  483. CompositionHookPage.prototype.toJSON = function toJSON() {
  484.   let clone = {};
  485.   _.forOwn(this, function(value, key) {
  486.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  487.       clone[key] = value;
  488.     }
  489.   });
  490.   return clone;
  491. };
  493. CompositionHookPage.prototype[util.inspect.custom] = function inspect(depth,
  494.     options) {
  495.   return util.inspect(this.toJSON(), options);
  496. };
  499. /* jshint ignore:start */
  500. /**
  501.  * Initialize the CompositionHookContext
  502.  *
  503.  * @constructor Twilio.Video.V1.CompositionHookInstance
  504.  *
  505.  * @property {string} accountSid - The SID of the Account that created the resource
  506.  * @property {string} friendlyName -
  507.  *          The string that you assigned to describe the resource
  508.  * @property {boolean} enabled - Whether the CompositionHook is active
  509.  * @property {Date} dateCreated -
  510.  *          The ISO 8601 date and time in GMT when the resource was created
  511.  * @property {Date} dateUpdated -
  512.  *          The ISO 8601 date and time in GMT when the resource was last updated
  513.  * @property {string} sid - The unique string that identifies the resource
  514.  * @property {string} audioSources -
  515.  *          The array of track names to include in the compositions created by the composition hook
  516.  * @property {string} audioSourcesExcluded -
  517.  *          The array of track names to exclude from the compositions created by the composition hook
  518.  * @property {object} videoLayout -
  519.  *          A JSON object that describes the video layout of the Composition
  520.  * @property {string} resolution -
  521.  *          The dimensions of the video image in pixels expressed as columns (width) and rows (height)
  522.  * @property {boolean} trim - Whether intervals with no media are clipped
  523.  * @property {composition_hook.format} format -
  524.  *          The container format of the media files used by the compositions created by the composition hook
  525.  * @property {string} statusCallback -
  526.  *          The URL to send status information to your application
  527.  * @property {string} statusCallbackMethod -
  528.  *          The HTTP method we should use to call status_callback
  529.  * @property {string} url - The absolute URL of the resource
  530.  *
  531.  * @param {V1} version - Version of the resource
  532.  * @param {CompositionHookPayload} payload - The instance payload
  533.  * @param {sid} sid - The SID that identifies the resource to fetch
  534.  */
  535. /* jshint ignore:end */
  536. CompositionHookInstance = function CompositionHookInstance(version, payload,
  537.                                                             sid) {
  538.   this._version = version;
  540.   // Marshaled Properties
  541.   this.accountSid = payload.account_sid; // jshint ignore:line
  542.   this.friendlyName = payload.friendly_name; // jshint ignore:line
  543.   this.enabled = payload.enabled; // jshint ignore:line
  544.   this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
  545.   this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
  546.   this.sid = payload.sid; // jshint ignore:line
  547.   this.audioSources = payload.audio_sources; // jshint ignore:line
  548.   this.audioSourcesExcluded = payload.audio_sources_excluded; // jshint ignore:line
  549.   this.videoLayout = payload.video_layout; // jshint ignore:line
  550.   this.resolution = payload.resolution; // jshint ignore:line
  551.   this.trim = payload.trim; // jshint ignore:line
  552.   this.format = payload.format; // jshint ignore:line
  553.   this.statusCallback = payload.status_callback; // jshint ignore:line
  554.   this.statusCallbackMethod = payload.status_callback_method; // jshint ignore:line
  555.   this.url = payload.url; // jshint ignore:line
  557.   // Context
  558.   this._context = undefined;
  559.   this._solution = {sid: sid || this.sid, };
  560. };
  562. Object.defineProperty(CompositionHookInstance.prototype,
  563.   '_proxy', {
  564.     get: function() {
  565.       if (!this._context) {
  566.         this._context = new CompositionHookContext(this._version, this._solution.sid);
  567.       }
  569.       return this._context;
  570.     }
  571. });
  573. /* jshint ignore:start */
  574. /**
  575.  * fetch a CompositionHookInstance
  576.  *
  577.  * @function fetch
  578.  * @memberof Twilio.Video.V1.CompositionHookInstance#
  579.  *
  580.  * @param {function} [callback] - Callback to handle processed record
  581.  *
  582.  * @returns {Promise} Resolves to processed CompositionHookInstance
  583.  */
  584. /* jshint ignore:end */
  585. CompositionHookInstance.prototype.fetch = function fetch(callback) {
  586.   return this._proxy.fetch(callback);
  587. };
  589. /* jshint ignore:start */
  590. /**
  591.  * remove a CompositionHookInstance
  592.  *
  593.  * @function remove
  594.  * @memberof Twilio.Video.V1.CompositionHookInstance#
  595.  *
  596.  * @param {function} [callback] - Callback to handle processed record
  597.  *
  598.  * @returns {Promise} Resolves to processed CompositionHookInstance
  599.  */
  600. /* jshint ignore:end */
  601. CompositionHookInstance.prototype.remove = function remove(callback) {
  602.   return this._proxy.remove(callback);
  603. };
  605. /* jshint ignore:start */
  606. /**
  607.  * update a CompositionHookInstance
  608.  *
  609.  * @function update
  610.  * @memberof Twilio.Video.V1.CompositionHookInstance#
  611.  *
  612.  * @param {object} opts - Options for request
  613.  * @param {string} opts.friendlyName - A unique string to describe the resource
  614.  * @param {boolean} [opts.enabled] - Whether the composition hook is active
  615.  * @param {object} [opts.videoLayout] -
  616.  *          A JSON object that describes the video layout of the composition hook
  617.  * @param {string|list} [opts.audioSources] -
  618.  *          An array of track names from the same group room to merge
  619.  * @param {string|list} [opts.audioSourcesExcluded] -
  620.  *          An array of track names to exclude
  621.  * @param {boolean} [opts.trim] -
  622.  *          Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook
  623.  * @param {composition_hook.format} [opts.format] -
  624.  *          The container format of the media files used by the compositions created by the composition hook
  625.  * @param {string} [opts.resolution] -
  626.  *          A string that describes the columns (width) and rows (height) of the generated composed video in pixels
  627.  * @param {string} [opts.statusCallback] -
  628.  *          The URL we should call to send status information to your application
  629.  * @param {string} [opts.statusCallbackMethod] -
  630.  *          The HTTP method we should use to call status_callback
  631.  * @param {function} [callback] - Callback to handle processed record
  632.  *
  633.  * @returns {Promise} Resolves to processed CompositionHookInstance
  634.  */
  635. /* jshint ignore:end */
  636. CompositionHookInstance.prototype.update = function update(opts, callback) {
  637.   return this._proxy.update(opts, callback);
  638. };
  640. /* jshint ignore:start */
  641. /**
  642.  * Provide a user-friendly representation
  643.  *
  644.  * @function toJSON
  645.  * @memberof Twilio.Video.V1.CompositionHookInstance#
  646.  *
  647.  * @returns Object
  648.  */
  649. /* jshint ignore:end */
  650. CompositionHookInstance.prototype.toJSON = function toJSON() {
  651.   let clone = {};
  652.   _.forOwn(this, function(value, key) {
  653.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  654.       clone[key] = value;
  655.     }
  656.   });
  657.   return clone;
  658. };
  660. CompositionHookInstance.prototype[util.inspect.custom] = function inspect(depth,
  661.     options) {
  662.   return util.inspect(this.toJSON(), options);
  663. };
  666. /* jshint ignore:start */
  667. /**
  668.  * Initialize the CompositionHookContext
  669.  *
  670.  * @constructor Twilio.Video.V1.CompositionHookContext
  671.  *
  672.  * @param {V1} version - Version of the resource
  673.  * @param {sid} sid - The SID that identifies the resource to fetch
  674.  */
  675. /* jshint ignore:end */
  676. CompositionHookContext = function CompositionHookContext(version, sid) {
  677.   this._version = version;
  679.   // Path Solution
  680.   this._solution = {sid: sid, };
  681.   this._uri = `/CompositionHooks/${sid}`;
  682. };
  684. /* jshint ignore:start */
  685. /**
  686.  * fetch a CompositionHookInstance
  687.  *
  688.  * @function fetch
  689.  * @memberof Twilio.Video.V1.CompositionHookContext#
  690.  *
  691.  * @param {function} [callback] - Callback to handle processed record
  692.  *
  693.  * @returns {Promise} Resolves to processed CompositionHookInstance
  694.  */
  695. /* jshint ignore:end */
  696. CompositionHookContext.prototype.fetch = function fetch(callback) {
  697.   var deferred = Q.defer();
  698.   var promise = this._version.fetch({uri: this._uri, method: 'GET'});
  700.   promise = promise.then(function(payload) {
  701.     deferred.resolve(new CompositionHookInstance(this._version, payload, this._solution.sid));
  702.   }.bind(this));
  704.   promise.catch(function(error) {
  705.     deferred.reject(error);
  706.   });
  708.   if (_.isFunction(callback)) {
  709.     deferred.promise.nodeify(callback);
  710.   }
  712.   return deferred.promise;
  713. };
  715. /* jshint ignore:start */
  716. /**
  717.  * remove a CompositionHookInstance
  718.  *
  719.  * @function remove
  720.  * @memberof Twilio.Video.V1.CompositionHookContext#
  721.  *
  722.  * @param {function} [callback] - Callback to handle processed record
  723.  *
  724.  * @returns {Promise} Resolves to processed CompositionHookInstance
  725.  */
  726. /* jshint ignore:end */
  727. CompositionHookContext.prototype.remove = function remove(callback) {
  728.   var deferred = Q.defer();
  729.   var promise = this._version.remove({uri: this._uri, method: 'DELETE'});
  731.   promise = promise.then(function(payload) {
  732.     deferred.resolve(payload);
  733.   }.bind(this));
  735.   promise.catch(function(error) {
  736.     deferred.reject(error);
  737.   });
  739.   if (_.isFunction(callback)) {
  740.     deferred.promise.nodeify(callback);
  741.   }
  743.   return deferred.promise;
  744. };
  746. /* jshint ignore:start */
  747. /**
  748.  * update a CompositionHookInstance
  749.  *
  750.  * @function update
  751.  * @memberof Twilio.Video.V1.CompositionHookContext#
  752.  *
  753.  * @param {object} opts - Options for request
  754.  * @param {string} opts.friendlyName - A unique string to describe the resource
  755.  * @param {boolean} [opts.enabled] - Whether the composition hook is active
  756.  * @param {object} [opts.videoLayout] -
  757.  *          A JSON object that describes the video layout of the composition hook
  758.  * @param {string|list} [opts.audioSources] -
  759.  *          An array of track names from the same group room to merge
  760.  * @param {string|list} [opts.audioSourcesExcluded] -
  761.  *          An array of track names to exclude
  762.  * @param {boolean} [opts.trim] -
  763.  *          Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook
  764.  * @param {composition_hook.format} [opts.format] -
  765.  *          The container format of the media files used by the compositions created by the composition hook
  766.  * @param {string} [opts.resolution] -
  767.  *          A string that describes the columns (width) and rows (height) of the generated composed video in pixels
  768.  * @param {string} [opts.statusCallback] -
  769.  *          The URL we should call to send status information to your application
  770.  * @param {string} [opts.statusCallbackMethod] -
  771.  *          The HTTP method we should use to call status_callback
  772.  * @param {function} [callback] - Callback to handle processed record
  773.  *
  774.  * @returns {Promise} Resolves to processed CompositionHookInstance
  775.  */
  776. /* jshint ignore:end */
  777. CompositionHookContext.prototype.update = function update(opts, callback) {
  778.   if (_.isUndefined(opts)) {
  779.     throw new Error('Required parameter "opts" missing.');
  780.   }
  781.   if (_.isUndefined(opts.friendlyName)) {
  782.     throw new Error('Required parameter "opts.friendlyName" missing.');
  783.   }
  785.   var deferred = Q.defer();
  786.   var data = values.of({
  787.     'FriendlyName': _.get(opts, 'friendlyName'),
  788.     'Enabled': serialize.bool(_.get(opts, 'enabled')),
  789.     'VideoLayout': serialize.object(_.get(opts, 'videoLayout')),
  790.     'AudioSources': serialize.map(_.get(opts, 'audioSources'), function(e) { return e; }),
  791.     'AudioSourcesExcluded': serialize.map(_.get(opts, 'audioSourcesExcluded'), function(e) { return e; }),
  792.     'Trim': serialize.bool(_.get(opts, 'trim')),
  793.     'Format': _.get(opts, 'format'),
  794.     'Resolution': _.get(opts, 'resolution'),
  795.     'StatusCallback': _.get(opts, 'statusCallback'),
  796.     'StatusCallbackMethod': _.get(opts, 'statusCallbackMethod')
  797.   });
  799.   var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
  801.   promise = promise.then(function(payload) {
  802.     deferred.resolve(new CompositionHookInstance(this._version, payload, this._solution.sid));
  803.   }.bind(this));
  805.   promise.catch(function(error) {
  806.     deferred.reject(error);
  807.   });
  809.   if (_.isFunction(callback)) {
  810.     deferred.promise.nodeify(callback);
  811.   }
  813.   return deferred.promise;
  814. };
  816. /* jshint ignore:start */
  817. /**
  818.  * Provide a user-friendly representation
  819.  *
  820.  * @function toJSON
  821.  * @memberof Twilio.Video.V1.CompositionHookContext#
  822.  *
  823.  * @returns Object
  824.  */
  825. /* jshint ignore:end */
  826. CompositionHookContext.prototype.toJSON = function toJSON() {
  827.   return this._solution;
  828. };
  830. CompositionHookContext.prototype[util.inspect.custom] = function inspect(depth,
  831.     options) {
  832.   return util.inspect(this.toJSON(), options);
  833. };
  835. module.exports = {
  836.   CompositionHookList: CompositionHookList,
  837.   CompositionHookPage: CompositionHookPage,
  838.   CompositionHookInstance: CompositionHookInstance,
  839.   CompositionHookContext: CompositionHookContext
  840. };