congress-dot-gov - v0.4.3
    Preparing search index...

    Class HouseCommunicationClient

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseUrl endpoint

    Methods

    get getCommunication getCommunications getCommunicationsByCongress getCommunicationsByCongressAndType

    Constructors

    Properties

    apiKey: string
    baseUrl: string
    endpoint: string

    Methods

    • Returns detailed information for a specified House communication.

      Parameters

      • congress: number

        The congress of the communication

      • communicationType: string

        The type of the communication

      • communicationNumber: string

        The communication number

      • params: { format?: Format } = {}

        {BaseParams} - Accepts format parameter

      Returns Promise<
          {
              "house-communication"?: {
                  abstract: string;
                  chamber: "House";
                  committees: {
                      name: string;
                      referralDate: string;
                      systemCode: string;
                      url: string;
                  }[];
                  communicationType: {
                      code: CommunicationTypeCode;
                      name: CommunicationTypeName;
                  };
                  congress: number;
                  congressionalRecordDate: string;
                  congressNumber?: number;
                  houseDocument: { citation: string; title: string }[];
                  isRulemaking: string;
                  legalAuthority?: string;
                  matchingRequirements?: { number: string; url: string }[];
                  number: number;
                  reportNature: string;
                  sessionNumber: 1 | 2;
                  submittingAgency: string;
                  submittingOfficial: string;
                  updateDate: string;
              };
              houseCommunication: {
                  abstract: string;
                  chamber: "House";
                  committees: {
                      name: string;
                      referralDate: string;
                      systemCode: string;
                      url: string;
                  }[];
                  communicationType: {
                      code: CommunicationTypeCode;
                      name: CommunicationTypeName;
                  };
                  congress: number;
                  congressionalRecordDate: string;
                  congressNumber?: number;
                  houseDocument: { citation: string; title: string }[];
                  isRulemaking: string;
                  legalAuthority?: string;
                  matchingRequirements?: { number: string; url: string }[];
                  number: number;
                  reportNature: string;
                  sessionNumber: 1 | 2;
                  submittingAgency: string;
                  submittingOfficial: string;
                  updateDate: string;
              };
              rateLimit: RateLimitInfo;
          },
      >

      Detailed information for the specified House communication

    • Returns a list of House communications.

      Parameters

      • params: { format?: Format; limit?: number; offset?: number } = {}

        {PaginationParams} - Accepts pagination and format parameters

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

      A list of House communications

    • Returns a list of House communications filtered by the specified congress.

      Parameters

      • congress: number

        The congress to filter by

      • params: { format?: Format; limit?: number; offset?: number } = {}

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          {
              houseCommunications: {
                  chamber: "House";
                  communicationType: {
                      code: CommunicationTypeCode;
                      name: CommunicationTypeName;
                  };
                  congress: number;
                  number: number;
                  reportNature?: string;
                  submittingAgency?: string;
                  submittingOfficial?: string;
                  updateDate: string;
                  url?: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of House communications for the specified congress

    • Returns a list of House communications filtered by the specified congress and communication type.

      Parameters

      • congress: number

        The congress to filter by

      • communicationType: string

        The communication type to filter by

      • params: { format?: Format; limit?: number; offset?: number } = {}

        {PaginationParams} - Accepts pagination and format parameters

      Returns Promise<
          {
              houseCommunications: {
                  chamber: "House";
                  communicationType: {
                      code: CommunicationTypeCode;
                      name: CommunicationTypeName;
                  };
                  congress: number;
                  number: number;
                  reportNature?: string;
                  submittingAgency?: string;
                  submittingOfficial?: string;
                  updateDate: string;
                  url?: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of House communications for the specified congress and communication type

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods