Remove thread messages delete endpoint

openai-php · Dec 22, 2023 · c39ee92 · c39ee92
1 parent bc93450
commit c39ee92
Show file tree

Hide file tree

Showing 9 changed files with 0 additions and 201 deletions.
diff --git a/README.md b/README.md
@@ -1315,23 +1315,6 @@ $response->metadata; // ['name' => 'My new message name']
 $response->toArray(); // ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
 ```
 
-#### `delete`
-
-Delete a message.
-
-```php
-$response = $client->threads()->messages()->delete(
-    threadId: 'thread_tKFLqzRN9n7MnyKKvc1Q7868',
-    messageId: 'msg_SKYwvF3zcigxthfn6F4hnpdU',
-);
-
-$response->id; // 'msg_SKYwvF3zcigxthfn6F4hnpdU'
-$response->object; // 'thread.message.deleted'
-$response->deleted; // true
-
-$response->toArray(); // ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
-```
-
 #### `list`
 
 Returns a list of messages for a given thread.

diff --git a/src/Contracts/Resources/ThreadsMessagesContract.php b/src/Contracts/Resources/ThreadsMessagesContract.php
@@ -2,7 +2,6 @@
 
 namespace OpenAI\Contracts\Resources;
 
-use OpenAI\Responses\Threads\Messages\ThreadMessageDeleteResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageListResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageResponse;
 
@@ -33,13 +32,6 @@ public function retrieve(string $threadId, string $messageId): ThreadMessageResp
      */
     public function modify(string $threadId, string $messageId, array $parameters): ThreadMessageResponse;
 
-    /**
-     * Delete a message.
-     *
-     * @see TBD - there is no documentation yet
-     */
-    public function delete(string $threadId, string $messageId): ThreadMessageDeleteResponse;
-
     /**
      * Returns a list of messages for a given thread.
      *

diff --git a/src/Resources/ThreadsMessages.php b/src/Resources/ThreadsMessages.php
@@ -6,7 +6,6 @@
 
 use OpenAI\Contracts\Resources\ThreadsMessagesContract;
 use OpenAI\Contracts\Resources\ThreadsMessagesFilesContract;
-use OpenAI\Responses\Threads\Messages\ThreadMessageDeleteResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageListResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageResponse;
 use OpenAI\ValueObjects\Transporter\Payload;
@@ -65,21 +64,6 @@ public function modify(string $threadId, string $messageId, array $parameters):
         return ThreadMessageResponse::from($response->data(), $response->meta());
     }
 
-    /**
-     * Delete a message.
-     *
-     * @see TBD - there is no documentation yet
-     */
-    public function delete(string $threadId, string $messageId): ThreadMessageDeleteResponse
-    {
-        $payload = Payload::delete("threads/$threadId/messages", $messageId);
-
-        /** @var Response<array{id: string, object: string, deleted: bool}> $response */
-        $response = $this->transporter->requestObject($payload);
-
-        return ThreadMessageDeleteResponse::from($response->data(), $response->meta());
-    }
-
     /**
      * Returns a list of messages for a given thread.
      *

diff --git a/src/Responses/Threads/Messages/ThreadMessageDeleteResponse.php b/src/Responses/Threads/Messages/ThreadMessageDeleteResponse.php
diff --git a/src/Testing/Resources/ThreadsMessagesTestResource.php b/src/Testing/Resources/ThreadsMessagesTestResource.php
@@ -4,7 +4,6 @@
 
 use OpenAI\Contracts\Resources\ThreadsMessagesContract;
 use OpenAI\Resources\ThreadsMessages;
-use OpenAI\Responses\Threads\Messages\ThreadMessageDeleteResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageListResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageResponse;
 use OpenAI\Testing\Resources\Concerns\Testable;
@@ -33,11 +32,6 @@ public function modify(string $threadId, string $messageId, array $parameters):
         return $this->record(__FUNCTION__, func_get_args());
     }
 
-    public function delete(string $threadId, string $messageId): ThreadMessageDeleteResponse
-    {
-        return $this->record(__FUNCTION__, func_get_args());
-    }
-
     public function list(string $threadId, array $parameters = []): ThreadMessageListResponse
     {
         return $this->record(__FUNCTION__, func_get_args());

diff --git a/tests/Fixtures/ThreadMessage.php b/tests/Fixtures/ThreadMessage.php
@@ -71,15 +71,3 @@ function threadMessageListResource(): array
         'has_more' => false,
     ];
 }
-
-/**
- * @return array<string, mixed>
- */
-function threadMessageDeleteResource(): array
-{
-    return [
-        'id' => 'msg_KNsDDwE41BUAHhcPNpDkdHWZ',
-        'object' => 'thread.message.deleted',
-        'deleted' => true,
-    ];
-}
diff --git a/tests/Resources/ThreadsMessages.php b/tests/Resources/ThreadsMessages.php
@@ -1,7 +1,6 @@
 <?php
 
 use OpenAI\Responses\Meta\MetaInformation;
-use OpenAI\Responses\Threads\Messages\ThreadMessageDeleteResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageListResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageResponseContentImageFileObject;
@@ -126,18 +125,3 @@
     expect($result->meta())
         ->toBeInstanceOf(MetaInformation::class);
 });
-
-test('delete', function () {
-    $client = mockClient('DELETE', 'threads/thread_agvtHUGezjTCt4SKgQg0NJ2Y/messages/msg_KNsDDwE41BUAHhcPNpDkdHWZ', [], Response::from(threadMessageDeleteResource(), metaHeaders()));
-
-    $result = $client->threads()->messages()->delete('thread_agvtHUGezjTCt4SKgQg0NJ2Y', 'msg_KNsDDwE41BUAHhcPNpDkdHWZ');
-
-    expect($result)
-        ->toBeInstanceOf(ThreadMessageDeleteResponse::class)
-        ->id->toBe('msg_KNsDDwE41BUAHhcPNpDkdHWZ')
-        ->object->toBe('thread.message.deleted')
-        ->deleted->toBe(true);
-
-    expect($result->meta())
-        ->toBeInstanceOf(MetaInformation::class);
-});
diff --git a/tests/Responses/Threads/Messages/ThreadMessageDeleteResponse.php b/tests/Responses/Threads/Messages/ThreadMessageDeleteResponse.php
diff --git a/tests/Testing/Resources/ThreadsMessagesTestResource.php b/tests/Testing/Resources/ThreadsMessagesTestResource.php
@@ -1,7 +1,6 @@
 <?php
 
 use OpenAI\Resources\ThreadsMessages;
-use OpenAI\Responses\Threads\Messages\ThreadMessageDeleteResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageListResponse;
 use OpenAI\Responses\Threads\Messages\ThreadMessageResponse;
 use OpenAI\Testing\ClientFake;
@@ -66,23 +65,6 @@
     });
 });
 
-it('records a thread message delete request', function () {
-    $fake = new ClientFake([
-        ThreadMessageDeleteResponse::fake(),
-    ]);
-
-    $fake->threads()->messages()->delete(
-        threadId: 'thread_tKFLqzRN9n7MnyKKvc1Q7868',
-        messageId: 'msg_SKYwvF3zcigxthfn6F4hnpdU',
-    );
-
-    $fake->assertSent(ThreadsMessages::class, function ($method, $threadId, $messageId) {
-        return $method === 'delete' &&
-            $threadId === 'thread_tKFLqzRN9n7MnyKKvc1Q7868' &&
-            $messageId === 'msg_SKYwvF3zcigxthfn6F4hnpdU';
-    });
-});
-
 it('records a thread message list request', function () {
     $fake = new ClientFake([
         ThreadMessageListResponse::fake(),