appcenter-cli/dist/util/apis/generated/models/releaseUpdateRequest.js

Command line tool for Visual Studio App Center

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 * Changes may cause incorrect behavior and will be lost if the code is
 * regenerated.
 */

'use strict';

/**
 * A request containing information for updating a release.
 *
 */
class ReleaseUpdateRequest {
  /**
   * Create a ReleaseUpdateRequest.
   * @property {string} [distributionGroupName] OBSOLETE. Will be removed in
   * future releases - use destinations instead. Name of a distribution group.
   * The release will be associated with this distribution group. If the
   * distribution group doesn't exist a 400 is returned. If both distribution
   * group name and id are passed, the id is taking precedence.
   * @property {string} [distributionGroupId] OBSOLETE. Will be removed in
   * future releases - use destinations instead. Id of a distribution group.
   * The release will be associated with this distribution group. If the
   * distribution group doesn't exist a 400 is returned. If both distribution
   * group name and id are passed, the id is taking precedence.
   * @property {string} [destinationName] OBSOLETE. Will be removed in future
   * releases - use destinations instead. Name of a destination. The release
   * will be associated with this destination. If the destination doesn't exist
   * a 400 is returned. If both distribution group name and id are passed, the
   * id is taking precedence.
   * @property {string} [destinationId] OBSOLETE. Will be removed in future
   * releases - use destinations instead. Id of a destination. The release will
   * be associated with this destination. If the destination doesn't exist a
   * 400 is returned. If both destination name and id are passed, the id is
   * taking precedence.
   * @property {string} [destinationType] Not used anymore.
   * @property {string} [releaseNotes] Release notes for this release.
   * @property {boolean} [mandatoryUpdate] A boolean which determines whether
   * this version should be a mandatory update or not.
   * @property {array} [destinations] Distribute this release under the
   * following list of destinations (store groups or distribution groups).
   * @property {object} [build]
   * @property {string} [build.branch] The branch name of the build producing
   * the release
   * @property {string} [build.commitHash] The commit hash of the build
   * producing the release
   * @property {string} [build.commitMessage] The commit message of the build
   * producing the release
   * @property {boolean} [notifyTesters] A boolean which determines whether to
   * notify testers of a new release, default to true. Default value: true .
   */
  constructor() {
  }

  /**
   * Defines the metadata of ReleaseUpdateRequest
   *
   * @returns {object} metadata of ReleaseUpdateRequest
   *
   */
  mapper() {
    return {
      required: false,
      serializedName: 'ReleaseUpdateRequest',
      type: {
        name: 'Composite',
        className: 'ReleaseUpdateRequest',
        modelProperties: {
          distributionGroupName: {
            required: false,
            serializedName: 'distribution_group_name',
            type: {
              name: 'String'
            }
          },
          distributionGroupId: {
            required: false,
            serializedName: 'distribution_group_id',
            type: {
              name: 'String'
            }
          },
          destinationName: {
            required: false,
            serializedName: 'destination_name',
            type: {
              name: 'String'
            }
          },
          destinationId: {
            required: false,
            serializedName: 'destination_id',
            type: {
              name: 'String'
            }
          },
          destinationType: {
            required: false,
            serializedName: 'destination_type',
            type: {
              name: 'String'
            }
          },
          releaseNotes: {
            required: false,
            serializedName: 'release_notes',
            type: {
              name: 'String'
            }
          },
          mandatoryUpdate: {
            required: false,
            serializedName: 'mandatory_update',
            type: {
              name: 'Boolean'
            }
          },
          destinations: {
            required: false,
            serializedName: 'destinations',
            type: {
              name: 'Sequence',
              element: {
                  required: false,
                  serializedName: 'DestinationIdElementType',
                  type: {
                    name: 'Composite',
                    className: 'DestinationId'
                  }
              }
            }
          },
          build: {
            required: false,
            serializedName: 'build',
            type: {
              name: 'Composite',
              className: 'BuildInfo'
            }
          },
          notifyTesters: {
            required: false,
            serializedName: 'notify_testers',
            defaultValue: true,
            type: {
              name: 'Boolean'
            }
          }
        }
      }
    };
  }
}

module.exports = ReleaseUpdateRequest;