UploadRequests
in package
Client operations for Inttegro upload requests.
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 upload requests resource client.
- cancel() : UploadRequest
- Cancels the upload request.
- create() : UploadRequest
- Creates a new upload request.
- fulfill() : UploadFulfillment
- Fulfills the upload request with the supplied file.
- lookup() : UploadRequest
- Retrieves the requested upload request.
- page() : Page
- Retrieves a paginated collection of upload requests.
- review() : UploadRequest
- Records a review decision for the upload request.
Methods
__construct()
Creates the upload requests resource client.
public
__construct(HttpClient $http) : mixed
Parameters
- $http : HttpClient
-
Shared authenticated HTTP transport used by this resource client.
cancel()
Cancels the upload request.
public
cancel(array<string, mixed> $payload[, array<string, mixed> $options = [] ]) : UploadRequest
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
UploadRequest —The canceled upload request.
create()
Creates a new upload request.
public
create(array<string, mixed> $payload[, array<string, mixed> $options = [] ]) : UploadRequest
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
UploadRequest —The created upload request.
fulfill()
Fulfills the upload request with the supplied file.
public
fulfill(array<string, mixed> $payload) : UploadFulfillment
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
UploadFulfillment —The resulting upload fulfillment.
lookup()
Retrieves the requested upload request.
public
lookup(string $id) : UploadRequest
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
UploadRequest —The requested upload request.
page()
Retrieves a paginated collection of upload requests.
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 upload requests.
review()
Records a review decision for the upload request.
public
review(array<string, mixed> $payload[, array<string, mixed> $options = [] ]) : UploadRequest
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
UploadRequest —The resulting upload request.