Merge pull request #11 from klaviyo/20230301-weekly

adding page_size support

Author: jon-batscha

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
 
+## 2.0.0
+
+### Added
+- `page_size`:  you can now set page_size when paging through endpoints that return profiles
+
 ## 1.2.1
 
 ### Bug Fixes

README.md

@@ -1,6 +1,6 @@
 # Klaviyo PHP SDK
 
-- SDK version: 1.2.1
+- SDK version: 2.0.0
 - API Revision: 2023-02-22
 
 ## Helpful Resources
@@ -172,7 +172,7 @@ $klaviyo->Campaigns->createCampaignClone($body);
 
 
 
-#### [Create Campaign Message Assign Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
+#### [Assign Campaign Message Template](https://developers.klaviyo.com/en/v2023-02-22/reference/create_campaign_message_assign_template)
 
 ```python
 ## Positional Arguments
@@ -1738,8 +1738,9 @@ $klaviyo->Lists->getList($id, $fields_list=$fields_list);
 # $fields_profile | string[]
 # $filter | string
 # $page_cursor | string
+# $page_size | int
 
-$klaviyo->Lists->getListProfiles($list_id, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor);
+$klaviyo->Lists->getListProfiles($list_id, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size);
 ```
 
 
@@ -1955,8 +1956,9 @@ $klaviyo->Profiles->getProfileSegments($profile_id, $fields_segment=$fields_segm
 # $filter | string
 # $page_cursor | string
 # $sort | string
+# $page_size | int
 
-$klaviyo->Profiles->getProfiles($fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort);
+$klaviyo->Profiles->getProfiles($fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $sort=$sort, $page_size=$page_size);
 ```
 
 
@@ -2061,8 +2063,9 @@ $klaviyo->Segments->getSegment($id, $fields_segment=$fields_segment);
 # $fields_profile | string[]
 # $filter | string
 # $page_cursor | string
+# $page_size | int
 
-$klaviyo->Segments->getSegmentProfiles($segment_id, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor);
+$klaviyo->Segments->getSegmentProfiles($segment_id, $fields_profile=$fields_profile, $filter=$filter, $page_cursor=$page_cursor, $page_size=$page_size);
 ```
 
 

composer.json

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

lib/API/CampaignsApi.php

@@ -845,7 +845,7 @@ public function createCampaignCloneRequest($campaign_clone_query, $apiKey = null
     /**
      * Operation createCampaignMessageAssignTemplate
      *
-     * Create Campaign Message Assign Template
+     * Assign Campaign Message Template
      *
      * @param  \KlaviyoAPI\Model\CampaignMessageAssignTemplateQuery $campaign_message_assign_template_query Takes a reusable template, clones it, and assigns the non-reusable clone to the message. (required)
      *
@@ -862,7 +862,7 @@ public function createCampaignMessageAssignTemplate($campaign_message_assign_tem
     /**
      * Operation createCampaignMessageAssignTemplateWithHttpInfo
      *
-     * Create Campaign Message Assign Template
+     * Assign Campaign Message Template
      *
      * @param  \KlaviyoAPI\Model\CampaignMessageAssignTemplateQuery $campaign_message_assign_template_query Takes a reusable template, clones it, and assigns the non-reusable clone to the message. (required)
      *
@@ -1030,7 +1030,7 @@ public function createCampaignMessageAssignTemplateWithHttpInfo($campaign_messag
     /**
      * Operation createCampaignMessageAssignTemplateAsync
      *
-     * Create Campaign Message Assign Template
+     * Assign Campaign Message Template
      *
      * @param  \KlaviyoAPI\Model\CampaignMessageAssignTemplateQuery $campaign_message_assign_template_query Takes a reusable template, clones it, and assigns the non-reusable clone to the message. (required)
      *
@@ -1050,7 +1050,7 @@ function ($response) {
     /**
      * Operation createCampaignMessageAssignTemplateAsyncWithHttpInfo
      *
-     * Create Campaign Message Assign Template
+     * Assign Campaign Message Template
      *
      * @param  \KlaviyoAPI\Model\CampaignMessageAssignTemplateQuery $campaign_message_assign_template_query Takes a reusable template, clones it, and assigns the non-reusable clone to the message. (required)
      *

lib/API/CatalogsApi.php

@@ -4959,7 +4959,7 @@ public function getFlowsRequest($fields_flow_action = null, $fields_flow = null,
      *
      * Update Flow Status
      *
-     * @param  string $id  (required)
+     * @param  string $id ID of the Flow to update. Ex: XVTP5Q (required)
      * @param  \KlaviyoAPI\Model\FlowUpdateQuery $flow_update_query flow_update_query (required)
      *
      * @throws \KlaviyoAPI\ApiException on non-2xx response
@@ -4977,7 +4977,7 @@ public function updateFlow($id, $flow_update_query, $apiKey = null)
      *
      * Update Flow Status
      *
-     * @param  string $id  (required)
+     * @param  string $id ID of the Flow to update. Ex: XVTP5Q (required)
      * @param  \KlaviyoAPI\Model\FlowUpdateQuery $flow_update_query (required)
      *
      * @throws \KlaviyoAPI\ApiException on non-2xx response
@@ -5146,7 +5146,7 @@ public function updateFlowWithHttpInfo($id, $flow_update_query, $apiKey = null)
      *
      * Update Flow Status
      *
-     * @param  string $id  (required)
+     * @param  string $id ID of the Flow to update. Ex: XVTP5Q (required)
      * @param  \KlaviyoAPI\Model\FlowUpdateQuery $flow_update_query (required)
      *
      * @throws \InvalidArgumentException
@@ -5167,7 +5167,7 @@ function ($response) {
      *
      * Update Flow Status
      *
-     * @param  string $id  (required)
+     * @param  string $id ID of the Flow to update. Ex: XVTP5Q (required)
      * @param  \KlaviyoAPI\Model\FlowUpdateQuery $flow_update_query (required)
      *
      * @throws \InvalidArgumentException
@@ -5222,7 +5222,7 @@ function ($exception) {
     /**
      * Create request for operation 'updateFlow'
      *
-     * @param  string $id  (required)
+     * @param  string $id ID of the Flow to update. Ex: XVTP5Q (required)
      * @param  \KlaviyoAPI\Model\FlowUpdateQuery $flow_update_query (required)
      *
      * @throws \InvalidArgumentException

lib/API/FlowsApi.php

@@ -1698,14 +1698,15 @@ public function getListRequest($id, $fields_list = null, $apiKey = null)
      * @param  string[] $fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets (optional)
      * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering<br>Allowed field(s)/operator(s):<br>`email`: `any`<br>`phone_number`: `any`<br>`push_token`: `any`<br>`_kx`: `equals` (optional)
      * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination (optional)
+     * @param  int $page_size page_size (optional)
      *
      * @throws \KlaviyoAPI\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array<string,mixed>|\KlaviyoAPI\Model\GetCampaigns400Response|\KlaviyoAPI\Model\GetCampaigns400Response
      */
-    public function getListProfiles($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $apiKey = null)
+    public function getListProfiles($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $page_size = null, $apiKey = null)
     {
-        list($response) = $this->getListProfilesWithHttpInfo($list_id, $fields_profile, $filter, $page_cursor, $apiKey);
+        list($response) = $this->getListProfilesWithHttpInfo($list_id, $fields_profile, $filter, $page_cursor, $page_size, $apiKey);
         return $response;
     }
 
@@ -1718,14 +1719,15 @@ public function getListProfiles($list_id, $fields_profile = null, $filter = null
      * @param  string[] $fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets (optional)
      * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; (optional)
      * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination (optional)
+     * @param  int $page_size (optional)
      *
      * @throws \KlaviyoAPI\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array of array<string,mixed>|\KlaviyoAPI\Model\GetCampaigns400Response|\KlaviyoAPI\Model\GetCampaigns400Response, HTTP status code, HTTP response headers (array of strings)
      */
-    public function getListProfilesWithHttpInfo($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $apiKey = null)
+    public function getListProfilesWithHttpInfo($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $page_size = null, $apiKey = null)
     {
-        $request = $this->getListProfilesRequest($list_id, $fields_profile, $filter, $page_cursor, $apiKey);
+        $request = $this->getListProfilesRequest($list_id, $fields_profile, $filter, $page_cursor, $page_size, $apiKey);
 
         try {
             $options = $this->createHttpClientOption();
@@ -1889,13 +1891,14 @@ public function getListProfilesWithHttpInfo($list_id, $fields_profile = null, $f
      * @param  string[] $fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets (optional)
      * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; (optional)
      * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination (optional)
+     * @param  int $page_size (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function getListProfilesAsync($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $apiKey = null)
+    public function getListProfilesAsync($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $page_size = null, $apiKey = null)
     {
-        return $this->getListProfilesAsyncWithHttpInfo($list_id, $fields_profile, $filter, $page_cursor, $apiKey)
+        return $this->getListProfilesAsyncWithHttpInfo($list_id, $fields_profile, $filter, $page_cursor, $page_size, $apiKey)
             ->then(
                 function ($response) {
                     return $response[0];
@@ -1912,14 +1915,15 @@ function ($response) {
      * @param  string[] $fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets (optional)
      * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; (optional)
      * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination (optional)
+     * @param  int $page_size (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function getListProfilesAsyncWithHttpInfo($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $apiKey = null)
+    public function getListProfilesAsyncWithHttpInfo($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $page_size = null, $apiKey = null)
     {
         $returnType = 'array<string,mixed>';
-        $request = $this->getListProfilesRequest($list_id, $fields_profile, $filter, $page_cursor, $apiKey);
+        $request = $this->getListProfilesRequest($list_id, $fields_profile, $filter, $page_cursor, $page_size, $apiKey);
 
         return $this->client
             ->sendAsync($request, $this->createHttpClientOption())
@@ -1969,11 +1973,12 @@ function ($exception) {
      * @param  string[] $fields_profile For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#sparse-fieldsets (optional)
      * @param  string $filter For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#filtering&lt;br&gt;Allowed field(s)/operator(s):&lt;br&gt;&#x60;email&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;phone_number&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;push_token&#x60;: &#x60;any&#x60;&lt;br&gt;&#x60;_kx&#x60;: &#x60;equals&#x60; (optional)
      * @param  string $page_cursor For more information please visit https://developers.klaviyo.com/en/v2023-02-22/reference/api-overview#pagination (optional)
+     * @param  int $page_size (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Psr7\Request
      */
-    public function getListProfilesRequest($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $apiKey = null)
+    public function getListProfilesRequest($list_id, $fields_profile = null, $filter = null, $page_cursor = null, $page_size = null, $apiKey = null)
     {
         // verify the required parameter 'list_id' is set
         if ($list_id === null || (is_array($list_id) && count($list_id) === 0)) {
@@ -2016,6 +2021,15 @@ public function getListProfilesRequest($list_id, $fields_profile = null, $filter
             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
+        ) ?? []);
 
 
         // path params