chore: update SDK from api-definitions (#683)

Co-authored-by: rebilly-machine-user <[email protected]> Co-authored-by: Arif Kurkchi <[email protected]> Co-authored-by: Arif Kurkchi <[email protected]>
Rebilly · Apr 11, 2024 · 5f15fd3 · 5f15fd3
1 parent 8647367
commit 5f15fd3
Show file tree

Hide file tree

Showing 78 changed files with 1,487 additions and 1,351 deletions.
diff --git a/.changeset/seven-houses-travel.md b/.changeset/seven-houses-travel.md
@@ -0,0 +1,5 @@
+---
+"@rebilly/client-php": patch
+---
+
+Improve type hints for API classes
diff --git a/src/Api/AllowlistsApi.php b/src/Api/AllowlistsApi.php
@@ -39,9 +39,6 @@ public function delete(
         $this->client->send($request);
     }
 
-    /**
-     * @return Allowlist
-     */
     public function getAllowlist(
         string $id,
     ): Allowlist {
@@ -51,7 +48,9 @@ public function getAllowlist(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/allowlists/{id}');
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -75,7 +74,9 @@ public function getAllowlistCollection(
         ];
         $uri = '/allowlists?' . http_build_query($queryParams);
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -87,6 +88,9 @@ public function getAllowlistCollection(
         );
     }
 
+    /**
+     * @return Paginator<Allowlist>
+     */
     public function getAllowlistCollectionPaginator(
         ?string $filter = null,
         ?array $sort = null,
@@ -106,15 +110,14 @@ public function getAllowlistCollectionPaginator(
         );
     }
 
-    /**
-     * @return Allowlist
-     */
     public function storeAllowlist(
         Allowlist $allowlist,
     ): Allowlist {
         $uri = '/allowlists';
 
-        $request = new Request('POST', $uri, body: Utils::jsonEncode($allowlist));
+        $request = new Request('POST', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($allowlist));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 

diff --git a/src/Api/AmlChecksApi.php b/src/Api/AmlChecksApi.php
@@ -27,9 +27,6 @@ public function __construct(protected ?ClientInterface $client)
     {
     }
 
-    /**
-     * @return AmlCheck
-     */
     public function get(
         string $id,
     ): AmlCheck {
@@ -39,7 +36,9 @@ public function get(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/aml-checks/{id}');
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -65,7 +64,9 @@ public function getAll(
         ];
         $uri = '/aml-checks?' . http_build_query($queryParams);
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -77,6 +78,9 @@ public function getAll(
         );
     }
 
+    /**
+     * @return Paginator<AmlCheck>
+     */
     public function getAllPaginator(
         ?int $limit = null,
         ?int $offset = null,
@@ -98,9 +102,6 @@ public function getAllPaginator(
         );
     }
 
-    /**
-     * @return AmlCheck
-     */
     public function review(
         string $id,
         AmlCheckReview $amlCheckReview,
@@ -111,16 +112,15 @@ public function review(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/aml-checks/{id}/review');
 
-        $request = new Request('POST', $uri, body: Utils::jsonEncode($amlCheckReview));
+        $request = new Request('POST', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($amlCheckReview));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
         return AmlCheck::from($data);
     }
 
-    /**
-     * @return AmlCheck
-     */
     public function startReview(
         string $id,
     ): AmlCheck {
@@ -130,16 +130,15 @@ public function startReview(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/aml-checks/{id}/start-review');
 
-        $request = new Request('POST', $uri);
+        $request = new Request('POST', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
         return AmlCheck::from($data);
     }
 
-    /**
-     * @return AmlCheck
-     */
     public function stopReview(
         string $id,
     ): AmlCheck {
@@ -149,7 +148,9 @@ public function stopReview(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/aml-checks/{id}/stop-review');
 
-        $request = new Request('POST', $uri);
+        $request = new Request('POST', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 

diff --git a/src/Api/AmlSettingsApi.php b/src/Api/AmlSettingsApi.php
@@ -24,29 +24,27 @@ public function __construct(protected ?ClientInterface $client)
     {
     }
 
-    /**
-     * @return AmlSettings
-     */
     public function getAmlSettings(): AmlSettings
     {
         $uri = '/aml-settings';
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
         return AmlSettings::from($data);
     }
 
-    /**
-     * @return AmlSettings
-     */
     public function putAmlSettings(
         AmlSettings $amlSettings,
     ): AmlSettings {
         $uri = '/aml-settings';
 
-        $request = new Request('PUT', $uri, body: Utils::jsonEncode($amlSettings));
+        $request = new Request('PUT', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($amlSettings));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 

diff --git a/src/Api/ApiKeysApi.php b/src/Api/ApiKeysApi.php
@@ -26,15 +26,14 @@ public function __construct(protected ?ClientInterface $client)
     {
     }
 
-    /**
-     * @return ApiKey
-     */
     public function create(
         ApiKey $apiKey,
     ): ApiKey {
         $uri = '/api-keys';
 
-        $request = new Request('POST', $uri, body: Utils::jsonEncode($apiKey));
+        $request = new Request('POST', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($apiKey));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -54,9 +53,6 @@ public function delete(
         $this->client->send($request);
     }
 
-    /**
-     * @return ApiKey
-     */
     public function get(
         string $id,
     ): ApiKey {
@@ -66,7 +62,9 @@ public function get(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/api-keys/{id}');
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -88,7 +86,9 @@ public function getAll(
         ];
         $uri = '/api-keys?' . http_build_query($queryParams);
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
@@ -100,6 +100,9 @@ public function getAll(
         );
     }
 
+    /**
+     * @return Paginator<ApiKey>
+     */
     public function getAllPaginator(
         ?int $limit = null,
         ?int $offset = null,
@@ -117,9 +120,6 @@ public function getAllPaginator(
         );
     }
 
-    /**
-     * @return ApiKey
-     */
     public function update(
         string $id,
         ApiKey $apiKey,
@@ -130,7 +130,9 @@ public function update(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/api-keys/{id}');
 
-        $request = new Request('PUT', $uri, body: Utils::jsonEncode($apiKey));
+        $request = new Request('PUT', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($apiKey));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 

diff --git a/src/Api/ApplicationInstancesApi.php b/src/Api/ApplicationInstancesApi.php
@@ -38,9 +38,6 @@ public function delete(
         $this->client->send($request);
     }
 
-    /**
-     * @return ApplicationInstance
-     */
     public function get(
         string $applicationId,
     ): ApplicationInstance {
@@ -50,16 +47,15 @@ public function get(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/application-instances/{applicationId}');
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
         return ApplicationInstance::from($data);
     }
 
-    /**
-     * @return ApplicationInstanceConfiguration
-     */
     public function getConfiguration(
         string $applicationId,
     ): ApplicationInstanceConfiguration {
@@ -69,16 +65,15 @@ public function getConfiguration(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/application-instances/{applicationId}/configuration');
 
-        $request = new Request('GET', $uri);
+        $request = new Request('GET', $uri, headers: [
+            'Accept' => 'application/json',
+        ]);
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
         return ApplicationInstanceConfiguration::from($data);
     }
 
-    /**
-     * @return ApplicationInstance
-     */
     public function upsert(
         string $applicationId,
         ApplicationInstance $applicationInstance,
@@ -89,16 +84,15 @@ public function upsert(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/application-instances/{applicationId}');
 
-        $request = new Request('PUT', $uri, body: Utils::jsonEncode($applicationInstance));
+        $request = new Request('PUT', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($applicationInstance));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);
 
         return ApplicationInstance::from($data);
     }
 
-    /**
-     * @return ApplicationInstanceConfiguration
-     */
     public function upsertConfiguration(
         string $applicationId,
         ApplicationInstanceConfiguration $applicationInstanceConfiguration,
@@ -109,7 +103,9 @@ public function upsertConfiguration(
 
         $uri = str_replace(array_keys($pathParams), array_values($pathParams), '/application-instances/{applicationId}/configuration');
 
-        $request = new Request('PUT', $uri, body: Utils::jsonEncode($applicationInstanceConfiguration));
+        $request = new Request('PUT', $uri, headers: [
+            'Accept' => 'application/json',
+        ], body: Utils::jsonEncode($applicationInstanceConfiguration));
         $response = $this->client->send($request);
         $data = Utils::jsonDecode((string) $response->getBody(), true);