From 3c65134de966bf670a1019303a1323846e60901e Mon Sep 17 00:00:00 2001 From: nguyentoanit Date: Tue, 3 Aug 2021 01:28:08 +0000 Subject: [PATCH] chore: update api models --- src/api-models/index.ts | 2 + src/api-models/orders-api-model/api.ts | 116 ++++++++++++++++-- src/api-models/tokens-api-model/api.ts | 26 ++-- src/api-models/tokens-api-model/base.ts | 2 +- src/api-models/tokens-api-model/common.ts | 2 +- .../tokens-api-model/configuration.ts | 2 +- src/api-models/tokens-api-model/index.ts | 2 +- 7 files changed, 129 insertions(+), 23 deletions(-) diff --git a/src/api-models/index.ts b/src/api-models/index.ts index 66c642ef..077b63d1 100644 --- a/src/api-models/index.ts +++ b/src/api-models/index.ts @@ -629,6 +629,7 @@ export { TaxCollectionResponsiblePartyEnum as OrdersApiModelTaxCollectionResponsiblePartyEnum, Address as OrdersApiModelAddress, BuyerCustomizedInfoDetail as OrdersApiModelBuyerCustomizedInfoDetail, + BuyerInfo as OrdersApiModelBuyerInfo, BuyerTaxInfo as OrdersApiModelBuyerTaxInfo, FulfillmentInstruction as OrdersApiModelFulfillmentInstruction, GetOrderAddressResponse as OrdersApiModelGetOrderAddressResponse, @@ -637,6 +638,7 @@ export { GetOrderItemsResponse as OrdersApiModelGetOrderItemsResponse, GetOrderResponse as OrdersApiModelGetOrderResponse, GetOrdersResponse as OrdersApiModelGetOrdersResponse, + ItemBuyerInfo as OrdersApiModelItemBuyerInfo, MarketplaceTaxInfo as OrdersApiModelMarketplaceTaxInfo, ModelError as OrdersApiModelModelError, Money as OrdersApiModelMoney, diff --git a/src/api-models/orders-api-model/api.ts b/src/api-models/orders-api-model/api.ts index 15e6676a..0fa8bad7 100644 --- a/src/api-models/orders-api-model/api.ts +++ b/src/api-models/orders-api-model/api.ts @@ -129,6 +129,43 @@ export interface BuyerCustomizedInfoDetail { */ CustomizedURL?: string; } +/** + * Buyer information + * @export + * @interface BuyerInfo + */ +export interface BuyerInfo { + /** + * The anonymized email address of the buyer. + * @type {string} + * @memberof BuyerInfo + */ + BuyerEmail?: string; + /** + * The name of the buyer. + * @type {string} + * @memberof BuyerInfo + */ + BuyerName?: string; + /** + * The county of the buyer. + * @type {string} + * @memberof BuyerInfo + */ + BuyerCounty?: string; + /** + * + * @type {BuyerTaxInfo} + * @memberof BuyerInfo + */ + BuyerTaxInfo?: BuyerTaxInfo; + /** + * The purchase order (PO) number entered by the buyer at checkout. Returned only for orders where the buyer entered a PO number at checkout. + * @type {string} + * @memberof BuyerInfo + */ + PurchaseOrderNumber?: string; +} /** * Tax information about the buyer. * @export @@ -281,6 +318,43 @@ export interface GetOrdersResponse { */ errors?: Array; } +/** + * A single item\'s buyer information. + * @export + * @interface ItemBuyerInfo + */ +export interface ItemBuyerInfo { + /** + * + * @type {BuyerCustomizedInfoDetail} + * @memberof ItemBuyerInfo + */ + BuyerCustomizedInfo?: BuyerCustomizedInfoDetail; + /** + * + * @type {Money} + * @memberof ItemBuyerInfo + */ + GiftWrapPrice?: Money; + /** + * + * @type {Money} + * @memberof ItemBuyerInfo + */ + GiftWrapTax?: Money; + /** + * A gift message provided by the buyer. + * @type {string} + * @memberof ItemBuyerInfo + */ + GiftMessageText?: string; + /** + * The gift wrap level specified by the buyer. + * @type {string} + * @memberof ItemBuyerInfo + */ + GiftWrapLevel?: string; +} /** * Tax information about the marketplace. * @export @@ -572,6 +646,18 @@ export interface Order { * @memberof Order */ SellerDisplayName?: string; + /** + * + * @type {Address} + * @memberof Order + */ + ShippingAddress?: Address; + /** + * + * @type {BuyerInfo} + * @memberof Order + */ + BuyerInfo?: BuyerInfo; } /** @@ -877,6 +963,12 @@ export interface OrderItem { * @memberof OrderItem */ DeemedResellerCategory?: OrderItemDeemedResellerCategoryEnum | 'IOSS' | 'UOSS'; + /** + * + * @type {ItemBuyerInfo} + * @memberof OrderItem + */ + BuyerInfo?: ItemBuyerInfo; } /** @@ -1158,7 +1250,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns the shipping address for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1191,7 +1283,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns buyer information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1262,7 +1354,7 @@ export const OrdersV0ApiAxiosParamCreator = function (configuration?: Configurat }; }, /** - * Returns buyer information in the order items of the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -1436,7 +1528,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns the shipping address for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1446,7 +1538,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns buyer information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1467,7 +1559,7 @@ export const OrdersV0ApiFp = function(configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * Returns buyer information in the order items of the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -1523,7 +1615,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath)); }, /** - * Returns the shipping address for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1532,7 +1624,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath)); }, /** - * Returns buyer information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1551,7 +1643,7 @@ export const OrdersV0ApiFactory = function (configuration?: Configuration, baseP return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath)); }, /** - * Returns buyer information in the order items of the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format. * @param {string} [nextToken] A string token returned in the response of your previous request. * @param {*} [options] Override http request option. @@ -1817,7 +1909,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns the shipping address for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1828,7 +1920,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns buyer information for the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -1850,7 +1942,7 @@ export class OrdersV0Api extends BaseAPI { } /** - * Returns buyer information in the order items of the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/tokens-api-model/api.ts b/src/api-models/tokens-api-model/api.ts index 7c1ae83f..4dfba3b0 100644 --- a/src/api-models/tokens-api-model/api.ts +++ b/src/api-models/tokens-api-model/api.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Tokens - * The Selling Partner API for Tokens provides a secure way to access a customers\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent requests to access these restricted resources. + * The Selling Partner API for Tokens provides a secure way to access a customer\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent calls to restricted operations that correspond to the restricted resources that you specified. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/references/tokens-api/tokens_2021-03-01.md). * * The version of the OpenAPI document: 2021-03-01 * @@ -27,6 +27,12 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr * @interface CreateRestrictedDataTokenRequest */ export interface CreateRestrictedDataTokenRequest { + /** + * The application ID for the target application to which access is being delegated. + * @type {string} + * @memberof CreateRestrictedDataTokenRequest + */ + targetApplication?: string; /** * A list of restricted resources. Maximum: 50 * @type {Array} @@ -98,17 +104,23 @@ export interface ModelError { */ export interface RestrictedResource { /** - * The HTTP method used with the restricted resource. + * The HTTP method in the restricted resource. * @type {string} * @memberof RestrictedResource */ method: RestrictedResourceMethodEnum | 'GET' | 'PUT' | 'POST' | 'DELETE'; /** - * The path from a restricted operation. This could be: - A specific path containing a seller\'s order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. - A generic path that does not contain a seller\'s order ID, for example```/orders/v0/orders/{orderId}/address```). + * The path in the restricted resource. Here are some path examples: - ```/orders/v0/orders```. For getting an RDT for the getOrders operation of the Orders API. For bulk orders. - ```/orders/v0/orders/123-1234567-1234567```. For getting an RDT for the getOrder operation of the Orders API. For a specific order. - ```/orders/v0/orders/123-1234567-1234567/orderItems```. For getting an RDT for the getOrderItems operation of the Orders API. For the order items in a specific order. - ```/mfn/v0/shipments/FBA1234ABC5D```. For getting an RDT for the getShipment operation of the Shipping API. For a specific shipment. - ```/mfn/v0/shipments/{shipmentId}```. For getting an RDT for the getShipment operation of the Shipping API. For any of a selling partner\'s shipments that you specify when you call the getShipment operation. * @type {string} * @memberof RestrictedResource */ path: string; + /** + * Indicates the type of Personally Identifiable Information requested. This parameter is required only when getting an RDT for use with the getOrder, getOrders, or getOrderItems operation of the Orders API. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/references/tokens-api/tokens_2021-03-01.md). Possible values include: - **buyerInfo**. On the order level this includes general identifying information about the buyer and tax-related information. On the order item level this includes gift wrap information and custom order information, if available. - **shippingAddress**. This includes information for fulfilling orders. + * @type {Array} + * @memberof RestrictedResource + */ + dataElements?: Array; } /** @@ -130,7 +142,7 @@ export enum RestrictedResourceMethodEnum { export const TokensApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII). See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. The path of a restricted resource can be: - A specific path containing a seller\'s order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. The returned RDT authorizes a subsequent call to the getOrderAddress operation of the Orders API for that specific order only. For example, ```GET /orders/v0/orders/902-3159896-1390916/address```. - A generic path that does not contain a seller\'s order ID, for example```/orders/v0/orders/{orderId}/address```). The returned RDT authorizes subsequent calls to the getOrderAddress operation for *any* of a seller\'s order IDs. For example, ```GET /orders/v0/orders/902-3159896-1390916/address``` and ```GET /orders/v0/orders/483-3488972-0896720/address``` **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {CreateRestrictedDataTokenRequest} body The restricted data token request details. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -175,7 +187,7 @@ export const TokensApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = TokensApiAxiosParamCreator(configuration) return { /** - * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII). See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. The path of a restricted resource can be: - A specific path containing a seller\'s order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. The returned RDT authorizes a subsequent call to the getOrderAddress operation of the Orders API for that specific order only. For example, ```GET /orders/v0/orders/902-3159896-1390916/address```. - A generic path that does not contain a seller\'s order ID, for example```/orders/v0/orders/{orderId}/address```). The returned RDT authorizes subsequent calls to the getOrderAddress operation for *any* of a seller\'s order IDs. For example, ```GET /orders/v0/orders/902-3159896-1390916/address``` and ```GET /orders/v0/orders/483-3488972-0896720/address``` **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {CreateRestrictedDataTokenRequest} body The restricted data token request details. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -195,7 +207,7 @@ export const TokensApiFactory = function (configuration?: Configuration, basePat const localVarFp = TokensApiFp(configuration) return { /** - * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII). See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. The path of a restricted resource can be: - A specific path containing a seller\'s order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. The returned RDT authorizes a subsequent call to the getOrderAddress operation of the Orders API for that specific order only. For example, ```GET /orders/v0/orders/902-3159896-1390916/address```. - A generic path that does not contain a seller\'s order ID, for example```/orders/v0/orders/{orderId}/address```). The returned RDT authorizes subsequent calls to the getOrderAddress operation for *any* of a seller\'s order IDs. For example, ```GET /orders/v0/orders/902-3159896-1390916/address``` and ```GET /orders/v0/orders/483-3488972-0896720/address``` **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {CreateRestrictedDataTokenRequest} body The restricted data token request details. * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -228,7 +240,7 @@ export interface TokensApiCreateRestrictedDataTokenRequest { */ export class TokensApi extends BaseAPI { /** - * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII). See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. The path of a restricted resource can be: - A specific path containing a seller\'s order ID, for example ```/orders/v0/orders/902-3159896-1390916/address```. The returned RDT authorizes a subsequent call to the getOrderAddress operation of the Orders API for that specific order only. For example, ```GET /orders/v0/orders/902-3159896-1390916/address```. - A generic path that does not contain a seller\'s order ID, for example```/orders/v0/orders/{orderId}/address```). The returned RDT authorizes subsequent calls to the getOrderAddress operation for *any* of a seller\'s order IDs. For example, ```GET /orders/v0/orders/902-3159896-1390916/address``` and ```GET /orders/v0/orders/483-3488972-0896720/address``` **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. + * Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 1 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation. * @param {TokensApiCreateRestrictedDataTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} diff --git a/src/api-models/tokens-api-model/base.ts b/src/api-models/tokens-api-model/base.ts index dc530ae3..9dda2bef 100644 --- a/src/api-models/tokens-api-model/base.ts +++ b/src/api-models/tokens-api-model/base.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Tokens - * The Selling Partner API for Tokens provides a secure way to access a customers\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent requests to access these restricted resources. + * The Selling Partner API for Tokens provides a secure way to access a customer\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent calls to restricted operations that correspond to the restricted resources that you specified. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/references/tokens-api/tokens_2021-03-01.md). * * The version of the OpenAPI document: 2021-03-01 * diff --git a/src/api-models/tokens-api-model/common.ts b/src/api-models/tokens-api-model/common.ts index b564ce7a..4469e122 100644 --- a/src/api-models/tokens-api-model/common.ts +++ b/src/api-models/tokens-api-model/common.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Tokens - * The Selling Partner API for Tokens provides a secure way to access a customers\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent requests to access these restricted resources. + * The Selling Partner API for Tokens provides a secure way to access a customer\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent calls to restricted operations that correspond to the restricted resources that you specified. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/references/tokens-api/tokens_2021-03-01.md). * * The version of the OpenAPI document: 2021-03-01 * diff --git a/src/api-models/tokens-api-model/configuration.ts b/src/api-models/tokens-api-model/configuration.ts index ed702b46..9be7a5a3 100644 --- a/src/api-models/tokens-api-model/configuration.ts +++ b/src/api-models/tokens-api-model/configuration.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Tokens - * The Selling Partner API for Tokens provides a secure way to access a customers\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent requests to access these restricted resources. + * The Selling Partner API for Tokens provides a secure way to access a customer\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent calls to restricted operations that correspond to the restricted resources that you specified. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/references/tokens-api/tokens_2021-03-01.md). * * The version of the OpenAPI document: 2021-03-01 * diff --git a/src/api-models/tokens-api-model/index.ts b/src/api-models/tokens-api-model/index.ts index b978da52..e116fb0e 100644 --- a/src/api-models/tokens-api-model/index.ts +++ b/src/api-models/tokens-api-model/index.ts @@ -2,7 +2,7 @@ /* eslint-disable */ /** * Selling Partner API for Tokens - * The Selling Partner API for Tokens provides a secure way to access a customers\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent requests to access these restricted resources. + * The Selling Partner API for Tokens provides a secure way to access a customer\'s PII (Personally Identifiable Information). You can call the Tokens API to get a Restricted Data Token (RDT) for one or more restricted resources that you specify. The RDT authorizes you to make subsequent calls to restricted operations that correspond to the restricted resources that you specified. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/references/tokens-api/tokens_2021-03-01.md). * * The version of the OpenAPI document: 2021-03-01 *