sib-api-v3-sdk 2.0.1 → 2.1.0

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

@@ -193,26 +193,26 @@ module SibApiV3Sdk
 
     # Create a folder
     # 
-    # @param name Name of the folder
+    # @param create_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [CreateModel]
-    def create_folder(name, opts = {})
-      data, _status_code, _headers = create_folder_with_http_info(name, opts)
+    def create_folder(create_folder, opts = {})
+      data, _status_code, _headers = create_folder_with_http_info(create_folder, opts)
       return data
     end
 
     # Create a folder
     # 
-    # @param name Name of the folder
+    # @param create_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
-    def create_folder_with_http_info(name, opts = {})
+    def create_folder_with_http_info(create_folder, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ContactsApi.create_folder ..."
       end
-      # verify the required parameter 'name' is set
-      if @api_client.config.client_side_validation && name.nil?
-        fail ArgumentError, "Missing the required parameter 'name' when calling ContactsApi.create_folder"
+      # verify the required parameter 'create_folder' is set
+      if @api_client.config.client_side_validation && create_folder.nil?
+        fail ArgumentError, "Missing the required parameter 'create_folder' when calling ContactsApi.create_folder"
       end
       # resource path
       local_var_path = "/contacts/folders"
@@ -231,7 +231,7 @@ module SibApiV3Sdk
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(name)
+      post_body = @api_client.object_to_http_body(create_folder)
       auth_names = ['api-key']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -685,7 +685,7 @@ module SibApiV3Sdk
     # 
     # @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 [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
     # @option opts [Integer] :limit Number of documents per page (default to 50)
     # @option opts [Integer] :offset Index of the first document of the page (default to 0)
     # @return [GetContacts]
@@ -698,7 +698,7 @@ module SibApiV3Sdk
     # 
     # @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 [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
     # @option opts [Integer] :limit Number of documents per page
     # @option opts [Integer] :offset Index of the first document of the page
     # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
@@ -710,10 +710,6 @@ module SibApiV3Sdk
       if @api_client.config.client_side_validation && list_id.nil?
         fail ArgumentError, "Missing the required parameter 'list_id' when calling ContactsApi.get_contacts_from_list"
       end
-      if @api_client.config.client_side_validation && !opts[:'modified_since'].nil? && opts[:'modified_since'] !~ Regexp.new(/YYYY-MM-DD HH:mm:ss/)
-        fail ArgumentError, "invalid value for 'opts[:\"modified_since\"]' when calling ContactsApi.get_contacts_from_list, must conform to the pattern /YYYY-MM-DD HH:mm:ss/."
-      end
-
       if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts_from_list, must be smaller than or equal to 500.'
       end
@@ -1288,21 +1284,21 @@ module SibApiV3Sdk
     # Update a contact folder
     # 
     # @param folder_id Id of the folder
-    # @param name Name of the folder
+    # @param update_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def update_folder(folder_id, name, opts = {})
-      update_folder_with_http_info(folder_id, name, opts)
+    def update_folder(folder_id, update_folder, opts = {})
+      update_folder_with_http_info(folder_id, update_folder, opts)
       return nil
     end
 
     # Update a contact folder
     # 
     # @param folder_id Id of the folder
-    # @param name Name of the folder
+    # @param update_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def update_folder_with_http_info(folder_id, name, opts = {})
+    def update_folder_with_http_info(folder_id, update_folder, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: ContactsApi.update_folder ..."
       end
@@ -1310,9 +1306,9 @@ module SibApiV3Sdk
       if @api_client.config.client_side_validation && folder_id.nil?
         fail ArgumentError, "Missing the required parameter 'folder_id' when calling ContactsApi.update_folder"
       end
-      # verify the required parameter 'name' is set
-      if @api_client.config.client_side_validation && name.nil?
-        fail ArgumentError, "Missing the required parameter 'name' when calling ContactsApi.update_folder"
+      # verify the required parameter 'update_folder' is set
+      if @api_client.config.client_side_validation && update_folder.nil?
+        fail ArgumentError, "Missing the required parameter 'update_folder' when calling ContactsApi.update_folder"
       end
       # resource path
       local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
@@ -1331,7 +1327,7 @@ module SibApiV3Sdk
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(name)
+      post_body = @api_client.object_to_http_body(update_folder)
       auth_names = ['api-key']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,

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

@@ -22,26 +22,26 @@ module SibApiV3Sdk
 
     # Create a folder
     # 
-    # @param name Name of the folder
+    # @param create_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [CreateModel]
-    def create_folder(name, opts = {})
-      data, _status_code, _headers = create_folder_with_http_info(name, opts)
+    def create_folder(create_folder, opts = {})
+      data, _status_code, _headers = create_folder_with_http_info(create_folder, opts)
       return data
     end
 
     # Create a folder
     # 
-    # @param name Name of the folder
+    # @param create_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
-    def create_folder_with_http_info(name, opts = {})
+    def create_folder_with_http_info(create_folder, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: FoldersApi.create_folder ..."
       end
-      # verify the required parameter 'name' is set
-      if @api_client.config.client_side_validation && name.nil?
-        fail ArgumentError, "Missing the required parameter 'name' when calling FoldersApi.create_folder"
+      # verify the required parameter 'create_folder' is set
+      if @api_client.config.client_side_validation && create_folder.nil?
+        fail ArgumentError, "Missing the required parameter 'create_folder' when calling FoldersApi.create_folder"
       end
       # resource path
       local_var_path = "/contacts/folders"
@@ -60,7 +60,7 @@ module SibApiV3Sdk
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(name)
+      post_body = @api_client.object_to_http_body(create_folder)
       auth_names = ['api-key']
       data, status_code, headers = @api_client.call_api(:POST, local_var_path,
         :header_params => header_params,
@@ -319,21 +319,21 @@ module SibApiV3Sdk
     # Update a contact folder
     # 
     # @param folder_id Id of the folder
-    # @param name Name of the folder
+    # @param update_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def update_folder(folder_id, name, opts = {})
-      update_folder_with_http_info(folder_id, name, opts)
+    def update_folder(folder_id, update_folder, opts = {})
+      update_folder_with_http_info(folder_id, update_folder, opts)
       return nil
     end
 
     # Update a contact folder
     # 
     # @param folder_id Id of the folder
-    # @param name Name of the folder
+    # @param update_folder Name of the folder
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
-    def update_folder_with_http_info(folder_id, name, opts = {})
+    def update_folder_with_http_info(folder_id, update_folder, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: FoldersApi.update_folder ..."
       end
@@ -341,9 +341,9 @@ module SibApiV3Sdk
       if @api_client.config.client_side_validation && folder_id.nil?
         fail ArgumentError, "Missing the required parameter 'folder_id' when calling FoldersApi.update_folder"
       end
-      # verify the required parameter 'name' is set
-      if @api_client.config.client_side_validation && name.nil?
-        fail ArgumentError, "Missing the required parameter 'name' when calling FoldersApi.update_folder"
+      # verify the required parameter 'update_folder' is set
+      if @api_client.config.client_side_validation && update_folder.nil?
+        fail ArgumentError, "Missing the required parameter 'update_folder' when calling FoldersApi.update_folder"
       end
       # resource path
       local_var_path = "/contacts/folders/{folderId}".sub('{' + 'folderId' + '}', folder_id.to_s)
@@ -362,7 +362,7 @@ module SibApiV3Sdk
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(name)
+      post_body = @api_client.object_to_http_body(update_folder)
       auth_names = ['api-key']
       data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
         :header_params => header_params,

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

@@ -194,7 +194,7 @@ module SibApiV3Sdk
     # 
     # @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 [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
     # @option opts [Integer] :limit Number of documents per page (default to 50)
     # @option opts [Integer] :offset Index of the first document of the page (default to 0)
     # @return [GetContacts]
@@ -207,7 +207,7 @@ module SibApiV3Sdk
     # 
     # @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 [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given date-time (YYYY-MM-DDTHH:mm:ss.SSSZ)
     # @option opts [Integer] :limit Number of documents per page
     # @option opts [Integer] :offset Index of the first document of the page
     # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
@@ -219,10 +219,6 @@ module SibApiV3Sdk
       if @api_client.config.client_side_validation && list_id.nil?
         fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.get_contacts_from_list"
       end
-      if @api_client.config.client_side_validation && !opts[:'modified_since'].nil? && opts[:'modified_since'] !~ Regexp.new(/YYYY-MM-DD HH:mm:ss/)
-        fail ArgumentError, "invalid value for 'opts[:\"modified_since\"]' when calling ListsApi.get_contacts_from_list, must conform to the pattern /YYYY-MM-DD HH:mm:ss/."
-      end
-
       if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ListsApi.get_contacts_from_list, must be smaller than or equal to 500.'
       end

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

@@ -198,7 +198,7 @@ module SibApiV3Sdk
     # @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
+    # @option opts [Integer] :template_id Filter on a specific template id
     # @return [GetEmailEventReport]
     def get_email_event_report(opts = {})
       data, _status_code, _headers = get_email_event_report_with_http_info(opts)
@@ -217,7 +217,7 @@ module SibApiV3Sdk
     # @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
+    # @option opts [Integer] :template_id Filter on a specific template id
     # @return [Array<(GetEmailEventReport, Fixnum, Hash)>] GetEmailEventReport data, response status code and response headers
     def get_email_event_report_with_http_info(opts = {})
       if @api_client.config.debugging

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

@@ -29,7 +29,7 @@ module SibApiV3Sdk
     # Mandatory if htmlContent is empty. Url to the message (HTML)
     attr_accessor :html_url
 
-    # Sending date and time (YYYY-MM-DD HH:mm:ss)
+    # Sending date and time (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :scheduled_at
 
     # Subject of the campaign
@@ -121,7 +121,7 @@ module SibApiV3Sdk
         :'name' => :'String',
         :'html_content' => :'String',
         :'html_url' => :'String',
-        :'scheduled_at' => :'String',
+        :'scheduled_at' => :'DateTime',
         :'subject' => :'String',
         :'reply_to' => :'String',
         :'to_field' => :'String',
@@ -231,10 +231,6 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'name', name cannot be nil.")
       end
 
-      if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
-        invalid_properties.push("invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
-      end
-
       if @subject.nil?
         invalid_properties.push("invalid value for 'subject', subject cannot be nil.")
       end
@@ -250,7 +246,6 @@ module SibApiV3Sdk
     # @return true if the model is valid
     def valid?
       return false if @name.nil?
-      return false if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
       return false if @subject.nil?
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["classic", "trigger"])
@@ -258,17 +253,6 @@ module SibApiV3Sdk
       return true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] scheduled_at Value to be assigned
-    def scheduled_at=(scheduled_at)
-
-      if !scheduled_at.nil? && scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
-        fail ArgumentError, "invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
-      end
-
-      @scheduled_at = scheduled_at
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)

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

@@ -26,7 +26,7 @@ module SibApiV3Sdk
 
     attr_accessor :recipients
 
-    # Date and time on which the campaign has to run (YYYY-MM-DD HH:mm:ss)
+    # Date and time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :scheduled_at
 
 
@@ -48,7 +48,7 @@ module SibApiV3Sdk
         :'sender' => :'String',
         :'content' => :'String',
         :'recipients' => :'CreateSmsCampaignRecipients',
-        :'scheduled_at' => :'String'
+        :'scheduled_at' => :'DateTime'
       }
     end
 
@@ -98,10 +98,6 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'sender', the character length must be smaller than or equal to 11.")
       end
 
-      if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
-        invalid_properties.push("invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
-      end
-
       return invalid_properties
     end
 
@@ -111,7 +107,6 @@ module SibApiV3Sdk
       return false if @name.nil?
       return false if @sender.nil?
       return false if @sender.to_s.length > 11
-      return false if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
       return true
     end
 
@@ -129,17 +124,6 @@ module SibApiV3Sdk
       @sender = sender
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] scheduled_at Value to be assigned
-    def scheduled_at=(scheduled_at)
-
-      if !scheduled_at.nil? && scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
-        fail ArgumentError, "invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
-      end
-
-      @scheduled_at = scheduled_at
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/sib-api-v3-sdk/models/{crea_update_folder.rb → create_update_folder.rb}

@@ -14,7 +14,7 @@ require 'date'
 
 module SibApiV3Sdk
 
-  class CreaUpdateFolder
+  class CreateUpdateFolder
     # Name of the folder
     attr_accessor :name
 

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

@@ -24,6 +24,12 @@ module SibApiV3Sdk
     # Remaining credits of the user. This can either be \"User Limit\" or \"Send Limit\" depending on the plan.
     attr_accessor :credits
 
+    # Date of the period from which the plan will start (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type)
+    attr_accessor :start_date
+
+    # Date of the period from which the plan will end (only available for \"subscription\", \"unlimited\" and \"reseller\" plan type)
+    attr_accessor :end_date
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +57,9 @@ module SibApiV3Sdk
       {
         :'type' => :'type',
         :'credits_type' => :'creditsType',
-        :'credits' => :'credits'
+        :'credits' => :'credits',
+        :'start_date' => :'startDate',
+        :'end_date' => :'endDate'
       }
     end
 
@@ -60,7 +68,9 @@ module SibApiV3Sdk
       {
         :'type' => :'String',
         :'credits_type' => :'String',
-        :'credits' => :'Float'
+        :'credits' => :'Float',
+        :'start_date' => :'Date',
+        :'end_date' => :'Date'
       }
     end
 
@@ -84,6 +94,14 @@ module SibApiV3Sdk
         self.credits = attributes[:'credits']
       end
 
+      if attributes.has_key?(:'startDate')
+        self.start_date = attributes[:'startDate']
+      end
+
+      if attributes.has_key?(:'endDate')
+        self.end_date = attributes[:'endDate']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -145,7 +163,9 @@ module SibApiV3Sdk
       self.class == o.class &&
           type == o.type &&
           credits_type == o.credits_type &&
-          credits == o.credits
+          credits == o.credits &&
+          start_date == o.start_date &&
+          end_date == o.end_date
     end
 
     # @see the `==` method
@@ -157,7 +177,7 @@ module SibApiV3Sdk
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, credits_type, credits].hash
+      [type, credits_type, credits, start_date, end_date].hash
     end
 
     # Builds the object from hash

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

@@ -30,7 +30,7 @@ module SibApiV3Sdk
     # Status of the campaign
     attr_accessor :status
 
-    # Date on which campaign is scheduled (YYYY-MM-DD HH:mm:ss)
+    # Date on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
     attr_accessor :scheduled_at
 
     class EnumAttributeValidator
@@ -75,7 +75,7 @@ module SibApiV3Sdk
         :'subject' => :'String',
         :'type' => :'String',
         :'status' => :'String',
-        :'scheduled_at' => :'String'
+        :'scheduled_at' => :'DateTime'
       }
     end
 
@@ -137,10 +137,6 @@ module SibApiV3Sdk
         invalid_properties.push("invalid value for 'status', status cannot be nil.")
       end
 
-      if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
-        invalid_properties.push("invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/.")
-      end
-
       return invalid_properties
     end
 
@@ -156,7 +152,6 @@ module SibApiV3Sdk
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["draft", "sent", "archive", "queued", "suspended", "in_process"])
       return false unless status_validator.valid?(@status)
-      return false if !@scheduled_at.nil? && @scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
       return true
     end
 
@@ -180,17 +175,6 @@ module SibApiV3Sdk
       @status = status
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] scheduled_at Value to be assigned
-    def scheduled_at=(scheduled_at)
-
-      if !scheduled_at.nil? && scheduled_at !~ Regexp.new(/^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/)
-        fail ArgumentError, "invalid value for 'scheduled_at', must conform to the pattern /^([1-9]\d{3}-\d{2}-\d{2} [0-2]\d:[0-5]\d:[0-5]\d)?$/."
-      end
-
-      @scheduled_at = scheduled_at
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)