sib-api-v3-sdk 5.2.4 → 5.2.5

data/docs/UpdateChildAccountStatus.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**transactional_email** | **BOOLEAN** | Status of Transactional Email (SMTP) Platform activation for your account (true=enabled, false=disabled) | [optional] 
+**transactional_email** | **BOOLEAN** | Status of Transactional Email Platform activation for your account (true=enabled, false=disabled) | [optional] 
 **transactional_sms** | **BOOLEAN** | Status of Transactional SMS Platform activation for your account (true=enabled, false=disabled) | [optional] 
 **marketing_automation** | **BOOLEAN** | Status of Marketing Automation Platform activation for your account (true=enabled, false=disabled) | [optional] 
 

data/docs/UpdateContact.md

@@ -8,6 +8,6 @@ Name | Type | Description | Notes
 **sms_blacklisted** | **BOOLEAN** | Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true) | [optional] 
 **list_ids** | **Array<Integer>** | Ids of the lists to add the contact to | [optional] 
 **unlink_list_ids** | **Array<Integer>** | Ids of the lists to remove the contact from | [optional] 
-**smtp_blacklist_sender** | **Array<String>** | SMTP forbidden sender for contact. Use only for email Contact | [optional] 
+**smtp_blacklist_sender** | **Array<String>** | transactional email forbidden sender for contact. Use only for email Contact | [optional] 
 
 

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

@@ -114,6 +114,10 @@ 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_email_content'
+require 'sib-api-v3-sdk/models/get_transac_email_content_events'
+require 'sib-api-v3-sdk/models/get_transac_emails_list'
+require 'sib-api-v3-sdk/models/get_transac_emails_list_transactional_emails'
 require 'sib-api-v3-sdk/models/get_transac_sms_report'
 require 'sib-api-v3-sdk/models/get_transac_sms_report_reports'
 require 'sib-api-v3-sdk/models/get_webhook'

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

@@ -20,9 +20,9 @@ module SibApiV3Sdk
       @api_client = api_client
     end
 
-    # Create an smtp template
+    # Create a transactional email template
     # 
-    # @param smtp_template values to update in smtp template
+    # @param smtp_template values to update in transactional email template
     # @param [Hash] opts the optional parameters
     # @return [CreateModel]
     def create_smtp_template(smtp_template, opts = {})
@@ -30,9 +30,9 @@ module SibApiV3Sdk
       return data
     end
 
-    # Create an smtp template
+    # Create a transactional email template
     # 
-    # @param smtp_template values to update in smtp template
+    # @param smtp_template values to update in transactional email template
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateModel, Fixnum, Hash)>] CreateModel data, response status code and response headers
     def create_smtp_template_with_http_info(smtp_template, opts = {})
@@ -125,7 +125,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Delete an inactive smtp template
+    # Delete an inactive transactional email template
     # 
     # @param template_id id of the template
     # @param [Hash] opts the optional parameters
@@ -135,7 +135,7 @@ module SibApiV3Sdk
       return nil
     end
 
-    # Delete an inactive smtp template
+    # Delete an inactive transactional email template
     # 
     # @param template_id id of the template
     # @param [Hash] opts the optional parameters
@@ -179,7 +179,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Get your SMTP activity aggregated over a period of time
+    # Get your transactional email activity aggregated over a period of time
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
@@ -192,7 +192,7 @@ module SibApiV3Sdk
       return data
     end
 
-    # Get your SMTP activity aggregated over a period of time
+    # Get your transactional email activity aggregated over a period of time
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
@@ -240,7 +240,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Get all your SMTP activity (unaggregated events)
+    # Get all your transactional email activity (unaggregated events)
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number limitation for the result returned (default to 50)
@@ -259,7 +259,7 @@ module SibApiV3Sdk
       return data
     end
 
-    # Get all your SMTP activity (unaggregated events)
+    # Get all your transactional email activity (unaggregated events)
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number limitation for the result returned
@@ -326,7 +326,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Get your SMTP activity aggregated per day
+    # Get your transactional email activity aggregated per day
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents returned per page (default to 50)
@@ -341,7 +341,7 @@ module SibApiV3Sdk
       return data
     end
 
