version 12.1.0

Author: klaviyo-sdk

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
 
+## [12.1.0] - revision 2024-10-15
+### Changed
+- Updated REAME to use named arguments
+- Some methods have been renamed- the old methods are now deprecated aliases
+
 ## [12.0.1] - revision 2024-10-15
 ### Fixed
 - Updated [Uploading Image From File](https://github.com/klaviyo/klaviyo-api-php#uploading-image-from-file) section of README

README.md

@@ -1,6 +1,6 @@
 {
     "name": "klaviyo/api",
-    "version": "12.0.1",
+    "version": "12.1.0",
     "description": "PHP SDK for Klaviyo's API.",
     "keywords": [
         "openapitools",

composer.json

@@ -2165,14 +2165,18 @@ public function getFormsRequest($fields_form = null, $filter = null, $page_curso
      * Get Version IDs for Form
      *
      * @param  string $id The ID of the form (required)
+     * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`form_type`: `any`, `equals`<br>`status`: `equals`<br>`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`<br>`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` (optional)
+     * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination (optional)
+     * @param  int $page_size Default: 20. Min: 1. Max: 100. (optional, default to 20)
+     * @param  string $sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting (optional)
      *
      * @throws \KlaviyoAPI\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array<string,mixed>|\KlaviyoAPI\Model\GetAccounts400Response|\KlaviyoAPI\Model\GetAccounts400Response
      */
-    public function getVersionIdsForForm($id, $apiKey = null)
+    public function getVersionIdsForForm($id, $filter = null, $page_cursor = null, $page_size = 20, $sort = null, $apiKey = null)
     {
-        list($response) = $this->getVersionIdsForFormWithHttpInfo($id, $apiKey);
+        list($response) = $this->getVersionIdsForFormWithHttpInfo($id, $filter, $page_cursor, $page_size, $sort, $apiKey);
         return $response;
     }
 
@@ -2185,20 +2189,33 @@ public function getFormRelationshipsFormVersions(...$args) {
         return $this->getVersionIdsForForm(...$args);
     }
 
+    /**
+     * Alias of `getVersionIdsForForm`
+     *
+     * @deprecated use `getVersionIdsForForm` instead
+     */
+    public function getFormRelationshipsVersions(...$args) {
+        return $this->getVersionIdsForForm(...$args);
+    }
+
     /**
      * Operation getVersionIdsForFormWithHttpInfo
      *
      * Get Version IDs for Form
      *
      * @param  string $id The ID of the form (required)
+     * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; (optional)
+     * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination (optional)
+     * @param  int $page_size Default: 20. Min: 1. Max: 100. (optional, default to 20)
+     * @param  string $sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting (optional)
      *
      * @throws \KlaviyoAPI\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array of array<string,mixed>|\KlaviyoAPI\Model\GetAccounts400Response|\KlaviyoAPI\Model\GetAccounts400Response, HTTP status code, HTTP response headers (array of strings)
      */
-    public function getVersionIdsForFormWithHttpInfo($id, $apiKey = null)
+    public function getVersionIdsForFormWithHttpInfo($id, $filter = null, $page_cursor = null, $page_size = 20, $sort = null, $apiKey = null)
     {
-        $request = $this->getVersionIdsForFormRequest($id, $apiKey);
+        $request = $this->getVersionIdsForFormRequest($id, $filter, $page_cursor, $page_size, $sort, $apiKey);
 
         try {
             $options = $this->createHttpClientOption();
@@ -2362,19 +2379,32 @@ public function getFormRelationshipsFormVersionsWithHttpInfo(...$args) {
         return $this->getVersionIdsForFormWithHttpInfo(...$args);
     }
 
+    /**
+     * Alias of `getVersionIdsForFormWithHttpInfo`
+     *
+     * @deprecated use `getVersionIdsForFormWithHttpInfo` instead
+     */
+    public function getFormRelationshipsVersionsWithHttpInfo(...$args) {
+        return $this->getVersionIdsForFormWithHttpInfo(...$args);
+    }
+
     /**
      * Operation getVersionIdsForFormAsync
      *
      * Get Version IDs for Form
      *
      * @param  string $id The ID of the form (required)
+     * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; (optional)
+     * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination (optional)
+     * @param  int $page_size Default: 20. Min: 1. Max: 100. (optional, default to 20)
+     * @param  string $sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function getVersionIdsForFormAsync($id, $apiKey = null)
+    public function getVersionIdsForFormAsync($id, $filter = null, $page_cursor = null, $page_size = 20, $sort = null, $apiKey = null)
     {
-        return $this->getVersionIdsForFormAsyncWithHttpInfo($id, $apiKey)
+        return $this->getVersionIdsForFormAsyncWithHttpInfo($id, $filter, $page_cursor, $page_size, $sort, $apiKey)
             ->then(
                 function ($response) {
                     return $response[0];
@@ -2391,20 +2421,33 @@ public function getFormRelationshipsFormVersionsAsync(...$args) {
         return $this->getVersionIdsForFormAsync(...$args);
     }
 
+    /**
+     * Alias of `getVersionIdsForFormAsync`
+     *
+     * @deprecated use `getVersionIdsForFormAsync` instead
+     */
+    public function getFormRelationshipsVersionsAsync(...$args) {
+        return $this->getVersionIdsForFormAsync(...$args);
+    }
+
     /**
      * Operation getVersionIdsForFormAsyncWithHttpInfo
      *
      * Get Version IDs for Form
      *
      * @param  string $id The ID of the form (required)
+     * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; (optional)
+     * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination (optional)
+     * @param  int $page_size Default: 20. Min: 1. Max: 100. (optional, default to 20)
+     * @param  string $sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function getVersionIdsForFormAsyncWithHttpInfo($id, $apiKey = null)
+    public function getVersionIdsForFormAsyncWithHttpInfo($id, $filter = null, $page_cursor = null, $page_size = 20, $sort = null, $apiKey = null)
     {
         $returnType = 'array<string,mixed>';
-        $request = $this->getVersionIdsForFormRequest($id, $apiKey);
+        $request = $this->getVersionIdsForFormRequest($id, $filter, $page_cursor, $page_size, $sort, $apiKey);
 
         return $this->client
             ->sendAsync($request, $this->createHttpClientOption())
@@ -2456,22 +2499,42 @@ public function getFormRelationshipsFormVersionsAsyncWithHttpInfo(...$args) {
         return $this->getVersionIdsForFormAsyncWithHttpInfo(...$args);
     }
 
+    /**
+     * Alias of `getVersionIdsForFormAsyncWithHttpInfo`
+     *
+     * @deprecated use `getVersionIdsForFormAsyncWithHttpInfo` instead
+     */
+    public function getFormRelationshipsVersionsAsyncWithHttpInfo(...$args) {
+        return $this->getVersionIdsForFormAsyncWithHttpInfo(...$args);
+    }
+
     /**
      * Create request for operation 'getVersionIdsForForm'
      *
      * @param  string $id The ID of the form (required)
+     * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;form_type&#x60;: &#x60;any&#x60;, &#x60;equals&#x60;&lt;br&gt;&#x60;status&#x60;: &#x60;equals&#x60;&lt;br&gt;&#x60;updated_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60;&lt;br&gt;&#x60;created_at&#x60;: &#x60;greater-or-equal&#x60;, &#x60;greater-than&#x60;, &#x60;less-or-equal&#x60;, &#x60;less-than&#x60; (optional)
+     * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#pagination (optional)
+     * @param  int $page_size Default: 20. Min: 1. Max: 100. (optional, default to 20)
+     * @param  string $sort For more information please visit https://developers.klaviyo.com/en/v2024-10-15/reference/api-overview#sorting (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Psr7\Request
      */
-    public function getVersionIdsForFormRequest($id, $apiKey = null)
+    public function getVersionIdsForFormRequest($id, $filter = null, $page_cursor = null, $page_size = 20, $sort = null, $apiKey = null)
     {
         // verify the required parameter 'id' is set
         if ($id === null || (is_array($id) && count($id) === 0)) {
             throw new \InvalidArgumentException(
                 'Missing the required parameter $id when calling getVersionIdsForForm'
             );
         }
+        if ($page_size !== null && $page_size > 100) {
+            throw new \InvalidArgumentException('invalid value for "$page_size" when calling FormsApi.getVersionIdsForForm, must be smaller than or equal to 100.');
+        }
+        if ($page_size !== null && $page_size < 1) {
+            throw new \InvalidArgumentException('invalid value for "$page_size" when calling FormsApi.getVersionIdsForForm, must be bigger than or equal to 1.');
+        }
+
 
         $resourcePath = '/api/forms/{id}/relationships/form-versions';
         $formParams = [];
@@ -2480,6 +2543,42 @@ public function getVersionIdsForFormRequest($id, $apiKey = null)
         $httpBody = '';
         $multipart = false;
 
+        // query params
+        $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
+            $filter,
+            'filter', // param base name
+            'string', // openApiType
+            'form', // style
+            true, // explode
+            false // required
+        ) ?? []);
+        // query params
+        $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
+            $page_cursor,
+            'page[cursor]', // param base name
+            'string', // openApiType
+            'form', // style
+            true, // explode
+            false // required
+        ) ?? []);
+        // query params
+        $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
+            $page_size,
+            'page[size]', // param base name
+            'integer', // openApiType
+            'form', // style
+            true, // explode
+            false // required
+        ) ?? []);
+        // query params
+        $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
+            $sort,
+            'sort', // param base name
+            'string', // openApiType
+            'form', // style
+            true, // explode
+            false // required
+        ) ?? []);
 
 
         // path params
