Function TerminalReadersApiFactory

TerminalReadersApiFactory(configuration?, basePath?, axios?): {
    getTerminal(requestParameters, options?) => AxiosPromise<TerminalReader>;
    getTerminalStatus(requestParameters, options?) => AxiosPromise<TerminalReaderConnectionStatus>;
    listTerminalReaders(requestParameters, options?) => AxiosPromise<ListTerminalReaders200Response>;
    updateTerminal(requestParameters, options?) => AxiosPromise<TerminalReader>;
}
TerminalReadersApi - factory interface

Export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns {
    getTerminal(requestParameters, options?) => AxiosPromise<TerminalReader>;
    getTerminalStatus(requestParameters, options?) => AxiosPromise<TerminalReaderConnectionStatus>;
    listTerminalReaders(requestParameters, options?) => AxiosPromise<ListTerminalReaders200Response>;
    updateTerminal(requestParameters, options?) => AxiosPromise<TerminalReader>;
}
- getTerminal:function
  - getTerminal(requestParameters, options?): AxiosPromise<TerminalReader>
  - Retrieves the details of an existing Terminal Reader.
    
    Summary
    Get a Terminal Reader
    
    Throws
    Parameters
    - requestParameters: TerminalReadersApiGetTerminalRequest
      
      Request parameters.
    - Optional options: RawAxiosRequestConfig<any>
      
      Override http request option.
    Returns AxiosPromise<TerminalReader>
    - Defined in api/terminal-readers-api.ts:363
- getTerminalStatus:function
  - getTerminalStatus(requestParameters, options?): AxiosPromise<TerminalReaderConnectionStatus>
  - Retrieves the network connection status of an existing Terminal Reader.
    
    Summary
    Get a Terminal Reader status
    
    Throws
    Parameters
    - requestParameters: TerminalReadersApiGetTerminalStatusRequest
      
      Request parameters.
    - Optional options: RawAxiosRequestConfig<any>
      
      Override http request option.
    Returns AxiosPromise<TerminalReaderConnectionStatus>
    - Defined in api/terminal-readers-api.ts:373
- listTerminalReaders:function
  - listTerminalReaders(requestParameters, options?): AxiosPromise<ListTerminalReaders200Response>
  - Returns a list of an Account's Terminal Readers. The Terminal Readers are sorted with the most recently created appearing first.
    
    Summary
    List all Terminal Readers
    
    Throws
    Parameters
    - requestParameters: TerminalReadersApiListTerminalReadersRequest
      
      Request parameters.
    - Optional options: RawAxiosRequestConfig<any>
      
      Override http request option.
    Returns AxiosPromise<ListTerminalReaders200Response>
    - Defined in api/terminal-readers-api.ts:383
- updateTerminal:function
  - updateTerminal(requestParameters, options?): AxiosPromise<TerminalReader>
  - Updates the Terminal Reader by setting the values of the provided parameters. Any parameters not provided will be left unchanged.
    
    Summary
    Update a Terminal Reader
    
    Throws
    Parameters
    - requestParameters: TerminalReadersApiUpdateTerminalRequest
      
      Request parameters.
    - Optional options: RawAxiosRequestConfig<any>
      
      Override http request option.
    Returns AxiosPromise<TerminalReader>
    - Defined in api/terminal-readers-api.ts:393
- Defined in api/terminal-readers-api.ts:353

Generated using TypeDoc