v12.0.1 (#67)

* version 12.0.1

* Update CHANGELOG.md

---------

Co-authored-by: klaviyo-sdk <[email protected]>
Co-authored-by: Ben Horgan <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -7,6 +7,10 @@ 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.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
+
 ## [12.0.0] - revision 2024-10-15
 ### Changed
   - **Breaking:** Improved Retry Logic

README.md

@@ -1,6 +1,6 @@
 # Klaviyo PHP SDK
 
-- SDK version: 12.0.0
+- SDK version: 12.0.1
 - API Revision: 2024-10-15
 
 ## Helpful Resources
@@ -203,22 +203,19 @@ $klaviyo->Tags->getTagRelationshipsCampaigns('f4bc6670-1aa5-47df-827a-d30a7e5430
 
 #### Uploading Image From File
 
-When using `Images.uploadImageFromFile(file, name=name)`, `file`` can be either a file path string OR a bytearray.
-
-NOTE: when file is a bytearray, you will need to use the optional `name` parameter to specify the file name, else name will default to `unnamed_image_from_python_sdk`
+When using `$klaviyo->Images->uploadImageFromFile($file, $name)`, `$file` can be either a file path string OR a `SplFileObject`.
 
 *as a file path*
-```python
-filepath = '/path/to/image.png'
-klaviyo.Images.upload_image_from_file(file, name=name)
+```php
+$filepath = '/path/to/image.png';
+$klaviyo->Images->uploadImageFromFile($filepath);
 ```
 
-*as a bytearray*
-```python
-filepath = '/path/to/image.png'
-with open(filepath, 'rb') as f:
-    file = f.read()
-klaviyo.Images.upload_image_from_file(file, name=name)
+*as a `SplFileObject`*
+```php
+$filepath = '/path/to/image.png';
+$file = new SplFileObject($filepath);
+$klaviyo->Images->uploadImageFromFile($file);
 ```
 
 

composer.json

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

lib/Configuration.php

@@ -101,7 +101,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'klaviyo-api-php/12.0.0';
+    protected $userAgent = 'klaviyo-api-php/12.0.1';
 
     /**
      * Debug switch (default set to false)
@@ -434,7 +434,7 @@ public static function toDebugReport()
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
         $report .= '    The version of the OpenAPI document: 2024-10-15' . PHP_EOL;
-        $report .= '    SDK Package Version: 12.0.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 12.0.1' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;

lib/Model/FormSeriesRequestDTOResourceObjectAttributes.php

@@ -514,7 +514,7 @@ public function getGroupBy()
     /**
      * Sets group_by
      *
-     * @param string[]|null $group_by List of attributes to group the data by. Allowed group-bys are form_version_id, form_id. If not passed in, the data will be grouped by form_id. If a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id
+     * @param string[]|null $group_by List of attributes to group the data by. Allowed group-bys are form_id, form_version_id. If not passed in, the data will be grouped by form_id. If a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id
      *
      * @return self
      */
@@ -559,7 +559,7 @@ public function getFilter()
     /**
      * Sets filter
      *
-     * @param string|null $filter API filter string used to filter the query. Allowed filters are form_version_id, form_id. Allowed operators are equals, any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter.
+     * @param string|null $filter API filter string used to filter the query. Allowed filters are form_id, form_version_id. Allowed operators are equals, any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter.
      *
      * @return self
      */

lib/Model/FormValuesRequestDTOResourceObjectAttributes.php

@@ -437,7 +437,7 @@ public function getGroupBy()
     /**
      * Sets group_by
      *
-     * @param string[]|null $group_by List of attributes to group the data by. Allowed group-bys are form_version_id, form_id. If not passed in, the data will be grouped by form_id. If a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id
+     * @param string[]|null $group_by List of attributes to group the data by. Allowed group-bys are form_id, form_version_id. If not passed in, the data will be grouped by form_id. If a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id
      *
      * @return self
      */
@@ -482,7 +482,7 @@ public function getFilter()
     /**
      * Sets filter
      *
-     * @param string|null $filter API filter string used to filter the query. Allowed filters are form_version_id, form_id. Allowed operators are equals, any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter.
+     * @param string|null $filter API filter string used to filter the query. Allowed filters are form_id, form_version_id. Allowed operators are equals, any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter.
      *
      * @return self
      */