@@ -2569,6 +2668,15 @@ public function getFormRelationshipsFormVersionsRequest(...$args) {
         return $this->getVersionIdsForFormRequest(...$args);
     }
 
+    /**
+     * Alias of `getVersionIdsForFormRequest`
+     *
+     * @deprecated use `getVersionIdsForFormRequest` instead
+     */
+    public function getFormRelationshipsVersionsRequest(...$args) {
+        return $this->getVersionIdsForFormRequest(...$args);
+    }
+
     /**
      * Operation getVersionsForForm
      *
@@ -2600,6 +2708,15 @@ public function getFormFormVersions(...$args) {
         return $this->getVersionsForForm(...$args);
     }
 
+    /**
+     * Alias of `getVersionsForForm`
+     *
+     * @deprecated use `getVersionsForForm` instead
+     */
+    public function getFormVersions(...$args) {
+        return $this->getVersionsForForm(...$args);
+    }
+
     /**
      * Operation getVersionsForFormWithHttpInfo
      *
@@ -2782,6 +2899,15 @@ public function getFormFormVersionsWithHttpInfo(...$args) {
         return $this->getVersionsForFormWithHttpInfo(...$args);
     }
 
+    /**
+     * Alias of `getVersionsForFormWithHttpInfo`
+     *
+     * @deprecated use `getVersionsForFormWithHttpInfo` instead
+     */
+    public function getFormVersionsWithHttpInfo(...$args) {
+        return $this->getVersionsForFormWithHttpInfo(...$args);
+    }
+
     /**
      * Operation getVersionsForFormAsync
      *
@@ -2816,6 +2942,15 @@ public function getFormFormVersionsAsync(...$args) {
         return $this->getVersionsForFormAsync(...$args);
     }
 
+    /**
+     * Alias of `getVersionsForFormAsync`
+     *
+     * @deprecated use `getVersionsForFormAsync` instead
+     */
+    public function getFormVersionsAsync(...$args) {
+        return $this->getVersionsForFormAsync(...$args);
+    }
+
     /**
      * Operation getVersionsForFormAsyncWithHttpInfo
      *
@@ -2886,6 +3021,15 @@ public function getFormFormVersionsAsyncWithHttpInfo(...$args) {
         return $this->getVersionsForFormAsyncWithHttpInfo(...$args);
     }
 
+    /**
+     * Alias of `getVersionsForFormAsyncWithHttpInfo`
+     *
+     * @deprecated use `getVersionsForFormAsyncWithHttpInfo` instead
+     */
+    public function getFormVersionsAsyncWithHttpInfo(...$args) {
+        return $this->getVersionsForFormAsyncWithHttpInfo(...$args);
+    }
+
     /**
      * Create request for operation 'getVersionsForForm'
      *
@@ -3056,6 +3200,15 @@ public function getFormFormVersionsRequest(...$args) {
         return $this->getVersionsForFormRequest(...$args);
     }
 
+    /**
+     * Alias of `getVersionsForFormRequest`
+     *
+     * @deprecated use `getVersionsForFormRequest` instead
+     */
+    public function getFormVersionsRequest(...$args) {
+        return $this->getVersionsForFormRequest(...$args);
+    }
+
     /**
      * Create http client option
      *