sib-api-v3-sdk 8.0.0 → 8.1.0

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

@@ -30,7 +30,7 @@ module SibApiV3Sdk
     end
 
     
-    # Get file data by id.
+    # Get file details.
     # @param id File id to get file data.
     # @param [Hash] opts the optional parameters
     # @return [FileData]
@@ -39,7 +39,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get file data by id.
+    # Get file details
     # @param id File id to get file data.
     # @param [Hash] opts the optional parameters
     # @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
@@ -82,7 +82,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Delete file.
+    # Delete a file
     # @param id File id to delete.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -91,7 +91,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Delete file.
+    # Delete a file
     # @param id File id to delete.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -133,7 +133,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Download file by id.
+    # Download a file
     # @param id File id to download.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -142,7 +142,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Download file by id.
+    # Download a file
     # @param id File id to download.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -184,7 +184,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Upload and create file.
+    # Upload a file
     # @param file File data to create a file.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :deals_ids Deal ids linked to a file
@@ -194,7 +194,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Upload and create file.
+    # Upload a file
     # @param file File data to create a file.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :deals_ids Deal ids linked to a file
@@ -240,7 +240,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Delete Note by ID
+    # Delete a note
     # @param id Note ID to delete
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -249,7 +249,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Delete Note by ID
+    # Delete a note
     # @param id Note ID to delete
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -291,7 +291,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get one Note by ID
+    # Get a note
     # @param id Note ID to get
     # @param [Hash] opts the optional parameters
     # @return [Note]
@@ -300,7 +300,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get one Note by ID
+    # Get a note
     # @param id Note ID to get
     # @param [Hash] opts the optional parameters
     # @return [Array<(Note, Fixnum, Hash)>] Note data, response status code and response headers
@@ -401,7 +401,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Create a new Note
+    # Create a note
     # @param body Note data to create a note.
     # @param [Hash] opts the optional parameters
     # @return [Note]
@@ -410,7 +410,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Create a new Note
+    # Create a note
     # @param body Note data to create a note.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Note, Fixnum, Hash)>] Note data, response status code and response headers
@@ -453,7 +453,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Delete Task by id
+    # Delete a task
     # @param id 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -462,7 +462,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Delete Task by id
+    # Delete a task
     # @param id 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -504,7 +504,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get one Task by ID
+    # Get a task
     # @param id 
     # @param [Hash] opts the optional parameters
     # @return [Task]
@@ -513,7 +513,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get one Task by ID
+    # Get a task
     # @param id 
     # @param [Hash] opts the optional parameters
     # @return [Array<(Task, Fixnum, Hash)>] Task data, response status code and response headers
@@ -556,7 +556,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Update partial existing task
+    # Update a task
     # @param id 
     # @param body Updated task details.
     # @param [Hash] opts the optional parameters
@@ -566,7 +566,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Update partial existing task
+    # Update a task
     # @param id 
     # @param body Updated task details.
     # @param [Hash] opts the optional parameters
@@ -614,7 +614,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Create a new Task
+    # Create a task
     # @param body Task name.
     # @param [Hash] opts the optional parameters
     # @return [Task]
@@ -623,7 +623,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Create a new Task
+    # Create a task
     # @param body Task name.
     # @param [Hash] opts the optional parameters
     # @return [Array<(Task, Fixnum, Hash)>] Task data, response status code and response headers
@@ -666,5 +666,51 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
+    # Get all task types
+    # @param [Hash] opts the optional parameters
+    # @return [TaskTypes]
+    def crm_tasktypes_get(opts = {})
+      data, _status_code, _headers = crm_tasktypes_get_with_http_info(opts)
+      data
+    end
+
+    # Get all task types
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TaskTypes, Fixnum, Hash)>] TaskTypes data, response status code and response headers
+    def crm_tasktypes_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CRMApi.crm_tasktypes_get ...'
+      end
+      # resource path
+      local_var_path = '/crm/tasktypes'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api-key', 'partner-key']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'TaskTypes')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CRMApi#crm_tasktypes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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

@@ -140,6 +140,57 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
+    # Delete a sub-account
+    # @param id Id of the sub-account organization to be deleted
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def corporate_sub_account_id_delete(id, opts = {})
+      corporate_sub_account_id_delete_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a sub-account
+    # @param id Id of the sub-account organization to be deleted
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def corporate_sub_account_id_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MasterAccountApi.corporate_sub_account_id_delete ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling MasterAccountApi.corporate_sub_account_id_delete"
+      end
+      # resource path
+      local_var_path = '/corporate/subAccount/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api-key', 'partner-key']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MasterAccountApi#corporate_sub_account_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Get sub-account details
     # This endpoint will provide the details of specified sub-account organization
     # @param id Id of the sub-account organization

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

@@ -438,8 +438,8 @@ module SibApiV3Sdk
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be smaller than or equal to 100.'
       end
 
-      if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error'].include?(opts[:'event'])
-        fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed, error'
+      if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error', 'loadedByProxy'].include?(opts[:'event'])
+        fail ArgumentError, 'invalid value for "event", must be one of bounces, hardBounces, softBounces, delivered, spam, requests, opened, clicks, invalid, deferred, blocked, unsubscribed, error, loadedByProxy'
       end
       if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
         fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'

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

@@ -17,6 +17,9 @@ module SibApiV3Sdk
     # Name of the organization
     attr_accessor :company_name
 
+    # Email address for the organization
+    attr_accessor :email
+
     # Language for identifying localization information
     attr_accessor :language
 
