Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Contracts/Resources/FilesContract.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ interface FilesContract
* Returns a list of files that belong to the user's organization.
*
* @see https://platform.openai.com/docs/api-reference/files/list
*
* @param array<string, mixed> $parameters
*/
public function list(): ListResponse;
public function list(array $parameters = []): ListResponse;

/**
* Returns information about a specific file.
Expand Down
4 changes: 2 additions & 2 deletions src/Resources/Files.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ final class Files implements FilesContract
*
* @see https://platform.openai.com/docs/api-reference/files/list
*/
public function list(): ListResponse
public function list(array $parameters = []): ListResponse
{
$payload = Payload::list('files');
$payload = Payload::list('files', $parameters);

/** @var Response<array{object: string, data: array<int, array{id: string, object: string, created_at: int, bytes: ?int, filename: string, purpose: string, status: string, status_details: array<array-key, mixed>|string|null}>}> $response */
$response = $this->transporter->requestObject($payload);
Expand Down
4 changes: 2 additions & 2 deletions src/Testing/Resources/FilesTestResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ protected function resource(): string
return Files::class;
}

public function list(): ListResponse
public function list(array $parameters = []): ListResponse
{
return $this->record(__FUNCTION__);
return $this->record(__FUNCTION__, func_get_args());
}

public function retrieve(string $file): RetrieveResponse
Expand Down
15 changes: 15 additions & 0 deletions tests/Testing/Resources/FilesTestResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,21 @@
});
});

it('records a file list request with parameters', function () {
$fake = new ClientFake([
ListResponse::fake(),
]);

$fake->files()->list([
'limit' => 1,
]);

$fake->assertSent(Files::class, function ($method, $parameters) {
return $method === 'list' &&
$parameters['limit'] === 1;
});
});

it('records a files download request', function () {
$fake = new ClientFake([
'fake-file-content',
Expand Down