microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
lib/app-center-node-client/src/codepush/operations/index.d.ts
1273lines · modecode
| 1 | /* |
| 2 | * Code generated by Microsoft (R) AutoRest Code Generator. |
| 3 | * Changes may cause incorrect behavior and will be lost if the code is |
| 4 | * regenerated. |
| 5 | */ |
| 6 | |
| 7 | import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; |
| 8 | import * as stream from 'stream'; |
| 9 | import * as models from '../models'; |
| 10 | |
| 11 | |
| 12 | /** |
| 13 | * @class |
| 14 | * CodePushAcquisition |
| 15 | * __NOTE__: An instance of this class is automatically created for an |
| 16 | * instance of the CodepushClient. |
| 17 | */ |
| 18 | export interface CodePushAcquisition { |
| 19 | |
| 20 | |
| 21 | /** |
| 22 | * Report Deployment status metric |
| 23 | * |
| 24 | * @param {object} releaseMetadata Deployment status metric properties |
| 25 | * |
| 26 | * @param {string} releaseMetadata.deploymentKey |
| 27 | * |
| 28 | * @param {string} [releaseMetadata.label] |
| 29 | * |
| 30 | * @param {string} [releaseMetadata.appVersion] |
| 31 | * |
| 32 | * @param {string} [releaseMetadata.previousDeploymentKey] |
| 33 | * |
| 34 | * @param {string} [releaseMetadata.previousLabelOrAppVersion] |
| 35 | * |
| 36 | * @param {string} [releaseMetadata.status] |
| 37 | * |
| 38 | * @param {string} [releaseMetadata.clientUniqueId] |
| 39 | * |
| 40 | * @param {object} [options] Optional Parameters. |
| 41 | * |
| 42 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 43 | * request |
| 44 | * |
| 45 | * @returns {Promise} A promise is returned |
| 46 | * |
| 47 | * @resolve {HttpOperationResponse<null>} - The deserialized result object. |
| 48 | * |
| 49 | * @reject {Error|ServiceError} - The error object. |
| 50 | */ |
| 51 | updateDeployStatusWithHttpOperationResponse(releaseMetadata: models.CodePushStatusMetricMetadata, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; |
| 52 | |
| 53 | /** |
| 54 | * Report Deployment status metric |
| 55 | * |
| 56 | * @param {object} releaseMetadata Deployment status metric properties |
| 57 | * |
| 58 | * @param {string} releaseMetadata.deploymentKey |
| 59 | * |
| 60 | * @param {string} [releaseMetadata.label] |
| 61 | * |
| 62 | * @param {string} [releaseMetadata.appVersion] |
| 63 | * |
| 64 | * @param {string} [releaseMetadata.previousDeploymentKey] |
| 65 | * |
| 66 | * @param {string} [releaseMetadata.previousLabelOrAppVersion] |
| 67 | * |
| 68 | * @param {string} [releaseMetadata.status] |
| 69 | * |
| 70 | * @param {string} [releaseMetadata.clientUniqueId] |
| 71 | * |
| 72 | * @param {object} [options] Optional Parameters. |
| 73 | * |
| 74 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 75 | * request |
| 76 | * |
| 77 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 78 | * |
| 79 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 80 | * parameter then it returns the callback else returns a Promise. |
| 81 | * |
| 82 | * {Promise} A promise is returned. |
| 83 | * |
| 84 | * @resolve {null} - The deserialized result object. |
| 85 | * |
| 86 | * @reject {Error|ServiceError} - The error object. |
| 87 | * |
| 88 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 89 | * |
| 90 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 91 | * |
| 92 | * {null} [result] - The deserialized result object if an error did not occur. |
| 93 | * |
| 94 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 95 | * |
| 96 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 97 | */ |
| 98 | updateDeployStatus(releaseMetadata: models.CodePushStatusMetricMetadata, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; |
| 99 | updateDeployStatus(releaseMetadata: models.CodePushStatusMetricMetadata, callback: ServiceCallback<void>): void; |
| 100 | updateDeployStatus(releaseMetadata: models.CodePushStatusMetricMetadata, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; |
| 101 | |
| 102 | |
| 103 | /** |
| 104 | * Report download of specified release |
| 105 | * |
| 106 | * @param {object} releaseMetadata Deployment status metric properties |
| 107 | * |
| 108 | * @param {string} releaseMetadata.deploymentKey |
| 109 | * |
| 110 | * @param {string} [releaseMetadata.label] |
| 111 | * |
| 112 | * @param {string} [releaseMetadata.appVersion] |
| 113 | * |
| 114 | * @param {string} [releaseMetadata.previousDeploymentKey] |
| 115 | * |
| 116 | * @param {string} [releaseMetadata.previousLabelOrAppVersion] |
| 117 | * |
| 118 | * @param {string} [releaseMetadata.status] |
| 119 | * |
| 120 | * @param {string} [releaseMetadata.clientUniqueId] |
| 121 | * |
| 122 | * @param {object} [options] Optional Parameters. |
| 123 | * |
| 124 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 125 | * request |
| 126 | * |
| 127 | * @returns {Promise} A promise is returned |
| 128 | * |
| 129 | * @resolve {HttpOperationResponse<null>} - The deserialized result object. |
| 130 | * |
| 131 | * @reject {Error|ServiceError} - The error object. |
| 132 | */ |
| 133 | updateDownloadStatusWithHttpOperationResponse(releaseMetadata: models.CodePushStatusMetricMetadata, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; |
| 134 | |
| 135 | /** |
| 136 | * Report download of specified release |
| 137 | * |
| 138 | * @param {object} releaseMetadata Deployment status metric properties |
| 139 | * |
| 140 | * @param {string} releaseMetadata.deploymentKey |
| 141 | * |
| 142 | * @param {string} [releaseMetadata.label] |
| 143 | * |
| 144 | * @param {string} [releaseMetadata.appVersion] |
| 145 | * |
| 146 | * @param {string} [releaseMetadata.previousDeploymentKey] |
| 147 | * |
| 148 | * @param {string} [releaseMetadata.previousLabelOrAppVersion] |
| 149 | * |
| 150 | * @param {string} [releaseMetadata.status] |
| 151 | * |
| 152 | * @param {string} [releaseMetadata.clientUniqueId] |
| 153 | * |
| 154 | * @param {object} [options] Optional Parameters. |
| 155 | * |
| 156 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 157 | * request |
| 158 | * |
| 159 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 160 | * |
| 161 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 162 | * parameter then it returns the callback else returns a Promise. |
| 163 | * |
| 164 | * {Promise} A promise is returned. |
| 165 | * |
| 166 | * @resolve {null} - The deserialized result object. |
| 167 | * |
| 168 | * @reject {Error|ServiceError} - The error object. |
| 169 | * |
| 170 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 171 | * |
| 172 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 173 | * |
| 174 | * {null} [result] - The deserialized result object if an error did not occur. |
| 175 | * |
| 176 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 177 | * |
| 178 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 179 | */ |
| 180 | updateDownloadStatus(releaseMetadata: models.CodePushStatusMetricMetadata, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; |
| 181 | updateDownloadStatus(releaseMetadata: models.CodePushStatusMetricMetadata, callback: ServiceCallback<void>): void; |
| 182 | updateDownloadStatus(releaseMetadata: models.CodePushStatusMetricMetadata, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; |
| 183 | |
| 184 | |
| 185 | /** |
| 186 | * Check for updates |
| 187 | * |
| 188 | * @param {string} appVersion |
| 189 | * |
| 190 | * @param {string} deploymentKey |
| 191 | * |
| 192 | * @param {object} [options] Optional Parameters. |
| 193 | * |
| 194 | * @param {string} [options.clientUniqueId] |
| 195 | * |
| 196 | * @param {boolean} [options.isCompanion] |
| 197 | * |
| 198 | * @param {string} [options.label] |
| 199 | * |
| 200 | * @param {string} [options.packageHash] |
| 201 | * |
| 202 | * @param {string} [options.previousDeploymentKey] |
| 203 | * |
| 204 | * @param {string} [options.previousLabelOrAppVersion] |
| 205 | * |
| 206 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 207 | * request |
| 208 | * |
| 209 | * @returns {Promise} A promise is returned |
| 210 | * |
| 211 | * @resolve {HttpOperationResponse<UpdateCheckResponse>} - The deserialized result object. |
| 212 | * |
| 213 | * @reject {Error|ServiceError} - The error object. |
| 214 | */ |
| 215 | updateCheckWithHttpOperationResponse(appVersion: string, deploymentKey: string, options?: { clientUniqueId? : string, isCompanion? : boolean, label? : string, packageHash? : string, previousDeploymentKey? : string, previousLabelOrAppVersion? : string, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.UpdateCheckResponse>>; |
| 216 | |
| 217 | /** |
| 218 | * Check for updates |
| 219 | * |
| 220 | * @param {string} appVersion |
| 221 | * |
| 222 | * @param {string} deploymentKey |
| 223 | * |
| 224 | * @param {object} [options] Optional Parameters. |
| 225 | * |
| 226 | * @param {string} [options.clientUniqueId] |
| 227 | * |
| 228 | * @param {boolean} [options.isCompanion] |
| 229 | * |
| 230 | * @param {string} [options.label] |
| 231 | * |
| 232 | * @param {string} [options.packageHash] |
| 233 | * |
| 234 | * @param {string} [options.previousDeploymentKey] |
| 235 | * |
| 236 | * @param {string} [options.previousLabelOrAppVersion] |
| 237 | * |
| 238 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 239 | * request |
| 240 | * |
| 241 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 242 | * |
| 243 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 244 | * parameter then it returns the callback else returns a Promise. |
| 245 | * |
| 246 | * {Promise} A promise is returned. |
| 247 | * |
| 248 | * @resolve {UpdateCheckResponse} - The deserialized result object. |
| 249 | * |
| 250 | * @reject {Error|ServiceError} - The error object. |
| 251 | * |
| 252 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 253 | * |
| 254 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 255 | * |
| 256 | * {UpdateCheckResponse} [result] - The deserialized result object if an error did not occur. |
| 257 | * See {@link UpdateCheckResponse} for more information. |
| 258 | * |
| 259 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 260 | * |
| 261 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 262 | */ |
| 263 | updateCheck(appVersion: string, deploymentKey: string, options?: { clientUniqueId? : string, isCompanion? : boolean, label? : string, packageHash? : string, previousDeploymentKey? : string, previousLabelOrAppVersion? : string, customHeaders? : { [headerName: string]: string; } }): Promise<models.UpdateCheckResponse>; |
| 264 | updateCheck(appVersion: string, deploymentKey: string, callback: ServiceCallback<models.UpdateCheckResponse>): void; |
| 265 | updateCheck(appVersion: string, deploymentKey: string, options: { clientUniqueId? : string, isCompanion? : boolean, label? : string, packageHash? : string, previousDeploymentKey? : string, previousLabelOrAppVersion? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.UpdateCheckResponse>): void; |
| 266 | } |
| 267 | |
| 268 | /** |
| 269 | * @class |
| 270 | * CodePushDeployments |
| 271 | * __NOTE__: An instance of this class is automatically created for an |
| 272 | * instance of the CodepushClient. |
| 273 | */ |
| 274 | export interface CodePushDeployments { |
| 275 | |
| 276 | |
| 277 | /** |
| 278 | * Gets a list of CodePush deployments for the given app |
| 279 | * |
| 280 | * @param {string} appName The name of the application |
| 281 | * |
| 282 | * @param {string} ownerName The name of the owner |
| 283 | * |
| 284 | * @param {object} [options] Optional Parameters. |
| 285 | * |
| 286 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 287 | * request |
| 288 | * |
| 289 | * @returns {Promise} A promise is returned |
| 290 | * |
| 291 | * @resolve {HttpOperationResponse<Array>} - The deserialized result object. |
| 292 | * |
| 293 | * @reject {Error|ServiceError} - The error object. |
| 294 | */ |
| 295 | listWithHttpOperationResponse(appName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Deployment[]>>; |
| 296 | |
| 297 | /** |
| 298 | * Gets a list of CodePush deployments for the given app |
| 299 | * |
| 300 | * @param {string} appName The name of the application |
| 301 | * |
| 302 | * @param {string} ownerName The name of the owner |
| 303 | * |
| 304 | * @param {object} [options] Optional Parameters. |
| 305 | * |
| 306 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 307 | * request |
| 308 | * |
| 309 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 310 | * |
| 311 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 312 | * parameter then it returns the callback else returns a Promise. |
| 313 | * |
| 314 | * {Promise} A promise is returned. |
| 315 | * |
| 316 | * @resolve {Array} - The deserialized result object. |
| 317 | * |
| 318 | * @reject {Error|ServiceError} - The error object. |
| 319 | * |
| 320 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 321 | * |
| 322 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 323 | * |
| 324 | * {Array} [result] - The deserialized result object if an error did not occur. |
| 325 | * |
| 326 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 327 | * |
| 328 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 329 | */ |
| 330 | list(appName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.Deployment[]>; |
| 331 | list(appName: string, ownerName: string, callback: ServiceCallback<models.Deployment[]>): void; |
| 332 | list(appName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Deployment[]>): void; |
| 333 | |
| 334 | |
| 335 | /** |
| 336 | * Creates a CodePush Deployment for the given app |
| 337 | * |
| 338 | * @param {string} appName The name of the application |
| 339 | * |
| 340 | * @param {object} deployment Deployment to be created |
| 341 | * |
| 342 | * @param {string} [deployment.key] |
| 343 | * |
| 344 | * @param {string} deployment.name |
| 345 | * |
| 346 | * @param {object} [deployment.latestRelease] |
| 347 | * |
| 348 | * @param {string} [deployment.latestRelease.label] |
| 349 | * |
| 350 | * @param {string} [deployment.latestRelease.packageHash] |
| 351 | * |
| 352 | * @param {string} [deployment.latestRelease.blobUrl] |
| 353 | * |
| 354 | * @param {object} [deployment.latestRelease.diffPackageMap] |
| 355 | * |
| 356 | * @param {string} [deployment.latestRelease.originalDeployment] Set on |
| 357 | * 'Promote' |
| 358 | * |
| 359 | * @param {string} [deployment.latestRelease.originalLabel] Set on 'Promote' |
| 360 | * and 'Rollback' |
| 361 | * |
| 362 | * @param {string} [deployment.latestRelease.releasedBy] |
| 363 | * |
| 364 | * @param {string} [deployment.latestRelease.releaseMethod] The release method |
| 365 | * is unknown if unspecified. Possible values include: 'Upload', 'Promote', |
| 366 | * 'Rollback' |
| 367 | * |
| 368 | * @param {number} [deployment.latestRelease.size] |
| 369 | * |
| 370 | * @param {number} [deployment.latestRelease.uploadTime] |
| 371 | * |
| 372 | * @param {string} [deployment.latestRelease.targetBinaryRange] |
| 373 | * |
| 374 | * @param {string} [deployment.latestRelease.description] |
| 375 | * |
| 376 | * @param {boolean} [deployment.latestRelease.isDisabled] |
| 377 | * |
| 378 | * @param {boolean} [deployment.latestRelease.isMandatory] |
| 379 | * |
| 380 | * @param {number} [deployment.latestRelease.rollout] |
| 381 | * |
| 382 | * @param {string} ownerName The name of the owner |
| 383 | * |
| 384 | * @param {object} [options] Optional Parameters. |
| 385 | * |
| 386 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 387 | * request |
| 388 | * |
| 389 | * @returns {Promise} A promise is returned |
| 390 | * |
| 391 | * @resolve {HttpOperationResponse<Deployment>} - The deserialized result object. |
| 392 | * |
| 393 | * @reject {Error|ServiceError} - The error object. |
| 394 | */ |
| 395 | createWithHttpOperationResponse(appName: string, deployment: models.Deployment, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Deployment>>; |
| 396 | |
| 397 | /** |
| 398 | * Creates a CodePush Deployment for the given app |
| 399 | * |
| 400 | * @param {string} appName The name of the application |
| 401 | * |
| 402 | * @param {object} deployment Deployment to be created |
| 403 | * |
| 404 | * @param {string} [deployment.key] |
| 405 | * |
| 406 | * @param {string} deployment.name |
| 407 | * |
| 408 | * @param {object} [deployment.latestRelease] |
| 409 | * |
| 410 | * @param {string} [deployment.latestRelease.label] |
| 411 | * |
| 412 | * @param {string} [deployment.latestRelease.packageHash] |
| 413 | * |
| 414 | * @param {string} [deployment.latestRelease.blobUrl] |
| 415 | * |
| 416 | * @param {object} [deployment.latestRelease.diffPackageMap] |
| 417 | * |
| 418 | * @param {string} [deployment.latestRelease.originalDeployment] Set on |
| 419 | * 'Promote' |
| 420 | * |
| 421 | * @param {string} [deployment.latestRelease.originalLabel] Set on 'Promote' |
| 422 | * and 'Rollback' |
| 423 | * |
| 424 | * @param {string} [deployment.latestRelease.releasedBy] |
| 425 | * |
| 426 | * @param {string} [deployment.latestRelease.releaseMethod] The release method |
| 427 | * is unknown if unspecified. Possible values include: 'Upload', 'Promote', |
| 428 | * 'Rollback' |
| 429 | * |
| 430 | * @param {number} [deployment.latestRelease.size] |
| 431 | * |
| 432 | * @param {number} [deployment.latestRelease.uploadTime] |
| 433 | * |
| 434 | * @param {string} [deployment.latestRelease.targetBinaryRange] |
| 435 | * |
| 436 | * @param {string} [deployment.latestRelease.description] |
| 437 | * |
| 438 | * @param {boolean} [deployment.latestRelease.isDisabled] |
| 439 | * |
| 440 | * @param {boolean} [deployment.latestRelease.isMandatory] |
| 441 | * |
| 442 | * @param {number} [deployment.latestRelease.rollout] |
| 443 | * |
| 444 | * @param {string} ownerName The name of the owner |
| 445 | * |
| 446 | * @param {object} [options] Optional Parameters. |
| 447 | * |
| 448 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 449 | * request |
| 450 | * |
| 451 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 452 | * |
| 453 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 454 | * parameter then it returns the callback else returns a Promise. |
| 455 | * |
| 456 | * {Promise} A promise is returned. |
| 457 | * |
| 458 | * @resolve {Deployment} - The deserialized result object. |
| 459 | * |
| 460 | * @reject {Error|ServiceError} - The error object. |
| 461 | * |
| 462 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 463 | * |
| 464 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 465 | * |
| 466 | * {Deployment} [result] - The deserialized result object if an error did not occur. |
| 467 | * See {@link Deployment} for more information. |
| 468 | * |
| 469 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 470 | * |
| 471 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 472 | */ |
| 473 | create(appName: string, deployment: models.Deployment, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.Deployment>; |
| 474 | create(appName: string, deployment: models.Deployment, ownerName: string, callback: ServiceCallback<models.Deployment>): void; |
| 475 | create(appName: string, deployment: models.Deployment, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Deployment>): void; |
| 476 | |
| 477 | |
| 478 | /** |
| 479 | * Deletes a CodePush Deployment for the given app |
| 480 | * |
| 481 | * @param {string} appName The name of the application |
| 482 | * |
| 483 | * @param {string} deploymentName deployment name |
| 484 | * |
| 485 | * @param {string} ownerName The name of the owner |
| 486 | * |
| 487 | * @param {object} [options] Optional Parameters. |
| 488 | * |
| 489 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 490 | * request |
| 491 | * |
| 492 | * @returns {Promise} A promise is returned |
| 493 | * |
| 494 | * @resolve {HttpOperationResponse<null>} - The deserialized result object. |
| 495 | * |
| 496 | * @reject {Error|ServiceError} - The error object. |
| 497 | */ |
| 498 | deleteMethodWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; |
| 499 | |
| 500 | /** |
| 501 | * Deletes a CodePush Deployment for the given app |
| 502 | * |
| 503 | * @param {string} appName The name of the application |
| 504 | * |
| 505 | * @param {string} deploymentName deployment name |
| 506 | * |
| 507 | * @param {string} ownerName The name of the owner |
| 508 | * |
| 509 | * @param {object} [options] Optional Parameters. |
| 510 | * |
| 511 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 512 | * request |
| 513 | * |
| 514 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 515 | * |
| 516 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 517 | * parameter then it returns the callback else returns a Promise. |
| 518 | * |
| 519 | * {Promise} A promise is returned. |
| 520 | * |
| 521 | * @resolve {null} - The deserialized result object. |
| 522 | * |
| 523 | * @reject {Error|ServiceError} - The error object. |
| 524 | * |
| 525 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 526 | * |
| 527 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 528 | * |
| 529 | * {null} [result] - The deserialized result object if an error did not occur. |
| 530 | * |
| 531 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 532 | * |
| 533 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 534 | */ |
| 535 | deleteMethod(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; |
| 536 | deleteMethod(appName: string, deploymentName: string, ownerName: string, callback: ServiceCallback<void>): void; |
| 537 | deleteMethod(appName: string, deploymentName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; |
| 538 | |
| 539 | |
| 540 | /** |
| 541 | * Gets a CodePush Deployment for the given app |
| 542 | * |
| 543 | * @param {string} appName The name of the application |
| 544 | * |
| 545 | * @param {string} deploymentName deployment name |
| 546 | * |
| 547 | * @param {string} ownerName The name of the owner |
| 548 | * |
| 549 | * @param {object} [options] Optional Parameters. |
| 550 | * |
| 551 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 552 | * request |
| 553 | * |
| 554 | * @returns {Promise} A promise is returned |
| 555 | * |
| 556 | * @resolve {HttpOperationResponse<Deployment>} - The deserialized result object. |
| 557 | * |
| 558 | * @reject {Error|ServiceError} - The error object. |
| 559 | */ |
| 560 | getWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Deployment>>; |
| 561 | |
| 562 | /** |
| 563 | * Gets a CodePush Deployment for the given app |
| 564 | * |
| 565 | * @param {string} appName The name of the application |
| 566 | * |
| 567 | * @param {string} deploymentName deployment name |
| 568 | * |
| 569 | * @param {string} ownerName The name of the owner |
| 570 | * |
| 571 | * @param {object} [options] Optional Parameters. |
| 572 | * |
| 573 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 574 | * request |
| 575 | * |
| 576 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 577 | * |
| 578 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 579 | * parameter then it returns the callback else returns a Promise. |
| 580 | * |
| 581 | * {Promise} A promise is returned. |
| 582 | * |
| 583 | * @resolve {Deployment} - The deserialized result object. |
| 584 | * |
| 585 | * @reject {Error|ServiceError} - The error object. |
| 586 | * |
| 587 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 588 | * |
| 589 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 590 | * |
| 591 | * {Deployment} [result] - The deserialized result object if an error did not occur. |
| 592 | * See {@link Deployment} for more information. |
| 593 | * |
| 594 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 595 | * |
| 596 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 597 | */ |
| 598 | get(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.Deployment>; |
| 599 | get(appName: string, deploymentName: string, ownerName: string, callback: ServiceCallback<models.Deployment>): void; |
| 600 | get(appName: string, deploymentName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Deployment>): void; |
| 601 | |
| 602 | |
| 603 | /** |
| 604 | * Modifies a CodePush Deployment for the given app |
| 605 | * |
| 606 | * @param {string} appName The name of the application |
| 607 | * |
| 608 | * @param {object} deployment Deployment modification. All fields are optional |
| 609 | * and only provided fields will get updated. |
| 610 | * |
| 611 | * @param {string} deployment.name |
| 612 | * |
| 613 | * @param {string} deploymentName deployment name |
| 614 | * |
| 615 | * @param {string} ownerName The name of the owner |
| 616 | * |
| 617 | * @param {object} [options] Optional Parameters. |
| 618 | * |
| 619 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 620 | * request |
| 621 | * |
| 622 | * @returns {Promise} A promise is returned |
| 623 | * |
| 624 | * @resolve {HttpOperationResponse<null>} - The deserialized result object. |
| 625 | * |
| 626 | * @reject {Error|ServiceError} - The error object. |
| 627 | */ |
| 628 | updateWithHttpOperationResponse(appName: string, deployment: models.DeploymentModification, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; |
| 629 | |
| 630 | /** |
| 631 | * Modifies a CodePush Deployment for the given app |
| 632 | * |
| 633 | * @param {string} appName The name of the application |
| 634 | * |
| 635 | * @param {object} deployment Deployment modification. All fields are optional |
| 636 | * and only provided fields will get updated. |
| 637 | * |
| 638 | * @param {string} deployment.name |
| 639 | * |
| 640 | * @param {string} deploymentName deployment name |
| 641 | * |
| 642 | * @param {string} ownerName The name of the owner |
| 643 | * |
| 644 | * @param {object} [options] Optional Parameters. |
| 645 | * |
| 646 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 647 | * request |
| 648 | * |
| 649 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 650 | * |
| 651 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 652 | * parameter then it returns the callback else returns a Promise. |
| 653 | * |
| 654 | * {Promise} A promise is returned. |
| 655 | * |
| 656 | * @resolve {null} - The deserialized result object. |
| 657 | * |
| 658 | * @reject {Error|ServiceError} - The error object. |
| 659 | * |
| 660 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 661 | * |
| 662 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 663 | * |
| 664 | * {null} [result] - The deserialized result object if an error did not occur. |
| 665 | * |
| 666 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 667 | * |
| 668 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 669 | */ |
| 670 | update(appName: string, deployment: models.DeploymentModification, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; |
| 671 | update(appName: string, deployment: models.DeploymentModification, deploymentName: string, ownerName: string, callback: ServiceCallback<void>): void; |
| 672 | update(appName: string, deployment: models.DeploymentModification, deploymentName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; |
| 673 | |
| 674 | |
| 675 | /** |
| 676 | * Promote one release (default latest one) from one deployment to another |
| 677 | * |
| 678 | * @param {string} appName The name of the application |
| 679 | * |
| 680 | * @param {string} deploymentName deployment name |
| 681 | * |
| 682 | * @param {string} ownerName The name of the owner |
| 683 | * |
| 684 | * @param {string} promoteDeploymentName deployment name |
| 685 | * |
| 686 | * @param {object} [options] Optional Parameters. |
| 687 | * |
| 688 | * @param {object} [options.release] Release to be promoted, only needs to |
| 689 | * provide optional fields, description, label, disabled, mandatory, rollout, |
| 690 | * targetBinaryVersion |
| 691 | * |
| 692 | * @param {string} [options.release.label] |
| 693 | * |
| 694 | * @param {string} [options.release.targetBinaryRange] |
| 695 | * |
| 696 | * @param {string} [options.release.description] |
| 697 | * |
| 698 | * @param {boolean} [options.release.isDisabled] |
| 699 | * |
| 700 | * @param {boolean} [options.release.isMandatory] |
| 701 | * |
| 702 | * @param {number} [options.release.rollout] |
| 703 | * |
| 704 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 705 | * request |
| 706 | * |
| 707 | * @returns {Promise} A promise is returned |
| 708 | * |
| 709 | * @resolve {HttpOperationResponse<CodePushRelease>} - The deserialized result object. |
| 710 | * |
| 711 | * @reject {Error|ServiceError} - The error object. |
| 712 | */ |
| 713 | promoteWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, promoteDeploymentName: string, options?: { release? : models.CodePushReleasePromote, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.CodePushRelease>>; |
| 714 | |
| 715 | /** |
| 716 | * Promote one release (default latest one) from one deployment to another |
| 717 | * |
| 718 | * @param {string} appName The name of the application |
| 719 | * |
| 720 | * @param {string} deploymentName deployment name |
| 721 | * |
| 722 | * @param {string} ownerName The name of the owner |
| 723 | * |
| 724 | * @param {string} promoteDeploymentName deployment name |
| 725 | * |
| 726 | * @param {object} [options] Optional Parameters. |
| 727 | * |
| 728 | * @param {object} [options.release] Release to be promoted, only needs to |
| 729 | * provide optional fields, description, label, disabled, mandatory, rollout, |
| 730 | * targetBinaryVersion |
| 731 | * |
| 732 | * @param {string} [options.release.label] |
| 733 | * |
| 734 | * @param {string} [options.release.targetBinaryRange] |
| 735 | * |
| 736 | * @param {string} [options.release.description] |
| 737 | * |
| 738 | * @param {boolean} [options.release.isDisabled] |
| 739 | * |
| 740 | * @param {boolean} [options.release.isMandatory] |
| 741 | * |
| 742 | * @param {number} [options.release.rollout] |
| 743 | * |
| 744 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 745 | * request |
| 746 | * |
| 747 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 748 | * |
| 749 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 750 | * parameter then it returns the callback else returns a Promise. |
| 751 | * |
| 752 | * {Promise} A promise is returned. |
| 753 | * |
| 754 | * @resolve {CodePushRelease} - The deserialized result object. |
| 755 | * |
| 756 | * @reject {Error|ServiceError} - The error object. |
| 757 | * |
| 758 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 759 | * |
| 760 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 761 | * |
| 762 | * {CodePushRelease} [result] - The deserialized result object if an error did not occur. |
| 763 | * See {@link CodePushRelease} for more information. |
| 764 | * |
| 765 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 766 | * |
| 767 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 768 | */ |
| 769 | promote(appName: string, deploymentName: string, ownerName: string, promoteDeploymentName: string, options?: { release? : models.CodePushReleasePromote, customHeaders? : { [headerName: string]: string; } }): Promise<models.CodePushRelease>; |
| 770 | promote(appName: string, deploymentName: string, ownerName: string, promoteDeploymentName: string, callback: ServiceCallback<models.CodePushRelease>): void; |
| 771 | promote(appName: string, deploymentName: string, ownerName: string, promoteDeploymentName: string, options: { release? : models.CodePushReleasePromote, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.CodePushRelease>): void; |
| 772 | } |
| 773 | |
| 774 | /** |
| 775 | * @class |
| 776 | * CodePushDeploymentMetrics |
| 777 | * __NOTE__: An instance of this class is automatically created for an |
| 778 | * instance of the CodepushClient. |
| 779 | */ |
| 780 | export interface CodePushDeploymentMetrics { |
| 781 | |
| 782 | |
| 783 | /** |
| 784 | * Gets all releases metrics for specified Deployment |
| 785 | * |
| 786 | * @param {string} appName The name of the application |
| 787 | * |
| 788 | * @param {string} deploymentName deployment name |
| 789 | * |
| 790 | * @param {string} ownerName The name of the owner |
| 791 | * |
| 792 | * @param {object} [options] Optional Parameters. |
| 793 | * |
| 794 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 795 | * request |
| 796 | * |
| 797 | * @returns {Promise} A promise is returned |
| 798 | * |
| 799 | * @resolve {HttpOperationResponse<Array>} - The deserialized result object. |
| 800 | * |
| 801 | * @reject {Error|ServiceError} - The error object. |
| 802 | */ |
| 803 | getWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.CodePushReleaseMetric[]>>; |
| 804 | |
| 805 | /** |
| 806 | * Gets all releases metrics for specified Deployment |
| 807 | * |
| 808 | * @param {string} appName The name of the application |
| 809 | * |
| 810 | * @param {string} deploymentName deployment name |
| 811 | * |
| 812 | * @param {string} ownerName The name of the owner |
| 813 | * |
| 814 | * @param {object} [options] Optional Parameters. |
| 815 | * |
| 816 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 817 | * request |
| 818 | * |
| 819 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 820 | * |
| 821 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 822 | * parameter then it returns the callback else returns a Promise. |
| 823 | * |
| 824 | * {Promise} A promise is returned. |
| 825 | * |
| 826 | * @resolve {Array} - The deserialized result object. |
| 827 | * |
| 828 | * @reject {Error|ServiceError} - The error object. |
| 829 | * |
| 830 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 831 | * |
| 832 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 833 | * |
| 834 | * {Array} [result] - The deserialized result object if an error did not occur. |
| 835 | * |
| 836 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 837 | * |
| 838 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 839 | */ |
| 840 | get(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.CodePushReleaseMetric[]>; |
| 841 | get(appName: string, deploymentName: string, ownerName: string, callback: ServiceCallback<models.CodePushReleaseMetric[]>): void; |
| 842 | get(appName: string, deploymentName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.CodePushReleaseMetric[]>): void; |
| 843 | } |
| 844 | |
| 845 | /** |
| 846 | * @class |
| 847 | * CodePushDeploymentReleases |
| 848 | * __NOTE__: An instance of this class is automatically created for an |
| 849 | * instance of the CodepushClient. |
| 850 | */ |
| 851 | export interface CodePushDeploymentReleases { |
| 852 | |
| 853 | |
| 854 | /** |
| 855 | * Clears a Deployment of releases |
| 856 | * |
| 857 | * @param {string} appName The name of the application |
| 858 | * |
| 859 | * @param {string} deploymentName deployment name |
| 860 | * |
| 861 | * @param {string} ownerName The name of the owner |
| 862 | * |
| 863 | * @param {object} [options] Optional Parameters. |
| 864 | * |
| 865 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 866 | * request |
| 867 | * |
| 868 | * @returns {Promise} A promise is returned |
| 869 | * |
| 870 | * @resolve {HttpOperationResponse<null>} - The deserialized result object. |
| 871 | * |
| 872 | * @reject {Error|ServiceError} - The error object. |
| 873 | */ |
| 874 | deleteMethodWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; |
| 875 | |
| 876 | /** |
| 877 | * Clears a Deployment of releases |
| 878 | * |
| 879 | * @param {string} appName The name of the application |
| 880 | * |
| 881 | * @param {string} deploymentName deployment name |
| 882 | * |
| 883 | * @param {string} ownerName The name of the owner |
| 884 | * |
| 885 | * @param {object} [options] Optional Parameters. |
| 886 | * |
| 887 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 888 | * request |
| 889 | * |
| 890 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 891 | * |
| 892 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 893 | * parameter then it returns the callback else returns a Promise. |
| 894 | * |
| 895 | * {Promise} A promise is returned. |
| 896 | * |
| 897 | * @resolve {null} - The deserialized result object. |
| 898 | * |
| 899 | * @reject {Error|ServiceError} - The error object. |
| 900 | * |
| 901 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 902 | * |
| 903 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 904 | * |
| 905 | * {null} [result] - The deserialized result object if an error did not occur. |
| 906 | * |
| 907 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 908 | * |
| 909 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 910 | */ |
| 911 | deleteMethod(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; |
| 912 | deleteMethod(appName: string, deploymentName: string, ownerName: string, callback: ServiceCallback<void>): void; |
| 913 | deleteMethod(appName: string, deploymentName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; |
| 914 | |
| 915 | |
| 916 | /** |
| 917 | * Gets the history of releases on a Deployment |
| 918 | * |
| 919 | * @param {string} appName The name of the application |
| 920 | * |
| 921 | * @param {string} deploymentName deployment name |
| 922 | * |
| 923 | * @param {string} ownerName The name of the owner |
| 924 | * |
| 925 | * @param {object} [options] Optional Parameters. |
| 926 | * |
| 927 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 928 | * request |
| 929 | * |
| 930 | * @returns {Promise} A promise is returned |
| 931 | * |
| 932 | * @resolve {HttpOperationResponse<Array>} - The deserialized result object. |
| 933 | * |
| 934 | * @reject {Error|ServiceError} - The error object. |
| 935 | */ |
| 936 | getWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.CodePushRelease[]>>; |
| 937 | |
| 938 | /** |
| 939 | * Gets the history of releases on a Deployment |
| 940 | * |
| 941 | * @param {string} appName The name of the application |
| 942 | * |
| 943 | * @param {string} deploymentName deployment name |
| 944 | * |
| 945 | * @param {string} ownerName The name of the owner |
| 946 | * |
| 947 | * @param {object} [options] Optional Parameters. |
| 948 | * |
| 949 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 950 | * request |
| 951 | * |
| 952 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 953 | * |
| 954 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 955 | * parameter then it returns the callback else returns a Promise. |
| 956 | * |
| 957 | * {Promise} A promise is returned. |
| 958 | * |
| 959 | * @resolve {Array} - The deserialized result object. |
| 960 | * |
| 961 | * @reject {Error|ServiceError} - The error object. |
| 962 | * |
| 963 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 964 | * |
| 965 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 966 | * |
| 967 | * {Array} [result] - The deserialized result object if an error did not occur. |
| 968 | * |
| 969 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 970 | * |
| 971 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 972 | */ |
| 973 | get(appName: string, deploymentName: string, ownerName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.CodePushRelease[]>; |
| 974 | get(appName: string, deploymentName: string, ownerName: string, callback: ServiceCallback<models.CodePushRelease[]>): void; |
| 975 | get(appName: string, deploymentName: string, ownerName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.CodePushRelease[]>): void; |
| 976 | |
| 977 | |
| 978 | /** |
| 979 | * Create a new CodePush release for the specified deployment |
| 980 | * |
| 981 | * @param {string} appName The name of the application |
| 982 | * |
| 983 | * @param {string} deploymentName1 deployment name |
| 984 | * |
| 985 | * @param {string} ownerName The name of the owner |
| 986 | * |
| 987 | * @param {string} targetBinaryVersion the binary version of the application |
| 988 | * |
| 989 | * @param {object} [options] Optional Parameters. |
| 990 | * |
| 991 | * @param {string} [options.deploymentName] This specifies which deployment you |
| 992 | * want to release the update to. Default is Staging. |
| 993 | * |
| 994 | * @param {string} [options.description] This provides an optional "change log" |
| 995 | * for the deployment. |
| 996 | * |
| 997 | * @param {boolean} [options.disabled] This specifies whether an update should |
| 998 | * be downloadable by end users or not. |
| 999 | * |
| 1000 | * @param {boolean} [options.mandatory] This specifies whether the update |
| 1001 | * should be considered mandatory or not (e.g. it includes a critical security |
| 1002 | * fix). |
| 1003 | * |
| 1004 | * @param {boolean} [options.noDuplicateReleaseError] This specifies that if |
| 1005 | * the update is identical to the latest release on the deployment, the CLI |
| 1006 | * should generate a warning instead of an error. |
| 1007 | * |
| 1008 | * @param {object} [options.packageProperty] The upload zip file |
| 1009 | * |
| 1010 | * @param {number} [options.rollout] This specifies the percentage of users (as |
| 1011 | * an integer between 1 and 100) that should be eligible to receive this |
| 1012 | * update. |
| 1013 | * |
| 1014 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 1015 | * request |
| 1016 | * |
| 1017 | * @returns {Promise} A promise is returned |
| 1018 | * |
| 1019 | * @resolve {HttpOperationResponse<CodePushRelease>} - The deserialized result object. |
| 1020 | * |
| 1021 | * @reject {Error|ServiceError} - The error object. |
| 1022 | */ |
| 1023 | createWithHttpOperationResponse(appName: string, deploymentName1: string, ownerName: string, targetBinaryVersion: string, options?: { deploymentName? : string, description? : string, disabled? : boolean, mandatory? : boolean, noDuplicateReleaseError? : boolean, packageProperty? : stream.Readable, rollout? : number, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.CodePushRelease>>; |
| 1024 | |
| 1025 | /** |
| 1026 | * Create a new CodePush release for the specified deployment |
| 1027 | * |
| 1028 | * @param {string} appName The name of the application |
| 1029 | * |
| 1030 | * @param {string} deploymentName1 deployment name |
| 1031 | * |
| 1032 | * @param {string} ownerName The name of the owner |
| 1033 | * |
| 1034 | * @param {string} targetBinaryVersion the binary version of the application |
| 1035 | * |
| 1036 | * @param {object} [options] Optional Parameters. |
| 1037 | * |
| 1038 | * @param {string} [options.deploymentName] This specifies which deployment you |
| 1039 | * want to release the update to. Default is Staging. |
| 1040 | * |
| 1041 | * @param {string} [options.description] This provides an optional "change log" |
| 1042 | * for the deployment. |
| 1043 | * |
| 1044 | * @param {boolean} [options.disabled] This specifies whether an update should |
| 1045 | * be downloadable by end users or not. |
| 1046 | * |
| 1047 | * @param {boolean} [options.mandatory] This specifies whether the update |
| 1048 | * should be considered mandatory or not (e.g. it includes a critical security |
| 1049 | * fix). |
| 1050 | * |
| 1051 | * @param {boolean} [options.noDuplicateReleaseError] This specifies that if |
| 1052 | * the update is identical to the latest release on the deployment, the CLI |
| 1053 | * should generate a warning instead of an error. |
| 1054 | * |
| 1055 | * @param {object} [options.packageProperty] The upload zip file |
| 1056 | * |
| 1057 | * @param {number} [options.rollout] This specifies the percentage of users (as |
| 1058 | * an integer between 1 and 100) that should be eligible to receive this |
| 1059 | * update. |
| 1060 | * |
| 1061 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 1062 | * request |
| 1063 | * |
| 1064 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 1065 | * |
| 1066 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 1067 | * parameter then it returns the callback else returns a Promise. |
| 1068 | * |
| 1069 | * {Promise} A promise is returned. |
| 1070 | * |
| 1071 | * @resolve {CodePushRelease} - The deserialized result object. |
| 1072 | * |
| 1073 | * @reject {Error|ServiceError} - The error object. |
| 1074 | * |
| 1075 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 1076 | * |
| 1077 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 1078 | * |
| 1079 | * {CodePushRelease} [result] - The deserialized result object if an error did not occur. |
| 1080 | * See {@link CodePushRelease} for more information. |
| 1081 | * |
| 1082 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 1083 | * |
| 1084 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 1085 | */ |
| 1086 | create(appName: string, deploymentName1: string, ownerName: string, targetBinaryVersion: string, options?: { deploymentName? : string, description? : string, disabled? : boolean, mandatory? : boolean, noDuplicateReleaseError? : boolean, packageProperty? : stream.Readable, rollout? : number, customHeaders? : { [headerName: string]: string; } }): Promise<models.CodePushRelease>; |
| 1087 | create(appName: string, deploymentName1: string, ownerName: string, targetBinaryVersion: string, callback: ServiceCallback<models.CodePushRelease>): void; |
| 1088 | create(appName: string, deploymentName1: string, ownerName: string, targetBinaryVersion: string, options: { deploymentName? : string, description? : string, disabled? : boolean, mandatory? : boolean, noDuplicateReleaseError? : boolean, packageProperty? : stream.Readable, rollout? : number, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.CodePushRelease>): void; |
| 1089 | } |
| 1090 | |
| 1091 | /** |
| 1092 | * @class |
| 1093 | * DeploymentReleases |
| 1094 | * __NOTE__: An instance of this class is automatically created for an |
| 1095 | * instance of the CodepushClient. |
| 1096 | */ |
| 1097 | export interface DeploymentReleases { |
| 1098 | |
| 1099 | |
| 1100 | /** |
| 1101 | * Modifies a CodePush release metadata under the given Deployment |
| 1102 | * |
| 1103 | * @param {string} appName The name of the application |
| 1104 | * |
| 1105 | * @param {string} deploymentName deployment name |
| 1106 | * |
| 1107 | * @param {string} ownerName The name of the owner |
| 1108 | * |
| 1109 | * @param {object} release Release modification. All fields are optional and |
| 1110 | * only provided fields will get updated. |
| 1111 | * |
| 1112 | * @param {string} [release.targetBinaryRange] |
| 1113 | * |
| 1114 | * @param {string} [release.description] |
| 1115 | * |
| 1116 | * @param {boolean} [release.isDisabled] |
| 1117 | * |
| 1118 | * @param {boolean} [release.isMandatory] |
| 1119 | * |
| 1120 | * @param {number} [release.rollout] |
| 1121 | * |
| 1122 | * @param {string} releaseLabel release label |
| 1123 | * |
| 1124 | * @param {object} [options] Optional Parameters. |
| 1125 | * |
| 1126 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 1127 | * request |
| 1128 | * |
| 1129 | * @returns {Promise} A promise is returned |
| 1130 | * |
| 1131 | * @resolve {HttpOperationResponse<CodePushRelease>} - The deserialized result object. |
| 1132 | * |
| 1133 | * @reject {Error|ServiceError} - The error object. |
| 1134 | */ |
| 1135 | updateWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, release: models.CodePushReleaseModification, releaseLabel: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.CodePushRelease>>; |
| 1136 | |
| 1137 | /** |
| 1138 | * Modifies a CodePush release metadata under the given Deployment |
| 1139 | * |
| 1140 | * @param {string} appName The name of the application |
| 1141 | * |
| 1142 | * @param {string} deploymentName deployment name |
| 1143 | * |
| 1144 | * @param {string} ownerName The name of the owner |
| 1145 | * |
| 1146 | * @param {object} release Release modification. All fields are optional and |
| 1147 | * only provided fields will get updated. |
| 1148 | * |
| 1149 | * @param {string} [release.targetBinaryRange] |
| 1150 | * |
| 1151 | * @param {string} [release.description] |
| 1152 | * |
| 1153 | * @param {boolean} [release.isDisabled] |
| 1154 | * |
| 1155 | * @param {boolean} [release.isMandatory] |
| 1156 | * |
| 1157 | * @param {number} [release.rollout] |
| 1158 | * |
| 1159 | * @param {string} releaseLabel release label |
| 1160 | * |
| 1161 | * @param {object} [options] Optional Parameters. |
| 1162 | * |
| 1163 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 1164 | * request |
| 1165 | * |
| 1166 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 1167 | * |
| 1168 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 1169 | * parameter then it returns the callback else returns a Promise. |
| 1170 | * |
| 1171 | * {Promise} A promise is returned. |
| 1172 | * |
| 1173 | * @resolve {CodePushRelease} - The deserialized result object. |
| 1174 | * |
| 1175 | * @reject {Error|ServiceError} - The error object. |
| 1176 | * |
| 1177 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 1178 | * |
| 1179 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 1180 | * |
| 1181 | * {CodePushRelease} [result] - The deserialized result object if an error did not occur. |
| 1182 | * See {@link CodePushRelease} for more information. |
| 1183 | * |
| 1184 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 1185 | * |
| 1186 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 1187 | */ |
| 1188 | update(appName: string, deploymentName: string, ownerName: string, release: models.CodePushReleaseModification, releaseLabel: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.CodePushRelease>; |
| 1189 | update(appName: string, deploymentName: string, ownerName: string, release: models.CodePushReleaseModification, releaseLabel: string, callback: ServiceCallback<models.CodePushRelease>): void; |
| 1190 | update(appName: string, deploymentName: string, ownerName: string, release: models.CodePushReleaseModification, releaseLabel: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.CodePushRelease>): void; |
| 1191 | } |
| 1192 | |
| 1193 | /** |
| 1194 | * @class |
| 1195 | * CodePushDeploymentRelease |
| 1196 | * __NOTE__: An instance of this class is automatically created for an |
| 1197 | * instance of the CodepushClient. |
| 1198 | */ |
| 1199 | export interface CodePushDeploymentRelease { |
| 1200 | |
| 1201 | |
| 1202 | /** |
| 1203 | * Rollback the latest or a specific release for an app deployment |
| 1204 | * |
| 1205 | * @param {string} appName The name of the application |
| 1206 | * |
| 1207 | * @param {string} deploymentName deployment name |
| 1208 | * |
| 1209 | * @param {string} ownerName The name of the owner |
| 1210 | * |
| 1211 | * @param {object} [options] Optional Parameters. |
| 1212 | * |
| 1213 | * @param {object} [options.releaseLabel] The specific release label that you |
| 1214 | * want to rollback to |
| 1215 | * |
| 1216 | * @param {string} [options.releaseLabel.label] |
| 1217 | * |
| 1218 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 1219 | * request |
| 1220 | * |
| 1221 | * @returns {Promise} A promise is returned |
| 1222 | * |
| 1223 | * @resolve {HttpOperationResponse<CodePushRelease>} - The deserialized result object. |
| 1224 | * |
| 1225 | * @reject {Error|ServiceError} - The error object. |
| 1226 | */ |
| 1227 | rollbackWithHttpOperationResponse(appName: string, deploymentName: string, ownerName: string, options?: { releaseLabel? : models.CodePushReleaseLabel, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.CodePushRelease>>; |
| 1228 | |
| 1229 | /** |
| 1230 | * Rollback the latest or a specific release for an app deployment |
| 1231 | * |
| 1232 | * @param {string} appName The name of the application |
| 1233 | * |
| 1234 | * @param {string} deploymentName deployment name |
| 1235 | * |
| 1236 | * @param {string} ownerName The name of the owner |
| 1237 | * |
| 1238 | * @param {object} [options] Optional Parameters. |
| 1239 | * |
| 1240 | * @param {object} [options.releaseLabel] The specific release label that you |
| 1241 | * want to rollback to |
| 1242 | * |
| 1243 | * @param {string} [options.releaseLabel.label] |
| 1244 | * |
| 1245 | * @param {object} [options.customHeaders] Headers that will be added to the |
| 1246 | * request |
| 1247 | * |
| 1248 | * @param {ServiceCallback} [optionalCallback] - The optional callback. |
| 1249 | * |
| 1250 | * @returns {ServiceCallback|Promise} If a callback was passed as the last |
| 1251 | * parameter then it returns the callback else returns a Promise. |
| 1252 | * |
| 1253 | * {Promise} A promise is returned. |
| 1254 | * |
| 1255 | * @resolve {CodePushRelease} - The deserialized result object. |
| 1256 | * |
| 1257 | * @reject {Error|ServiceError} - The error object. |
| 1258 | * |
| 1259 | * {ServiceCallback} optionalCallback(err, result, request, response) |
| 1260 | * |
| 1261 | * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. |
| 1262 | * |
| 1263 | * {CodePushRelease} [result] - The deserialized result object if an error did not occur. |
| 1264 | * See {@link CodePushRelease} for more information. |
| 1265 | * |
| 1266 | * {WebResource} [request] - The HTTP Request object if an error did not occur. |
| 1267 | * |
| 1268 | * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. |
| 1269 | */ |
| 1270 | rollback(appName: string, deploymentName: string, ownerName: string, options?: { releaseLabel? : models.CodePushReleaseLabel, customHeaders? : { [headerName: string]: string; } }): Promise<models.CodePushRelease>; |
| 1271 | rollback(appName: string, deploymentName: string, ownerName: string, callback: ServiceCallback<models.CodePushRelease>): void; |
| 1272 | rollback(appName: string, deploymentName: string, ownerName: string, options: { releaseLabel? : models.CodePushReleaseLabel, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.CodePushRelease>): void; |
| 1273 | } |
| 1274 | |