Class NominationClient

Hierarchy (View Summary)

BaseClient
- NominationClient

Index

Constructors

Properties

Methods

get getNomination getNominationActions getNominationCommittees getNominationHearings getNominations getNominationsByCongress getNominees

Constructors

constructor

new NominationClient(__namedParameters: { apiKey: string }): NominationClient
Parameters
- __namedParameters: { apiKey: string }
Returns NominationClient
Overrides BaseClient.constructor
- Defined in src/clients/nomination.ts:13

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

getNomination

getNomination(
    congress: number,
    nominationNumber: string,
    params?: { format?: Format },
): Promise<
    {
        nomination: {
            actions: { count: number; url: string };
            citation: string;
            committees: { count: number; url: string };
            congress: number;
            description: string;
            isList?: boolean;
            latestAction: { actionDate: string; text: string };
            nominationType?: { isCivilian?: boolean; isMilitary?: boolean };
            nominees: {
                introText?: string;
                nomineeCount: number;
                ordinal: number;
                organization: string;
                positionTitle: string;
                url: string;
            }[];
            number: number;
            partNumber: string;
            receivedDate: string;
            updateDate: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for a specified nomination.
Parameters
- congress: number
  The congress of the nomination
- nominationNumber: string
  The nomination number
- params: { format?: Format } = {}
  {BaseParams} - Accepts format parameter
Returns Promise<
    {
        nomination: {
            actions: { count: number; url: string };
            citation: string;
            committees: { count: number; url: string };
            congress: number;
            description: string;
            isList?: boolean;
            latestAction: { actionDate: string; text: string };
            nominationType?: { isCivilian?: boolean; isMilitary?: boolean };
            nominees: {
                introText?: string;
                nomineeCount: number;
                ordinal: number;
                organization: string;
                positionTitle: string;
                url: string;
            }[];
            number: number;
            partNumber: string;
            receivedDate: string;
            updateDate: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Detailed information for the specified nomination
- Defined in src/clients/nomination.ts:46

getNominationActions

getNominationActions(
    congress: number,
    nominationNumber: string,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        actions: {
            actionCode: string;
            actionDate: string;
            committees?: { name: string; systemCode: string; url: string }[];
            text: string;
            type: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns the list of actions on a specified nomination.
Parameters
- congress: number
  The congress of the nomination
- nominationNumber: string
  The nomination number
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    {
        actions: {
            actionCode: string;
            actionDate: string;
            committees?: { name: string; systemCode: string; url: string }[];
            text: string;
            type: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
The list of actions for the specified nomination
- Defined in src/clients/nomination.ts:84

getNominationCommittees

getNominationCommittees(
    congress: number,
    nominationNumber: string,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        committees: {
            activities: { date: string; name: string }[];
            chamber: "Senate";
            name: string;
            systemCode: string;
            type: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns the list of committees associated with a specified nomination.
Parameters
- congress: number
  The congress of the nomination
- nominationNumber: string
  The nomination number
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    {
        committees: {
            activities: { date: string; name: string }[];
            chamber: "Senate";
            name: string;
            systemCode: string;
            type: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
The list of committees for the specified nomination
- Defined in src/clients/nomination.ts:102

getNominationHearings

getNominationHearings(
    congress: number,
    nominationNumber: string,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        hearings: {
            chamber: "Senate";
            citation: string;
            date: string;
            jacketNumber: number;
            number: number;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns the list of printed hearings associated with a specified nomination.
Parameters
- congress: number
  The congress of the nomination
- nominationNumber: string
  The nomination number
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    {
        hearings: {
            chamber: "Senate";
            citation: string;
            date: string;
            jacketNumber: number;
            number: number;
        }[];
    } & { rateLimit: RateLimitInfo },
>
The list of hearings for the specified nomination
- Defined in src/clients/nomination.ts:120

getNominations

getNominations(
    params?: { format?: Format; limit?: number; offset?: number } & DateFilterParams,
): Promise<
    {
        nominations: {
            citation: string;
            congress: number;
            description: string;
            latestAction: { actionDate: string; text: string };
            nominationType?: { isCivilian?: boolean; isMilitary?: boolean };
            number: number;
            organization: string;
            partNumber: string;
            receivedDate: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of nominations sorted by date received from the President.
Parameters
- params: { format?: Format; limit?: number; offset?: number } & DateFilterParams = {}
  {PaginationParams & DateFilterParams} - Pagination, date range filter and format parameters
Returns Promise<
    {
        nominations: {
            citation: string;
            congress: number;
            description: string;
            latestAction: { actionDate: string; text: string };
            nominationType?: { isCivilian?: boolean; isMilitary?: boolean };
            number: number;
            organization: string;
            partNumber: string;
            receivedDate: string;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of nominations
- Defined in src/clients/nomination.ts:22

getNominationsByCongress

getNominationsByCongress(
    congress: number,
    params?: { format?: Format; limit?: number; offset?: number } & DateFilterParams,
): Promise<
    {
        nominations: {
            actions: { count: number; url: string };
            citation: string;
            committees: { count: number; url: string };
            congress: number;
            description: string;
            isList?: boolean;
            latestAction: { actionDate: string; text: string };
            nominationType?: { isCivilian?: boolean; isMilitary?: boolean };
            nominees: {
                introText?: string;
                nomineeCount: number;
                ordinal: number;
                organization: string;
                positionTitle: string;
                url: string;
            }[];
            number: number;
            partNumber: string;
            receivedDate: string;
            updateDate: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of nominations filtered by the specified congress and sorted by date received from the President.
Parameters
- congress: number
  The congress to filter by
- params: { format?: Format; limit?: number; offset?: number } & DateFilterParams = {}
  {PaginationParams & DateFilterParams} - Pagination, date range filter and format parameters
Returns Promise<
    {
        nominations: {
            actions: { count: number; url: string };
            citation: string;
            committees: { count: number; url: string };
            congress: number;
            description: string;
            isList?: boolean;
            latestAction: { actionDate: string; text: string };
            nominationType?: { isCivilian?: boolean; isMilitary?: boolean };
            nominees: {
                introText?: string;
                nomineeCount: number;
                ordinal: number;
                organization: string;
                positionTitle: string;
                url: string;
            }[];
            number: number;
            partNumber: string;
            receivedDate: string;
            updateDate: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of nominations for the specified congress
- Defined in src/clients/nomination.ts:32

getNominees

getNominees(
    congress: number,
    nominationNumber: string,
    ordinal: string,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        nominees: {
            firstName: string;
            lastName: string;
            middleName: string;
            ordinal: number;
            state: StateCode;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns the list nominees for a position within the nomination.
Parameters
- congress: number
  The congress of the nomination
- nominationNumber: string
  The nomination number
- ordinal: string
  The ordinal of the nominee
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    {
        nominees: {
            firstName: string;
            lastName: string;
            middleName: string;
            ordinal: number;
            state: StateCode;
        }[];
    } & { rateLimit: RateLimitInfo },
>
The list of nominees for the specified position
- Defined in src/clients/nomination.ts:65

Class NominationClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NominationClient

Properties

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

Methods

`Protected`get

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getNomination

Parameters

getNominationActions

Parameters

Returns Promise<
    {
        actions: {
            actionCode: string;
            actionDate: string;
            committees?: { name: string; systemCode: string; url: string }[];
            text: string;
            type: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>

getNominationCommittees

Parameters

Returns Promise<
    {
        committees: {
            activities: { date: string; name: string }[];
            chamber: "Senate";
            name: string;
            systemCode: string;
            type: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>

getNominationHearings

Parameters

Returns Promise<
    {
        hearings: {
            chamber: "Senate";
            citation: string;
            date: string;
            jacketNumber: number;
            number: number;
        }[];
    } & { rateLimit: RateLimitInfo },
>

getNominations

Parameters

getNominationsByCongress

Parameters

getNominees

Parameters

Returns Promise<
    {
        nominees: {
            firstName: string;
            lastName: string;
            middleName: string;
            ordinal: number;
            state: StateCode;
        }[];
    } & { rateLimit: RateLimitInfo },
>

Settings

On This Page

Class NominationClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NominationClient

Properties

Protected ReadonlyapiKey

Protected ReadonlybaseUrl

Protected Readonlyendpoint

Methods

Protectedget

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getNomination

Parameters

getNominationActions

Parameters

Returns Promise< { actions: { actionCode: string; actionDate: string; committees?: { name: string; systemCode: string; url: string }[]; text: string; type: string; }[]; } & { rateLimit: RateLimitInfo },>

getNominationCommittees

Parameters

Returns Promise< { committees: { activities: { date: string; name: string }[]; chamber: "Senate"; name: string; systemCode: string; type: string; url: string; }[]; } & { rateLimit: RateLimitInfo },>

getNominationHearings

Parameters

Returns Promise< { hearings: { chamber: "Senate"; citation: string; date: string; jacketNumber: number; number: number; }[]; } & { rateLimit: RateLimitInfo },>

getNominations

Parameters

getNominationsByCongress

Parameters

getNominees

Parameters

Returns Promise< { nominees: { firstName: string; lastName: string; middleName: string; ordinal: number; state: StateCode; }[]; } & { rateLimit: RateLimitInfo },>

Settings

On This Page

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

`Protected`get

Returns Promise<
{
actions: {
actionCode: string;
actionDate: string;
committees?: { name: string; systemCode: string; url: string }[];
text: string;
type: string;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
committees: {
activities: { date: string; name: string }[];
chamber: "Senate";
name: string;
systemCode: string;
type: string;
url: string;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
hearings: {
chamber: "Senate";
citation: string;
date: string;
jacketNumber: number;
number: number;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
nominees: {
firstName: string;
lastName: string;
middleName: string;
ordinal: number;
state: StateCode;
}[];
} & { rateLimit: RateLimitInfo },
>