sib-api-v3-sdk 5.3.0 → 5.4.0

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

@@ -122,7 +122,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Export the recipients of a campaign
+    # Export the recipients of an email 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
@@ -132,7 +132,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Export the recipients of a campaign
+    # Export the recipients of an email 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
@@ -176,7 +176,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get A/B test email campaign result
+    # Get an A/B test email campaign results
     # Obtain winning version of an A/B test email campaign
     # @param campaign_id Id of the A/B test campaign
     # @param [Hash] opts the optional parameters
@@ -186,7 +186,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get A/B test email campaign result
+    # Get an A/B test email campaign results
     # Obtain winning version of an A/B test email campaign
     # @param campaign_id Id of the A/B test campaign
     # @param [Hash] opts the optional parameters
@@ -230,7 +230,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get campaign informations
+    # Get an email campaign report
     # @param campaign_id Id of the campaign
     # @param [Hash] opts the optional parameters
     # @return [GetEmailCampaign]
@@ -239,7 +239,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get campaign informations
+    # Get an email campaign report
     # @param campaign_id Id of the campaign
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetEmailCampaign, Fixnum, Hash)>] GetEmailCampaign data, response status code and response headers
@@ -282,7 +282,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Return all your created campaigns
+    # Return all your created email 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
@@ -296,7 +296,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Return all your created campaigns
+    # Return all your created email 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
@@ -461,7 +461,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Send the report of a campaigns
+    # Send the report of a campaign
     # 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
@@ -472,7 +472,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Send the report of a campaigns
+    # Send the report of a campaign
     # 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
@@ -577,7 +577,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Update a campaign status
+    # Update an email campaign status
     # @param campaign_id Id of the campaign
     # @param status Status of the campaign
     # @param [Hash] opts the optional parameters
@@ -587,7 +587,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Update a campaign status
+    # Update an email campaign status
     # @param campaign_id Id of the campaign
     # @param status Status of the campaign
     # @param [Hash] opts the optional parameters
@@ -634,7 +634,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Update a campaign
+    # Update an email campaign
     # @param campaign_id Id of the campaign
     # @param email_campaign Values to update a campaign
     # @param [Hash] opts the optional parameters
@@ -644,7 +644,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Update a campaign
+    # Update an email campaign
     # @param campaign_id Id of the campaign
     # @param email_campaign Values to update a campaign
     # @param [Hash] opts the optional parameters
@@ -691,5 +691,56 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
+    # Upload an image to your account's image gallery
+    # @param upload_image Parameters to upload an image
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def upload_image_to_gallery(upload_image, opts = {})
+      upload_image_to_gallery_with_http_info(upload_image, opts)
+      nil
+    end
+
+    # Upload an image to your account&#39;s image gallery
+    # @param upload_image Parameters to upload an image
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def upload_image_to_gallery_with_http_info(upload_image, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailCampaignsApi.upload_image_to_gallery ...'
+      end
+      # verify the required parameter 'upload_image' is set
+      if @api_client.config.client_side_validation && upload_image.nil?
+        fail ArgumentError, "Missing the required parameter 'upload_image' when calling EmailCampaignsApi.upload_image_to_gallery"
+      end
+      # resource path
+      local_var_path = '/emailCampaigns/images'
+
+      # 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(upload_image)
+      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: EmailCampaignsApi#upload_image_to_gallery\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/folders_api.rb

@@ -122,7 +122,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Returns folder details
+    # Returns a folder's details
     # @param folder_id id of the folder
     # @param [Hash] opts the optional parameters
     # @return [GetFolder]
@@ -131,7 +131,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Returns folder details
+    # Returns a folder's details
     # @param folder_id id of the folder
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetFolder, Fixnum, Hash)>] GetFolder data, response status code and response headers
@@ -174,7 +174,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get the lists in a folder
+    # Get 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 (default to 10)
@@ -185,7 +185,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get the lists in a folder
+    # Get 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
@@ -236,7 +236,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get all the folders
+    # Get all folders
     # @param limit Number of documents per page
     # @param offset Index of the first document of the page
     # @param [Hash] opts the optional parameters
@@ -246,7 +246,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get all the folders
+    # Get all folders
     # @param limit Number of documents per page
     # @param offset Index of the first document of the page
     # @param [Hash] opts the optional parameters
@@ -300,7 +300,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Update a contact folder
+    # Update a folder
     # @param folder_id Id of the folder
     # @param update_folder Name of the folder
     # @param [Hash] opts the optional parameters
@@ -310,7 +310,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Update a contact folder
+    # Update a folder
     # @param folder_id Id of the folder
     # @param update_folder Name of the folder
     # @param [Hash] opts the optional parameters

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

@@ -180,7 +180,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get the contacts in a list
+    # 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.
@@ -192,7 +192,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get the contacts in a list
+    # 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.
@@ -245,7 +245,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get the lists in a folder
+    # Get 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 (default to 10)
@@ -256,7 +256,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get the lists in a folder
+    # Get 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
@@ -307,7 +307,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Get the details of a list
+    # Get a list's details
     # @param list_id Id of the list
     # @param [Hash] opts the optional parameters
     # @return [GetExtendedList]
@@ -316,7 +316,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Get the details of a list
+    # Get a list's details
     # @param list_id Id of the list
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetExtendedList, Fixnum, Hash)>] GetExtendedList data, response status code and response headers
@@ -415,7 +415,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Remove existing contacts from a list
+    # Delete a contact from a list
     # @param list_id Id of the list
     # @param contact_emails Emails adresses of the contact
     # @param [Hash] opts the optional parameters
