amazon_spapi/models/tokens_2021_03_01/
restricted_resource.rs

1/*
2 * Selling Partner API for Tokens 
3 *
4 * 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 subsequent calls to restricted operations that correspond to the restricted resources that you specified.  For more information, see the [Tokens API Use Case Guide](doc:tokens-api-use-case-guide).
5 *
6 * The version of the OpenAPI document: 2021-03-01
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// RestrictedResource : Model of a restricted resource.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct RestrictedResource {
17    /// The HTTP method in the restricted resource.
18    #[serde(rename = "method")]
19    pub method: Method,
20    /// 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.
21    #[serde(rename = "path")]
22    pub path: String,
23    /// 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.
24    #[serde(rename = "dataElements", skip_serializing_if = "Option::is_none")]
25    pub data_elements: Option<Vec<String>>,
26}
27
28impl RestrictedResource {
29    /// Model of a restricted resource.
30    pub fn new(method: Method, path: String) -> RestrictedResource {
31        RestrictedResource {
32            method,
33            path,
34            data_elements: None,
35        }
36    }
37}
38/// The HTTP method in the restricted resource.
39#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
40pub enum Method {
41    #[serde(rename = "GET")]
42    Get,
43    #[serde(rename = "PUT")]
44    Put,
45    #[serde(rename = "POST")]
46    Post,
47    #[serde(rename = "DELETE")]
48    Delete,
49}
50
51impl Default for Method {
52    fn default() -> Method {
53        Self::Get
54    }
55}
56
amazon_spapi/models/tokens_2021_03_01/restricted_resource.rs

amazon_spapi/models/tokens_2021_03_01/
restricted_resource.rs
