Class: PlatformAPI::FilterApps

Inherits:

Object

• Object
• PlatformAPI::FilterApps

Defined in:

lib/platform-api/client.rb

Overview

Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed. Each filter endpoint endpoint is responsible for determining its supported request format. The endpoints are over POST in order to handle large request bodies without hitting request uri query length limitations, but the requests themselves are idempotent and will not have side effects.

Instance Method Summary

• #apps(body = {}) ⇒ Object

  Request an apps list filtered by app id.

• #initialize(client) ⇒ FilterApps constructor

  A new instance of FilterApps.

Constructor Details

#initialize(client) ⇒ FilterApps

# File 'lib/platform-api/client.rb', line 1940

def initialize(client)
  @client = client
end

Instance Method Details

#apps(body = {}) ⇒ Object

Request an apps list filtered by app id.

# File 'lib/platform-api/client.rb', line 1947

def apps(body = {})
  @client.filter_apps.apps(body)
end