@@ -425,7 +425,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Remove existing contacts from a list
+    # Delete a contact from a list
     # @param list_id Id of the list
     # @param contact_emails Emails adresses of the contact
     # @param [Hash] opts the optional parameters

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

@@ -134,7 +134,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Creates a domain for a child account
+    # Create a domain for a child account
     # @param child_auth_key auth key of reseller's child
     # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
     # @param [Hash] opts the optional parameters
@@ -144,7 +144,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Creates a domain for a child account
+    # Create a domain for a child account
     # @param child_auth_key auth key of reseller's child
     # @param add_child_domain Sender domain to add for a specific child account. This will not be displayed to the parent account.
     # @param [Hash] opts the optional parameters
@@ -239,7 +239,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
+    # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
     # @param child_auth_key auth key of reseller's child
     # @param domain_name Pass the existing domain that needs to be deleted
     # @param [Hash] opts the optional parameters
@@ -249,7 +249,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Deletes the sender domain of the reseller child based on the childAuthKey and domainName passed
+    # Delete the sender domain of the reseller child based on the childAuthKey and domainName passed
     # @param child_auth_key auth key of reseller's child
     # @param domain_name Pass the existing domain that needs to be deleted
     # @param [Hash] opts the optional parameters
@@ -296,7 +296,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Deletes a single reseller child based on the childAuthKey supplied
+    # Delete a single reseller child based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller's child
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -305,7 +305,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Deletes a single reseller child based on the childAuthKey supplied
+    # Delete a single reseller child based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller's child
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
@@ -404,7 +404,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Returns the status of reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
+    # Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller&#39;s child
     # @param [Hash] opts the optional parameters
     # @return [GetChildAccountCreationStatus]
@@ -413,7 +413,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Returns the status of reseller&#39;s child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
+    # Get the status of a reseller&#39;s child account creation, whether it is successfully created (exists) or not based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller&#39;s child
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetChildAccountCreationStatus, Fixnum, Hash)>] GetChildAccountCreationStatus data, response status code and response headers
@@ -456,7 +456,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Gets all the sender domains of a specific child account
+    # Get all sender domains for a specific child account
     # @param child_auth_key auth key of reseller&#39;s child
     # @param [Hash] opts the optional parameters
     # @return [GetChildDomains]
@@ -465,7 +465,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Gets all the sender domains of a specific child account
+    # Get all sender domains for a specific child account
     # @param child_auth_key auth key of reseller&#39;s child
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetChildDomains, Fixnum, Hash)>] GetChildDomains data, response status code and response headers
@@ -508,7 +508,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Gets the info about a specific child account
+    # Get a child account's details
     # @param child_auth_key auth key of reseller&#39;s child
     # @param [Hash] opts the optional parameters
     # @return [GetChildInfo]
@@ -517,7 +517,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Gets the info about a specific child account
+    # Get a child account&#39;s details
     # @param child_auth_key auth key of reseller&#39;s child
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetChildInfo, Fixnum, Hash)>] GetChildInfo data, response status code and response headers
@@ -560,7 +560,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Gets the list of all reseller's children accounts
+    # Get the list of all children accounts
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents for child accounts information per page (default to 10)
     # @option opts [Integer] :offset Index of the first document in the page (default to 0)
@@ -570,7 +570,7 @@ module SibApiV3Sdk
       data
     end
 
-    # Gets the list of all reseller&#39;s children accounts
+    # Get the list of all children accounts
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents for child accounts information per page
     # @option opts [Integer] :offset Index of the first document in the page
@@ -728,7 +728,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Updates infos of reseller's child account status based on the childAuthKey supplied
+    # Update info of reseller's child account status based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller&#39;s child
     # @param update_child_account_status values to update in child account status
     # @param [Hash] opts the optional parameters
@@ -738,7 +738,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Updates infos of reseller&#39;s child account status based on the childAuthKey supplied
+    # Update info of reseller&#39;s child account status based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller&#39;s child
     # @param update_child_account_status values to update in child account status
     # @param [Hash] opts the optional parameters
@@ -785,7 +785,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Updates the sender domain of reseller's child based on the childAuthKey and domainName passed
+    # Update the sender domain of reseller's child based on the childAuthKey and domainName passed
     # @param child_auth_key auth key of reseller&#39;s child
     # @param domain_name Pass the existing domain that needs to be updated
     # @param update_child_domain value to update for sender domain
@@ -796,7 +796,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Updates the sender domain of reseller&#39;s child based on the childAuthKey and domainName passed
+    # Update the sender domain of reseller&#39;s child based on the childAuthKey and domainName passed
     # @param child_auth_key auth key of reseller&#39;s child
     # @param domain_name Pass the existing domain that needs to be updated
     # @param update_child_domain value to update for sender domain
@@ -848,7 +848,7 @@ module SibApiV3Sdk
       end
       return data, status_code, headers
     end
-    # Updates infos of reseller's child based on the childAuthKey supplied
+    # Update info of reseller's child based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller&#39;s child
     # @param reseller_child values to update in child profile
     # @param [Hash] opts the optional parameters
@@ -858,7 +858,7 @@ module SibApiV3Sdk
       nil
     end
 
-    # Updates infos of reseller&#39;s child based on the childAuthKey supplied
+    # Update info of reseller&#39;s child based on the childAuthKey supplied
     # @param child_auth_key auth key of reseller&#39;s child
     # @param reseller_child values to update in child profile
     # @param [Hash] opts the optional parameters