CC-1726: gem name updated from brevo-ruby to brevo (#1)

getbrevo · Aug 25, 2023 · 9306498 · 9306498
1 parent 9c34bcd
commit 9306498
Show file tree

Hide file tree

Showing 1,080 changed files with 5,779 additions and 4,734 deletions.
diff --git a/README.md b/README.md
diff --git a/brevo-ruby.gemspec → brevo.gemspec b/brevo-ruby.gemspec → brevo.gemspec
@@ -3,7 +3,7 @@
 =begin
 #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/getbrevo  **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  | 
 
 OpenAPI spec version: 3.0.0
 Contact: contact@brevo.com
@@ -13,11 +13,11 @@ Swagger Codegen version: 2.4.19
 =end
 
 $:.push File.expand_path("../lib", __FILE__)
-require "brevo-ruby/version"
+require "brevo/version"
 
 Gem::Specification.new do |s|
-  s.name        = "brevo-ruby"
-  s.version     = BrevoRuby::VERSION
+  s.name        = "brevo"
+  s.version     = Brevo::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Brevo Developers"]
   s.email       = ["contact@brevo.com"]

diff --git a/docs/AbTestCampaignResult.md b/docs/AbTestCampaignResult.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AbTestCampaignResult
+# Brevo::AbTestCampaignResult
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AbTestCampaignResultClickedLinks.md b/docs/AbTestCampaignResultClickedLinks.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AbTestCampaignResultClickedLinks
+# Brevo::AbTestCampaignResultClickedLinks
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AbTestCampaignResultStatistics.md b/docs/AbTestCampaignResultStatistics.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AbTestCampaignResultStatistics
+# Brevo::AbTestCampaignResultStatistics
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AbTestVersionClicks.md b/docs/AbTestVersionClicks.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AbTestVersionClicks
+# Brevo::AbTestVersionClicks
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AbTestVersionClicksInner.md b/docs/AbTestVersionClicksInner.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AbTestVersionClicksInner
+# Brevo::AbTestVersionClicksInner
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AbTestVersionStats.md b/docs/AbTestVersionStats.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AbTestVersionStats
+# Brevo::AbTestVersionStats
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AccountApi.md b/docs/AccountApi.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AccountApi
+# Brevo::AccountApi
 
 All URIs are relative to *https://api.brevo.com/v3*
 
@@ -16,9 +16,9 @@ Get your account information, plan and credits details
 ### Example
 ```ruby
 # load the gem
-require 'brevo-ruby'
+require 'brevo'
 # setup authorization
-BrevoRuby.configure do |config|
+Brevo.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)
@@ -30,13 +30,13 @@ BrevoRuby.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = BrevoRuby::AccountApi.new
+api_instance = Brevo::AccountApi.new
 
 begin
   #Get your account information, plan and credits details
   result = api_instance.get_account
   p result
-rescue BrevoRuby::ApiError => e
+rescue Brevo::ApiError => e
   puts "Exception when calling AccountApi->get_account: #{e}"
 end
 ```
@@ -67,9 +67,9 @@ Get user activity logs
 ### Example
 ```ruby
 # load the gem
-require 'brevo-ruby'
+require 'brevo'
 # setup authorization
-BrevoRuby.configure do |config|
+Brevo.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)
@@ -81,7 +81,7 @@ BrevoRuby.configure do |config|
   #config.api_key_prefix['partner-key'] = 'Bearer'
 end
 
-api_instance = BrevoRuby::AccountApi.new
+api_instance = Brevo::AccountApi.new
 
 opts = { 
   start_date: 'start_date_example', # String | Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period that can be selected is one month. Additionally, you can retrieve activity logs from the past 12 months from the date of your search.
@@ -94,7 +94,7 @@ begin
   #Get user activity logs
   result = api_instance.get_account_activity(opts)
   p result
-rescue BrevoRuby::ApiError => e
+rescue Brevo::ApiError => e
   puts "Exception when calling AccountApi->get_account_activity: #{e}"
 end
 ```

diff --git a/docs/AddChildDomain.md b/docs/AddChildDomain.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AddChildDomain
+# Brevo::AddChildDomain
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AddContactToList.md b/docs/AddContactToList.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AddContactToList
+# Brevo::AddContactToList
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AddCredits.md b/docs/AddCredits.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AddCredits
+# Brevo::AddCredits
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/AuthenticateDomainModel.md b/docs/AuthenticateDomainModel.md
@@ -1,4 +1,4 @@
-# BrevoRuby::AuthenticateDomainModel
+# Brevo::AuthenticateDomainModel
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/BlockDomain.md b/docs/BlockDomain.md
@@ -1,4 +1,4 @@
-# BrevoRuby::BlockDomain
+# Brevo::BlockDomain
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body.md b/docs/Body.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body
+# Brevo::Body
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body1.md b/docs/Body1.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body1
+# Brevo::Body1
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body10.md b/docs/Body10.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body10
+# Brevo::Body10
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body11.md b/docs/Body11.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body11
+# Brevo::Body11
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body12.md b/docs/Body12.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body12
+# Brevo::Body12
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body2.md b/docs/Body2.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body2
+# Brevo::Body2
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body3.md b/docs/Body3.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body3
+# Brevo::Body3
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body4.md b/docs/Body4.md
@@ -1,9 +1,9 @@
-# BrevoRuby::Body4
+# Brevo::Body4
 
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of deal | [optional] 
-**attributes** | **Object** | Attributes for deal update  If you wish to update the pipeline of a deal you need to provide the &#x60;pipeline&#x60; and the &#x60;deal_stage&#x60;.   Pipeline and deal_stage are ids you can fetch using this endpoint &#x60;/crm/pipeline/details/{pipelineID}&#x60;  | [optional] 
+**attributes** | **Object** | Attributes for deal update  If you wish to update the pipeline of a deal you need to provide the &#x60;pipeline&#x60; and the &#x60;deal_stage&#x60;.  Pipeline and deal_stage are ids you can fetch using this endpoint &#x60;/crm/pipeline/details/{pipelineID}&#x60;  | [optional] 
 
 
diff --git a/docs/Body5.md b/docs/Body5.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body5
+# Brevo::Body5
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body6.md b/docs/Body6.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body6
+# Brevo::Body6
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body7.md b/docs/Body7.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body7
+# Brevo::Body7
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body8.md b/docs/Body8.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body8
+# Brevo::Body8
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/Body9.md b/docs/Body9.md
@@ -1,4 +1,4 @@
-# BrevoRuby::Body9
+# Brevo::Body9
 
 ## Properties
 Name | Type | Description | Notes

diff --git a/docs/BodyVariablesItems.md b/docs/BodyVariablesItems.md
@@ -1,4 +1,4 @@
-# BrevoRuby::BodyVariablesItems
+# Brevo::BodyVariablesItems
 
 ## Properties
 Name | Type | Description | Notes