class Peddler::API::DataKiosk20231115

Selling Partner API for Data Kiosk

The Selling Partner API for Data Kiosk lets you submit GraphQL queries from a variety of schemas to help selling partners manage their businesses.

Public Instance Methods

cancel_query(query_id, rate_limit: 0.0222) click to toggle source

Cancels the query specified by the ‘queryId` parameter. Only queries with a non-terminal `processingStatus` (`IN_QUEUE`, `IN_PROGRESS`) can be cancelled. Cancelling a query that already has a `processingStatus` of `CANCELLED` will no-op. Cancelled queries are returned in subsequent calls to the `getQuery` and `getQueries` operations.

@note This operation can make a static sandbox call. @param query_id [String] The identifier for the query. This identifier is unique only in combination with a

selling partner account ID.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/data_kiosk_2023_11_15.rb, line 75
def cancel_query(query_id, rate_limit: 0.0222)
  path = "/dataKiosk/2023-11-15/queries/#{query_id}"

  meter(rate_limit).delete(path)
end
create_query(body, rate_limit: 0.0167) click to toggle source

Creates a Data Kiosk query request. Note: The retention of a query varies based on the fields requested. Each field within a schema is annotated with a ‘@resultRetention` directive that defines how long a query containing that field will be retained. When a query contains multiple fields with different retentions, the shortest (minimum) retention is applied. The retention of a query’s resulting documents always matches the retention of the query.

@note This operation can make a static sandbox call. @param body [Hash] The body of the request. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/data_kiosk_2023_11_15.rb, line 59
def create_query(body, rate_limit: 0.0167)
  path = "/dataKiosk/2023-11-15/queries"

  meter(rate_limit).post(path, body:)
end
get_document(document_id, rate_limit: 0.0167) click to toggle source

Returns the information required for retrieving a Data Kiosk document’s contents. See the ‘createQuery` operation for details about document retention.

@note This operation can make a static sandbox call. @param document_id [String] The identifier for the Data Kiosk document. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/data_kiosk_2023_11_15.rb, line 101
def get_document(document_id, rate_limit: 0.0167)
  path = "/dataKiosk/2023-11-15/documents/#{document_id}"

  meter(rate_limit).get(path)
end
get_queries(processing_statuses: nil, page_size: 10, created_since: nil, created_until: nil, pagination_token: nil, rate_limit: 0.0222) click to toggle source

Returns details for the Data Kiosk queries that match the specified filters. See the ‘createQuery` operation for details about query retention.

@note This operation can make a static sandbox call. @param processing_statuses [Array<String>] A list of processing statuses used to filter queries. @param page_size [Integer] The maximum number of queries to return in a single call. @param created_since [String] The earliest query creation date and time for queries to include in the response,

in ISO 8601 date time format. The default is 90 days ago.

@param created_until [String] The latest query creation date and time for queries to include in the response, in

ISO 8601 date time format. The default is the time of the `getQueries` request.

@param pagination_token [String] A token to fetch a certain page of results when there are multiple pages of

results available. The value of this token is fetched from the `pagination.nextToken` field returned in the
`GetQueriesResponse` object. All other parameters must be provided with the same values that were provided
with the request that generated this token, with the exception of `pageSize` which can be modified between
calls to `getQueries`. In the absence of this token value, `getQueries` returns the first page of results.

@param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/data_kiosk_2023_11_15.rb, line 35
def get_queries(processing_statuses: nil, page_size: 10, created_since: nil, created_until: nil,
  pagination_token: nil, rate_limit: 0.0222)
  path = "/dataKiosk/2023-11-15/queries"
  params = {
    "processingStatuses" => processing_statuses,
    "pageSize" => page_size,
    "createdSince" => created_since,
    "createdUntil" => created_until,
    "paginationToken" => pagination_token,
  }.compact

  meter(rate_limit).get(path, params:)
end
get_query(query_id, rate_limit: 2.0) click to toggle source

Returns query details for the query specified by the ‘queryId` parameter. See the `createQuery` operation for details about query retention.

@note This operation can make a static sandbox call. @param query_id [String] The query identifier. @param rate_limit [Float] Requests per second @return [Hash] The API response

# File lib/peddler/api/data_kiosk_2023_11_15.rb, line 88
def get_query(query_id, rate_limit: 2.0)
  path = "/dataKiosk/2023-11-15/queries/#{query_id}"

  meter(rate_limit).get(path)
end