Class: Peddler::APIs::DataKiosk20231115

Inherits:
Peddler::API show all
Includes:
Helpers::DataKiosk20231115
Defined in:
lib/peddler/apis/data_kiosk_2023_11_15.rb,
lib/peddler/apis/data_kiosk_2023_11_15/error.rb,
lib/peddler/apis/data_kiosk_2023_11_15/query.rb,
lib/peddler/apis/data_kiosk_2023_11_15/error_list.rb,
lib/peddler/apis/data_kiosk_2023_11_15/query_list.rb,
lib/peddler/apis/data_kiosk_2023_11_15/get_queries_response.rb,
lib/peddler/apis/data_kiosk_2023_11_15/create_query_response.rb,
lib/peddler/apis/data_kiosk_2023_11_15/get_document_response.rb,
lib/peddler/apis/data_kiosk_2023_11_15/create_query_specification.rb,
sig/peddler/apis/data_kiosk_2023_11_15.rbs

Overview

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.

See Also:

Defined Under Namespace

Classes: CreateQueryResponse, CreateQuerySpecification, Error, ErrorList, GetDocumentResponse, GetQueriesResponse, Query, QueryList

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods included from Helpers::DataKiosk20231115

#download_query_document, #download_query_document_from_url

Methods inherited from Peddler::API

#cannot_sandbox!, #delete, #endpoint_uri, #get, #http, #initialize, #must_sandbox!, #patch, #percent_encode, #post, #put, #request, #sandbox, #sandbox?, #stringify_array, #timestamp, #user_agent

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#cancel_query(query_id, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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.

Parameters:

  • query_id (String) —

    The identifier for the query. This identifier is unique only in combination with a selling partner account ID.

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

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



74
75
76
77
 
# File 'lib/peddler/apis/data_kiosk_2023_11_15.rb', line 74

def cancel_query(query_id, rate_limit: 0.0222)
  path = "/dataKiosk/2023-11-15/queries/#{percent_encode(query_id)}"
  delete(path, rate_limit:)
end

#create_query(body, rate_limit: 0.0167) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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.

Parameters:

  • body (Hash) —

    The body of the request.

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

    Requests per second

  • (Hash[untyped, untyped])
  • rate_limit: (Float) (defaults to: 0.0167)

Returns:



58
59
60
61
62
 
# File 'lib/peddler/apis/data_kiosk_2023_11_15.rb', line 58

def create_query(body, rate_limit: 0.0167)
  path = "/dataKiosk/2023-11-15/queries"
  parser = -> { CreateQueryResponse }
  post(path, body:, rate_limit:, parser:)
end

#get_document(document_id, rate_limit: 0.0167) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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

Parameters:

  • document_id (String) —

    The identifier for the Data Kiosk document.

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

    Requests per second

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

Returns:



99
100
101
102
103
 
# File 'lib/peddler/apis/data_kiosk_2023_11_15.rb', line 99

def get_document(document_id, rate_limit: 0.0167)
  path = "/dataKiosk/2023-11-15/documents/#{percent_encode(document_id)}"
  parser = -> { GetDocumentResponse }
  get(path, rate_limit:, parser:)
end

#get_queries(processing_statuses: nil, page_size: 10, created_since: nil, created_until: nil, pagination_token: nil, rate_limit: 0.0222) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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

Parameters:

  • processing_statuses (Array<String>) (defaults to: nil) —

    A list of processing statuses used to filter queries.

  • page_size (Integer) (defaults to: 10) —

    The maximum number of queries to return in a single call.

  • created_since (String) (defaults to: nil) —

    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.

  • created_until (String) (defaults to: nil) —

    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.

  • pagination_token (String) (defaults to: nil) —

    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.

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

    Requests per second

  • processing_statuses: (Array[String], nil) (defaults to: nil)
  • page_size: (Integer, nil) (defaults to: 10)
  • created_since: (String, nil) (defaults to: nil)
  • created_until: (String, nil) (defaults to: nil)
  • pagination_token: (String, nil) (defaults to: nil)
  • rate_limit: (Float) (defaults to: 0.0222)

Returns:



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/peddler/apis/data_kiosk_2023_11_15.rb', line 33

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" => stringify_array(processing_statuses),
    "pageSize" => page_size,
    "createdSince" => created_since,
    "createdUntil" => created_until,
    "paginationToken" => pagination_token,
  }.compact
  parser = -> { GetQueriesResponse }
  get(path, params:, rate_limit:, parser:)
end

#get_query(query_id, rate_limit: 2.0) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

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

Parameters:

  • query_id (String) —

    The query identifier.

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

    Requests per second

  • (String)
  • rate_limit: (Float) (defaults to: 2.0)

Returns:



86
87
88
89
90
 
# File 'lib/peddler/apis/data_kiosk_2023_11_15.rb', line 86

def get_query(query_id, rate_limit: 2.0)
  path = "/dataKiosk/2023-11-15/queries/#{percent_encode(query_id)}"
  parser = -> { Query }
  get(path, rate_limit:, parser:)
end