sib-api-v3-sdk 5.5.0 → 7.0.0

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

@@ -20,7 +20,7 @@ module SibApiV3Sdk
     # Description of the webhook
     attr_accessor :description
 
-    # 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
+    # Events triggering the webhook. Possible values for Transactional type webhook – `sent` OR `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`
     attr_accessor :events
 
     class EnumAttributeValidator

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

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.12
 =end
 
 module SibApiV3Sdk
-  VERSION = "5.5.0"
+  VERSION = "7.0.0"
 end

data/spec/api/contacts_api_spec.rb

@@ -35,7 +35,7 @@ describe 'ContactsApi' do
   # unit tests for add_contact_to_list
   # Add existing contacts to a list
   # @param list_id Id of the list
-  # @param contact_emails Emails addresses of the contacts
+  # @param contact_emails Emails addresses OR IDs of the contacts
   # @param [Hash] opts the optional parameters
   # @return [PostContactInfo]
   describe 'add_contact_to_list test' do
@@ -115,7 +115,7 @@ describe 'ContactsApi' do
 
   # unit tests for delete_contact
   # Delete a contact
-  # @param email Email (urlencoded) of the contact
+  # @param identifier Email (urlencoded) OR ID of the contact
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'delete_contact test' do
@@ -158,7 +158,7 @@ describe 'ContactsApi' do
 
   # unit tests for get_contact_info
   # Get a contact's details
-  # @param email Email (urlencoded) of the contact OR its SMS attribute value
+  # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
   # @param [Hash] opts the optional parameters
   # @return [GetExtendedContactDetails]
   describe 'get_contact_info test' do
@@ -169,7 +169,7 @@ describe 'ContactsApi' do
 
   # unit tests for get_contact_stats
   # Get email campaigns' statistics for a contact
-  # @param email Email address (urlencoded) of the contact
+  # @param identifier Email (urlencoded) OR ID of the contact
   # @param [Hash] opts the optional parameters
   # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to endDate
   # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to startDate
@@ -281,7 +281,7 @@ describe 'ContactsApi' do
   # unit tests for remove_contact_from_list
   # Delete a contact from a list
   # @param list_id Id of the list
-  # @param contact_emails Emails adresses of the contact
+  # @param contact_emails Emails addresses OR IDs of the contacts
   # @param [Hash] opts the optional parameters
   # @return [PostContactInfo]
   describe 'remove_contact_from_list test' do
@@ -317,7 +317,7 @@ describe 'ContactsApi' do
 
   # unit tests for update_contact
   # Update a contact
-  # @param email Email (urlencoded) of the contact
+  # @param identifier Email (urlencoded) OR ID of the contact
   # @param update_contact Values to update a contact
   # @param [Hash] opts the optional parameters
   # @return [nil]

data/spec/api/lists_api_spec.rb

@@ -35,7 +35,7 @@ describe 'ListsApi' do
   # unit tests for add_contact_to_list
   # Add existing contacts to a list
   # @param list_id Id of the list
-  # @param contact_emails Emails addresses of the contacts
+  # @param contact_emails Emails addresses OR IDs of the contacts
   # @param [Hash] opts the optional parameters
   # @return [PostContactInfo]
   describe 'add_contact_to_list test' do
@@ -119,7 +119,7 @@ describe 'ListsApi' do
   # unit tests for remove_contact_from_list
   # Delete a contact from a list
   # @param list_id Id of the list
-  # @param contact_emails Emails adresses of the contact
+  # @param contact_emails Emails addresses OR IDs of the contacts
   # @param [Hash] opts the optional parameters
   # @return [PostContactInfo]
   describe 'remove_contact_from_list test' do

data/spec/api/{smtp_api_spec.rb → transactional_emails_api_spec.rb}

@@ -13,22 +13,22 @@ Swagger Codegen version: 2.4.12
 require 'spec_helper'
 require 'json'
 
-# Unit tests for SibApiV3Sdk::SMTPApi
+# Unit tests for SibApiV3Sdk::TransactionalEmailsApi
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
-describe 'SMTPApi' do
+describe 'TransactionalEmailsApi' do
   before do
     # run before each test