-    # Get your SMTP activity aggregated per day
+    # Get your transactional email activity aggregated per day
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of documents returned per page
@@ -452,7 +452,7 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Get the list of SMTP templates
+    # Get the list of transactional email templates
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
@@ -464,7 +464,7 @@ module SibApiV3Sdk
       return data
     end
 
-    # Get the list of SMTP templates
+    # Get the list of transactional email templates
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :template_status Filter on the status of the template. Active &#x3D; true, inactive &#x3D; false
@@ -514,6 +514,125 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
+    # Get the personalized content of a sent transactional email
+    # 
+    # @param uuid Unique id of the transactional email that has been sent to a particular contact
+    # @param [Hash] opts the optional parameters
+    # @return [GetTransacEmailContent]
+    def get_transac_email_content(uuid, opts = {})
+      data, _status_code, _headers = get_transac_email_content_with_http_info(uuid, opts)
+      return data
+    end
+
+    # Get the personalized content of a sent transactional email
+    # 
+    # @param uuid Unique id of the transactional email that has been sent to a particular contact
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetTransacEmailContent, Fixnum, Hash)>] GetTransacEmailContent data, response status code and response headers
+    def get_transac_email_content_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SMTPApi.get_transac_email_content ..."
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling SMTPApi.get_transac_email_content"
+      end
+      # resource path
+      local_var_path = "/smtp/emails/{uuid}".sub('{' + 'uuid' + '}', uuid.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 => 'GetTransacEmailContent')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SMTPApi#get_transac_email_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the list of transactional emails on the basis of allowed filters
+    # This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
+    # @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
+    # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
+    # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @return [GetTransacEmailsList]
+    def get_transac_emails_list(opts = {})
+      data, _status_code, _headers = get_transac_emails_list_with_http_info(opts)
+      return data
+    end
+
+    # Get the list of transactional emails on the basis of allowed filters
+    # This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :email Mandatory if templateId and messageId are not passed in query filters. Email address to which transactional email has been sent.
+    # @option opts [Integer] :template_id Mandatory if email and messageId are not passed in query filters. Id of the template that was used to compose transactional email.
+    # @option opts [String] :message_id Mandatory if templateId and email are not passed in query filters. Message ID of the transactional email sent.
+    # @option opts [String] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @return [Array<(GetTransacEmailsList, Fixnum, Hash)>] GetTransacEmailsList data, response status code and response headers
+    def get_transac_emails_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: SMTPApi.get_transac_emails_list ..."
+      end
+      # resource path
+      local_var_path = "/smtp/emails"
+
+      # query parameters
+      query_params = {}
+      query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
+      query_params[:'templateId'] = opts[:'template_id'] if !opts[:'template_id'].nil?
+      query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
+      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+
+      # 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 => 'GetTransacEmailsList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SMTPApi#get_transac_emails_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Send a template
     # This endpoint is deprecated. Prefer v3/smtp/email instead.
     # @param template_id Id of the template
@@ -690,10 +809,10 @@ module SibApiV3Sdk
       return data, status_code, headers
     end
 
-    # Updates an smtp templates
+    # Updates a transactional email templates
     # 
     # @param template_id id of the template
-    # @param smtp_template values to update in smtp template
+    # @param smtp_template values to update in transactional email template
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def update_smtp_template(template_id, smtp_template, opts = {})
@@ -701,10 +820,10 @@ module SibApiV3Sdk
       return nil
     end
 
-    # Updates an smtp templates
+    # Updates a transactional email templates
     # 
     # @param template_id id of the template
-    # @param smtp_template values to update in smtp template
+    # @param smtp_template values to update in transactional email template
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def update_smtp_template_with_http_info(template_id, smtp_template, opts = {})

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

@@ -33,7 +33,7 @@ module SibApiV3Sdk
     # Facilitate to update the existing contact in the same request (updateEnabled = true)
     attr_accessor :update_enabled
 
-    # SMTP forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
+    # transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )
     attr_accessor :smtp_blacklist_sender
 
 

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

@@ -29,7 +29,7 @@ module SibApiV3Sdk
     # Mandatory if htmlContent and templateId are empty. Url to the message (HTML)
     attr_accessor :html_url
 