@@ -49,6 +52,7 @@ module SibApiV3Sdk
     def self.attribute_map
       {
         :'company_name' => :'companyName',
+        :'email' => :'email',
         :'language' => :'language',
         :'timezone' => :'timezone'
       }
@@ -58,6 +62,7 @@ module SibApiV3Sdk
     def self.swagger_types
       {
         :'company_name' => :'String',
+        :'email' => :'String',
         :'language' => :'String',
         :'timezone' => :'String'
       }
@@ -75,6 +80,10 @@ module SibApiV3Sdk
         self.company_name = attributes[:'companyName']
       end
 
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
       if attributes.has_key?(:'language')
         self.language = attributes[:'language']
       end
@@ -92,6 +101,10 @@ module SibApiV3Sdk
         invalid_properties.push('invalid value for "company_name", company_name cannot be nil.')
       end
 
+      if @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -99,6 +112,7 @@ module SibApiV3Sdk
     # @return true if the model is valid
     def valid?
       return false if @company_name.nil?
+      return false if @email.nil?
       language_validator = EnumAttributeValidator.new('String', ['en', 'fr', 'it', 'es', 'pt', 'de'])
       return false unless language_validator.valid?(@language)
       true
@@ -120,6 +134,7 @@ module SibApiV3Sdk
       return true if self.equal?(o)
       self.class == o.class &&
           company_name == o.company_name &&
+          email == o.email &&
           language == o.language &&
           timezone == o.timezone
     end
@@ -133,7 +148,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [company_name, language, timezone].hash
+      [company_name, email, language, timezone].hash
     end
 
     # Builds the object from hash

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

@@ -186,7 +186,7 @@ module SibApiV3Sdk
       return false if @date.nil?
       return false if @message_id.nil?
       return false if @event.nil?
-      event_validator = EnumAttributeValidator.new('String', ['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error'])
+      event_validator = EnumAttributeValidator.new('String', ['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error', 'loadedByProxy'])
       return false unless event_validator.valid?(@event)
       true
     end
@@ -194,7 +194,7 @@ module SibApiV3Sdk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event Object to be assigned
     def event=(event)
-      validator = EnumAttributeValidator.new('String', ['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error'])
+      validator = EnumAttributeValidator.new('String', ['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error', 'loadedByProxy'])
       unless validator.valid?(event)
         fail ArgumentError, 'invalid value for "event", must be one of #{validator.allowable_values}.'
       end

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

@@ -14,12 +14,15 @@ require 'date'
 
 module SibApiV3Sdk
   class RequestContactImport
-    # Mandatory if fileBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv
+    # Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json
     attr_accessor :file_url
 
-    # Mandatory if fileUrl is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.
+    # Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.
     attr_accessor :file_body
 
+    # **Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files. 
+    attr_accessor :json_body
+
     # Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].
     attr_accessor :list_ids
 
@@ -45,6 +48,7 @@ module SibApiV3Sdk
       {
         :'file_url' => :'fileUrl',
         :'file_body' => :'fileBody',
+        :'json_body' => :'jsonBody',
         :'list_ids' => :'listIds',
         :'notify_url' => :'notifyUrl',
         :'new_list' => :'newList',
@@ -60,6 +64,7 @@ module SibApiV3Sdk
       {
         :'file_url' => :'String',
         :'file_body' => :'String',
+        :'json_body' => :'Array<Hash<String, Object>>',
         :'list_ids' => :'Array<Integer>',
         :'notify_url' => :'String',
         :'new_list' => :'RequestContactImportNewList',
@@ -86,6 +91,12 @@ module SibApiV3Sdk
         self.file_body = attributes[:'fileBody']
       end
 
+      if attributes.has_key?(:'jsonBody')
+        if (value = attributes[:'jsonBody']).is_a?(Array)
+          self.json_body = value
+        end
+      end
+
       if attributes.has_key?(:'listIds')
         if (value = attributes[:'listIds']).is_a?(Array)
           self.list_ids = value
@@ -145,6 +156,7 @@ module SibApiV3Sdk
       self.class == o.class &&
           file_url == o.file_url &&
           file_body == o.file_body &&
+          json_body == o.json_body &&
           list_ids == o.list_ids &&
           notify_url == o.notify_url &&
           new_list == o.new_list &&
@@ -163,7 +175,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [file_url, file_body, list_ids, notify_url, new_list, email_blacklist, sms_blacklist, update_existing_contacts, empty_contacts_attributes].hash
+      [file_url, file_body, json_body, list_ids, notify_url, new_list, email_blacklist, sms_blacklist, update_existing_contacts, empty_contacts_attributes].hash
     end
 
     # Builds the object from hash

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

@@ -36,19 +36,19 @@ module SibApiV3Sdk
 
     attr_accessor :reply_to
 
-    # Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv and pkpass ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored )
+    # Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored )
     attr_accessor :attachment
 
     # Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`.
     attr_accessor :headers
 
-    # Id of the template. Mandatory if messageVersions are passed
+    # Id of the template.
     attr_accessor :template_id
 
     # Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format.
     attr_accessor :params
 
-    # You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 200. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails
+    # You can customize and send out multiple versions of a mail. templateId can be customized only if global parameter contains templateId. htmlContent and textContent can be customized only if any of the two, htmlContent or textContent, is present in global parameters. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 2000. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails
     attr_accessor :message_versions
 
     # Tag your emails to find them more easily