From 0ea3c87ddb4cefa9c9220c1f0240e0f7ae3cd92e Mon Sep 17 00:00:00 2001 From: Azure SDK for Python bot Date: Tue, 5 Mar 2019 17:50:09 +0000 Subject: [PATCH] Generated from fc54df16998b34ed493122f98c184b67444a6995 Apply suggestions from code review Clarify operation descriptions Co-Authored-By: zachraMSFT --- .../arm-marketplaceordering/LICENSE.txt | 42 +-- .../@azure/arm-marketplaceordering/README.md | 204 +++++++-------- .../marketplaceOrderingAgreementsContext.ts | 2 +- .../lib/models/index.ts | 81 +++++- .../lib/operations/marketplaceAgreements.ts | 244 ++++++++++++++++++ .../arm-marketplaceordering/package.json | 8 +- .../arm-marketplaceordering/rollup.config.js | 22 +- 7 files changed, 465 insertions(+), 138 deletions(-) diff --git a/packages/@azure/arm-marketplaceordering/LICENSE.txt b/packages/@azure/arm-marketplaceordering/LICENSE.txt index a70e8cf66038..8f3d856145c5 100644 --- a/packages/@azure/arm-marketplaceordering/LICENSE.txt +++ b/packages/@azure/arm-marketplaceordering/LICENSE.txt @@ -1,21 +1,21 @@ -The MIT License (MIT) - -Copyright (c) 2018 Microsoft - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +The MIT License (MIT) + +Copyright (c) 2019 Microsoft + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/@azure/arm-marketplaceordering/README.md b/packages/@azure/arm-marketplaceordering/README.md index 91e0e121f37b..a747eade86df 100644 --- a/packages/@azure/arm-marketplaceordering/README.md +++ b/packages/@azure/arm-marketplaceordering/README.md @@ -1,102 +1,102 @@ -## Azure MarketplaceOrderingAgreements SDK for JavaScript - -This package contains an isomorphic SDK for MarketplaceOrderingAgreements. - -### Currently supported environments - -- Node.js version 6.x.x or higher -- Browser JavaScript - -### How to Install - -``` -npm install @azure/arm-marketplaceordering -``` - -### How to use - -#### nodejs - Authentication, client creation and get marketplaceAgreements as an example written in TypeScript. - -##### Install @azure/ms-rest-nodeauth - -``` -npm install @azure/ms-rest-nodeauth -``` - -##### Sample code - -```ts -import * as msRest from "@azure/ms-rest-js"; -import * as msRestAzure from "@azure/ms-rest-azure-js"; -import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; -import { MarketplaceOrderingAgreements, MarketplaceOrderingAgreementsModels, MarketplaceOrderingAgreementsMappers } from "@azure/arm-marketplaceordering"; -const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; - -msRestNodeAuth.interactiveLogin().then((creds) => { - const client = new MarketplaceOrderingAgreements(creds, subscriptionId); - const publisherId = "testpublisherId"; - const offerId = "testofferId"; - const planId = "testplanId"; - client.marketplaceAgreements.get(publisherId, offerId, planId).then((result) => { - console.log("The result is:"); - console.log(result); - }); -}).catch((err) => { - console.error(err); -}); -``` - -#### browser - Authentication, client creation and get marketplaceAgreements as an example written in JavaScript. - -##### Install @azure/ms-rest-browserauth - -``` -npm install @azure/ms-rest-browserauth -``` - -##### Sample code - -See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. - -- index.html -```html - - - - @azure/arm-marketplaceordering sample - - - - - - - - -``` - -## Related projects - -- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) +## Azure MarketplaceOrderingAgreements SDK for JavaScript + +This package contains an isomorphic SDK for MarketplaceOrderingAgreements. + +### Currently supported environments + +- Node.js version 6.x.x or higher +- Browser JavaScript + +### How to Install + +```bash +npm install @azure/arm-marketplaceordering +``` + +### How to use + +#### nodejs - Authentication, client creation and get marketplaceAgreements as an example written in TypeScript. + +##### Install @azure/ms-rest-nodeauth + +```bash +npm install @azure/ms-rest-nodeauth +``` + +##### Sample code + +```typescript +import * as msRest from "@azure/ms-rest-js"; +import * as msRestAzure from "@azure/ms-rest-azure-js"; +import * as msRestNodeAuth from "@azure/ms-rest-nodeauth"; +import { MarketplaceOrderingAgreements, MarketplaceOrderingAgreementsModels, MarketplaceOrderingAgreementsMappers } from "@azure/arm-marketplaceordering"; +const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"]; + +msRestNodeAuth.interactiveLogin().then((creds) => { + const client = new MarketplaceOrderingAgreements(creds, subscriptionId); + const publisherId = "testpublisherId"; + const offerId = "testofferId"; + const planId = "testplanId"; + client.marketplaceAgreements.get(publisherId, offerId, planId).then((result) => { + console.log("The result is:"); + console.log(result); + }); +}).catch((err) => { + console.error(err); +}); +``` + +#### browser - Authentication, client creation and get marketplaceAgreements as an example written in JavaScript. + +##### Install @azure/ms-rest-browserauth + +```bash +npm install @azure/ms-rest-browserauth +``` + +##### Sample code + +See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser. + +- index.html +```html + + + + @azure/arm-marketplaceordering sample + + + + + + + + +``` + +## Related projects + +- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js) diff --git a/packages/@azure/arm-marketplaceordering/lib/marketplaceOrderingAgreementsContext.ts b/packages/@azure/arm-marketplaceordering/lib/marketplaceOrderingAgreementsContext.ts index bc5b4be3acc1..f887b693a463 100644 --- a/packages/@azure/arm-marketplaceordering/lib/marketplaceOrderingAgreementsContext.ts +++ b/packages/@azure/arm-marketplaceordering/lib/marketplaceOrderingAgreementsContext.ts @@ -13,7 +13,7 @@ import * as msRest from "@azure/ms-rest-js"; import * as msRestAzure from "@azure/ms-rest-azure-js"; const packageName = "@azure/arm-marketplaceordering"; -const packageVersion = "0.1.0"; +const packageVersion = "1.2.0"; export class MarketplaceOrderingAgreementsContext extends msRestAzure.AzureServiceClient { credentials: msRest.ServiceClientCredentials; diff --git a/packages/@azure/arm-marketplaceordering/lib/models/index.ts b/packages/@azure/arm-marketplaceordering/lib/models/index.ts index 6dcd20ca0a16..02f481eba327 100644 --- a/packages/@azure/arm-marketplaceordering/lib/models/index.ts +++ b/packages/@azure/arm-marketplaceordering/lib/models/index.ts @@ -115,8 +115,9 @@ export interface ErrorResponseError { /** * @interface * An interface representing ErrorResponse. - * Error reponse indicates Microsoft.MarketplaceOrdering service is not able to - * process the incoming request. The reason is provided in the error message. + * Error response indicates Microsoft.MarketplaceOrdering service is not able + * to process the incoming request. The reason is provided in the error + * message. * */ export interface ErrorResponse { @@ -237,6 +238,82 @@ export type MarketplaceAgreementsCreateResponse = AgreementTerms & { }; }; +/** + * Contains response data for the sign operation. + */ +export type MarketplaceAgreementsSignResponse = AgreementTerms & { + /** + * The underlying HTTP response. + */ + _response: msRest.HttpResponse & { + /** + * The response body as text (string format) + */ + bodyAsText: string; + /** + * The response body as parsed JSON or XML + */ + parsedBody: AgreementTerms; + }; +}; + +/** + * Contains response data for the cancel operation. + */ +export type MarketplaceAgreementsCancelResponse = AgreementTerms & { + /** + * The underlying HTTP response. + */ + _response: msRest.HttpResponse & { + /** + * The response body as text (string format) + */ + bodyAsText: string; + /** + * The response body as parsed JSON or XML + */ + parsedBody: AgreementTerms; + }; +}; + +/** + * Contains response data for the getAgreement operation. + */ +export type MarketplaceAgreementsGetAgreementResponse = AgreementTerms & { + /** + * The underlying HTTP response. + */ + _response: msRest.HttpResponse & { + /** + * The response body as text (string format) + */ + bodyAsText: string; + /** + * The response body as parsed JSON or XML + */ + parsedBody: AgreementTerms; + }; +}; + +/** + * Contains response data for the list operation. + */ +export type MarketplaceAgreementsListResponse = Array & { + /** + * The underlying HTTP response. + */ + _response: msRest.HttpResponse & { + /** + * The response body as text (string format) + */ + bodyAsText: string; + /** + * The response body as parsed JSON or XML + */ + parsedBody: AgreementTerms[]; + }; +}; + /** * Contains response data for the list operation. */ diff --git a/packages/@azure/arm-marketplaceordering/lib/operations/marketplaceAgreements.ts b/packages/@azure/arm-marketplaceordering/lib/operations/marketplaceAgreements.ts index 0759dda8293c..4748d93d7eb0 100644 --- a/packages/@azure/arm-marketplaceordering/lib/operations/marketplaceAgreements.ts +++ b/packages/@azure/arm-marketplaceordering/lib/operations/marketplaceAgreements.ts @@ -101,6 +101,138 @@ export class MarketplaceAgreements { createOperationSpec, callback) as Promise; } + + /** + * Sign marketplace terms. + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param [options] The optional parameters + * @returns Promise + */ + sign(publisherId: string, offerId: string, planId: string, options?: msRest.RequestOptionsBase): Promise; + /** + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param callback The callback + */ + sign(publisherId: string, offerId: string, planId: string, callback: msRest.ServiceCallback): void; + /** + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param options The optional parameters + * @param callback The callback + */ + sign(publisherId: string, offerId: string, planId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; + sign(publisherId: string, offerId: string, planId: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + publisherId, + offerId, + planId, + options + }, + signOperationSpec, + callback) as Promise; + } + + /** + * Cancel marketplace terms. + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param [options] The optional parameters + * @returns Promise + */ + cancel(publisherId: string, offerId: string, planId: string, options?: msRest.RequestOptionsBase): Promise; + /** + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param callback The callback + */ + cancel(publisherId: string, offerId: string, planId: string, callback: msRest.ServiceCallback): void; + /** + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param options The optional parameters + * @param callback The callback + */ + cancel(publisherId: string, offerId: string, planId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; + cancel(publisherId: string, offerId: string, planId: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + publisherId, + offerId, + planId, + options + }, + cancelOperationSpec, + callback) as Promise; + } + + /** + * Get marketplace agreement. + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param [options] The optional parameters + * @returns Promise + */ + getAgreement(publisherId: string, offerId: string, planId: string, options?: msRest.RequestOptionsBase): Promise; + /** + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param callback The callback + */ + getAgreement(publisherId: string, offerId: string, planId: string, callback: msRest.ServiceCallback): void; + /** + * @param publisherId Publisher identifier string of image being deployed. + * @param offerId Offer identifier string of image being deployed. + * @param planId Plan identifier string of image being deployed. + * @param options The optional parameters + * @param callback The callback + */ + getAgreement(publisherId: string, offerId: string, planId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; + getAgreement(publisherId: string, offerId: string, planId: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + publisherId, + offerId, + planId, + options + }, + getAgreementOperationSpec, + callback) as Promise; + } + + /** + * List marketplace agreements in the subscription. + * @param [options] The optional parameters + * @returns Promise + */ + list(options?: msRest.RequestOptionsBase): Promise; + /** + * @param callback The callback + */ + list(callback: msRest.ServiceCallback): void; + /** + * @param options The optional parameters + * @param callback The callback + */ + list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback): void; + list(options?: msRest.RequestOptionsBase | msRest.ServiceCallback, callback?: msRest.ServiceCallback): Promise { + return this.client.sendOperationRequest( + { + options + }, + listOperationSpec, + callback) as Promise; + } } // Operation Specifications @@ -165,3 +297,115 @@ const createOperationSpec: msRest.OperationSpec = { }, serializer }; + +const signOperationSpec: msRest.OperationSpec = { + httpMethod: "PUT", + path: "subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/sign", + urlParameters: [ + Parameters.subscriptionId, + Parameters.publisherId, + Parameters.offerId, + Parameters.planId + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + responses: { + 200: { + bodyMapper: Mappers.AgreementTerms + }, + default: { + bodyMapper: Mappers.ErrorResponse + } + }, + serializer +}; + +const cancelOperationSpec: msRest.OperationSpec = { + httpMethod: "PUT", + path: "subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}/cancel", + urlParameters: [ + Parameters.subscriptionId, + Parameters.publisherId, + Parameters.offerId, + Parameters.planId + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + responses: { + 200: { + bodyMapper: Mappers.AgreementTerms + }, + default: { + bodyMapper: Mappers.ErrorResponse + } + }, + serializer +}; + +const getAgreementOperationSpec: msRest.OperationSpec = { + httpMethod: "GET", + path: "subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements/{publisherId}/offers/{offerId}/plans/{planId}", + urlParameters: [ + Parameters.subscriptionId, + Parameters.publisherId, + Parameters.offerId, + Parameters.planId + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + responses: { + 200: { + bodyMapper: Mappers.AgreementTerms + }, + default: { + bodyMapper: Mappers.CloudError + } + }, + serializer +}; + +const listOperationSpec: msRest.OperationSpec = { + httpMethod: "GET", + path: "subscriptions/{subscriptionId}/providers/Microsoft.MarketplaceOrdering/agreements", + urlParameters: [ + Parameters.subscriptionId + ], + queryParameters: [ + Parameters.apiVersion + ], + headerParameters: [ + Parameters.acceptLanguage + ], + responses: { + 200: { + bodyMapper: { + serializedName: "parsedResponse", + type: { + name: "Sequence", + element: { + type: { + name: "Composite", + className: "AgreementTerms" + } + } + } + } + }, + default: { + bodyMapper: Mappers.CloudError + } + }, + serializer +}; diff --git a/packages/@azure/arm-marketplaceordering/package.json b/packages/@azure/arm-marketplaceordering/package.json index 82880600bfc5..f2a123ba9d6e 100644 --- a/packages/@azure/arm-marketplaceordering/package.json +++ b/packages/@azure/arm-marketplaceordering/package.json @@ -4,8 +4,8 @@ "description": "MarketplaceOrderingAgreements Library with typescript type definitions for node.js and browser.", "version": "1.2.0", "dependencies": { - "@azure/ms-rest-azure-js": "^1.1.0", - "@azure/ms-rest-js": "^1.1.0", + "@azure/ms-rest-azure-js": "^1.2.0", + "@azure/ms-rest-js": "^1.2.0", "tslib": "^1.9.3" }, "keywords": [ @@ -23,6 +23,7 @@ "typescript": "^3.1.1", "rollup": "^0.66.2", "rollup-plugin-node-resolve": "^3.4.0", + "rollup-plugin-sourcemaps": "^0.4.2", "uglify-js": "^3.4.9" }, "homepage": "https://github.com/azure/azure-sdk-for-js/tree/master/packages/@azure/arm-marketplaceordering", @@ -51,6 +52,5 @@ "minify": "uglifyjs -c -m --comments --source-map \"content='./dist/arm-marketplaceordering.js.map'\" -o ./dist/arm-marketplaceordering.min.js ./dist/arm-marketplaceordering.js", "prepack": "npm install && npm run build" }, - "sideEffects": false, - "authPublish": true + "sideEffects": false } diff --git a/packages/@azure/arm-marketplaceordering/rollup.config.js b/packages/@azure/arm-marketplaceordering/rollup.config.js index 9f0a38d1b1c9..869a472c7d40 100644 --- a/packages/@azure/arm-marketplaceordering/rollup.config.js +++ b/packages/@azure/arm-marketplaceordering/rollup.config.js @@ -1,10 +1,16 @@ +import rollup from "rollup"; import nodeResolve from "rollup-plugin-node-resolve"; +import sourcemaps from "rollup-plugin-sourcemaps"; + /** - * @type {import('rollup').RollupFileOptions} + * @type {rollup.RollupFileOptions} */ const config = { - input: './esm/marketplaceOrderingAgreements.js', - external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"], + input: "./esm/marketplaceOrderingAgreements.js", + external: [ + "@azure/ms-rest-js", + "@azure/ms-rest-azure-js" + ], output: { file: "./dist/arm-marketplaceordering.js", format: "umd", @@ -16,16 +22,16 @@ const config = { }, banner: `/* * Copyright (c) Microsoft Corporation. All rights reserved. - * Licensed under the MIT License. See License.txt in the project root for - * license information. + * 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. + * Changes may cause incorrect behavior and will be lost if the code is regenerated. */` }, plugins: [ - nodeResolve({ module: true }) + nodeResolve({ module: true }), + sourcemaps() ] }; + export default config;