sib-api-v3-sdk 7.5.0 → 9.0.0

data/docs/CompaniesApi.md

@@ -0,0 +1,425 @@
+# SibApiV3Sdk::CompaniesApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**companies_attributes_get**](CompaniesApi.md#companies_attributes_get) | **GET** /companies/attributes | Get company attributes
+[**companies_get**](CompaniesApi.md#companies_get) | **GET** /companies | Get all companies
+[**companies_id_delete**](CompaniesApi.md#companies_id_delete) | **DELETE** /companies/{id} | Delete a company
+[**companies_id_get**](CompaniesApi.md#companies_id_get) | **GET** /companies/{id} | Get a company
+[**companies_id_patch**](CompaniesApi.md#companies_id_patch) | **PATCH** /companies/{id} | Update a company
+[**companies_link_unlink_id_patch**](CompaniesApi.md#companies_link_unlink_id_patch) | **PATCH** /companies/link-unlink/{id} | Link and Unlink company with contacts and deals
+[**companies_post**](CompaniesApi.md#companies_post) | **POST** /companies | Create a company
+
+
+# **companies_attributes_get**
+> CompanyAttributes companies_attributes_get
+
+Get company attributes
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+begin
+  #Get company attributes
+  result = api_instance.companies_attributes_get
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_attributes_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CompanyAttributes**](CompanyAttributes.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **companies_get**
+> CompaniesList companies_get(opts)
+
+Get all companies
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+opts = { 
+  filters: 'filters_example', # String | Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}
+  linked_contacts_ids: 789, # Integer | Filter by linked contacts ids
+  linked_deals_ids: 'linked_deals_ids_example', # String | Filter by linked deals ids
+  page: 789, # Integer | Index of the first document of the page
+  limit: 50, # Integer | Number of documents per page
+  sort: 'sort_example', # String | Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+  sort_by: 'sort_by_example' # String | The field used to sort field names.
+}
+
+begin
+  #Get all companies
+  result = api_instance.companies_get(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filters** | **String**| Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"} | [optional] 
+ **linked_contacts_ids** | **Integer**| Filter by linked contacts ids | [optional] 
+ **linked_deals_ids** | **String**| Filter by linked deals ids | [optional] 
+ **page** | **Integer**| Index of the first document of the page | [optional] 
+ **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
+ **sort** | **String**| Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed | [optional] 
+ **sort_by** | **String**| The field used to sort field names. | [optional] 
+
+### Return type
+
+[**CompaniesList**](CompaniesList.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **companies_id_delete**
+> companies_id_delete(id)
+
+Delete a company
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #Delete a company
+  api_instance.companies_id_delete(id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **companies_id_get**
+> Company companies_id_get(id)
+
+Get a company
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #Get a company
+  result = api_instance.companies_id_get(id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**Company**](Company.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **companies_id_patch**
+> Company companies_id_patch(id, body)
+
+Update a company
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+id = 'id_example' # String | 
+
+body = SibApiV3Sdk::Body1.new # Body1 | Updated company details.
+
+
+begin
+  #Update a company
+  result = api_instance.companies_id_patch(id, body)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **body** | [**Body1**](Body1.md)| Updated company details. | 
+
+### Return type
+
+[**Company**](Company.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **companies_link_unlink_id_patch**
+> companies_link_unlink_id_patch(id, body)
+
+Link and Unlink company with contacts and deals
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+id = 'id_example' # String | 
+
+body = SibApiV3Sdk::Body2.new # Body2 | Linked / Unlinked contacts and deals ids.
+
+
+begin
+  #Link and Unlink company with contacts and deals
+  api_instance.companies_link_unlink_id_patch(id, body)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_link_unlink_id_patch: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **body** | [**Body2**](Body2.md)| Linked / Unlinked contacts and deals ids. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **companies_post**
+> InlineResponse200 companies_post(body)
+
+Create a company
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::CompaniesApi.new
+
+body = SibApiV3Sdk::Body.new # Body | Company create data.
+
+
+begin
+  #Create a company
+  result = api_instance.companies_post(body)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling CompaniesApi->companies_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Body**](Body.md)| Company create data. | 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/CompaniesList.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::CompaniesList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<Company>**](Company.md) | List of compaies | [optional] 
+
+

data/docs/Company.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::Company
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique company id | [optional] 
+**attributes** | **Object** | Company attributes with values | [optional] 
+**linked_contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this company | [optional] 
+**linked_deals_ids** | **Array<String>** | Deals ids for companies linked to this company | [optional] 
+
+

data/docs/CompanyAttributes.md

@@ -0,0 +1,7 @@
+# SibApiV3Sdk::CompanyAttributes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/CompanyAttributesInner.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::CompanyAttributesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**internal_name** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**attribute_type_name** | **String** |  | [optional] 
+**attribute_options** | **Array<Object>** |  | [optional] 
+**is_required** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ContactsApi.md

@@ -28,6 +28,7 @@ Method | HTTP request | Description
 [**remove_contact_from_list**](ContactsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact 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} | Update contact attribute
+[**update_batch_contacts**](ContactsApi.md#update_batch_contacts) | **POST** /contacts/batch | Update multiple contacts
 [**update_contact**](ContactsApi.md#update_contact) | **PUT** /contacts/{identifier} | Update a contact
 [**update_folder**](ContactsApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
 [**update_list**](ContactsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
@@ -661,10 +662,12 @@ This endpoint does not need any parameter.
 
 
 # **get_contact_info**
-> GetExtendedContactDetails get_contact_info(identifier)
+> GetExtendedContactDetails get_contact_info(identifier, opts)
 
 Get a contact's details
 
+Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
+
 ### Example
 ```ruby
 # load the gem
@@ -686,10 +689,14 @@ api_instance = SibApiV3Sdk::ContactsApi.new
 
 identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the contact OR its SMS attribute value
 
+opts = { 
+  start_date: nil, # Object | **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate 
+  end_date: nil # Object | **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. 
+}
 
 begin
   #Get a contact's details
-  result = api_instance.get_contact_info(identifier)
+  result = api_instance.get_contact_info(identifier, opts)
   p result
 rescue SibApiV3Sdk::ApiError => e
   puts "Exception when calling ContactsApi->get_contact_info: #{e}"
@@ -701,6 +708,8 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | **String**| Email (urlencoded) OR ID of the contact OR its SMS attribute value | 
+ **start_date** | [**Object**](.md)| **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate  | [optional] 
+ **end_date** | [**Object**](.md)| **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate.  | [optional] 
 
 ### Return type
 
@@ -745,7 +754,7 @@ identifier = 'identifier_example' # String | Email (urlencoded) OR ID of the con
 
 opts = { 
   start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
-  end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
+  end_date: 'end_date_example' # String | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days
 }
 
 begin
@@ -763,7 +772,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **identifier** | **String**| Email (urlencoded) OR ID of the contact | 
  **start_date** | **String**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate | [optional] 
- **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate | [optional] 
+ **end_date** | **String**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate. Maximum difference between startDate and endDate should not be greater than 90 days | [optional] 
 
 ### Return type
 
@@ -1456,6 +1465,62 @@ nil (empty response body)
 
 
 
+# **update_batch_contacts**
+> update_batch_contacts(update_batch_contacts)
+
+Update multiple contacts
+
+### 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'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::ContactsApi.new
+
+update_batch_contacts = SibApiV3Sdk::UpdateBatchContacts.new # UpdateBatchContacts | Values to update multiple contacts
+
+
+begin
+  #Update multiple contacts
+  api_instance.update_batch_contacts(update_batch_contacts)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling ContactsApi->update_batch_contacts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_batch_contacts** | [**UpdateBatchContacts**](UpdateBatchContacts.md)| Values to update multiple contacts | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **update_contact**
 > update_contact(identifier, update_contact)