sib-api-v3-sdk 1.0.0

data/spec/api/reseller_api_spec.rb

@@ -0,0 +1,147 @@
+=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::ResellerApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ResellerApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::ResellerApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ResellerApi' do
+    it 'should create an instance of ResellerApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::ResellerApi)
+    end
+  end
+
+  # unit tests for add_credits
+  # Add Email and/or SMS credits to a specific child account
+  # 
+  # @param child_id id of reseller's child
+  # @param add_credits Values to post to add credit to a specific child account
+  # @param [Hash] opts the optional parameters
+  # @return [RemainingCreditModel]
+  describe 'add_credits 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 associate_ip_to_child
+  # Associate a dedicated IP to the child
+  # 
+  # @param child_id id of reseller's child
+  # @param ip_id IP's id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'associate_ip_to_child 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_reseller_child
+  # Creates a reseller child
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreateChild] :reseller_child reseller child to add
+  # @return [CreateModel]
+  describe 'create_reseller_child 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_reseller_child
+  # Deletes a single reseller child based on the childId supplied
+  # 
+  # @param child_id id of reseller's child
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_reseller_child 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 dissociate_ip_from_child
+  # Dissociate a dedicated IP to the child
+  # 
+  # @param child_id id of reseller's child
+  # @param ip_id IP's id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'dissociate_ip_from_child 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_child_info
+  # Gets the info about a specific child account
+  # 
+  # @param child_id id of reseller's child
+  # @param [Hash] opts the optional parameters
+  # @return [GetChildInfo]
+  describe 'get_child_info 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_reseller_childs
+  # Gets the list of all reseller's children accounts
+  # 
+  # @param [Hash] opts the optional parameters
+  # @return [GetChildrenList]
+  describe 'get_reseller_childs 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_credits
+  # Remove Email and/or SMS credits from a specific child account
+  # 
+  # @param child_id id of reseller's child
+  # @param remove_credits Values to post to remove email or SMS credits from a specific child account
+  # @param [Hash] opts the optional parameters
+  # @return [RemainingCreditModel]
+  describe 'remove_credits 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_reseller_child
+  # Updates infos of reseller's child based on the childId supplied
+  # 
+  # @param child_id id of reseller's child
+  # @param reseller_child values to update in child profile
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_reseller_child 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/senders_api_spec.rb

@@ -0,0 +1,108 @@
+=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::SendersApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SendersApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::SendersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SendersApi' do
+    it 'should create an instance of SendersApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::SendersApi)
+    end
+  end
+
+  # unit tests for create_sender
+  # Create a new sender
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreateSender] :sender sender's name
+  # @return [CreateSenderModel]
+  describe 'create_sender 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_sender
+  # Delete a sender
+  # 
+  # @param sender_id Id of the sender
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_sender 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_ips
+  # Return all the dedicated IPs for your account
+  # 
+  # @param [Hash] opts the optional parameters
+  # @return [GetIps]
+  describe 'get_ips 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_ips_from_sender
+  # Return all the dedicated IPs for a sender
+  # 
+  # @param sender_id Id of the sender
+  # @param [Hash] opts the optional parameters
+  # @return [GetIpsFromSender]
+  describe 'get_ips_from_sender 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_senders
+  # Get the list of all your senders
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :ip Filter your senders for a specific ip (available for dedicated IP usage only)
+  # @option opts [String] :domain Filter your senders for a specific domain
+  # @return [GetSendersList]
+  describe 'get_senders 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_sender
+  # Update a sender
+  # 
+  # @param sender_id Id of the sender
+  # @param [Hash] opts the optional parameters
+  # @option opts [UpdateSender] :sender sender's name
+  # @return [nil]
+  describe 'update_sender 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/sms_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::SMSCampaignsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SMSCampaignsApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::SMSCampaignsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SMSCampaignsApi' do
+    it 'should create an instance of SMSCampaignsApi' do
+      expect(@instance).to be_instance_of(SibApiV3Sdk::SMSCampaignsApi)
+    end
+  end
+
+  # unit tests for create_sms_campaign
+  # Creates a SMS campaign
+  # 
+  # @param create_sms_campaign Values to create an SMS Campaign
+  # @param [Hash] opts the optional parameters
+  # @return [CreateModel]
+  describe 'create_sms_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_sms_campaigns
+  # Delete the SMS campaign
+  # 
+  # @param campaign_id id of the SMS campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_sms_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 get_sms_campaign
+  # Get a SMS campaign
+  # 
+  # @param campaign_id id of the SMS campaign
+  # @param get_sms_campaign Values to update an SMS Campaign
+  # @param [Hash] opts the optional parameters
+  # @return [GetSmsCampaign]
+  describe 'get_sms_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_sms_campaigns
+  # Returns the informations for all your created SMS campaigns
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :status Status of campaign.
+  # @option opts [Integer] :limit Number limitation for the result returned
+  # @option opts [Integer] :offset Beginning point in the list to retrieve from.
+  # @return [GetSmsCampaigns]
+  describe 'get_sms_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 request_sms_recipient_export
+  # Exports the recipients of the specified campaign.
+  # It returns the background process ID which on completion calls the notify URL that you have set in the input.
+  # @param campaign_id id of the campaign
+  # @param [Hash] opts the optional parameters
+  # @option opts [RequestSMSRecipientExport] :recipient_export Values to send for a recipient export request
+  # @return [CreatedProcessId]
+  describe 'request_sms_recipient_export 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_sms_campaign_now
+  # Send your SMS campaign immediately
+  # 
+  # @param campaign_id id of the campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_sms_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_sms_report
+  # Send report of SMS campaigns
+  # Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail.
+  # @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_sms_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_sms
+  # Send an SMS
+  # 
+  # @param campaign_id Id of the SMS campaign
+  # @param send_test_sms Mobile number to which send the test
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_test_sms 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_sms_campaign
+  # Updates a SMS campaign
+  # 
+  # @param campaign_id id of the SMS campaign
+  # @param update_sms_campaign Values to update an SMS Campaign
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_sms_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 update_sms_campaign_status
+  # Update the 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_sms_campaign_status 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/smtp_api_spec.rb

