class SunshineConversationsClient::ActionSubset
Attributes
The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999).
An ISO 4217 standard currency code in lowercase. Used for actions of type buy.
Boolean value indicating whether the action is the default action for a message item in Facebook Messenger
.
The fallback uri for channels that don’t support webviews. Used for actions of type webview.
Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.
The payload of a postback or reply button.
The size to display a webview. Used for actions of type webview.
The button text.
The type of action.
The webview URI. This is the URI that will open in the webview when clicking the button.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/sunshine-conversations-client/models/action_subset.rb, line 72 def self.attribute_map { :'type' => :'type', :'text' => :'text', :'amount' => :'amount', :'currency' => :'currency', :'metadata' => :'metadata', :'uri' => :'uri', :'default' => :'default', :'extra_channel_options' => :'extraChannelOptions', :'payload' => :'payload', :'size' => :'size', :'fallback' => :'fallback', :'open_on_receive' => :'openOnReceive' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/action_subset.rb, line 298 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/sunshine-conversations-client/models/action_subset.rb, line 131 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::ActionSubset` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::ActionSubset`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'text') self.text = attributes[:'text'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] end if attributes.key?(:'currency') self.currency = attributes[:'currency'] end if attributes.key?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.key?(:'uri') self.uri = attributes[:'uri'] end if attributes.key?(:'default') self.default = attributes[:'default'] end if attributes.key?(:'extra_channel_options') self.extra_channel_options = attributes[:'extra_channel_options'] end if attributes.key?(:'payload') self.payload = attributes[:'payload'] end if attributes.key?(:'size') self.size = attributes[:'size'] end if attributes.key?(:'fallback') self.fallback = attributes[:'fallback'] end if attributes.key?(:'open_on_receive') self.open_on_receive = attributes[:'open_on_receive'] end end
discriminator's property name in OpenAPI v3
# File lib/sunshine-conversations-client/models/action_subset.rb, line 125 def self.openapi_discriminator_name :'type' end
List of attributes with nullable: true
# File lib/sunshine-conversations-client/models/action_subset.rb, line 108 def self.openapi_nullable Set.new([ :'metadata', ]) end
List of class defined in oneOf (OpenAPI v3)
# File lib/sunshine-conversations-client/models/action_subset.rb, line 115 def self.openapi_one_of [ :'Buy', :'Link', :'Postback', :'Webview' ] end
Attribute type mapping.
# File lib/sunshine-conversations-client/models/action_subset.rb, line 90 def self.openapi_types { :'type' => :'String', :'text' => :'String', :'amount' => :'Integer', :'currency' => :'String', :'metadata' => :'Object', :'uri' => :'String', :'default' => :'Boolean', :'extra_channel_options' => :'ExtraChannelOptions', :'payload' => :'String', :'size' => :'String', :'fallback' => :'String', :'open_on_receive' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/action_subset.rb, line 266 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && text == o.text && amount == o.amount && currency == o.currency && metadata == o.metadata && uri == o.uri && default == o.default && extra_channel_options == o.extra_channel_options && payload == o.payload && size == o.size && fallback == o.fallback && open_on_receive == o.open_on_receive end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/sunshine-conversations-client/models/action_subset.rb, line 326 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 SunshineConversationsClient.const_get(type).build_from_hash(value) end 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
# File lib/sunshine-conversations-client/models/action_subset.rb, line 395 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/sunshine-conversations-client/models/action_subset.rb, line 305 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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
@see the `==` method @param [Object] Object to be compared
# File lib/sunshine-conversations-client/models/action_subset.rb, line 285 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/sunshine-conversations-client/models/action_subset.rb, line 291 def hash [type, text, amount, currency, metadata, uri, default, extra_channel_options, payload, size, fallback, open_on_receive].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/sunshine-conversations-client/models/action_subset.rb, line 195 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @text.nil? invalid_properties.push('invalid value for "text", text cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @uri.nil? invalid_properties.push('invalid value for "uri", uri cannot be nil.') end if @payload.nil? invalid_properties.push('invalid value for "payload", payload cannot be nil.') end if @fallback.nil? invalid_properties.push('invalid value for "fallback", fallback cannot be nil.') end invalid_properties end
Custom
attribute writer method checking allowed values (enum). @param [Object] size Object to be assigned
# File lib/sunshine-conversations-client/models/action_subset.rb, line 256 def size=(size) validator = EnumAttributeValidator.new('String', ["compact", "tall", "full"]) unless validator.valid?(size) fail ArgumentError, "invalid value for \"size\", must be one of #{validator.allowable_values}." end @size = size end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/sunshine-conversations-client/models/action_subset.rb, line 377 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/sunshine-conversations-client/models/action_subset.rb, line 365 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/sunshine-conversations-client/models/action_subset.rb, line 226 def valid? return false if @type.nil? return false if @text.nil? return false if @amount.nil? return false if @uri.nil? return false if @payload.nil? size_validator = EnumAttributeValidator.new('String', ["compact", "tall", "full"]) return false unless size_validator.valid?(@size) return false if @fallback.nil? _one_of_found = false self.class.openapi_one_of.each do |_class| _one_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash) if _one_of.valid? if _one_of_found return false else _one_of_found = true end end end if !_one_of_found return false end true end