sib-api-v3-sdk 7.2.0 → 8.0.0

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

@@ -6,7 +6,7 @@
 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
+Swagger Codegen version: 2.4.19
 
 =end
 
@@ -622,6 +622,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
     # Get a contact's details
+    # Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
     # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
     # @param [Hash] opts the optional parameters
     # @return [GetExtendedContactDetails]
@@ -631,6 +632,7 @@ module SibApiV3Sdk
     end
 
     # Get a contact's details
+    # Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats (https://developers.sendinblue.com/reference/contacts-7#getcontactstats) endpoint with the appropriate date ranges.
     # @param identifier Email (urlencoded) OR ID of the contact OR its SMS attribute value
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetExtendedContactDetails, Fixnum, Hash)>] GetExtendedContactDetails data, response status code and response headers
@@ -676,8 +678,8 @@ module SibApiV3Sdk
     # Get email campaigns' statistics for a 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
+    # @option opts [String] :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 [String] :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. Maximum difference between startDate and endDate should not be greater than 90 days
     # @return [GetContactCampaignStats]
     def get_contact_stats(identifier, opts = {})
       data, _status_code, _headers = get_contact_stats_with_http_info(identifier, opts)
@@ -687,8 +689,8 @@ module SibApiV3Sdk
     # Get email campaigns&#39; statistics for a 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
+    # @option opts [String] :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 [String] :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. Maximum difference between startDate and endDate should not be greater than 90 days
     # @return [Array<(GetContactCampaignStats, Fixnum, Hash)>] GetContactCampaignStats data, response status code and response headers
     def get_contact_stats_with_http_info(identifier, opts = {})
       if @api_client.config.debugging
@@ -735,8 +737,8 @@ module SibApiV3Sdk
     # @param [Hash] opts the optional parameters
     # @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)
-    # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
+    # @option opts [String] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
     # @return [GetContacts]
     def get_contacts(opts = {})
       data, _status_code, _headers = get_contacts_with_http_info(opts)
@@ -747,8 +749,8 @@ module SibApiV3Sdk
     # @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
-    # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
+    # @option opts [String] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
     # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
     def get_contacts_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -799,10 +801,10 @@ module SibApiV3Sdk
     # Get contacts in a list
     # @param list_id Id of the list
     # @param [Hash] opts the optional parameters
-    # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+    # @option opts [String] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
     # @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)
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
     # @return [GetContacts]
     def get_contacts_from_list(list_id, opts = {})
       data, _status_code, _headers = get_contacts_from_list_with_http_info(list_id, opts)
@@ -812,10 +814,10 @@ module SibApiV3Sdk
     # Get contacts in a list
     # @param list_id Id of the list
     # @param [Hash] opts the optional parameters
-    # @option opts [DateTime] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
+    # @option opts [String] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
     # @option opts [Integer] :limit Number of documents per page
     # @option opts [Integer] :offset Index of the first document of the page
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
     # @return [Array<(GetContacts, Fixnum, Hash)>] GetContacts data, response status code and response headers
     def get_contacts_from_list_with_http_info(list_id, opts = {})
       if @api_client.config.debugging
@@ -924,7 +926,7 @@ module SibApiV3Sdk
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents per page (default to 10)
     # @option opts [Integer] :offset Index of the first document of the page (default to 0)
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
     # @return [GetFolderLists]
     def get_folder_lists(folder_id, opts = {})
       data, _status_code, _headers = get_folder_lists_with_http_info(folder_id, opts)
@@ -936,7 +938,7 @@ module SibApiV3Sdk
     # @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
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
     # @return [Array<(GetFolderLists, Fixnum, Hash)>] GetFolderLists data, response status code and response headers
     def get_folder_lists_with_http_info(folder_id, opts = {})
       if @api_client.config.debugging
@@ -991,7 +993,7 @@ module SibApiV3Sdk
     # @param limit Number of documents per page
     # @param offset Index of the first document of the page
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
     # @return [GetFolders]
     def get_folders(limit, offset, opts = {})
       data, _status_code, _headers = get_folders_with_http_info(limit, offset, opts)
@@ -1002,7 +1004,7 @@ module SibApiV3Sdk
     # @param limit Number of documents per page
     # @param offset Index of the first document of the page
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
     # @return [Array<(GetFolders, Fixnum, Hash)>] GetFolders data, response status code and response headers
     def get_folders_with_http_info(limit, offset, opts = {})
       if @api_client.config.debugging
@@ -1113,7 +1115,7 @@ module SibApiV3Sdk
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents per page (default to 10)
     # @option opts [Integer] :offset Index of the first document of the page (default to 0)
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed (default to desc)
     # @return [GetLists]
     def get_lists(opts = {})
       data, _status_code, _headers = get_lists_with_http_info(opts)
@@ -1124,7 +1126,7 @@ module SibApiV3Sdk
     # @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
-    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if &#x60;sort&#x60; is not passed
     # @return [Array<(GetLists, Fixnum, Hash)>] GetLists data, response status code and response headers
     def get_lists_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1404,6 +1406,57 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
+    # Update multiple contacts
+    # @param update_batch_contacts Values to update multiple contacts
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_batch_contacts(update_batch_contacts, opts = {})
+      update_batch_contacts_with_http_info(update_batch_contacts, opts)
+      nil
+    end
+
+    # Update multiple contacts
+    # @param update_batch_contacts Values to update multiple contacts
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_batch_contacts_with_http_info(update_batch_contacts, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContactsApi.update_batch_contacts ...'
+      end
+      # verify the required parameter 'update_batch_contacts' is set
+      if @api_client.config.client_side_validation && update_batch_contacts.nil?
+        fail ArgumentError, "Missing the required parameter 'update_batch_contacts' when calling ContactsApi.update_batch_contacts"
+      end
+      # resource path
+      local_var_path = '/contacts/batch'
+
+      # 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 = @api_client.object_to_http_body(update_batch_contacts)
+      auth_names = ['api-key', 'partner-key']
+      data, status_code, headers = @api_client.call_api(:POST, 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: ContactsApi#update_batch_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update a contact
     # @param identifier Email (urlencoded) OR ID of the contact
     # @param update_contact Values to update a contact