feat: initial work on realtime tokens

Author: iBotPeaches

src/Contracts/Resources/RealtimeContract.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Contracts\Resources;
+
+interface RealtimeContract
+{
+    /**
+     * Create an ephemeral API token for real time sessions.
+     *
+     * @see https://platform.openai.com/docs/api-reference/realtime-sessions/create
+     *
+     * @param  array<string, mixed>  $parameters
+     */
+    public function token(array $parameters = []);
+
+    /**
+     * Create a new response.
+     *
+     * @see https://platform.openai.com/docs/api-reference/realtime-sessions/create-transcription
+     *
+     * @param  array<string, mixed>  $parameters
+     */
+    public function transcribeToken(array $parameters = []);
+}

src/Resources/Realtime.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Resources;
+
+use OpenAI\Contracts\Resources\RealtimeContract;
+use OpenAI\Responses\Responses\CreateResponse;
+use OpenAI\Responses\Responses\ListInputItems;
+use OpenAI\Responses\Responses\RetrieveResponse;
+
+/**
+ * @phpstan-import-type CreateResponseType from CreateResponse
+ * @phpstan-import-type RetrieveResponseType from RetrieveResponse
+ * @phpstan-import-type ListInputItemsType from ListInputItems
+ */
+final class Realtime implements RealtimeContract
+{
+    use Concerns\Streamable;
+    use Concerns\Transportable;
+
+    public function token(array $parameters = [])
+    {
+        // TODO: Implement token() method.
+    }
+
+    public function transcribeToken(array $parameters = [])
+    {
+        // TODO: Implement transcribeToken() method.
+    }
+}

src/Responses/Realtime/SessionClientSecret.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Responses\Realtime;
+
+use OpenAI\Contracts\ResponseContract;
+use OpenAI\Responses\Concerns\ArrayAccessible;
+use OpenAI\Testing\Responses\Concerns\Fakeable;
+
+/**
+ * @phpstan-type ClientSecretType array{expires_at: int, value: string}
+ *
+ * @implements ResponseContract<ClientSecretType>
+ */
+final class SessionClientSecret implements ResponseContract
+{
+    /**
+     * @use ArrayAccessible<ClientSecretType>
+     */
+    use ArrayAccessible;
+
+    use Fakeable;
+
+    private function __construct(
+        public readonly int $expiresAt,
+        public readonly string $value,
+    ) {}
+
+    /**
+     * @param  ClientSecretType  $attributes
+     */
+    public static function from(array $attributes): self
+    {
+        return new self(
+            expiresAt: $attributes['expires_at'],
+            value: $attributes['value'],
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray(): array
+    {
+        return [
+            'expires_at' => $this->expiresAt,
+            'value' => $this->value,
+        ];
+    }
+}

src/Responses/Realtime/SessionResponse.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenAI\Responses\Realtime;
+
+use OpenAI\Contracts\ResponseContract;
+use OpenAI\Responses\Concerns\ArrayAccessible;
+use OpenAI\Testing\Responses\Concerns\Fakeable;
+
+/**
+ * @phpstan-import-type ClientSecretType from SessionClientSecret
+ *
+ * @phpstan-type SessionType array{client_secret: ClientSecretType, input_audio_format: 'pcm16'|'g711_ulaw'|'g711_alaw'}
+ *
+ * @implements ResponseContract<SessionType>
+ */
+final class SessionResponse implements ResponseContract
+{
+    /**
+     * @use ArrayAccessible<SessionType>
+     */
+    use ArrayAccessible;
+
+    use Fakeable;
+
+    private function __construct(
+        public readonly SessionClientSecret $clientSecret,
+        public readonly string $inputAudioFormat,
+    ) {}
+
+    /**
+     * @param  SessionType  $attributes
+     */
+    public static function from(array $attributes): self
+    {
+        return new self(
+            clientSecret: SessionClientSecret::from($attributes['client_secret']),
+            inputAudioFormat: $attributes['input_audio_format'],
+        );
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function toArray(): array
+    {
+        return [
+            'client_secret' => $this->clientSecret->toArray(),
+            'input_audio_format' => $this->inputAudioFormat,
+        ];
+    }
+}