ReferenceAPI ReferenceProposals
List Proposals
List Proposals.
Request
interface ProposalsListRequest {
action: 'get'
resource: '/proposals'
details?: {
limit: number | undefined
offset: number | undefined
sort_by: 'created_at' | 'updated_at' | undefined
sort: 'asc' | 'desc' | undefined
filters: {
status: 'approved' | 'pending' | 'executed' | 'canceled' | 'rejected' | 'denied' | undefined
reviewer_id: string | undefined
created_by: string | undefined
action: string | undefined
resource: {
type: 'partial'
value: string
} | { type: 'exact'; value: string } | { type: 'exclude'; value: string } | { type: 'or'; value: unknown[] } | { type: 'and'; value: unknown[] } | undefined
resource_id: string | undefined
initiator_or_reviewer_id: string | undefined
batch_proposal_id: string | undefined
} | undefined
} | undefined
}Prop
Type
Response
interface ProposalsListResponse_success {
status: 'success'
error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
message?: string | undefined
details: {
pid: string
plid: string
action: string
resource: string
details: unknown
reviews: {
type: 'kofn'
data: {
k: number
group_id: string
group: string[]
reviews: {
uid: string
comment: string
created_at: string
username: string
verdict: 'approved' | 'denied' | 'pending'
} []
}
} | { type: 'and' | 'or'; data: { left: unknown | undefined; right: unknown | undefined } }
created_by: string
created_at: string
updated_at: string
batch_proposal_id: string | undefined
} & { status: 'approved' | 'canceled' | 'denied' | 'executed' | 'pending' } | { status: 'rejected'; rejection_reason: string }[]
metadata: {
total_count: number
}
}Prop
Type
Example
import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'
const response = await broadcastRequest<
typeof resourceSchema.shape.proposals.shape.list
>(
{
action: 'get',
resource: '/proposals',
details: {
// TODO: fill in required fields
},
},
blockstream,
)