distributions.js

define(["helpers"], function(helpers) {

    /**
     * @module Distributions
     * @description Method for [Wrapper for AT&T M2X Distribution API]{@link https://m2x.att.com/developer/documentation/distribution} endpoint.
     * @param client {object}
     * @param metadata {object}
     * @constructor
     */
    var Distributions = function(client, metadata) {
        this.client = client;
        this.metadata = metadata;
    };

    /**
     * @memberOf Distributions
     * @description Method for [List Distributions]{@link https://m2x.att.com/developer/documentation/v2/distribution#List-Distributions} endpoint.
     * @param params {params} Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns Distributions list
     */
    Distributions.prototype.list = function(params, callback, errorCallback) {
        if (typeof params === "function") {
            callback = params;
            errorCallback = callback;
            params = {};
        }
        return this.client.get("/distributions", { qs: params || {} }, callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [Create Distribution]{@link https://m2x.att.com/developer/documentation/v2/distribution#Create-Distribution} endpoint.
     * @param params {params} Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns Distribution details
     */
    Distributions.prototype.create = function(params, callback, errorCallback) {
        return this.client.post("/distributions", { params: params }, callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [View Distribution Details]{@link https://m2x.att.com/developer/documentation/v2/distribution#View-Distribution-Details} endpoint.
     * @param id {str} ID of the Distribution to retrieve
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns Distribution details
     */
    Distributions.prototype.view = function(id, callback, errorCallback) {
        return this.client.get(helpers.url("/distributions/{0}", id), callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [Update Distribution Details]{@link https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Details} endpoint.
     * @param id {str} ID of the Distribution to update
     * @param params {params} Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns HttpResponse The API response, see M2X API docs for details
     */
    Distributions.prototype.update = function(id, params, callback, errorCallback) {
        return this.client.put(
            helpers.url("/distributions/{0}", id),
            { params: params },
            callback, errorCallback
        );
    };

    /**
     * @memberOf Distributions
     * @description Method for [List Devices from an existing Distribution]{@link https://m2x.att.com/developer/documentation/v2/distribution#List-Devices-from-an-existing-Distribution} endpoint.
     * @param id {str} ID of the Distribution to retrieve list of devices
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns Devices list
     */
    Distributions.prototype.devices = function(id, callback, errorCallback) {
        return this.client.get(
            helpers.url("/distributions/{0}/devices", id),
            callback, errorCallback
        );
    };

    /**
     * @memberOf Distributions
     * @description Method for [Add Device to an existing Distribution]{@link https://m2x.att.com/developer/documentation/v2/distribution#Add-Device-to-an-existing-Distribution} endpoint.
     * @param id {str} ID of the Distribution to add device
     * @param serial {str} Serial ID of the new device to add
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns HttpResponse The API response, see M2X API docs for details
     */
    Distributions.prototype.addDevice = function(id, serial, callback, errorCallback) {
        return this.client.post(helpers.url("/distributions/{0}/devices", id), {
            headers: { "Content-Type": "application/json" },
            params: { serial: serial }
        }, callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [Delete Distribution]{@link https://m2x.att.com/developer/documentation/v2/distribution#Delete-Distribution} endpoint.
     * @param id {str} ID of the Distribution to delete device
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns HttpResponse The API response, see M2X API docs for details
     */
    Distributions.prototype.deleteDistribution = function(id, callback, errorCallback) {
        return this.client.del(helpers.url("/distributions/{0}", id), callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [List Data Streams]{@link https://m2x.att.com/developer/documentation/v2/distribution#List-Data-Streams} endpoint.
     * @param id {str} ID of the Distribution to retrieve a list of data streams
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns Data streams list
     */
    Distributions.prototype.dataStreams = function(id, callback, errorCallback) {
        return this.client.get(
            helpers.url("/distributions/{0}/streams", id),
            callback, errorCallback
        );
    };

    /**
     * @memberOf Distributions
     * @description Method for [Create/Update Data Stream]{@link https://m2x.att.com/developer/documentation/v2/distribution#Create-Update-Data-Stream} endpoint.
     * @param id {str} ID of the Distribution to create/update data streams
     * @param name {str} Name of the Data stream
     * @param params {params} Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns HttpResponse The API response, see M2X API docs for details
     */
    Distributions.prototype.updateDataStream = function(id, name, params, callback, errorCallback) {
        return this.client.put(
            helpers.url("/distributions/{0}/streams/{1}", id, name),
            {
                headers: { "Content-Type": "application/json" },
                params: params
            },
            callback, errorCallback
        );
    };

    /**
     * @memberOf Distributions
     * @description Method for [View Data Stream]{@link https://m2x.att.com/developer/documentation/v2/distribution#View-Data-Stream} endpoint.
     * @param id {str} ID of the Distribution to view data stream
     * @param name {str} Name of the Data stream
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns Data stream details
     */
    Distributions.prototype.dataStream = function(id, name, callback, errorCallback) {
        return this.client.get(
            helpers.url("/distributions/{0}/streams/{1}", id, name),
            callback, errorCallback
        );
    };

    /**
     * @memberOf Distributions
     * @description Method for [Delete Data Stream]{@link https://m2x.att.com/developer/documentation/v2/distribution#Delete-Data-Stream} endpoint.
     * @param id {str} ID of the Distribution to delete data stream
     * @param name {str} Name of the Data stream
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     * @returns HttpResponse The API response, see M2X API docs for details
     */
    Distributions.prototype.deleteDataStream = function(id, name, callback, errorCallback) {
        return this.client.del(
            helpers.url("/distributions/{0}/streams/{1}", id, name),
            callback, errorCallback
        );
    };

    /**
     * @memberOf Distributions
     * @description Method for [Read Distribution Metadata]{@link https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata} endpoint.
     * @param id {str} ID of the Distribution to read metadata
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     */
    Distributions.prototype.readMetadata = function(id, callback, errorCallback) {
        this.metadata.read("distributions", id, callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [Update Distribution Metadata]{@link https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata} endpoint.
     * @param id {str} ID of the Distribution to update metadata
     * @param params {params} Query parameters passed as keyword arguments. View M2X API Docs for listing of available parameters.
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     */
    Distributions.prototype.updateMetadata = function(id, params, callback, errorCallback) {
        this.metadata.update("distributions", id, params, callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [Read Distribution Metadata Field]{@link https://m2x.att.com/developer/documentation/v2/distribution#Read-Distribution-Metadata-Field} endpoint.
     * @param id {str} ID of the Distribution to read metadata field
     * @param field {str} Metadata field to be read
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     */
    Distributions.prototype.readMetadataField = function(id, field, callback, errorCallback) {
        this.metadata.readField("distributions", id, field, callback, errorCallback);
    };

    /**
     * @memberOf Distributions
     * @description Method for [Update Distribution Metadata Field]{@link https://m2x.att.com/developer/documentation/v2/distribution#Update-Distribution-Metadata-Field} endpoint.
     * @param id {str} ID of the Distribution to update metadata field
     * @param field {str} Metadata field to be updated
     * @param value {str} Value to be updated
     * @param callback {function} Response callback
     * @param errorCallback {function} Error callback
     */
    Distributions.prototype.updateMetadataField = function(id, field, value, callback, errorCallback) {
        this.metadata.updateField("distributions", id, field, value, callback, errorCallback);
    };

    return Distributions;
});