st-schema/lib/state/StateRefreshResponse.js

SmartThings Schema for C2C integration

/**
 *	Copyright 2018 SmartThings
 *
 *	Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 *	in compliance with the License. You may obtain a copy of the License at:
 *
 *		http://www.apache.org/licenses/LICENSE-2.0
 *
 *	Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
 *	on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
 *	for the specific language governing permissions and limitations under the License.
 *
 */

'use strict';

/**
 * @typedef {Object} StateRefreshResponse
 * @property {string} interactionType
 * @property {string} requestId
 * @property {Array} deviceState
 */

const StateResponse = require('./StateResponse');

/**
 * Class representing a state refresh response in ST schema.
 * @class StateRefreshResponse
 * @extends StateResponse
 */
class StateRefreshResponse extends StateResponse {
  /**
   * Create a state refresh response
   * @params {string} requestId
   */
  constructor(requestId) {
    super('stateRefreshResponse', requestId);
  }
}

module.exports = StateRefreshResponse;