@@ -0,0 +1,189 @@
+=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::SMTPApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SMTPApi' do
+  before do
+    # run before each test
+    @instance = SibApiV3Sdk::SMTPApi.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)
+    end
+  end
+
+  # unit tests for create_smtp_template
+  # Create an smtp template
+  # 
+  # @param smtp_template values to update in smtp template
+  # @param [Hash] opts the optional parameters
+  # @return [CreateModel]
+  describe 'create_smtp_template 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_hardbounces
+  # Delete hardbounces
+  # Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures)
+  # @param [Hash] opts the optional parameters
+  # @option opts [DeleteHardbounces] :delete_hardbounces values to delete hardbounces
+  # @return [nil]
+  describe 'delete_hardbounces 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_aggregated_smtp_report
+  # Get your SMTP activity aggregated over a period of time
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
+  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
+  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  # @option opts [String] :tag Tag of the emails
+  # @return [GetAggregatedReport]
+  describe 'get_aggregated_smtp_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 get_email_event_report
+  # Get all your SMTP activity (unaggregated events)
+  # 
+  # @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.
+  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
+  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
+  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  # @option opts [String] :email Filter the report for a specific email addresses
+  # @option opts [String] :event Filter the report for a specific event type
+  # @option opts [String] :tags Filter the report for tags (serialized and urlencoded array)
+  # @option opts [String] :message_id Filter on a specific message id
+  # @option opts [String] :template_id Filter on a specific template id
+  # @return [GetEmailEventReport]
+  describe 'get_email_event_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 get_smtp_report
+  # Get your SMTP activity aggregated per day
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Number of documents returned per page
+  # @option opts [Integer] :offset Index of the first document on the page
+  # @option opts [Date] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)
+  # @option opts [Date] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)
+  # @option opts [Integer] :days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'
+  # @option opts [String] :tag Tag of the emails
+  # @return [GetReports]
+  describe 'get_smtp_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 get_smtp_template
+  # Returns the template informations
+  # 
+  # @param template_id id of the template
+  # @param [Hash] opts the optional parameters
+  # @return [GetSmtpTemplateOverview]
+  describe 'get_smtp_template 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_smtp_templates
+  # Get the list of SMTP templates
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active = true, inactive = false
+  # @option opts [Integer] :limit Number of documents returned per page
+  # @option opts [Integer] :offset Index of the first document in the page
+  # @return [GetSmtpTemplates]
+  describe 'get_smtp_templates 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_template
+  # Send a template
+  # 
+  # @param template_id Id of the template
+  # @param send_email 
+  # @param [Hash] opts the optional parameters
+  # @return [SendTemplateEmail]
+  describe 'send_template 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_template
+  # Send a template to your test list
+  # 
+  # @param template_id Id of the template
+  # @param send_test_email 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_test_template 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_transac_email
+  # Send a transactional email
+  # 
+  # @param send_smtp_email Values to send a transactional email
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSmtpEmail]
+  describe 'send_transac_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_smtp_template
+  # Updates an smtp templates
+  # 
+  # @param template_id id of the template
+  # @param smtp_template values to update in smtp template
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_smtp_template test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end