Method: Unit::Application.list_applications

Defined in:
lib/unit/models/application/application.rb

.list_applications(offset: APPLICATION_LIST_OFFSET, limit: APPLICATION_LIST_LIMIT, email: nil, tags: nil, query: nil, status: nil, sort: nil) ⇒ UnitResponse, UnitError

List applications by calling Unit’s API

Parameters:

  • offset (Integer) (defaults to: APPLICATION_LIST_OFFSET) —

    Number of resources to skip.

  • limit (Integer) (defaults to: APPLICATION_LIST_LIMIT) —

    The limit Maximum number of resources that will be returned.

  • email (String) (defaults to: nil) —

    Filter applications by email address (case sensitive).

  • tags (String) (defaults to: nil) —

    Filter applications by tags. More information regarding tags: docs.unit.co/#tags

  • query (String) (defaults to: nil) —

    Search term according to the: docs.unit.co/#full-text-search

  • status (String) (defaults to: nil) —

    Filter applications by status: docs.unit.co/applications/#application-statuses

  • sort (String) (defaults to: nil) —

    Sorts the resources by the specified field.

  • sort=createdAt (Hash) —

    a customizable set of options

  • sort=-createdAt (Hash) —

    a customizable set of options

Returns:

See Also:



152
153
154
155
 
# File 'lib/unit/models/application/application.rb', line 152

def list_applications(offset: APPLICATION_LIST_OFFSET, limit: APPLICATION_LIST_LIMIT, email: nil, tags: nil, query: nil, status: nil, sort: nil)
  request = Unit::Application::ListApplicationParams.new(offset, limit, email, tags, query, status, sort)
  Unit::Resource::ApplicationResource.list_applications(request)
end