Module: Peddler::Types::Tokens20210301

Defined in:

lib/peddler/types/tokens_2021_03_01/error.rb,
lib/peddler/types/tokens_2021_03_01/error_list.rb,
lib/peddler/types/tokens_2021_03_01/restricted_resource.rb,
lib/peddler/types/tokens_2021_03_01/create_restricted_data_token_request.rb,
lib/peddler/types/tokens_2021_03_01/create_restricted_data_token_response.rb

Constant Summary

Error =

An error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

ErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>]
  attribute(:errors, [Error])
end

RestrictedResource =

Model of a restricted resource.

Structure.new do
  # @return [String] The HTTP method in the restricted resource.
  attribute(:method, String)

  # @return [String] 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.
  attribute(:path, String)

  # @return [Array<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](doc:tokens-api-use-case-guide). 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.
  # - **buyerTaxInformation**. This includes information for issuing tax invoices.
  attribute(:data_elements, [String], from: "dataElements")
end

CreateRestrictedDataTokenRequest =

The request schema for the createRestrictedDataToken operation.

Structure.new do
  # @return [String] The application ID for the target application to which access is being delegated.
  attribute(:target_application, String, from: "targetApplication")

  # @return [Array<RestrictedResource>] A list of restricted resources.
  # Maximum: 50
  attribute(:restricted_resources, [RestrictedResource], from: "restrictedResources")
end

CreateRestrictedDataTokenResponse =

The response schema for the createRestrictedDataToken operation.

Structure.new do
  # @return [String] A Restricted Data Token (RDT). This is a short-lived access token that authorizes calls to
  # restricted operations. Pass this value with the x-amz-access-token header when making subsequent calls to
  # these restricted resources.
  attribute(:restricted_data_token, String, from: "restrictedDataToken")

  # @return [Integer] The lifetime of the Restricted Data Token, in seconds.
  attribute(:expires_in, Integer, from: "expiresIn")
end