sib-api-v3-sdk 5.2.2 → 5.2.3

data/docs/UpdateChildDomain.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::UpdateChildDomain
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **String** | Value for the sender domain that will replace the existing domain | [optional] 
+
+

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

@@ -17,6 +17,7 @@ require 'sib-api-v3-sdk/version'
 require 'sib-api-v3-sdk/configuration'
 
 # Models
+require 'sib-api-v3-sdk/models/add_child_domain'
 require 'sib-api-v3-sdk/models/add_contact_to_list'
 require 'sib-api-v3-sdk/models/add_credits'
 require 'sib-api-v3-sdk/models/create_attribute'
@@ -55,6 +56,8 @@ require 'sib-api-v3-sdk/models/get_attributes_enumeration'
 require 'sib-api-v3-sdk/models/get_campaign_overview'
 require 'sib-api-v3-sdk/models/get_campaign_recipients'
 require 'sib-api-v3-sdk/models/get_campaign_stats'
+require 'sib-api-v3-sdk/models/get_child_domain'
+require 'sib-api-v3-sdk/models/get_child_domains'
 require 'sib-api-v3-sdk/models/get_child_info_api_keys'
 require 'sib-api-v3-sdk/models/get_child_info_api_keys_v2'
 require 'sib-api-v3-sdk/models/get_child_info_api_keys_v3'
@@ -108,6 +111,7 @@ require 'sib-api-v3-sdk/models/get_sms_event_report_events'
 require 'sib-api-v3-sdk/models/get_smtp_template_overview'
 require 'sib-api-v3-sdk/models/get_smtp_template_overview_sender'
 require 'sib-api-v3-sdk/models/get_smtp_templates'
+require 'sib-api-v3-sdk/models/get_sso_token'
 require 'sib-api-v3-sdk/models/get_stats_by_domain'
 require 'sib-api-v3-sdk/models/get_transac_aggregated_sms_report'
 require 'sib-api-v3-sdk/models/get_transac_sms_report'
@@ -148,6 +152,7 @@ require 'sib-api-v3-sdk/models/update_attribute'
 require 'sib-api-v3-sdk/models/update_attribute_enumeration'
 require 'sib-api-v3-sdk/models/update_campaign_status'
 require 'sib-api-v3-sdk/models/update_child'
+require 'sib-api-v3-sdk/models/update_child_domain'
 require 'sib-api-v3-sdk/models/update_contact'
 require 'sib-api-v3-sdk/models/update_email_campaign'
 require 'sib-api-v3-sdk/models/update_email_campaign_recipients'

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

