sib-api-v3-sdk 1.0.0

data/spec/api/email_campaigns_api_spec.rb

@@ -0,0 +1,163 @@
+=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  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SibApiV3Sdk::EmailCampaignsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EmailCampaignsApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::EmailCampaignsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EmailCampaignsApi' do
+    it 'should create an instance of EmailCampaignsApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::EmailCampaignsApi)
+    end
+  end
+
+  # unit tests for create_email_campaign
+  # Create an email campaign
+  # 
+  # @param email_campaigns Values to create a campaign
+  # @param [Hash] opts the optional parameters
+  # @return [CreateModel]
+  describe 'create_email_campaign test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_email_campaigns
+  # Delete an email campaign
+  # 
+  # @param campaign_id id of the campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_email_campaigns test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for email_export_recipients
+  # Export the recipients of a campaign
+  # 
+  # @param campaign_id Id of the campaign
+  # @param [Hash] opts the optional parameters
+  # @option opts [EmailExportRecipients] :recipient_export Values to send for a recipient export request
+  # @return [CreatedProcessId]
+  describe 'email_export_recipients test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_email_campaign
+  # Get campaign informations
+  # 
+  # @param campaign_id Id of the campaign
+  # @param [Hash] opts the optional parameters
+  # @return [GetEmailCampaign]
+  describe 'get_email_campaign test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_email_campaigns
+  # Return all your created campaigns
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :type Filter on the type of the campaigns
+  # @option opts [String] :status Filter on the status of the campaign
+  # @option opts [Integer] :limit Number of documents per page
+  # @option opts [Integer] :offset Index of the first document in the page
+  # @return [GetEmailCampaigns]
+  describe 'get_email_campaigns test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for send_email_campaign_now
+  # Send an email campaign id of the campaign immediately
+  # 
+  # @param campaign_id Id of the campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_email_campaign_now test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for send_report
+  # Send the report of a campaigns
+  # A PDF will be sent to the specified email addresses
+  # @param campaign_id Id of the campaign
+  # @param send_report Values for send a report
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_report test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for send_test_email
+  # Send an email campaign to your test list
+  # 
+  # @param campaign_id Id of the campaign
+  # @param email_to 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_test_email test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_campaign_status
+  # Update a campaign status
+  # 
+  # @param campaign_id Id of the campaign
+  # @param status Status of the campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_campaign_status test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_email_campaigns
+  # Update a campaign
+  # 
+  # @param campaign_id Id of the campaign
+  # @param email_campaign Values to update a campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_email_campaigns test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/folders_api_spec.rb

@@ -0,0 +1,111 @@
+=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  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SibApiV3Sdk::FoldersApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'FoldersApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::FoldersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of FoldersApi' do
+    it 'should create an instance of FoldersApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::FoldersApi)
+    end
+  end
+
+  # unit tests for create_folder
+  # Create a folder
+  # 
+  # @param name Name of the folder
+  # @param [Hash] opts the optional parameters
+  # @return [CreateModel]
+  describe 'create_folder test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_folder
+  # Delete a folder (and all its lists)
+  # 
+  # @param folder_id Id of the folder
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_folder test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_folder
+  # Returns folder details
+  # 
+  # @param folder_id id of the folder
+  # @param [Hash] opts the optional parameters
+  # @return [GetFolder]
+  describe 'get_folder test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_folder_lists
+  # Get the lists in a folder
+  # 
+  # @param folder_id Id of the folder
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of documents per page
+  # @option opts [Integer] :offset Index of the first document of the page
+  # @return [GetFolderLists]
+  describe 'get_folder_lists test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_folders
+  # Get all the folders
+  # 
+  # @param limit Number of documents per page
+  # @param offset Index of the first document of the page
+  # @param [Hash] opts the optional parameters
+  # @return [GetFolders]
+  describe 'get_folders test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_folder
+  # Update a contact folder
+  # 
+  # @param folder_id Id of the folder
+  # @param name Name of the folder
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_folder test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/lists_api_spec.rb

@@ -0,0 +1,152 @@
+=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  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SibApiV3Sdk::ListsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ListsApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::ListsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ListsApi' do
+    it 'should create an instance of ListsApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::ListsApi)
+    end
+  end
+
+  # 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 [Hash] opts the optional parameters
+  # @return [PostContactInfo]
+  describe 'add_contact_to_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_list
+  # Create a list
+  # 
+  # @param create_list Values to create a list
+  # @param [Hash] opts the optional parameters
+  # @return [CreateModel]
+  describe 'create_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_list
+  # Delete a list
+  # 
+  # @param list_id Id of the list
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_contacts_from_list
+  # Get the contacts in a list
+  # 
+  # @param list_id Id of the list
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :modified_since Filter the contacts modified after a given date (YYYY-MM-DD HH:mm:ss)
+  # @option opts [Integer] :limit Number of documents per page
+  # @option opts [Integer] :offset Index of the first document of the page
+  # @return [GetContacts]
+  describe 'get_contacts_from_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_folder_lists
+  # Get the lists in a folder
+  # 
+  # @param folder_id Id of the folder
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of documents per page
+  # @option opts [Integer] :offset Index of the first document of the page
+  # @return [GetFolderLists]
+  describe 'get_folder_lists test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_list
+  # Get the details of a list
+  # 
+  # @param list_id Id of the list
+  # @param [Hash] opts the optional parameters
+  # @return [GetExtendedList]
+  describe 'get_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_lists
+  # Get all the lists
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of documents per page
+  # @option opts [Integer] :offset Index of the first document of the page
+  # @return [GetLists]
+  describe 'get_lists test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for remove_contact_to_list
+  # Remove existing contacts from a list
+  # 
+  # @param list_id Id of the list
+  # @param contact_emails Emails adresses of the contact
+  # @param [Hash] opts the optional parameters
+  # @return [PostContactInfo]
+  describe 'remove_contact_to_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_list
+  # Update a list
+  # 
+  # @param list_id Id of the list
+  # @param update_list Values to update a list
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_list test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/process_api_spec.rb

@@ -0,0 +1,60 @@
+=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  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SibApiV3Sdk::ProcessApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ProcessApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::ProcessApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProcessApi' do
+    it 'should create an instance of ProcessApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::ProcessApi)
+    end
+  end
+
+  # unit tests for get_process
+  # Return the informations for a process
+  # 
+  # @param process_id Id of the process
+  # @param [Hash] opts the optional parameters
+  # @return [GetProcess]
+  describe 'get_process test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_processes
+  # Return all the processes for your account
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number limitation for the result returned
+  # @option opts [Integer] :offset Beginning point in the list to retrieve from.
+  # @return [GetProcesses]
+  describe 'get_processes test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end