Class CommitteeMeetingClient

Hierarchy (View Summary)

BaseClient
- CommitteeMeetingClient

Index

Constructors

constructor

new CommitteeMeetingClient(
__namedParameters: { apiKey: string },
): CommitteeMeetingClient
Parameters
- __namedParameters: { apiKey: string }
Returns CommitteeMeetingClient
Overrides BaseClient.constructor
- Defined in src/clients/committee-meeting.ts:7

Properties

`Protected` `Readonly`apiKey

apiKey: string

`Protected` `Readonly`baseUrl

baseUrl: string

`Protected` `Readonly`endpoint

endpoint: string

Methods

`Protected`get

get<T>(
endpoint: string,
params: Params,
): Promise<T & { rateLimit: RateLimitInfo }>
Type Parameters
- T
Parameters
- endpoint: string
- params: Params
Returns Promise<T & { rateLimit: RateLimitInfo }>
Inherited from BaseClient.get
- Defined in src/clients/base.ts:78

getMeeting

getMeeting(
    congress: number,
    chamber: Chamber,
    eventId: string,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        committeeMeeting: {
            chamber: Chamber;
            committees: { name: string; systemCode: string; url: string }[];
            congress: number;
            date: string;
            eventId: string;
            hearingTranscript: { jacketNumber: number; url: string }[];
            location: { building: string; room: string };
            meetingDocuments: {
                description?: null | string;
                documentType: string;
                format: string;
                name: string;
                url: string;
            }[];
            meetingStatus: string;
            relatedItems: {
                bills?: {
                    congress: number;
                    number: string;
                    type: string;
                    url: string;
                }[];
                nominations?: {
                    congress: number;
                    number: string;
                    part: string;
                    url: string;
                }[];
                treaties?: {
                    congress: number;
                    number: string;
                    part: string;
                    url: string;
                }[];
            };
            title: string;
            type: string;
            updateDate: string;
            videos: any[];
            witnessDocuments: { documentType: string; format: string; url: string }[];
            witnesses: { name: string; organization: string; position: string }[];
        };
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for a specified committee meeting.
Parameters
- congress: number
  The congress of the meeting
- chamber: Chamber
  The chamber of the meeting
- eventId: string
  The event ID of the meeting
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Pagination parameters
Returns Promise<
    {
        committeeMeeting: {
            chamber: Chamber;
            committees: { name: string; systemCode: string; url: string }[];
            congress: number;
            date: string;
            eventId: string;
            hearingTranscript: { jacketNumber: number; url: string }[];
            location: { building: string; room: string };
            meetingDocuments: {
                description?: null | string;
                documentType: string;
                format: string;
                name: string;
                url: string;
            }[];
            meetingStatus: string;
            relatedItems: {
                bills?: {
                    congress: number;
                    number: string;
                    type: string;
                    url: string;
                }[];
                nominations?: {
                    congress: number;
                    number: string;
                    part: string;
                    url: string;
                }[];
                treaties?: {
                    congress: number;
                    number: string;
                    part: string;
                    url: string;
                }[];
            };
            title: string;
            type: string;
            updateDate: string;
            videos: any[];
            witnessDocuments: { documentType: string; format: string; url: string }[];
            witnesses: { name: string; organization: string; position: string }[];
        };
    } & { rateLimit: RateLimitInfo },
>
Detailed information for the specified committee meeting
- Defined in src/clients/committee-meeting.ts:59

getMeetings

getMeetings(
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of committee meetings.
Parameters
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Pagination parameters
Returns Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of committee meetings
- Defined in src/clients/committee-meeting.ts:16

getMeetingsByCongress

getMeetingsByCongress(
    congress: number,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of committee meetings filtered by the specified congress.
Parameters
- congress: number
  The congress to filter by
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Pagination parameters
Returns Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of committee meetings for the specified congress
- Defined in src/clients/committee-meeting.ts:26

getMeetingsByCongressAndChamber

getMeetingsByCongressAndChamber(
    congress: number,
    chamber: Chamber,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of committee meetings filtered by the specified congress and chamber.
Parameters
- congress: number
  The congress to filter by
- chamber: Chamber
  The chamber to filter by
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Pagination parameters
Returns Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of committee meetings for the specified congress and chamber
- Defined in src/clients/committee-meeting.ts:40

Class CommitteeMeetingClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommitteeMeetingClient

Properties

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

Methods

`Protected`get

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getMeeting

Parameters

getMeetings

Parameters

Returns Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>

getMeetingsByCongress

Parameters

Returns Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>

getMeetingsByCongressAndChamber

Parameters

Returns Promise<
    {
        committeeMeetings: {
            chamber: Chamber;
            congress: number;
            eventId: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>

Settings

On This Page

Class CommitteeMeetingClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommitteeMeetingClient

Properties

Protected ReadonlyapiKey

Protected ReadonlybaseUrl

Protected Readonlyendpoint

Methods

Protectedget

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getMeeting

Parameters

getMeetings

Parameters

Returns Promise< { committeeMeetings: { chamber: Chamber; congress: number; eventId: string; updateDate: string; url: string; }[]; } & { rateLimit: RateLimitInfo },>

getMeetingsByCongress

Parameters

Returns Promise< { committeeMeetings: { chamber: Chamber; congress: number; eventId: string; updateDate: string; url: string; }[]; } & { rateLimit: RateLimitInfo },>

getMeetingsByCongressAndChamber

Parameters

Returns Promise< { committeeMeetings: { chamber: Chamber; congress: number; eventId: string; updateDate: string; url: string; }[]; } & { rateLimit: RateLimitInfo },>

Settings

On This Page

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

`Protected`get

Returns Promise<
{
committeeMeetings: {
chamber: Chamber;
congress: number;
eventId: string;
updateDate: string;
url: string;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
committeeMeetings: {
chamber: Chamber;
congress: number;
eventId: string;
updateDate: string;
url: string;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
committeeMeetings: {
chamber: Chamber;
congress: number;
eventId: string;
updateDate: string;
url: string;
}[];
} & { rateLimit: RateLimitInfo },
>