-    # Mandatory if htmlContent and htmlUrl are empty. Id of the SMTP template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
+    # Mandatory if htmlContent and htmlUrl are empty. Id of the transactional email template with status 'active'. Used to copy only its content fetched from htmlContent/htmlUrl to an email campaign for RSS feature.
     attr_accessor :template_id
 
     # Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result. If sendAtBestTime is set to true, your campaign will be sent according to the date passed (ignoring the time part).

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

@@ -15,7 +15,7 @@ require 'date'
 module SibApiV3Sdk
 
   class CreateSmtpEmail
-    # Message ID of the SMTP Email sent
+    # Message ID of the transactional email sent
     attr_accessor :message_id
 
 

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

@@ -13,9 +13,9 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Information about your SMTP account
+  # Information about your transactional email account
   class GetAccountRelay
-    # Status of your SMTP Account (true=Enabled, false=Disabled)
+    # Status of your transactional email Account (true=Enabled, false=Disabled)
     attr_accessor :enabled
 
     attr_accessor :data

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

@@ -13,9 +13,9 @@ Swagger Codegen version: 2.3.1
 require 'date'
 
 module SibApiV3Sdk
-  # Data regarding the SMTP account
+  # Data regarding the transactional email account
   class GetAccountRelayData
-    # Email to use as login on SMTP
+    # Email to use as login on transactional platform
     attr_accessor :user_name
 
     # URL of the SMTP Relay

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

@@ -15,7 +15,7 @@ require 'date'
 module SibApiV3Sdk
 
   class GetSmtpTemplates
-    # Count of smtp templates
+    # Count of transactional email templates
     attr_accessor :count
 
     attr_accessor :templates

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

@@ -0,0 +1,281 @@
+=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 GetTransacEmailContent
+    # Email address to which transactional email has been sent
+    attr_accessor :email
+
+    # Subject of the sent email
+    attr_accessor :subject
+
+    # Id of the template
+    attr_accessor :template_id
+
+    # Date on which transactional email was sent
+    attr_accessor :date
+
+    # Series of events which occurred on the transactional email
+    attr_accessor :events
+
+    # Actual content of the transactional email that has been sent
+    attr_accessor :body
+
+    # Count of the attachments that were sent in the email
+    attr_accessor :attachment_count
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'subject' => :'subject',
+        :'template_id' => :'templateId',
+        :'date' => :'date',
+        :'events' => :'events',
+        :'body' => :'body',
+        :'attachment_count' => :'attachmentCount'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'email' => :'String',
+        :'subject' => :'String',
+        :'template_id' => :'Integer',
+        :'date' => :'DateTime',
+        :'events' => :'Array<GetTransacEmailContentEvents>',
+        :'body' => :'String',
+        :'attachment_count' => :'Integer'
+      }
+    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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.has_key?(:'templateId')
+        self.template_id = attributes[:'templateId']
+      end
+
+      if attributes.has_key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.has_key?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
+        end
+      end
+
+      if attributes.has_key?(:'body')
+        self.body = attributes[:'body']
+      end
+
+      if attributes.has_key?(:'attachmentCount')
+        self.attachment_count = attributes[:'attachmentCount']
+      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
+      if @email.nil?
+        invalid_properties.push("invalid value for 'email', email cannot be nil.")
+      end
+
+      if @subject.nil?
+        invalid_properties.push("invalid value for 'subject', subject cannot be nil.")
+      end
+
+      if @date.nil?
+        invalid_properties.push("invalid value for 'date', date cannot be nil.")
+      end
+
+      if @events.nil?
+        invalid_properties.push("invalid value for 'events', events cannot be nil.")
+      end
+
+      if @body.nil?
+        invalid_properties.push("invalid value for 'body', body cannot be nil.")
+      end
+
+      if @attachment_count.nil?
+        invalid_properties.push("invalid value for 'attachment_count', attachment_count cannot be nil.")
+      end
+
+      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 false if @email.nil?
+      return false if @subject.nil?
+      return false if @date.nil?
+      return false if @events.nil?
+      return false if @body.nil?
+      return false if @attachment_count.nil?
+      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 &&
+          email == o.email &&
+          subject == o.subject &&
+          template_id == o.template_id &&
+          date == o.date &&
+          events == o.events &&
+          body == o.body &&
+          attachment_count == o.attachment_count
+    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
+      [email, subject, template_id, date, events, body, attachment_count].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