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

    Class SenateCommunicationClient

    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 Senate communication.

      Parameters

      • congress: number

        The congress of the communication

      • communicationType: string

        The type of the communication

      • communicationNumber: string

        The communication number

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

        {PaginationParams} - Pagination parameters

      Returns Promise<
          {
              senateCommunication: {
                  abstract?: string;
                  chamber: "Senate";
                  classificationType?: { code: string; name: string };
                  committees?: {
                      name: string;
                      referralDate: string;
                      systemCode: string;
                      url: string;
                  }[];
                  communicationType: {
                      code: CommunicationTypeCode;
                      name: CommunicationTypeName;
                  };
                  congress: number;
                  congressionalRecordDate?: string;
                  number: number;
                  sessionNumber: 1
                  | 2;
                  updateDate: string;
              };
          } & { rateLimit: RateLimitInfo },
      >

      Detailed information for the specified Senate communication

    • Returns a list of Senate communications.

      Parameters

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

        {PaginationParams} - Pagination parameters

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

      A list of Senate communications

    • Returns a list of Senate communications 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<
          {
              senateCommunications: {
                  chamber: "Senate";
                  communicationType: {
                      code: CommunicationTypeCode;
                      name: CommunicationTypeName;
                  };
                  congress: number;
                  number: number;
                  updateDate: string;
                  url: string;
              }[];
          } & { rateLimit: RateLimitInfo },
      >

      A list of Senate communications for the specified congress

    • Returns a list of Senate 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} - Pagination parameters

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

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods