Merge pull request #50 from getbrevo/feature_ACC-4880_1

ACC-4880: Update getAttribute API + add multiCategoryOptions
getbrevo · Jan 16, 2025 · f4741ee · f4741ee
2 parents ab71297 + 8dbbb9c
commit f4741ee
Show file tree

Hide file tree

Showing 9 changed files with 94 additions and 15 deletions.
diff --git a/docs/Model/CreateAttribute.md b/docs/Model/CreateAttribute.md
@@ -6,7 +6,8 @@ Name | Type | Description | Notes
 **value** | **string** | Value of the attribute. Use only if the attribute&#39;s category is &#39;calculated&#39; or &#39;global&#39; | [optional] 
 **isRecurring** | **bool** | Type of the attribute. Use only if the attribute&#39;s category is &#39;calculated&#39; or &#39;global&#39; | [optional] 
 **enumeration** | [**\Brevo\Client\Model\CreateAttributeEnumeration[]**](CreateAttributeEnumeration.md) | List of values and labels that the attribute can take. Use only if the attribute&#39;s category is \&quot;category\&quot;. For example, [{\&quot;value\&quot;:1, \&quot;label\&quot;:\&quot;male\&quot;}, {\&quot;value\&quot;:2, \&quot;label\&quot;:\&quot;female\&quot;}] | [optional] 
-**type** | **string** | Type of the attribute. Use only if the attribute&#39;s category is &#39;normal&#39;, &#39;category&#39; or &#39;transactional&#39; ( type &#39;boolean&#39; is only available if the category is &#39;normal&#39; attribute, type &#39;id&#39; is only available if the category is &#39;transactional&#39; attribute &amp; type &#39;category&#39; is only available if the category is &#39;category&#39; attribute ) | [optional] 
+**multiCategoryOptions** | **string[]** | List of options you want to add for multiple-choice attribute. **Use only if the attribute&#39;s category is \&quot;normal\&quot; and attribute&#39;s type is \&quot;multiple-choice\&quot;.** For example: **[\&quot;USA\&quot;,\&quot;INDIA\&quot;]** | [optional] 
+**type** | **string** | Type of the attribute. Use only if the attribute&#39;s category is &#39;normal&#39;, &#39;category&#39; or &#39;transactional&#39; ( type &#39;boolean&#39; and &#39;multiple-choice&#39; is only available if the category is &#39;normal&#39; attribute, type &#39;id&#39; is only available if the category is &#39;transactional&#39; attribute &amp; type &#39;category&#39; is only available if the category is &#39;category&#39; attribute ) | [optional] 
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

