Class: Perka::ClientApi::CustomerVisitGet

Inherits:

Flatpack::Client::FlatpackRequest

• Object
• Flatpack::Client::FlatpackRequest
• Perka::ClientApi::CustomerVisitGet

Defined in:

lib/perka/client_api.rb

Instance Method Summary

• #initialize(api, *args) ⇒ CustomerVisitGet constructor

  A new instance of CustomerVisitGet.

• #with_fast_poll(fast_poll) ⇒ Object

  By default, requests to this endpoint will hang for a period of time before returning in order to wait for a visit associated with the location to be created or updated.

Constructor Details

#initialize(api, *args) ⇒ CustomerVisitGet

Returns a new instance of CustomerVisitGet.

# File 'lib/perka/client_api.rb', line 231

def initialize(api, *args)
  super(api, "GET", "/api/2/customer/visit", *args)
end

Instance Method Details

#with_fast_poll(fast_poll) ⇒ Object

By default, requests to this endpoint will hang for a period of time before returning in order to wait for a visit associated with the location to be created or updated. Setting this query parameter to true will disable the hanging get behavior, which is appropriate for requests used for first-time UI initialization.

# File 'lib/perka/client_api.rb', line 240

def with_fast_poll(fast_poll)
  query_parameter('fastPoll', fast_poll);
end