-    @instance = SibApiV3Sdk::SMTPApi.new
+    @instance = SibApiV3Sdk::TransactionalEmailsApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of SMTPApi' do
-    it 'should create an instance of SMTPApi' do
-      expect(@instance).to be_instance_of(SibApiV3Sdk::SMTPApi)
+  describe 'test an instance of TransactionalEmailsApi' do
+    it 'should create an instance of TransactionalEmailsApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::TransactionalEmailsApi)
     end
   end
 

data/spec/models/ab_test_campaign_result_clicked_links_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SibApiV3Sdk::AbTestCampaignResultClickedLinks
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AbTestCampaignResultClickedLinks' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::AbTestCampaignResultClickedLinks.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AbTestCampaignResultClickedLinks' do
+    it 'should create an instance of AbTestCampaignResultClickedLinks' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::AbTestCampaignResultClickedLinks)
+    end
+  end
+  describe 'test attribute "version_a"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "version_b"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/ab_test_campaign_result_spec.rb

@@ -76,4 +76,16 @@ describe 'AbTestCampaignResult' do
     end
   end
 
+  describe 'test attribute "statistics"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "clicked_links"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/ab_test_campaign_result_statistics_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SibApiV3Sdk::AbTestCampaignResultStatistics
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AbTestCampaignResultStatistics' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::AbTestCampaignResultStatistics.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AbTestCampaignResultStatistics' do
+    it 'should create an instance of AbTestCampaignResultStatistics' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::AbTestCampaignResultStatistics)
+    end
+  end
+  describe 'test attribute "openers"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "clicks"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "unsubscribed"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "hard_bounces"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "soft_bounces"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "complaints"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/ab_test_version_clicks_inner_spec.rb

@@ -0,0 +1,53 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SibApiV3Sdk::AbTestVersionClicksInner
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AbTestVersionClicksInner' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::AbTestVersionClicksInner.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AbTestVersionClicksInner' do
+    it 'should create an instance of AbTestVersionClicksInner' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::AbTestVersionClicksInner)
+    end
+  end
+  describe 'test attribute "link"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "clicks_count"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "click_rate"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/ab_test_version_clicks_spec.rb

@@ -0,0 +1,35 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SibApiV3Sdk::AbTestVersionClicks
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AbTestVersionClicks' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::AbTestVersionClicks.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AbTestVersionClicks' do
+    it 'should create an instance of AbTestVersionClicks' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::AbTestVersionClicks)
+    end
+  end
+end

data/spec/models/ab_test_version_stats_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#SendinBlue API
+
+#SendinBlue 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/sendinblue  **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@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.12
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SibApiV3Sdk::AbTestVersionStats
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AbTestVersionStats' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::AbTestVersionStats.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AbTestVersionStats' do
+    it 'should create an instance of AbTestVersionStats' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::AbTestVersionStats)
+    end
+  end
+  describe 'test attribute "version_a"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "version_b"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/add_contact_to_list_spec.rb

@@ -38,4 +38,10 @@ describe 'AddContactToList' do
     end
   end
 
+  describe 'test attribute "ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/get_campaign_stats_spec.rb

@@ -104,4 +104,10 @@ describe 'GetCampaignStats' do
     end
   end
 
+  describe 'test attribute "return_bounce"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/models/remove_contact_from_list_spec.rb

@@ -38,6 +38,12 @@ describe 'RemoveContactFromList' do
     end
   end
 
+  describe 'test attribute "ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "all"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/send_smtp_email_sender_spec.rb

@@ -44,4 +44,10 @@ describe 'SendSmtpEmailSender' do
     end
   end
 
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/testfile.rb

@@ -0,0 +1,23 @@
+# 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'] = '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'
+  # 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::TransactionalEmailsApi.new
+template_id = 56 # Integer | id of the template
+begin
+  #Returns the template information
+  result = api_instance.get_smtp_template(template_id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling TransactionalEmailsApi->get_smtp_template: #{e}"
+end