Apps
in package
Application creation, lookup, and update operations.
Request arrays use the API's documented snake_case field names. Successful responses
are returned as immutable values from the corresponding singular resource namespace.
Table of Contents
Methods
- __construct() : mixed
- Creates the apps resource client.
- create() : App
- Creates a new application.
- lookup() : App
- Retrieves the requested application.
- update() : App
- Updates the supplied fields on the application.
Methods
__construct()
Creates the apps resource client.
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
-
Shared authenticated HTTP transport used by this resource client.
create()
Creates a new application.
public
create(array<string, mixed> $payload) : App
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $payload : array<string, mixed>
-
Request fields keyed by the documented
snake_caseAPI names.
Return values
App —The created app.
lookup()
Retrieves the requested application.
public
lookup() : App
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Return values
App —The requested app.
update()
Updates the supplied fields on the application.
public
update(array<string, mixed> $payload) : App
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $payload : array<string, mixed>
-
Request fields keyed by the documented
snake_caseAPI names.
Return values
App —The updated app.