sib-api-v3-sdk 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6fad8d5c02a96c35f9a292c4b81e95fd0d33f17
-  data.tar.gz: 0170907c035f45e4ffeab695648df3c30c6c95fa
+  metadata.gz: f40a8a4a33e345f692abd9267b472b9151026497
+  data.tar.gz: 23a4d1d1b59de476a60e88e7b8eaed7da9411f72
 SHA512:
-  metadata.gz: a65eaa8badf6964d911b1c4f0ef3f4114df0347742199fe271ebb057721945ed52b5cf6391c33589ce086b95ff5b4875b35e42c6b5e2d1e2620e60d8e07904ac
-  data.tar.gz: efdc8e77fd3c41923426dc4b008802085c1c44e54c0067e286998c6da866a4ac0aaa6f81303d53ee6243517b1b750ef26327ee257bf938c6c7f378cc030b0519
+  metadata.gz: a22a2d47aa5e4000e121abc2a15f8dee49a93320dd9be1cea747537f8ad41dbe6f8192b5f4653f452b5374a13ff62906caf644d5d58571d62263dd5cfd4f4e2d
+  data.tar.gz: c6a1b864ed343c44e5d7bca0c778978ff9a242b1ae0d4f8bdd2058ae796950e1715a648412f2c521b20c5738931dc4566d29c2fa071c2e4a1ba302eaa7af8845

data/README.md

@@ -80,15 +80,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details
-*SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
-*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
+*SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
+*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
 *SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
