smooch-api 5.7.0 → 5.8.0

data/lib/smooch-api/models/deployment_response.rb

@@ -0,0 +1,194 @@
+=begin
+#Smooch
+
+#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
+
+OpenAPI spec version: 5.8
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3-SNAPSHOT
+
+=end
+
+require 'date'
+
+module SmoochApi
+
+  class DeploymentResponse
+    # The deployment.
+    attr_accessor :deployment
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'deployment' => :'deployment'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'deployment' => :'Deployment'
+      }
+    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?(:'deployment')
+        self.deployment = attributes[:'deployment']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @deployment.nil?
+        invalid_properties.push("invalid value for 'deployment', deployment 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 @deployment.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 &&
+          deployment == o.deployment
+    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
+      [deployment].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 = SmoochApi.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

data/lib/smooch-api/models/destination.rb

@@ -3,7 +3,7 @@
 
 #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
 
-OpenAPI spec version: 5.7
+OpenAPI spec version: 5.8
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -18,7 +18,7 @@ module SmoochApi
     # The ID of the target integration.
     attr_accessor :integrationId
 
-    # The type of the target integration. See Enums.md for available values.
+    # The type of the target integration. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values.
     attr_accessor :integrationType
 
 

data/lib/smooch-api/models/display_settings.rb

@@ -3,7 +3,7 @@
 
 #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
 
-OpenAPI spec version: 5.7
+OpenAPI spec version: 5.8
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -15,7 +15,7 @@ require 'date'
 module SmoochApi
 
   class DisplaySettings
-    # Specifies how to display all carousel images. See Enums.md for available values.
+    # Specifies how to display all carousel images. See [**ImageAspectRatioEnum**](Enums.md#ImageAspectRatioEnum) for available values.
     attr_accessor :imageAspectRatio
 
 

data/lib/smooch-api/models/enums.rb

@@ -3,7 +3,7 @@
 
 #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
 
-OpenAPI spec version: 5.7
+OpenAPI spec version: 5.8
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -41,6 +41,12 @@ module SmoochApi
 
     attr_accessor :webhookTriggers
 
+    attr_accessor :deploymentHosting
+
+    attr_accessor :deploymentStatus
+
+    attr_accessor :deploymentActivationMethod
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -78,7 +84,10 @@ module SmoochApi
         :'messageItemSize' => :'MessageItemSize',
         :'messageType' => :'MessageType',
         :'role' => :'Role',
-        :'webhookTriggers' => :'WebhookTriggers'
+        :'webhookTriggers' => :'WebhookTriggers',
+        :'deploymentHosting' => :'DeploymentHosting',
+        :'deploymentStatus' => :'DeploymentStatus',
+        :'deploymentActivationMethod' => :'DeploymentActivationMethod'
       }
     end
 
@@ -97,7 +106,10 @@ module SmoochApi
         :'messageItemSize' => :'String',
         :'messageType' => :'String',
         :'role' => :'String',
-        :'webhookTriggers' => :'String'
+        :'webhookTriggers' => :'String',
+        :'deploymentHosting' => :'String',
+        :'deploymentStatus' => :'String',
+        :'deploymentActivationMethod' => :'String'
       }
     end
 
@@ -161,6 +173,18 @@ module SmoochApi
         self.webhookTriggers = attributes[:'WebhookTriggers']
       end
 
+      if attributes.has_key?(:'DeploymentHosting')
+        self.deploymentHosting = attributes[:'DeploymentHosting']
+      end
+
+      if attributes.has_key?(:'DeploymentStatus')
+        self.deploymentStatus = attributes[:'DeploymentStatus']
+      end
+
+      if attributes.has_key?(:'DeploymentActivationMethod')
+        self.deploymentActivationMethod = attributes[:'DeploymentActivationMethod']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -199,6 +223,12 @@ module SmoochApi
       return false unless role_validator.valid?(@role)
       webhookTriggers_validator = EnumAttributeValidator.new('String', ["appUser:delete", "client:add", "client:remove", "conversation:read", "conversation:referral", "link:failure", "link:match", "link:success", "merge:appUser", "message:appMaker", "message:appUser", "message:delivery:channel", "message:delivery:failure", "message:delivery:user", "payment:success", "postback", "typing:appUser"])
       return false unless webhookTriggers_validator.valid?(@webhookTriggers)
