Class: SmoochApi::Action
- Inherits:
-
Object
- Object
- SmoochApi::Action
- Defined in:
- lib/smooch-api/models/action.rb
Instance Attribute Summary collapse
-
#amount ⇒ Object
The amount being charged.
-
#currency ⇒ Object
The currency of the amount being charged (USD, CAD, etc.).
-
#default ⇒ Object
Flag indicating if the message action is the default for a message item in Facebook Messenger.
-
#extraChannelOptions ⇒ Object
Extra options to pass directly to the channel API.
-
#fallback ⇒ Object
The webview action fallback uri.
-
#iconUrl ⇒ Object
An icon to render next to the reply option (Facebook Messenger and Web Messenger only).
-
#metadata ⇒ Object
Flat JSON object containing any custom properties associated with the action.
-
#payload ⇒ Object
The payload to be sent with the resulting webhook.
-
#size ⇒ Object
The size used to display the webview.
-
#text ⇒ Object
The button text.
-
#type ⇒ Object
The action type.
-
#uri ⇒ Object
The action URI.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Action
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Action
Initializes the object
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/smooch-api/models/action.rb', line 93 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?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'text') self.text = attributes[:'text'] end if attributes.has_key?(:'payload') self.payload = attributes[:'payload'] end if attributes.has_key?(:'metadata') self. = attributes[:'metadata'] end if attributes.has_key?(:'amount') self.amount = attributes[:'amount'] end if attributes.has_key?(:'currency') self.currency = attributes[:'currency'] end if attributes.has_key?(:'default') self.default = attributes[:'default'] end if attributes.has_key?(:'iconUrl') self.iconUrl = attributes[:'iconUrl'] end if attributes.has_key?(:'uri') self.uri = attributes[:'uri'] end if attributes.has_key?(:'fallback') self.fallback = attributes[:'fallback'] end if attributes.has_key?(:'size') self.size = attributes[:'size'] end if attributes.has_key?(:'extraChannelOptions') self.extraChannelOptions = attributes[:'extraChannelOptions'] end end |
Instance Attribute Details
#amount ⇒ Object
The amount being charged. It needs to be specified in cents and is an integer. Required for buy actions.
31 32 33 |
# File 'lib/smooch-api/models/action.rb', line 31 def amount @amount end |
#currency ⇒ Object
The currency of the amount being charged (USD, CAD, etc.).
34 35 36 |
# File 'lib/smooch-api/models/action.rb', line 34 def currency @currency end |
#default ⇒ Object
Flag indicating if the message action is the default for a message item in Facebook Messenger.
37 38 39 |
# File 'lib/smooch-api/models/action.rb', line 37 def default @default end |
#extraChannelOptions ⇒ Object
Extra options to pass directly to the channel API. See [Extra Channel Options](docs.smooch.io/rest#extra-channel-options-schema)
52 53 54 |
# File 'lib/smooch-api/models/action.rb', line 52 def extraChannelOptions @extraChannelOptions end |
#fallback ⇒ Object
The webview action fallback uri. This is the link that will be used in clients that do not support webviews. Required for webview actions.
46 47 48 |
# File 'lib/smooch-api/models/action.rb', line 46 def fallback @fallback end |
#iconUrl ⇒ Object
An icon to render next to the reply option (Facebook Messenger and Web Messenger only).
40 41 42 |
# File 'lib/smooch-api/models/action.rb', line 40 def iconUrl @iconUrl end |
#metadata ⇒ Object
Flat JSON object containing any custom properties associated with the action.
28 29 30 |
# File 'lib/smooch-api/models/action.rb', line 28 def @metadata end |
#payload ⇒ Object
The payload to be sent with the resulting webhook. Required for postback and reply actions.
25 26 27 |
# File 'lib/smooch-api/models/action.rb', line 25 def payload @payload end |
#size ⇒ Object
The size used to display the webview. Allowed values are ["compact", "tall", "full"]. (Optional) Used for webview actions.
49 50 51 |
# File 'lib/smooch-api/models/action.rb', line 49 def size @size end |
#text ⇒ Object
The button text.
22 23 24 |
# File 'lib/smooch-api/models/action.rb', line 22 def text @text end |
#type ⇒ Object
The action type.
19 20 21 |
# File 'lib/smooch-api/models/action.rb', line 19 def type @type end |
#uri ⇒ Object
The action URI. This is the link that will be used in the clients when clicking the button. Required for link and webview actions.
43 44 45 |
# File 'lib/smooch-api/models/action.rb', line 43 def uri @uri end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/smooch-api/models/action.rb', line 56 def self.attribute_map { :'type' => :'type', :'text' => :'text', :'payload' => :'payload', :'metadata' => :'metadata', :'amount' => :'amount', :'currency' => :'currency', :'default' => :'default', :'iconUrl' => :'iconUrl', :'uri' => :'uri', :'fallback' => :'fallback', :'size' => :'size', :'extraChannelOptions' => :'extraChannelOptions' } end |
.swagger_types ⇒ Object
Attribute type mapping.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/smooch-api/models/action.rb', line 74 def self.swagger_types { :'type' => :'String', :'text' => :'String', :'payload' => :'String', :'metadata' => :'Object', :'amount' => :'Integer', :'currency' => :'String', :'default' => :'BOOLEAN', :'iconUrl' => :'String', :'uri' => :'String', :'fallback' => :'String', :'size' => :'String', :'extraChannelOptions' => :'Object' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/smooch-api/models/action.rb', line 174 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && text == o.text && payload == o.payload && == o. && amount == o.amount && currency == o.currency && default == o.default && iconUrl == o.iconUrl && uri == o.uri && fallback == o.fallback && size == o.size && extraChannelOptions == o.extraChannelOptions end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/smooch-api/models/action.rb', line 227 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 |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/smooch-api/models/action.rb', line 293 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 |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/smooch-api/models/action.rb', line 206 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 |
#eql?(o) ⇒ Boolean
193 194 195 |
# File 'lib/smooch-api/models/action.rb', line 193 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
199 200 201 |
# File 'lib/smooch-api/models/action.rb', line 199 def hash [type, text, payload, , amount, currency, default, iconUrl, uri, fallback, size, extraChannelOptions].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/smooch-api/models/action.rb', line 151 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 return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
273 274 275 |
# File 'lib/smooch-api/models/action.rb', line 273 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
279 280 281 282 283 284 285 286 287 |
# File 'lib/smooch-api/models/action.rb', line 279 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 |
#to_s ⇒ String
Returns the string representation of the object
267 268 269 |
# File 'lib/smooch-api/models/action.rb', line 267 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
166 167 168 169 170 |
# File 'lib/smooch-api/models/action.rb', line 166 def valid? return false if @type.nil? return false if @text.nil? return true end |