Class HouseRequirementClient

Hierarchy (View Summary)

BaseClient
- HouseRequirementClient

Index

Constructors

constructor

new HouseRequirementClient(
__namedParameters: { apiKey: string },
): HouseRequirementClient
Parameters
- __namedParameters: { apiKey: string }
Returns HouseRequirementClient
Overrides BaseClient.constructor
- Defined in src/clients/house-requirements.ts:10

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

getMatchingCommunications

getMatchingCommunications(
    requirementNumber: string,
    params?: { format?: Format },
): Promise<
    {
        matchingCommunications: {
            chamber: "House";
            communicationType: {
                code: CommunicationTypeCode;
                name: CommunicationTypeName;
            };
            congress: number;
            number: number;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of matching communications to a House requirement.
Parameters
- requirementNumber: string
  The requirement number
- params: { format?: Format } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    {
        matchingCommunications: {
            chamber: "House";
            communicationType: {
                code: CommunicationTypeCode;
                name: CommunicationTypeName;
            };
            congress: number;
            number: number;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of matching communications
- Defined in src/clients/house-requirements.ts:45

getRequirement

getRequirement(
    requirementNumber: string,
    params?: { format?: Format },
): Promise<
    {
        houseRequirement: {
            activeRecord: boolean;
            frequency: string;
            legalAuthority: string;
            matchingCommunications: { count: number; url: string };
            nature: string;
            number: number;
            parentAgency: string;
            submittingAgency: string;
            submittingOfficial?: string;
            updateDate: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for a specified House requirement.
Parameters
- requirementNumber: string
  The requirement number
- params: { format?: Format } = {}
  {BaseParams} - Accepts format parameter
Returns Promise<
    {
        houseRequirement: {
            activeRecord: boolean;
            frequency: string;
            legalAuthority: string;
            matchingCommunications: { count: number; url: string };
            nature: string;
            number: number;
            parentAgency: string;
            submittingAgency: string;
            submittingOfficial?: string;
            updateDate: string;
        };
    } & { rateLimit: RateLimitInfo },
>
Detailed information for the specified House requirement
- Defined in src/clients/house-requirements.ts:32

getRequirements

getRequirements(
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    {
        houseRequirements: PaginatedResponse<
            { number: number; updateDate: string; url: string }[],
        >;
    } & { rateLimit: RateLimitInfo },
>
Returns a list of House requirements.
Parameters
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    {
        houseRequirements: PaginatedResponse<
            { number: number; updateDate: string; url: string }[],
        >;
    } & { rateLimit: RateLimitInfo },
>
A list of House requirements
- Defined in src/clients/house-requirements.ts:19

Class HouseRequirementClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HouseRequirementClient

Properties

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

Methods

`Protected`get

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getMatchingCommunications

Parameters

getRequirement

Parameters

getRequirements

Parameters

Returns Promise<
    {
        houseRequirements: PaginatedResponse<
            { number: number; updateDate: string; url: string }[],
        >;
    } & { rateLimit: RateLimitInfo },
>

Settings

On This Page

Class HouseRequirementClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HouseRequirementClient

Properties

Protected ReadonlyapiKey

Protected ReadonlybaseUrl

Protected Readonlyendpoint

Methods

Protectedget

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getMatchingCommunications

Parameters

Returns Promise< { matchingCommunications: { chamber: "House"; communicationType: { code: CommunicationTypeCode; name: CommunicationTypeName; }; congress: number; number: number; url: string; }[]; } & { rateLimit: RateLimitInfo },>

getRequirement

Parameters

getRequirements

Parameters

Returns Promise< { houseRequirements: PaginatedResponse< { number: number; updateDate: string; url: string }[], >; } & { rateLimit: RateLimitInfo },>

Settings

On This Page

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

`Protected`get

Returns Promise<
{
matchingCommunications: {
chamber: "House";
communicationType: {
code: CommunicationTypeCode;
name: CommunicationTypeName;
};
congress: number;
number: number;
url: string;
}[];
} & { rateLimit: RateLimitInfo },
>

Returns Promise<
{
houseRequirements: PaginatedResponse<
{ number: number; updateDate: string; url: string }[],
>;
} & { rateLimit: RateLimitInfo },
>