Class: Peddler::APIs::ApplicationManagement20231130

Inherits:
Peddler::API
  • Object
show all
Defined in:
lib/peddler/apis/application_management_2023_11_30.rb,
lib/peddler/apis/application_management_2023_11_30/error.rb,
lib/peddler/apis/application_management_2023_11_30/error_list.rb

Overview

Selling Partner API for Application Management

The Selling Partner API for Application Management lets you programmatically update the client secret on registered applications.

See Also:

Constant Summary collapse

Error =

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>] array of errors
  attribute(:errors, [Error])
end

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#rotate_application_client_secret(rate_limit: 0.0167) ⇒ Peddler::Response

Rotates application client secrets for a developer application. Developers must register a destination queue in the developer console before calling this operation. When this operation is called a new client secret is generated and sent to the developer-registered queue. For more information, refer to Rotate your application client secret.

Parameters:

  • rate_limit (Float) (defaults to: 0.0167) —

    Requests per second

Returns:



22
23
24
25
26
27
 
# File 'lib/peddler/apis/application_management_2023_11_30.rb', line 22

def rotate_application_client_secret(rate_limit: 0.0167)
  cannot_sandbox!

  path = "/applications/2023-11-30/clientSecret"
  meter(rate_limit).post(path)
end