diff --git a/docs/Model/UpdateAttribute.md b/docs/Model/UpdateAttribute.md
@@ -4,7 +4,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **string** | Value of the attribute to update. Use only if the attribute&#39;s category is &#39;calculated&#39; or &#39;global&#39; | [optional] 
-**enumeration** | [**\Brevo\Client\Model\UpdateAttributeEnumeration[]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute&#39;s category is \"category\". For example, &#x60;[{\"value\":1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]&#x60; | [optional] 
+**enumeration** | [**\Brevo\Client\Model\UpdateAttributeEnumeration[]**](UpdateAttributeEnumeration.md) | List of the values and labels that the attribute can take. Use only if the attribute&#39;s category is \&quot;category\&quot;. For example, [{\&quot;value\&quot;:1, \&quot;label\&quot;:\&quot;male\&quot;}, {\&quot;value\&quot;:2, \&quot;label\&quot;:\&quot;female\&quot;}] | [optional] 
+**multiCategoryOptions** | **string[]** | Use this option to add multiple-choice attributes options only if the attribute&#39;s category is \&quot;normal\&quot;. **This option is specifically designed for updating multiple-choice attributes**. For example: **[\&quot;USA\&quot;,\&quot;INDIA\&quot;]** | [optional] 
+
 
 [[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
 

diff --git a/lib/Model/CreateAttribute.php b/lib/Model/CreateAttribute.php
@@ -13,7 +13,7 @@
 /**
  * Brevo API
  *
- * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity |
  *
  * OpenAPI spec version: 3.0.0
  * Contact: [email protected]
@@ -60,6 +60,7 @@ class CreateAttribute implements ModelInterface, ArrayAccess
         'value' => 'string',
         'isRecurring' => 'bool',
         'enumeration' => '\Brevo\Client\Model\CreateAttributeEnumeration[]',
+        'multiCategoryOptions' => 'string[]',
         'type' => 'string'
     ];
 
@@ -72,6 +73,7 @@ class CreateAttribute implements ModelInterface, ArrayAccess
         'value' => null,
         'isRecurring' => null,
         'enumeration' => null,
+        'multiCategoryOptions' => null,
         'type' => null
     ];
 
@@ -105,6 +107,7 @@ public static function swaggerFormats()
         'value' => 'value',
         'isRecurring' => 'isRecurring',
         'enumeration' => 'enumeration',
+        'multiCategoryOptions' => 'multiCategoryOptions',
         'type' => 'type'
     ];
 
@@ -117,6 +120,7 @@ public static function swaggerFormats()
         'value' => 'setValue',
         'isRecurring' => 'setIsRecurring',
         'enumeration' => 'setEnumeration',
+        'multiCategoryOptions' => 'setMultiCategoryOptions',
         'type' => 'setType'
     ];
 
@@ -129,6 +133,7 @@ public static function swaggerFormats()
         'value' => 'getValue',
         'isRecurring' => 'getIsRecurring',
         'enumeration' => 'getEnumeration',
+        'multiCategoryOptions' => 'getMultiCategoryOptions',
         'type' => 'getType'
     ];
 
@@ -179,6 +184,7 @@ public function getModelName()
     const TYPE_BOOLEAN = 'boolean';
     const TYPE_ID = 'id';
     const TYPE_CATEGORY = 'category';
+    const TYPE_MULTIPLE_CHOICE = 'multiple-choice';
 
 
 
@@ -196,6 +202,7 @@ public function getTypeAllowableValues()
             self::TYPE_BOOLEAN,
             self::TYPE_ID,
             self::TYPE_CATEGORY,
+            self::TYPE_MULTIPLE_CHOICE,
         ];
     }
 
@@ -218,6 +225,7 @@ public function __construct(array $data = null)
         $this->container['value'] = isset($data['value']) ? $data['value'] : null;
         $this->container['isRecurring'] = isset($data['isRecurring']) ? $data['isRecurring'] : null;
         $this->container['enumeration'] = isset($data['enumeration']) ? $data['enumeration'] : null;
+        $this->container['multiCategoryOptions'] = isset($data['multiCategoryOptions']) ? $data['multiCategoryOptions'] : null;
         $this->container['type'] = isset($data['type']) ? $data['type'] : null;
     }
 
@@ -325,6 +333,30 @@ public function setEnumeration($enumeration)
         return $this;
     }
 
+    /**
+     * Gets multiCategoryOptions
+     *
+     * @return string[]
+     */
+    public function getMultiCategoryOptions()
+    {
+        return $this->container['multiCategoryOptions'];
+    }
+
+    /**
+     * Sets multiCategoryOptions
+     *
+     * @param string[] $multiCategoryOptions List of options you want to add for multiple-choice attribute. **Use only if the attribute's category is \"normal\" and attribute's type is \"multiple-choice\".** For example: **[\"USA\",\"INDIA\"]**
+     *
+     * @return $this
+     */
+    public function setMultiCategoryOptions($multiCategoryOptions)
+    {
+        $this->container['multiCategoryOptions'] = $multiCategoryOptions;
+
+        return $this;
+    }
+
     /**
      * Gets type
      *
@@ -338,7 +370,7 @@ public function getType()
     /**
      * Sets type
      *
-     * @param string $type Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
+     * @param string $type Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' and 'multiple-choice' is only available if the category is 'normal' attribute, type 'id' is only available if the category is 'transactional' attribute & type 'category' is only available if the category is 'category' attribute )
      *
      * @return $this
      */

diff --git a/lib/Model/GetAttributes.php b/lib/Model/GetAttributes.php
@@ -13,7 +13,7 @@
 /**
  * Brevo API
  *
- * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity |
  *
  * OpenAPI spec version: 3.0.0
  * Contact: [email protected]

diff --git a/lib/Model/GetAttributesAttributes.php b/lib/Model/GetAttributesAttributes.php
@@ -13,7 +13,7 @@
 /**
  * Brevo API
  *
- * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity |
  *
  * OpenAPI spec version: 3.0.0
  * Contact: [email protected]

diff --git a/lib/Model/GetAttributesEnumeration.php b/lib/Model/GetAttributesEnumeration.php
@@ -13,7 +13,7 @@
 /**
  * Brevo API
  *
- * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity |
  *
  * OpenAPI spec version: 3.0.0
  * Contact: [email protected]

diff --git a/lib/Model/UpdateAttribute.php b/lib/Model/UpdateAttribute.php
@@ -13,7 +13,7 @@
 /**
  * Brevo API
  *
- * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |
+ * Brevo provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/brevo  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  |   | 422  | Error. Unprocessable Entity |
  *
  * OpenAPI spec version: 3.0.0
  * Contact: [email protected]
@@ -58,7 +58,8 @@ class UpdateAttribute implements ModelInterface, ArrayAccess
       */
     protected static $swaggerTypes = [
         'value' => 'string',
-        'enumeration' => '\Brevo\Client\Model\UpdateAttributeEnumeration[]'
+        'enumeration' => '\Brevo\Client\Model\UpdateAttributeEnumeration[]',
+        'multiCategoryOptions' => 'string[]'
     ];
 
     /**
@@ -68,7 +69,8 @@ class UpdateAttribute implements ModelInterface, ArrayAccess
       */
     protected static $swaggerFormats = [
         'value' => null,
-        'enumeration' => null
+        'enumeration' => null,
+        'multiCategoryOptions' => null
     ];
 
     /**
@@ -99,7 +101,8 @@ public static function swaggerFormats()
      */
     protected static $attributeMap = [
         'value' => 'value',
-        'enumeration' => 'enumeration'
+        'enumeration' => 'enumeration',
+        'multiCategoryOptions' => 'multiCategoryOptions'
     ];
 
     /**
@@ -109,7 +112,8 @@ public static function swaggerFormats()
      */
     protected static $setters = [
         'value' => 'setValue',
-        'enumeration' => 'setEnumeration'
+        'enumeration' => 'setEnumeration',
+        'multiCategoryOptions' => 'setMultiCategoryOptions'
     ];
 
     /**
@@ -119,7 +123,8 @@ public static function swaggerFormats()
      */
     protected static $getters = [
         'value' => 'getValue',
-        'enumeration' => 'getEnumeration'
+        'enumeration' => 'getEnumeration',
+        'multiCategoryOptions' => 'getMultiCategoryOptions'
     ];
 
     /**
@@ -184,6 +189,7 @@ public function __construct(array $data = null)
     {
         $this->container['value'] = isset($data['value']) ? $data['value'] : null;
         $this->container['enumeration'] = isset($data['enumeration']) ? $data['enumeration'] : null;
+        $this->container['multiCategoryOptions'] = isset($data['multiCategoryOptions']) ? $data['multiCategoryOptions'] : null;
     }
 
     /**
@@ -257,6 +263,30 @@ public function setEnumeration($enumeration)
 
         return $this;
     }
+
+    /**
+     * Gets multiCategoryOptions
+     *
+     * @return string[]
+     */
+    public function getMultiCategoryOptions()
+    {
+        return $this->container['multiCategoryOptions'];
+    }
+
+    /**
+     * Sets multiCategoryOptions
+     *
+     * @param string[] $multiCategoryOptions Use this option to add multiple-choice attributes options only if the attribute's category is \"normal\". **This option is specifically designed for updating multiple-choice attributes**. For example: **[\"USA\",\"INDIA\"]**
+     *
+     * @return $this
+     */
+    public function setMultiCategoryOptions($multiCategoryOptions)
+    {
+        $this->container['multiCategoryOptions'] = $multiCategoryOptions;
+
+        return $this;
+    }
     /**
      * Returns true if offset exists. False otherwise.
      *