FileLinks
in package
Client operations for Inttegro file links.
Request arrays use the API's documented snake_case field names. Responses
are returned as immutable values from the corresponding singular namespace.
Table of Contents
Methods
- __construct() : mixed
- Creates the file links resource client.
- create() : Creation
- Creates a new file link.
- lookup() : FileLink
- Retrieves the requested file link.
- open() : FileDownload
- Performs the `open` operation for the file link.
- page() : Page
- Retrieves a paginated collection of file links.
- revoke() : FileLink
- Performs the `revoke` operation for the file link.
Methods
__construct()
Creates the file links resource client.
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
-
Shared authenticated HTTP transport used by this resource client.
create()
Creates a new file link.
public
create(array<string, mixed> $payload[, array<string, mixed> $options = [] ]) : Creation
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. - $options : array<string, mixed> = []
-
Optional endpoint-specific request fields.
Return values
Creation —The created creation.
lookup()
Retrieves the requested file link.
public
lookup(string $id) : FileLink
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $id : string
-
ID value.
Return values
FileLink —The requested file link.
open()
Performs the `open` operation for the file link.
public
open(string $url[, string|null $saveTo = null ]) : FileDownload
Sends the documented request through the shared authenticated transport and hydrates the successful response into the declared return type.
Parameters
- $url : string
-
URL value.
- $saveTo : string|null = null
-
save To value.
Return values
FileDownload —The resulting file download.
page()
Retrieves a paginated collection of file links.
public
page([array<string, mixed> $payload = [] ]) : Page
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
Page —A typed page of matching file links.
revoke()
Performs the `revoke` operation for the file link.
public
revoke(array<string, mixed> $payload[, array<string, mixed> $options = [] ]) : FileLink
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. - $options : array<string, mixed> = []
-
Optional endpoint-specific request fields.
Return values
FileLink —The resulting file link.