+      deploymentHosting_validator = EnumAttributeValidator.new('String', ["self", "smooch"])
+      return false unless deploymentHosting_validator.valid?(@deploymentHosting)
+      deploymentStatus_validator = EnumAttributeValidator.new('String', ["starting", "unregistered", "registered", "integrated", "pending", "deleting", "error"])
+      return false unless deploymentStatus_validator.valid?(@deploymentStatus)
+      deploymentActivationMethod_validator = EnumAttributeValidator.new('String', ["voice", "sms"])
+      return false unless deploymentActivationMethod_validator.valid?(@deploymentActivationMethod)
       return true
     end
 
@@ -332,6 +362,36 @@ module SmoochApi
       @webhookTriggers = webhookTriggers
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deploymentHosting Object to be assigned
+    def deploymentHosting=(deploymentHosting)
+      validator = EnumAttributeValidator.new('String', ["self", "smooch"])
+      unless validator.valid?(deploymentHosting)
+        fail ArgumentError, "invalid value for 'deploymentHosting', must be one of #{validator.allowable_values}."
+      end
+      @deploymentHosting = deploymentHosting
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deploymentStatus Object to be assigned
+    def deploymentStatus=(deploymentStatus)
+      validator = EnumAttributeValidator.new('String', ["starting", "unregistered", "registered", "integrated", "pending", "deleting", "error"])
+      unless validator.valid?(deploymentStatus)
+        fail ArgumentError, "invalid value for 'deploymentStatus', must be one of #{validator.allowable_values}."
+      end
+      @deploymentStatus = deploymentStatus
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deploymentActivationMethod Object to be assigned
+    def deploymentActivationMethod=(deploymentActivationMethod)
+      validator = EnumAttributeValidator.new('String', ["voice", "sms"])
+      unless validator.valid?(deploymentActivationMethod)
+        fail ArgumentError, "invalid value for 'deploymentActivationMethod', must be one of #{validator.allowable_values}."
+      end
+      @deploymentActivationMethod = deploymentActivationMethod
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -349,7 +409,10 @@ module SmoochApi
           messageItemSize == o.messageItemSize &&
           messageType == o.messageType &&
           role == o.role &&
-          webhookTriggers == o.webhookTriggers
+          webhookTriggers == o.webhookTriggers &&
+          deploymentHosting == o.deploymentHosting &&
+          deploymentStatus == o.deploymentStatus &&
+          deploymentActivationMethod == o.deploymentActivationMethod
     end
 
     # @see the `==` method
@@ -361,7 +424,7 @@ module SmoochApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [actionSize, actionType, businessSystemType, confirmationType, conversationActivityType, imageAspectRatio, integrationStatus, integrationType, menuItemType, messageItemSize, messageType, role, webhookTriggers].hash
+      [actionSize, actionType, businessSystemType, confirmationType, conversationActivityType, imageAspectRatio, integrationStatus, integrationType, menuItemType, messageItemSize, messageType, role, webhookTriggers, deploymentHosting, deploymentStatus, deploymentActivationMethod].hash
     end
 
     # Builds the object from hash

data/lib/smooch-api/models/get_integration_profile_response.rb

@@ -3,7 +3,7 @@
 
 #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
 
-OpenAPI spec version: 5.7
+OpenAPI spec version: 5.8
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/models/get_messages_response.rb

@@ -3,7 +3,7 @@
 
 #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
 
-OpenAPI spec version: 5.7
+OpenAPI spec version: 5.8
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/models/integration.rb

@@ -3,7 +3,7 @@
 
 #The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
 
-OpenAPI spec version: 5.7
+OpenAPI spec version: 5.8
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -18,7 +18,7 @@ module SmoochApi
     # The integration ID, generated automatically.
     attr_accessor :id
 
-    # The integration type. See Enums.md for available values.
+    # The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values.
     attr_accessor :type
 
     # The integration display name. Used to map a human-friendly name to an integration. 
@@ -90,13 +90,16 @@ module SmoochApi
     # The binary of your APN certificate base64 encoded. Required for *apn* integrations. 
     attr_accessor :certificate
 
-    # Your WhatsApp API client's URL. Required for *WhatsApp* integrations. 
+    # Your WhatsApp deployment ID. Required for *WhatsApp* integrations. 
+    attr_accessor :deploymentId
+
+    # Your WhatsApp API client's URL. Required for *WhatsApp* integrations. (this usage is deprecated) 
     attr_accessor :baseUrl
 
     # Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. 
     attr_accessor :hsmFallbackLanguage
 
