Class: AmzSpApi::TokensApiModel::TokensApi
- Inherits:
-
Object
- Object
- AmzSpApi::TokensApiModel::TokensApi
- Defined in:
- lib/tokens-api-model/api/tokens_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_restricted_data_token(body, opts = {}) ⇒ CreateRestrictedDataTokenResponse
Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify.
-
#create_restricted_data_token_with_http_info(body, opts = {}) ⇒ Array<(CreateRestrictedDataTokenResponse, Integer, Hash)>
Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify.
-
#initialize(api_client = ApiClient.default) ⇒ TokensApi
constructor
A new instance of TokensApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
14 15 16 |
# File 'lib/tokens-api-model/api/tokens_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#create_restricted_data_token(body, opts = {}) ⇒ CreateRestrictedDataTokenResponse
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.
23 24 25 26 |
# File 'lib/tokens-api-model/api/tokens_api.rb', line 23 def create_restricted_data_token(body, opts = {}) data, _status_code, _headers = create_restricted_data_token_with_http_info(body, opts) data end |
#create_restricted_data_token_with_http_info(body, opts = {}) ⇒ Array<(CreateRestrictedDataTokenResponse, Integer, Hash)>
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.
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/tokens-api-model/api/tokens_api.rb', line 32 def create_restricted_data_token_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TokensApi.create_restricted_data_token ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling TokensApi.create_restricted_data_token" end # resource path local_var_path = '/tokens/2021-03-01/restrictedDataToken' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'CreateRestrictedDataTokenResponse' auth_names = opts[:auth_names] || [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: TokensApi#create_restricted_data_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |