65 lines
2.0 KiB
TypeScript
65 lines
2.0 KiB
TypeScript
|
import { APIResource } from "../../core/resource.js";
|
||
|
|
import * as ResponsesAPI from "./responses.js";
|
||
|
|
import { ResponseItemsPage } from "./responses.js";
|
||
|
|
import { type CursorPageParams, PagePromise } from "../../core/pagination.js";
|
||
|
|
import { RequestOptions } from "../../internal/request-options.js";
|
||
|
|
export declare class InputItems extends APIResource {
|
||
|
|
/**
|
||
|
|
* Returns a list of input items for a given response.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```ts
|
||
|
|
* // Automatically fetches more pages as needed.
|
||
|
|
* for await (const responseItem of client.responses.inputItems.list(
|
||
|
|
* 'response_id',
|
||
|
|
* )) {
|
||
|
|
* // ...
|
||
|
|
* }
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
list(responseID: string, query?: InputItemListParams | null | undefined, options?: RequestOptions): PagePromise<ResponseItemsPage, ResponsesAPI.ResponseItem>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* A list of Response items.
|
||
|
|
*/
|
||
|
|
export interface ResponseItemList {
|
||
|
|
/**
|
||
|
|
* A list of items used to generate this response.
|
||
|
|
*/
|
||
|
|
data: Array<ResponsesAPI.ResponseItem>;
|
||
|
|
/**
|
||
|
|
* The ID of the first item in the list.
|
||
|
|
*/
|
||
|
|
first_id: string;
|
||
|
|
/**
|
||
|
|
* Whether there are more items available.
|
||
|
|
*/
|
||
|
|
has_more: boolean;
|
||
|
|
/**
|
||
|
|
* The ID of the last item in the list.
|
||
|
|
*/
|
||
|
|
last_id: string;
|
||
|
|
/**
|
||
|
|
* The type of object returned, must be `list`.
|
||
|
|
*/
|
||
|
|
object: 'list';
|
||
|
|
}
|
||
|
|
export interface InputItemListParams extends CursorPageParams {
|
||
|
|
/**
|
||
|
|
* Additional fields to include in the response. See the `include` parameter for
|
||
|
|
* Response creation above for more information.
|
||
|
|
*/
|
||
|
|
include?: Array<ResponsesAPI.ResponseIncludable>;
|
||
|
|
/**
|
||
|
|
* The order to return the input items in. Default is `desc`.
|
||
|
|
*
|
||
|
|
* - `asc`: Return the input items in ascending order.
|
||
|
|
* - `desc`: Return the input items in descending order.
|
||
|
|
*/
|
||
|
|
order?: 'asc' | 'desc';
|
||
|
|
}
|
||
|
|
export declare namespace InputItems {
|
||
|
|
export { type ResponseItemList as ResponseItemList, type InputItemListParams as InputItemListParams };
|
||
|
|
}
|
||
|
|
export { type ResponseItemsPage };
|
||
|
|
//# sourceMappingURL=input-items.d.ts.map
|