sib-api-v3-sdk 1.0.0

data/docs/TransactionalSMSApi.md

@@ -0,0 +1,249 @@
+# SibApiV3Sdk::TransactionalSMSApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sms_events**](TransactionalSMSApi.md#get_sms_events) | **GET** /transactionalSMS/statistics/events | Get all the SMS activity (unaggregated events)
+[**get_transac_aggregated_sms_report**](TransactionalSMSApi.md#get_transac_aggregated_sms_report) | **GET** /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time
+[**get_transac_sms_report**](TransactionalSMSApi.md#get_transac_sms_report) | **GET** /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day
+[**send_transac_sms**](TransactionalSMSApi.md#send_transac_sms) | **POST** /transactionalSMS/sms | Send the SMS campaign to the specified mobile number
+
+
+# **get_sms_events**
+> GetSmsEventReport get_sms_events(opts)
+
+Get all the SMS activity (unaggregated events)
+
+### 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::TransactionalSMSApi.new
+
+opts = { 
+  limit: 50, # Integer | Number of documents per page
+  start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
+  end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
+  offset: 0, # Integer | Index of the first document of the page
+  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  phone_number: "phone_number_example", # String | Filter the report for a specific phone number
+  event: "event_example", # String | Filter the report for specific events
+  tags: "tags_example" # String | Filter the report for specific tags passed as a serialized urlencoded array
+}
+
+begin
+  #Get all the SMS activity (unaggregated events)
+  result = api_instance.get_sms_events(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalSMSApi->get_sms_events: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of documents per page | [optional] [default to 50]
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
+ **offset** | **Integer**| Index of the first document of the page | [optional] [default to 0]
+ **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] 
+ **phone_number** | **String**| Filter the report for a specific phone number | [optional] 
+ **event** | **String**| Filter the report for specific events | [optional] 
+ **tags** | **String**| Filter the report for specific tags passed as a serialized urlencoded array | [optional] 
+
+### Return type
+
+[**GetSmsEventReport**](GetSmsEventReport.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_transac_aggregated_sms_report**
+> GetTransacAggregatedSmsReport get_transac_aggregated_sms_report(opts)
+
+Get your SMS activity aggregated over a period of time
+
+### 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::TransactionalSMSApi.new
+
+opts = { 
+  start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
+  end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
+  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with startDate and endDate
+  tag: "tag_example" # String | Filter on a tag
+}
+
+begin
+  #Get your SMS activity aggregated over a period of time
+  result = api_instance.get_transac_aggregated_sms_report(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalSMSApi->get_transac_aggregated_sms_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
+ **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional] 
+ **tag** | **String**| Filter on a tag | [optional] 
+
+### Return type
+
+[**GetTransacAggregatedSmsReport**](GetTransacAggregatedSmsReport.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_transac_sms_report**
+> GetTransacSmsReport get_transac_sms_report(opts)
+
+Get your SMS activity aggregated per day
+
+### 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::TransactionalSMSApi.new
+
+opts = { 
+  start_date: Date.parse("2013-10-20"), # Date | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report
+  end_date: Date.parse("2013-10-20"), # Date | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report
+  days: 56, # Integer | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  tag: "tag_example" # String | Filter on a tag
+}
+
+begin
+  #Get your SMS activity aggregated per day
+  result = api_instance.get_transac_sms_report(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalSMSApi->get_transac_sms_report: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | **Date**| Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] 
+ **end_date** | **Date**| Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] 
+ **days** | **Integer**| Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] 
+ **tag** | **String**| Filter on a tag | [optional] 
+
+### Return type
+
+[**GetTransacSmsReport**](GetTransacSmsReport.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **send_transac_sms**
+> SendSms send_transac_sms(send_transac_sms)
+
+Send the SMS campaign to the specified mobile number
+
+### 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::TransactionalSMSApi.new
+
+send_transac_sms = SibApiV3Sdk::SendTransacSms.new # SendTransacSms | Values to send a transactional SMS
+
+
+begin
+  #Send the SMS campaign to the specified mobile number
+  result = api_instance.send_transac_sms(send_transac_sms)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalSMSApi->send_transac_sms: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **send_transac_sms** | [**SendTransacSms**](SendTransacSms.md)| Values to send a transactional SMS | 
+
+### Return type
+
+[**SendSms**](SendSms.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UpdateCampaignStatus.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::UpdateCampaignStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+
+

data/docs/UpdateChild.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::UpdateChild
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | New Email address to update the child account | [optional] 
+**first_name** | **String** | New First name to use to update the child account | [optional] 
+**last_name** | **String** | New Last name to use to update the child account | [optional] 
+**company_name** | **String** | New Company name to use to update the child account | [optional] 
+**password** | **String** | New password for the child account to login | [optional] 
+**ips** | **Array<Integer>** |  | [optional] 
+
+

data/docs/UpdateContact.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::UpdateContact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | **Hash<String, String>** |  | [optional] 
+**email_blacklisted** | **BOOLEAN** | Blacklist the contact for emails (emailBlacklisted = true) | [optional] 
+**sms_blacklisted** | **BOOLEAN** | Blacklist the contact for SMS (smsBlacklisted = true) | [optional] 
+**list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 
+**unlink_list_ids** | **Array<Integer>** | Ids of the lists to remove the contact from | [optional] 
+
+

data/docs/UpdateEmailCampaign.md

@@ -0,0 +1,24 @@
+# SibApiV3Sdk::UpdateEmailCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the campaign | [optional] 
+**sender** | [**UpdateEmailCampaignSender**](UpdateEmailCampaignSender.md) |  | [optional] 
+**name** | **String** | Name of the campaign | [optional] 
+**html_content** | **String** | Body of the message (HTML version). REQUIRED if htmlUrl is empty | [optional] 
+**html_url** | **String** | Url which contents the body of the email message. REQUIRED if htmlContent is empty | [optional] 
+**scheduled_at** | **String** | Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss) | [optional] 
+**subject** | **String** | Subject of the campaign | [optional] 
+**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
+**to_field** | **String** | This is to personalize the «To» Field. If you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. To use the contact attributes here, these must already exist in SendinBlue account | [optional] 
+**recipients** | [**UpdateEmailCampaignRecipients**](UpdateEmailCampaignRecipients.md) |  | [optional] 
+**attachment_url** | **String** | Absolute url of the attachment. Url not allowed from local machine. File must be hosted somewhere.Possilbe extension values are xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
+**inline_image_activation** | **BOOLEAN** | Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email. You cannot send a campaign of more than 4MB with images embedded in the email. Campaigns with the images embedded in the email must be sent to less than 5000 contacts. | [optional] [default to false]
+**mirror_active** | **BOOLEAN** | Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign | [optional] 
+**recurring** | **BOOLEAN** | FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times | [optional] [default to false]
+**footer** | **String** | Footer of the email campaign | [optional] 
+**header** | **String** | Header of the email campaign | [optional] 
+**utm_campaign** | **String** | Customize the utm_campaign value. If this field is empty, the campaign name will be used. Only alphanumeric characters and spaces are allowed | [optional] 
+
+

data/docs/UpdateEmailCampaignRecipients.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::UpdateEmailCampaignRecipients
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional] 
+**list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional] 
+
+

data/docs/UpdateEmailCampaignSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::UpdateEmailCampaignSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Sender Name from which the campaign emails are sent | [optional] 
+**email** | **String** | Sender email from which the campaign emails are sent | [optional] 
+
+

data/docs/UpdateList.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::UpdateList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the list. Only one parameter can be update at once | [optional] 
+**folder_id** | **Integer** | Id of the folder in which to move the list. Only one parameter can updated at once | [optional] 
+
+

data/docs/UpdateSender.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::UpdateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | From Name to update the sender | [optional] 
+**email** | **String** | From Email to update the sender | [optional] 
+**ips** | [**Array<CreateSenderIps>**](CreateSenderIps.md) | Only in case of dedicated IP, IPs to associate to the sender. If passed, will replace all the existing IPs. | [optional] 
+
+

data/docs/UpdateSmsCampaign.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::UpdateSmsCampaign
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the campaign | [optional] 
+**sender** | **String** | Name of the sender. The number of characters is limited to 11 | [optional] 
+**content** | **String** | Content of the message. The maximum characters used per SMS is 160, if used more than that, it will be counted as more than one SMS | [optional] 
+**recipients** | [**CreateSmsCampaignRecipients**](CreateSmsCampaignRecipients.md) |  | [optional] 
+**scheduled_at** | **String** | Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss) | [optional] 
+
+

data/docs/UpdateSmtpTemplate.md

@@ -0,0 +1,17 @@
+# SibApiV3Sdk::UpdateSmtpTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | Tag of the template | [optional] 
+**sender** | [**UpdateSmtpTemplateSender**](UpdateSmtpTemplateSender.md) |  | [optional] 
+**template_name** | **String** | Name of the template | [optional] 
+**html_content** | **String** | Required if htmlUrl is empty. Body of the message (HTML must have more than 10 characters) | [optional] 
+**html_url** | **String** | Required if htmlContent is empty. URL to the body of the email (HTML) | [optional] 
+**subject** | **String** | Subject of the email | [optional] 
+**reply_to** | **String** | Email on which campaign recipients will be able to reply to | [optional] 
+**to_field** | **String** | To personalize the «To» Field, e.g. if you want to include the first name and last name of your recipient, add [FNAME] [LNAME]. These attributes must already exist in contacts database | [optional] 
+**attachment_url** | **String** | Absolute url of the attachment (no local file). Extension allowed: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff and rtf | [optional] 
+**is_active** | **BOOLEAN** | Status of the template. isActive = false means template is inactive, isActive = true means template is active | [optional] 
+
+

data/docs/UpdateSmtpTemplateSender.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::UpdateSmtpTemplateSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the sender | [optional] 
+**email** | **String** | Email of the sender | [optional] 
+
+

data/docs/UpdateWebhook.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::UpdateWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL of the webhook | [optional] 
+**description** | **String** | Description of the webhook | [optional] 
+**events** | **Array<String>** | Events triggering the webhook. Possible values for Transactional type webhook – request, delivered, hardBounce, softBounce, blocked, spam, invalid, deferred, click, opened, uniqueOpened and unsubscribed and possible values for Marketing type webhook – spam, opened, click, hardBounce, softBounce, unsubscribed, listAddition and delivered | [optional] 
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,275 @@
+# SibApiV3Sdk::WebhooksApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /webhooks | Create a webhook
+[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{webhookId} | Delete a webhook
+[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{webhookId} | Get a webhook details
+[**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Get all webhooks
+[**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /webhooks/{webhookId} | Update a webhook
+
+
+# **create_webhook**
+> CreateModel create_webhook(create_webhook)
+
+Create a webhook
+
+### 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::WebhooksApi.new
+
+create_webhook = SibApiV3Sdk::CreateWebhook.new # CreateWebhook | Values to create a webhook
+
+
+begin
+  #Create a webhook
+  result = api_instance.create_webhook(create_webhook)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling WebhooksApi->create_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_webhook** | [**CreateWebhook**](CreateWebhook.md)| Values to create a webhook | 
+
+### Return type
+
+[**CreateModel**](CreateModel.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_webhook**
+> delete_webhook(webhook_id)
+
+Delete a webhook
+
+### 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::WebhooksApi.new
+
+webhook_id = "webhook_id_example" # String | Id of the webhook
+
+
+begin
+  #Delete a webhook
+  api_instance.delete_webhook(webhook_id)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| Id of the webhook | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_webhook**
+> GetWebhook get_webhook(webhook_id)
+
+Get a webhook details
+
+### 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::WebhooksApi.new
+
+webhook_id = "webhook_id_example" # String | Id of the webhook
+
+
+begin
+  #Get a webhook details
+  result = api_instance.get_webhook(webhook_id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling WebhooksApi->get_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| Id of the webhook | 
+
+### Return type
+
+[**GetWebhook**](GetWebhook.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_webhooks**
+> GetWebhooks get_webhooks(opts)
+
+Get all webhooks
+
+### 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::WebhooksApi.new
+
+opts = { 
+  type: "transactional" # String | Filter on webhook type
+}
+
+begin
+  #Get all webhooks
+  result = api_instance.get_webhooks(opts)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling WebhooksApi->get_webhooks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | **String**| Filter on webhook type | [optional] [default to transactional]
+
+### Return type
+
+[**GetWebhooks**](GetWebhooks.md)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_webhook**
+> update_webhook(webhook_id, update_webhook)
+
+Update a webhook
+
+### 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::WebhooksApi.new
+
+webhook_id = "webhook_id_example" # String | Id of the webhook
+
+update_webhook = SibApiV3Sdk::UpdateWebhook.new # UpdateWebhook | Values to update a webhook
+
+
+begin
+  #Update a webhook
+  api_instance.update_webhook(webhook_id, update_webhook)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling WebhooksApi->update_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| Id of the webhook | 
+ **update_webhook** | [**UpdateWebhook**](UpdateWebhook.md)| Values to update a webhook | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+