-    # The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (Optional) Used for *apn* integrations. 
+    # The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (this usage is deprecated) (Optional) Used for *apn* integrations. 
     attr_accessor :password
 
     # Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. 
@@ -132,7 +135,7 @@ module SmoochApi
     # The twitter userId. Returned on successful *twitter* integrations. 
     attr_accessor :userId
 
-    # The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* integrations. 
+    # The username for the account. Returned on successful *twitter* and *telegram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated) 
     attr_accessor :username
 
     # The public API key of your Mailgun account. Required for *mailgun* integrations. 
@@ -189,7 +192,7 @@ module SmoochApi
     # A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations. 
     attr_accessor :originWhitelist
 
-    # The integration status. See Enums.md for available values. [More info](https://docs.smooch.io/#integration-status).
+    # The integration status. See [**IntegrationStatusEnum**](Enums.md#IntegrationStatusEnum) for available values. [More info](https://docs.smooch.io/#integration-status).
     attr_accessor :status
 
     # The error causing the integration to fail. Will be present when `status` is 'error'.
@@ -224,6 +227,7 @@ module SmoochApi
         :'encodingAesKey' => :'encodingAesKey',
         :'fromAddress' => :'fromAddress',
         :'certificate' => :'certificate',
+        :'deploymentId' => :'deploymentId',
         :'baseUrl' => :'baseUrl',
         :'hsmFallbackLanguage' => :'hsmFallbackLanguage',
         :'password' => :'password',
@@ -290,6 +294,7 @@ module SmoochApi
         :'encodingAesKey' => :'String',
         :'fromAddress' => :'String',
         :'certificate' => :'String',
+        :'deploymentId' => :'String',
         :'baseUrl' => :'String',
         :'hsmFallbackLanguage' => :'String',
         :'password' => :'String',
@@ -436,6 +441,10 @@ module SmoochApi
         self.certificate = attributes[:'certificate']
       end
 
+      if attributes.has_key?(:'deploymentId')
+        self.deploymentId = attributes[:'deploymentId']
+      end
+
       if attributes.has_key?(:'baseUrl')
         self.baseUrl = attributes[:'baseUrl']
       end
@@ -635,6 +644,7 @@ module SmoochApi
           encodingAesKey == o.encodingAesKey &&
           fromAddress == o.fromAddress &&
           certificate == o.certificate &&
+          deploymentId == o.deploymentId &&
           baseUrl == o.baseUrl &&
           hsmFallbackLanguage == o.hsmFallbackLanguage &&
           password == o.password &&
@@ -681,7 +691,7 @@ module SmoochApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, type, displayName, pageAccessToken, appId, appSecret, accessTokenUrl, webhookSecret, pageId, accountSid, authToken, phoneNumberSid, phoneNumber, name, token, uri, channelId, channelSecret, channelAccessToken, serviceCode, switcherSecret, botName, encodingAesKey, fromAddress, certificate, baseUrl, hsmFallbackLanguage, password, autoUpdateBadge, production, serverKey, senderId, tier, envName, consumerKey, consumerSecret, accessTokenKey, accessTokenSecret, userId, username, apiKey, domain, incomingAddress, accessKey, originator, brandColor, fixedIntroPane, conversationColor, actionColor, displayStyle, buttonIconUrl, buttonWidth, buttonHeight, integrationOrder, businessName, businessIconUrl, backgroundImageUrl, originWhitelist, status, error].hash
+      [id, type, displayName, pageAccessToken, appId, appSecret, accessTokenUrl, webhookSecret, pageId, accountSid, authToken, phoneNumberSid, phoneNumber, name, token, uri, channelId, channelSecret, channelAccessToken, serviceCode, switcherSecret, botName, encodingAesKey, fromAddress, certificate, deploymentId, baseUrl, hsmFallbackLanguage, password, autoUpdateBadge, production, serverKey, senderId, tier, envName, consumerKey, consumerSecret, accessTokenKey, accessTokenSecret, userId, username, apiKey, domain, incomingAddress, accessKey, originator, brandColor, fixedIntroPane, conversationColor, actionColor, displayStyle, buttonIconUrl, buttonWidth, buttonHeight, integrationOrder, businessName, businessIconUrl, backgroundImageUrl, originWhitelist, status, error].hash
     end
 
     # Builds the object from hash