@@ -141,6 +141,66 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Creates 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
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def create_child_domain(child_auth_key, add_child_domain, opts = {})
+      create_child_domain_with_http_info(child_auth_key, add_child_domain, opts)
+      return nil
+    end
+
+    # Creates 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
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def create_child_domain_with_http_info(child_auth_key, add_child_domain, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ResellerApi.create_child_domain ..."
+      end
+      # verify the required parameter 'child_auth_key' is set
+      if @api_client.config.client_side_validation && child_auth_key.nil?
+        fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.create_child_domain"
+      end
+      # verify the required parameter 'add_child_domain' is set
+      if @api_client.config.client_side_validation && add_child_domain.nil?
+        fail ArgumentError, "Missing the required parameter 'add_child_domain' when calling ResellerApi.create_child_domain"
+      end
+      # resource path
+      local_var_path = "/reseller/children/{childAuthKey}/domains".sub('{' + 'childAuthKey' + '}', child_auth_key.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 = @api_client.object_to_http_body(add_child_domain)
+      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: ResellerApi#create_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Creates a reseller child
     # 
     # @param [Hash] opts the optional parameters
@@ -192,6 +252,66 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Deletes the sender domain of the reseller 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 deleted
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_child_domain(child_auth_key, domain_name, opts = {})
+      delete_child_domain_with_http_info(child_auth_key, domain_name, opts)
+      return nil
+    end
+
+    # Deletes the sender domain of the reseller 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 deleted
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_child_domain_with_http_info(child_auth_key, domain_name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ResellerApi.delete_child_domain ..."
+      end
+      # verify the required parameter 'child_auth_key' is set
+      if @api_client.config.client_side_validation && child_auth_key.nil?
+        fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.delete_child_domain"
+      end
+      # verify the required parameter 'domain_name' is set
+      if @api_client.config.client_side_validation && domain_name.nil?
+        fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.delete_child_domain"
+      end
+      # resource path
+      local_var_path = "/reseller/children/{childAuthKey}/domains/{domainName}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.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: ResellerApi#delete_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Deletes a single reseller child based on the childAuthKey supplied
     # 
     # @param child_auth_key auth key of reseller&#39;s child
@@ -306,6 +426,61 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Gets all the sender domains of a specific child account
+    # 
+    # @param child_auth_key auth key of reseller&#39;s child
+    # @param [Hash] opts the optional parameters
+    # @return [GetChildDomains]
+    def get_child_domains(child_auth_key, opts = {})
+      data, _status_code, _headers = get_child_domains_with_http_info(child_auth_key, opts)
+      return data
+    end
+
+    # Gets all the sender domains of 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
+    def get_child_domains_with_http_info(child_auth_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ResellerApi.get_child_domains ..."
+      end
+      # verify the required parameter 'child_auth_key' is set
+      if @api_client.config.client_side_validation && child_auth_key.nil?
+        fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_child_domains"
+      end
+      # resource path
+      local_var_path = "/reseller/children/{childAuthKey}/domains".sub('{' + 'childAuthKey' + '}', child_auth_key.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(: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 => 'GetChildDomains')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ResellerApi#get_child_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Gets the info about a specific child account
     # 
     # @param child_auth_key auth key of reseller&#39;s child
@@ -410,6 +585,61 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Generates a session token which will remain valid for a short period of time only.
+    # 
+    # @param child_auth_key auth key of reseller&#39;s child
+    # @param [Hash] opts the optional parameters
+    # @return [GetSsoToken]
+    def get_sso_token(child_auth_key, opts = {})
+      data, _status_code, _headers = get_sso_token_with_http_info(child_auth_key, opts)
+      return data
+    end
+
+    # Generates a session token which will remain valid for a short period of time only.
+    # 
+    # @param child_auth_key auth key of reseller&#39;s child
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetSsoToken, Fixnum, Hash)>] GetSsoToken data, response status code and response headers
+    def get_sso_token_with_http_info(child_auth_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ResellerApi.get_sso_token ..."
+      end
+      # verify the required parameter 'child_auth_key' is set
+      if @api_client.config.client_side_validation && child_auth_key.nil?
+        fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.get_sso_token"
+      end
+      # resource path
+      local_var_path = "/reseller/children/{childAuthKey}/auth".sub('{' + 'childAuthKey' + '}', child_auth_key.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(: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 => 'GetSsoToken')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ResellerApi#get_sso_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Remove Email and/or SMS credits from a specific child account
     # 
     # @param child_auth_key auth key of reseller&#39;s child
@@ -471,6 +701,72 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Updates 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
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_child_domain(child_auth_key, domain_name, update_child_domain, opts = {})
+      update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts)
+      return nil
+    end
+
+    # Updates 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
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_child_domain_with_http_info(child_auth_key, domain_name, update_child_domain, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: ResellerApi.update_child_domain ..."
+      end
+      # verify the required parameter 'child_auth_key' is set
+      if @api_client.config.client_side_validation && child_auth_key.nil?
+        fail ArgumentError, "Missing the required parameter 'child_auth_key' when calling ResellerApi.update_child_domain"
+      end
+      # verify the required parameter 'domain_name' is set
+      if @api_client.config.client_side_validation && domain_name.nil?
+        fail ArgumentError, "Missing the required parameter 'domain_name' when calling ResellerApi.update_child_domain"
+      end
+      # verify the required parameter 'update_child_domain' is set
+      if @api_client.config.client_side_validation && update_child_domain.nil?
+        fail ArgumentError, "Missing the required parameter 'update_child_domain' when calling ResellerApi.update_child_domain"
+      end
+      # resource path
+      local_var_path = "/reseller/children/{childAuthKey}/domains/{domainName}".sub('{' + 'childAuthKey' + '}', child_auth_key.to_s).sub('{' + 'domainName' + '}', domain_name.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 = @api_client.object_to_http_body(update_child_domain)
+      auth_names = ['api-key', 'partner-key']
+      data, status_code, headers = @api_client.call_api(:PUT, 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: ResellerApi#update_child_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Updates infos of reseller's child based on the childAuthKey supplied
     # 
     # @param child_auth_key auth key of reseller&#39;s child

data/lib/sib-api-v3-sdk/models/add_child_domain.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.3.1
+
+=end
+
+require 'date'
+
+module SibApiV3Sdk
+
+  class AddChildDomain
+    # Sender domain to add for a specific child account
+    attr_accessor :domain
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'domain' => :'domain'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'domain' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          domain == o.domain
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [domain].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = SibApiV3Sdk.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end