Function: listProducts()
listProducts(
client,props):Promise<{rows:object[];rowCount:number; }>
Lists products in a project.
Parameters
client
The API client instance
props
The request properties
query
{ pageOffset?: number; pageSize?: number; sortBy?: "code" | "name" | "createdAt" | "updatedAt"; sortDir?: "asc" | "desc"; orgName: string; projectName: string; } = listProductsQuerySchema
Query parameters (orgName, projectName, pagination, sort)
query.pageOffset?
number = ...
query.pageSize?
number = ...
query.sortBy?
"code" | "name" | "createdAt" | "updatedAt" = ...
query.sortDir?
"asc" | "desc" = ...
query.orgName
string = ...
query.projectName
string = ...
Returns
Promise<{ rows: object[]; rowCount: number; }>
Promise resolving to a paginated list of products
Operation Id
list-products