Class CommitteePrintClient

Hierarchy (View Summary)

BaseClient
- CommitteePrintClient

Index

Constructors

constructor

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

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

getPrint

getPrint(
    congress: number,
    chamber: Chamber,
    printNumber: string,
    params?: { format?: Format },
): Promise<
    {
        committeePrint: {
            associatedBills: {
                congress: number;
                number: string;
                type: string;
                url: string;
            }[];
            chamber: Chamber;
            citation: string;
            committees: { name: string; systemCode: string; url: string }[];
            congress: number;
            jacketNumber: number;
            number: string;
            text: { count: number; url: string };
            title: string;
            updateDate: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns detailed information for a specified committee print.
Parameters
- congress: number
  The congress of the print
- chamber: Chamber
  The chamber of the print
- printNumber: string
  The print number
- params: { format?: Format } = {}
  {BaseParams} - Accepts format parameters
Returns Promise<
    {
        committeePrint: {
            associatedBills: {
                congress: number;
                number: string;
                type: string;
                url: string;
            }[];
            chamber: Chamber;
            citation: string;
            committees: { name: string; systemCode: string; url: string }[];
            congress: number;
            jacketNumber: number;
            number: string;
            text: { count: number; url: string };
            title: string;
            updateDate: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Detailed information for the specified committee print
- Defined in src/clients/committee-print.ts:63

getPrints

getPrints(
    params?: { format?: Format; limit?: number; offset?: number } & DateFilterParams,
): Promise<
    {
        committeePrints: {
            chamber: Chamber;
            congress: number;
            jacketNumber: number;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of committee prints.
Parameters
- params: { format?: Format; limit?: number; offset?: number } & DateFilterParams = {}
  {PaginationParams & DateFilterParams} - Accepts pagination, date range, and format parameters
Returns Promise<
    {
        committeePrints: {
            chamber: Chamber;
            congress: number;
            jacketNumber: number;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of committee prints
- Defined in src/clients/committee-print.ts:20

getPrintsByCongress

getPrintsByCongress(
    congress: number,
    params?: { format?: Format; limit?: number; offset?: number } & DateFilterParams,
): Promise<
    {
        committeePrints: {
            chamber: Chamber;
            congress: number;
            jacketNumber: number;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of committee prints filtered by the specified congress.
Parameters
- congress: number
  The congress to filter by
- params: { format?: Format; limit?: number; offset?: number } & DateFilterParams = {}
  {PaginationParams & DateFilterParams} - Accepts pagination, date range, and format parameters
Returns Promise<
    {
        committeePrints: {
            chamber: Chamber;
            congress: number;
            jacketNumber: number;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of committee prints for the specified congress
- Defined in src/clients/committee-print.ts:30

getPrintsByCongressAndChamber

getPrintsByCongressAndChamber(
    congress: number,
    chamber: Chamber,
    params?: { format?: Format; limit?: number; offset?: number } & DateFilterParams,
): Promise<
    {
        committeePrints: {
            chamber: Chamber;
            congress: number;
            jacketNumber: number;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
Returns a list of committee prints 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 } & DateFilterParams = {}
  {PaginationParams & DateFilterParams} - Accepts pagination, date range, and format parameters
Returns Promise<
    {
        committeePrints: {
            chamber: Chamber;
            congress: number;
            jacketNumber: number;
            updateDate: string;
            url: string;
        }[];
    } & { rateLimit: RateLimitInfo },
>
A list of committee prints for the specified congress and chamber
- Defined in src/clients/committee-print.ts:44

getPrintTexts

getPrintTexts(
    congress: number,
    chamber: Chamber,
    jacketNumber: string,
    params?: { format?: Format; limit?: number; offset?: number },
): Promise<
    { text: { type: CommitteeReportFormat; url: string }[] } & {
        rateLimit: RateLimitInfo;
    },
>
Returns the list of texts for a specified committee print.
Parameters
- congress: number
  The congress of the print
- chamber: Chamber
  The chamber of the print
- jacketNumber: string
  The jacket number
- params: { format?: Format; limit?: number; offset?: number } = {}
  {PaginationParams} - Accepts pagination and format parameters
Returns Promise<
    { text: { type: CommitteeReportFormat; url: string }[] } & {
        rateLimit: RateLimitInfo;
    },
>
List of texts for a specified committee print.
- Defined in src/clients/committee-print.ts:83

Class CommitteePrintClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommitteePrintClient

Properties

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

Methods

`Protected`get

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getPrint

Parameters

getPrints

Parameters

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

getPrintsByCongress

Parameters

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

getPrintsByCongressAndChamber

Parameters

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

getPrintTexts

Parameters

Returns Promise<
    { text: { type: CommitteeReportFormat; url: string }[] } & {
        rateLimit: RateLimitInfo;
    },
>

Settings

On This Page

Class CommitteePrintClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CommitteePrintClient

Properties

Protected ReadonlyapiKey

Protected ReadonlybaseUrl

Protected Readonlyendpoint

Methods

Protectedget

Type Parameters

Parameters

Returns Promise<T & { rateLimit: RateLimitInfo }>

getPrint

Parameters

getPrints

Parameters

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

getPrintsByCongress

Parameters

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

getPrintsByCongressAndChamber

Parameters

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

getPrintTexts

Parameters

Returns Promise< { text: { type: CommitteeReportFormat; url: string }[] } & { rateLimit: RateLimitInfo; },>

Settings

On This Page

`Protected` `Readonly`apiKey

`Protected` `Readonly`baseUrl

`Protected` `Readonly`endpoint

`Protected`get

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

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

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

Returns Promise<
{ text: { type: CommitteeReportFormat; url: string }[] } & {
rateLimit: RateLimitInfo;
},
>