Function TerminalReadersApiFp

  • TerminalReadersApi - functional programming interface

    Export

    Parameters

    Returns {
        getTerminal(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<TerminalReader>)>;
        getTerminalStatus(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<TerminalReaderConnectionStatus>)>;
        listTerminalReaders(tilled_account, metadata?, q?, include_connected_accounts?, created_at_gte?, created_at_lte?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListTerminalReaders200Response>)>;
        updateTerminal(tilled_account, id, TerminalReaderUpdateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<TerminalReader>)>;
    }

    • getTerminal:function
      • getTerminal(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<TerminalReader>)>

      • Retrieves the details of an existing Terminal Reader.

        Summary

        Get a Terminal Reader

        Throws

        Parameters

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<TerminalReader>)>

    • getTerminalStatus:function
      • getTerminalStatus(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<TerminalReaderConnectionStatus>)>

      • Retrieves the network connection status of an existing Terminal Reader.

        Summary

        Get a Terminal Reader status

        Throws

        Parameters

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<TerminalReaderConnectionStatus>)>

    • listTerminalReaders:function
      • listTerminalReaders(tilled_account, metadata?, q?, include_connected_accounts?, created_at_gte?, created_at_lte?, offset?, limit?, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • Optional metadata: {
              [key: string]: string;
          }

          `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

          • [key: string]: string
        • Optional q: string

          The partial search of text fields. Supports searching by `terminal_reader.description`, `terminal_reader.serial_number`, `terminal_reader.type`

        • Optional include_connected_accounts: boolean

          Whether or not to include the results from any connected accounts.

        • Optional created_at_gte: string

          Minimum `created_at` value to filter by (inclusive).

        • Optional created_at_lte: string

          Maximum `created_at` value to filter by (inclusive).

        • Optional offset: number

          The (zero-based) offset of the first item in the collection to return.

        • Optional limit: number

          The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<ListTerminalReaders200Response>)>

    • updateTerminal:function
      • updateTerminal(tilled_account, id, TerminalReaderUpdateParams, options?): Promise<((axios?, basePath?) => 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

        • tilled_account: string

          The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

        • id: string
        • TerminalReaderUpdateParams: TerminalReaderUpdateParams
        • Optional options: RawAxiosRequestConfig<any>

          Override http request option.

        Returns Promise<((axios?, basePath?) => AxiosPromise<TerminalReader>)>

Settings

Member Visibility

Theme

Generated using TypeDoc