Blockstream Enterprise

Request

RecipientGroupsListRequest

interface RecipientGroupsListRequest {
  action: 'get'
  resource: '/recipient-groups'
  details?: {
    limit: number | undefined
    offset: number | undefined
    sort_by: 'created_at' | 'updated_at' | undefined
    sort: 'asc' | 'desc' | undefined
    filters: {
      ids: string[] | undefined
      name: string | undefined
      type: 'whitelist' | 'blacklist' | undefined
      created_by: string | undefined
    } | undefined
  } | undefined
}

Prop

Type

Response

RecipientGroupsListResponse_success

interface RecipientGroupsListResponse_success {
  status: 'success'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
  details: {
    id: string
    type: 'whitelist' | 'blacklist'
    name: string
    description: string | undefined
    members: string[]
    created_at: string
    created_by: string
    updated_at: string
    updated_by: string
  } []
  metadata: {
    total_count: number
  }
}

Prop

Type

RecipientGroupsListResponse_failed | pending | unauthorized | rejected

interface RecipientGroupsListResponse_failed | pending | unauthorized | rejected {
  status: 'failed' | 'pending' | 'unauthorized' | 'rejected'
  error_code?: '-1' | '-2' | '-3' | '-4' | '-5' | '-6' | '-7' | '-8' | '-9' | '-10' | '-11' | '-12' | '-13' | undefined
  message?: string | undefined
}

Prop

Type

Example

import { resourceSchema } from '@blockstream/ecs-js-sdk'
import { broadcastRequest } from './broadcaster'

const response = await broadcastRequest<
  typeof resourceSchema.shape.recipient-groups.shape.list
>(
  {
    action: 'get',
    resource: '/recipient-groups',
    details: {
      // TODO: fill in required fields
    },
  },
  blockstream,
)

List Recipient Groups

Request

Response

Example

On this page