+*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 *SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
-*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
+*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
 *SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
 *SibApiV3Sdk::ContactsApi* | [**create_folder**](docs/ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 *SibApiV3Sdk::ContactsApi* | [**create_list**](docs/ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
-*SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
+*SibApiV3Sdk::ContactsApi* | [**delete_attribute**](docs/ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
 *SibApiV3Sdk::ContactsApi* | [**delete_folder**](docs/ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
 *SibApiV3Sdk::ContactsApi* | [**delete_list**](docs/ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
 *SibApiV3Sdk::ContactsApi* | [**get_attributes**](docs/ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
@@ -104,6 +105,7 @@ Class | Method | HTTP request | Description
 *SibApiV3Sdk::ContactsApi* | [**import_contacts**](docs/ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
 *SibApiV3Sdk::ContactsApi* | [**remove_contact_to_list**](docs/ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 *SibApiV3Sdk::ContactsApi* | [**request_contact_export**](docs/ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
+*SibApiV3Sdk::ContactsApi* | [**update_attribute**](docs/ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 *SibApiV3Sdk::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
 *SibApiV3Sdk::ContactsApi* | [**update_folder**](docs/ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
 *SibApiV3Sdk::ContactsApi* | [**update_list**](docs/ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
@@ -187,7 +189,7 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::AddCredits](docs/AddCredits.md)
  - [SibApiV3Sdk::AddRemoveContactToList](docs/AddRemoveContactToList.md)
  - [SibApiV3Sdk::CreateAttribute](docs/CreateAttribute.md)
- - [SibApiV3Sdk::CreateAttributeEnumemaration](docs/CreateAttributeEnumemaration.md)
+ - [SibApiV3Sdk::CreateAttributeEnumeration](docs/CreateAttributeEnumeration.md)
  - [SibApiV3Sdk::CreateChild](docs/CreateChild.md)
  - [SibApiV3Sdk::CreateContact](docs/CreateContact.md)
  - [SibApiV3Sdk::CreateEmailCampaign](docs/CreateEmailCampaign.md)
@@ -310,6 +312,8 @@ Class | Method | HTTP request | Description
  - [SibApiV3Sdk::SendTestEmail](docs/SendTestEmail.md)
  - [SibApiV3Sdk::SendTestSms](docs/SendTestSms.md)
  - [SibApiV3Sdk::SendTransacSms](docs/SendTransacSms.md)
+ - [SibApiV3Sdk::UpdateAttribute](docs/UpdateAttribute.md)
+ - [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
  - [SibApiV3Sdk::UpdateCampaignStatus](docs/UpdateCampaignStatus.md)
  - [SibApiV3Sdk::UpdateChild](docs/UpdateChild.md)
  - [SibApiV3Sdk::UpdateContact](docs/UpdateContact.md)

data/docs/AttributesApi.md

@@ -4,15 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
-[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
+[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
+[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
 [**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
+[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 
 
 # **create_attribute**
-> CreateModel create_attribute(create_attribute)
+> create_attribute(attribute_category, attribute_name, create_attribute)
 
-Creates contact attributes
+Creates contact attribute
 
 ### Example
 ```ruby
@@ -28,13 +29,16 @@ end
 
 api_instance = SibApiV3Sdk::AttributesApi.new
 
+attribute_category = "attribute_category_example" # String | Category of the attribute
+
+attribute_name = "attribute_name_example" # String | Name of the attribute
+
 create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
 
 
 begin
-  #Creates contact attributes
-  result = api_instance.create_attribute(create_attribute)
-  p result
+  #Creates contact attribute
+  api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling AttributesApi->create_attribute: #{e}"
 end
@@ -44,11 +48,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **attribute_category** | **String**| Category of the attribute | 
+ **attribute_name** | **String**| Name of the attribute | 
  **create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute | 
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -62,7 +68,7 @@ Name | Type | Description  | Notes
 
 
 # **delete_attribute**
-> delete_attribute(attribute_id)
+> delete_attribute(attribute_category, attribute_name)
 
 Deletes an attribute
 
@@ -80,12 +86,14 @@ end
 
 api_instance = SibApiV3Sdk::AttributesApi.new
 
-attribute_id = 789 # Integer | id of the attribute
+attribute_category = "attribute_category_example" # String | Category of the attribute
+
+attribute_name = "attribute_name_example" # String | Name of the existing attribute
 
 
 begin
   #Deletes an attribute
-  api_instance.delete_attribute(attribute_id)
+  api_instance.delete_attribute(attribute_category, attribute_name)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling AttributesApi->delete_attribute: #{e}"
 end
@@ -95,7 +103,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **attribute_id** | **Integer**| id of the attribute | 
+ **attribute_category** | **String**| Category of the attribute | 
+ **attribute_name** | **String**| Name of the existing attribute | 
 
 ### Return type
 
@@ -158,3 +167,60 @@ This endpoint does not need any parameter.
 
 
 
+# **update_attribute**
+> update_attribute(attribute_category, attribute_name, update_attribute)
+
+Updates contact attribute
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::AttributesApi.new
+
+attribute_category = "attribute_category_example" # String | Category of the attribute
+
+attribute_name = "attribute_name_example" # String | Name of the existing attribute
+
+update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
+
+
+begin
+  #Updates contact attribute
+  api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling AttributesApi->update_attribute: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **attribute_category** | **String**| Category of the attribute | 
+ **attribute_name** | **String**| Name of the existing attribute | 
+ **update_attribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ContactsApi.md

@@ -5,11 +5,11 @@ All URIs are relative to *https://api.sendinblue.com/v3*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**add_contact_to_list**](ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
-[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
+[**create_attribute**](ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
 [**create_contact**](ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
 [**create_folder**](ContactsApi.md#create_folder) | **POST** /contacts/folders | Create a folder
 [**create_list**](ContactsApi.md#create_list) | **POST** /contacts/lists | Create a list
-[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
+[**delete_attribute**](ContactsApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
 [**delete_folder**](ContactsApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
 [**delete_list**](ContactsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
 [**get_attributes**](ContactsApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
@@ -25,6 +25,7 @@ Method | HTTP request | Description
 [**import_contacts**](ContactsApi.md#import_contacts) | **POST** /contacts/import | Import contacts
 [**remove_contact_to_list**](ContactsApi.md#remove_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/remove | Remove existing contacts from a list
 [**request_contact_export**](ContactsApi.md#request_contact_export) | **POST** /contacts/export | Export contacts
+[**update_attribute**](ContactsApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
 [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{email} | Updates a contact
 [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a contact folder
 [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
@@ -86,9 +87,9 @@ Name | Type | Description  | Notes
 
 
 # **create_attribute**
-> CreateModel create_attribute(create_attribute)
+> create_attribute(attribute_category, attribute_name, create_attribute)
 
-Creates contact attributes
+Creates contact attribute
 
 ### Example
 ```ruby
@@ -104,13 +105,16 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
+attribute_category = "attribute_category_example" # String | Category of the attribute
+
+attribute_name = "attribute_name_example" # String | Name of the attribute
+
 create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values to create an attribute
 
 
 begin
-  #Creates contact attributes
-  result = api_instance.create_attribute(create_attribute)
-  p result
+  #Creates contact attribute
+  api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->create_attribute: #{e}"
 end
@@ -120,11 +124,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
+ **attribute_category** | **String**| Category of the attribute | 
+ **attribute_name** | **String**| Name of the attribute | 
  **create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute | 
 
 ### Return type
 
-[**CreateModel**](CreateModel.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -294,7 +300,7 @@ Name | Type | Description  | Notes
 
 
 # **delete_attribute**
-> delete_attribute(attribute_id)
+> delete_attribute(attribute_category, attribute_name)
 
 Deletes an attribute
 
@@ -312,12 +318,14 @@ end
 
 api_instance = SibApiV3Sdk::ContactsApi.new
 
-attribute_id = 789 # Integer | id of the attribute
+attribute_category = "attribute_category_example" # String | Category of the attribute
+
+attribute_name = "attribute_name_example" # String | Name of the existing attribute
 
 
 begin
   #Deletes an attribute
-  api_instance.delete_attribute(attribute_id)
+  api_instance.delete_attribute(attribute_category, attribute_name)
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->delete_attribute: #{e}"
 end
@@ -327,7 +335,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **attribute_id** | **Integer**| id of the attribute | 
+ **attribute_category** | **String**| Category of the attribute | 
+ **attribute_name** | **String**| Name of the existing attribute | 
 
 ### Return type
 
@@ -1148,6 +1157,63 @@ Name | Type | Description  | Notes
 
 
 
+# **update_attribute**
+> update_attribute(attribute_category, attribute_name, update_attribute)
+
+Updates contact attribute
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::ContactsApi.new
+
+attribute_category = "attribute_category_example" # String | Category of the attribute
+
+attribute_name = "attribute_name_example" # String | Name of the existing attribute
+
+update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values to update an attribute
+
+
+begin
+  #Updates contact attribute
+  api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ContactsApi->update_attribute: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **attribute_category** | **String**| Category of the attribute | 
+ **attribute_name** | **String**| Name of the existing attribute | 
+ **update_attribute** | [**UpdateAttribute**](UpdateAttribute.md)| Values to update an attribute | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_contact**
 > update_contact(email, update_contact)
 

data/docs/CreateAttribute.md

@@ -3,10 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**category** | **String** | Attribute categorisation. | 
-**name** | **String** | Name of the attribute | 
-**value** | **String** | Value of the attribute | 
-**enumemaration** | [**Array<CreateAttributeEnumemaration>**](CreateAttributeEnumemaration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional] 
-**type** | **String** | Type of the attribute | [optional] 
+**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional] 
+**enumeration** | [**Array<CreateAttributeEnumeration>**](CreateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional] 
+**type** | **String** | Type of the attribute. Use only if the attribute's category is normal, category or transactional ( type 'id' only available if the category is 'transactional' attribute & type 'category' only available if the category is 'category' attribute ) | [optional] 
 
 

data/docs/CreateAttributeEnumeration.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::CreateAttributeEnumeration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Integer** | Id of the value | 
+**label** | **String** | Label of the value | 
+
+

data/docs/GetAttributesAttributes.md

@@ -3,7 +3,6 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **Integer** | ID of the attribute | 
 **name** | **String** | Name of the attribute | 
 **category** | **String** | Category of the attribute | 
 **type** | **String** | Type of the attribute | [optional] 

data/docs/SendSms.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **reference** | **String** |  | 
+**message_id** | **Integer** |  | 
 
 

data/docs/UpdateAttribute.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::UpdateAttribute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | Value of the attribute. Use only if the attribute's category is calculated or global | [optional] 
+**enumeration** | [**Array<UpdateAttributeEnumeration>**](UpdateAttributeEnumeration.md) | Values that the attribute can take. Use only if the attribute's category is category | [optional] 
+
+

data/docs/{CreateAttributeEnumemaration.md → UpdateAttributeEnumeration.md}

@@ -1,4 +1,4 @@
-# SibApiV3Sdk::CreateAttributeEnumemaration
+# SibApiV3Sdk::UpdateAttributeEnumeration
 
 ## Properties
 Name | Type | Description | Notes

data/lib/sib-api-v3-sdk.rb

@@ -20,7 +20,7 @@ require 'sib-api-v3-sdk/configuration'
 require 'sib-api-v3-sdk/models/add_credits'
 require 'sib-api-v3-sdk/models/add_remove_contact_to_list'
 require 'sib-api-v3-sdk/models/create_attribute'
-require 'sib-api-v3-sdk/models/create_attribute_enumemaration'
+require 'sib-api-v3-sdk/models/create_attribute_enumeration'
 require 'sib-api-v3-sdk/models/create_child'
 require 'sib-api-v3-sdk/models/create_contact'
 require 'sib-api-v3-sdk/models/create_email_campaign'
@@ -143,6 +143,8 @@ require 'sib-api-v3-sdk/models/send_template_email'
 require 'sib-api-v3-sdk/models/send_test_email'
 require 'sib-api-v3-sdk/models/send_test_sms'
 require 'sib-api-v3-sdk/models/send_transac_sms'
+require 'sib-api-v3-sdk/models/update_attribute'
+require 'sib-api-v3-sdk/models/update_attribute_enumeration'
 require 'sib-api-v3-sdk/models/update_campaign_status'
 require 'sib-api-v3-sdk/models/update_child'
 require 'sib-api-v3-sdk/models/update_contact'