Api-roll 43: 2016-12-13

generated/googleapis/lib/content/v2sandbox.dart

 // This is a generated file (see the discoveryapis_generator project).
 
 library googleapis.content.v2sandbox;
 
 import 'dart:core' as core;
 import 'dart:async' as async;
 import 'dart:convert' as convert;
 
 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
 import 'package:http/http.dart' as http;
@@ skipping 21 matching lines @@
 }
 
 
 class OrdersResourceApi {
   final commons.ApiRequester _requester;
 
   OrdersResourceApi(commons.ApiRequester client) : 
       _requester = client;
 
   /**
-   * Marks an order as acknowledged.
+   * Marks an order as acknowledged. This method can only be called for
+   * non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [OrdersAcknowledgeResponse].
@@ skipping 29 matching lines @@
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersAcknowledgeResponse.fromJson(data));
   }
 
   /**
    * Sandbox only. Moves a test order from state "inProgress" to state
-   * "pendingShipment".
+   * "pendingShipment". This method can only be called for non-multi-client
+   * accounts.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the test order to modify.
    *
    * Completes with a [OrdersAdvanceTestOrderResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
@@ skipping 23 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersAdvanceTestOrderResponse.fromJson(data));
   }
 
   /**
-   * Cancels all line items in an order.
+   * Cancels all line items in an order. This method can only be called for
+   * non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order to cancel.
    *
    * Completes with a [OrdersCancelResponse].
@@ skipping 28 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersCancelResponse.fromJson(data));
   }
 
   /**
-   * Cancels a line item.
+   * Cancels a line item. This method can only be called for non-multi-client
+   * accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [OrdersCancelLineItemResponse].
@@ skipping 28 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersCancelLineItemResponse.fromJson(data));
   }
 
   /**
-   * Sandbox only. Creates a test order.
+   * Sandbox only. Creates a test order. This method can only be called for
+   * non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * Completes with a [OrdersCreateTestOrderResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
@@ skipping 23 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersCreateTestOrderResponse.fromJson(data));
   }
 
   /**
-   * Retrieves or modifies multiple orders in a single request.
+   * Retrieves or modifies multiple orders in a single request. This method can
+   * only be called for non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * Completes with a [OrdersCustomBatchResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
    * error.
    *
@@ skipping 18 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersCustomBatchResponse.fromJson(data));
   }
 
   /**
-   * Retrieves an order from your Merchant Center account.
+   * Retrieves an order from your Merchant Center account. This method can only
+   * be called for non-multi-client accounts.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [Order].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
@@ skipping 23 matching lines @@
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new Order.fromJson(data));
   }
 
   /**
-   * Retrieves an order using merchant order id.
+   * Retrieves an order using merchant order id. This method can only be called
+   * for non-multi-client accounts.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [merchantOrderId] - The merchant order id to be looked for.
    *
    * Completes with a [OrdersGetByMerchantOrderIdResponse].
    *
    * Completes with a [commons.ApiRequestError] if the API endpoint returned an
@@ skipping 24 matching lines @@
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersGetByMerchantOrderIdResponse.fromJson(data));
   }
 
   /**
    * Sandbox only. Retrieves an order template that can be used to quickly
-   * create a new order in sandbox.
+   * create a new order in sandbox. This method can only be called for
+   * non-multi-client accounts.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [templateName] - The name of the template to retrieve.
    * Possible string values are:
    * - "template1"
    * - "template1a"
    * - "template1b"
@@ skipping 28 matching lines @@
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersGetTestOrderTemplateResponse.fromJson(data));
   }
 
   /**
-   * Lists the orders in your Merchant Center account.
+   * Lists the orders in your Merchant Center account. This method can only be
+   * called for non-multi-client accounts.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [acknowledged] - Obtains orders that match the acknowledgement status. When
    * set to true, obtains orders that have been acknowledged. When false,
    * obtains orders that have not been acknowledged.
    * We recommend using this filter set to false, in conjunction with the
    * acknowledge call, such that only un-acknowledged orders are returned.
@@ skipping 75 matching lines @@
                                        "GET",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersListResponse.fromJson(data));
   }
 
   /**
-   * Refund a portion of the order, up to the full amount paid.
+   * Refund a portion of the order, up to the full amount paid. This method can
+   * only be called for non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order to refund.
    *
    * Completes with a [OrdersRefundResponse].
@@ skipping 28 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersRefundResponse.fromJson(data));
   }
 
   /**
-   * Returns a line item.
+   * Returns a line item. This method can only be called for non-multi-client
+   * accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [OrdersReturnLineItemResponse].
@@ skipping 28 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersReturnLineItemResponse.fromJson(data));
   }
 
   /**
-   * Marks line item(s) as shipped.
+   * Marks line item(s) as shipped. This method can only be called for
+   * non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [OrdersShipLineItemsResponse].
@@ skipping 28 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersShipLineItemsResponse.fromJson(data));
   }
 
   /**
-   * Updates the merchant order ID for a given order.
+   * Updates the merchant order ID for a given order. This method can only be
+   * called for non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [OrdersUpdateMerchantOrderIdResponse].
@@ skipping 28 matching lines @@
                                        "POST",
                                        body: _body,
                                        queryParams: _queryParams,
                                        uploadOptions: _uploadOptions,
                                        uploadMedia: _uploadMedia,
                                        downloadOptions: _downloadOptions);
     return _response.then((data) => new OrdersUpdateMerchantOrderIdResponse.fromJson(data));
   }
 
   /**
-   * Updates a shipment's status, carrier, and/or tracking ID.
+   * Updates a shipment's status, carrier, and/or tracking ID. This method can
+   * only be called for non-multi-client accounts.
    *
    * [request] - The metadata request object.
    *
    * Request parameters:
    *
    * [merchantId] - The ID of the managing account.
    *
    * [orderId] - The ID of the order.
    *
    * Completes with a [OrdersUpdateShipmentResponse].
@@ skipping 440 matching lines @@
   }
 }
 
 class OrderCustomer {
   /** Email address of the customer. */
   core.String email;
   /**
    * If set, this indicates the user explicitly chose to opt in or out of
    * providing marketing rights to the merchant. If unset, this indicates the
    * user has already made this choice in a previous purchase, and was thus not
-   * shown the marketing right opt in/out checkbox during the Purchases on
-   * Google checkout flow.
+   * shown the marketing right opt in/out checkbox during the checkout flow.
    */
   core.bool explicitMarketingPreference;
   /** Full name of the customer. */
   core.String fullName;
 
   OrderCustomer();
 
   OrderCustomer.fromJson(core.Map _json) {
     if (_json.containsKey("email")) {
       email = _json["email"];
@@ skipping 2314 matching lines @@
   }
 }
 
 class TestOrderCustomer {
   /** Email address of the customer. */
   core.String email;
   /**
    * If set, this indicates the user explicitly chose to opt in or out of
    * providing marketing rights to the merchant. If unset, this indicates the
    * user has already made this choice in a previous purchase, and was thus not
-   * shown the marketing right opt in/out checkbox during the Purchases on
-   * Google checkout flow. Optional.
+   * shown the marketing right opt in/out checkbox during the checkout flow.
+   * Optional.
    */
   core.bool explicitMarketingPreference;
   /** Full name of the customer. */
   core.String fullName;
 
   TestOrderCustomer();
 
   TestOrderCustomer.fromJson(core.Map _json) {
     if (_json.containsKey("email")) {
       email = _json["email"];
@@ skipping 239 matching lines @@
     }
     if (predefinedBillingAddress != null) {
       _json["predefinedBillingAddress"] = predefinedBillingAddress;
     }
     if (type != null) {
       _json["type"] = type;
     }
     return _json;
   }
 }