Class: MxPlatformRuby::WidgetRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/mx-platform-ruby/models/widget_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WidgetRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 115

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::WidgetRequest` 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 `MxPlatformRuby::WidgetRequest`. 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?(:'client_redirect_url')
    self.client_redirect_url = attributes[:'client_redirect_url']
  end

  if attributes.key?(:'color_scheme')
    self.color_scheme = attributes[:'color_scheme']
  end

  if attributes.key?(:'current_institution_code')
    self.current_institution_code = attributes[:'current_institution_code']
  end

  if attributes.key?(:'current_institution_guid')
    self.current_institution_guid = attributes[:'current_institution_guid']
  end

  if attributes.key?(:'current_member_guid')
    self.current_member_guid = attributes[:'current_member_guid']
  end

  if attributes.key?(:'disable_background_agg')
    self.disable_background_agg = attributes[:'disable_background_agg']
  end

  if attributes.key?(:'disable_institution_search')
    self.disable_institution_search = attributes[:'disable_institution_search']
  end

  if attributes.key?(:'include_identity')
    self.include_identity = attributes[:'include_identity']
  end

  if attributes.key?(:'include_transactions')
    self.include_transactions = attributes[:'include_transactions']
  end

  if attributes.key?(:'insight_guid')
    self.insight_guid = attributes[:'insight_guid']
  end

  if attributes.key?(:'is_mobile_webview')
    self.is_mobile_webview = attributes[:'is_mobile_webview']
  end

  if attributes.key?(:'microwidget_instance_id')
    self.microwidget_instance_id = attributes[:'microwidget_instance_id']
  end

  if attributes.key?(:'mode')
    self.mode = attributes[:'mode']
  end

  if attributes.key?(:'oauth_referral_source')
    self.oauth_referral_source = attributes[:'oauth_referral_source']
  end

  if attributes.key?(:'ui_message_version')
    self.ui_message_version = attributes[:'ui_message_version']
  end

  if attributes.key?(:'ui_message_webview_url_scheme')
    self.ui_message_webview_url_scheme = attributes[:'ui_message_webview_url_scheme']
  end

  if attributes.key?(:'update_credentials')
    self.update_credentials = attributes[:'update_credentials']
  end

  if attributes.key?(:'widget_type')
    self.widget_type = attributes[:'widget_type']
  else
    self.widget_type = nil
  end
end

Instance Attribute Details

#client_redirect_url ⇒ Object

Returns the value of attribute client_redirect_url.



18
19
20
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 18

def client_redirect_url
  @client_redirect_url
end

#color_scheme ⇒ Object

Returns the value of attribute color_scheme.



20
21
22
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 20

def color_scheme
  @color_scheme
end

#current_institution_code ⇒ Object

Returns the value of attribute current_institution_code.



22
23
24
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 22

def current_institution_code
  @current_institution_code
end

#current_institution_guid ⇒ Object

Returns the value of attribute current_institution_guid.



24
25
26
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 24

def current_institution_guid
  @current_institution_guid
end

#current_member_guid ⇒ Object

Returns the value of attribute current_member_guid.



26
27
28
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 26

def current_member_guid
  @current_member_guid
end

#disable_background_agg ⇒ Object

Returns the value of attribute disable_background_agg.



28
29
30
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 28

def disable_background_agg
  @disable_background_agg
end

#disable_institution_search ⇒ Object

Returns the value of attribute disable_institution_search.



30
31
32
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 30

def disable_institution_search
  @disable_institution_search
end

#include_identity ⇒ Object

Returns the value of attribute include_identity.



32
33
34
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 32

def include_identity
  @include_identity
end

#include_transactions ⇒ Object

Returns the value of attribute include_transactions.



34
35
36
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 34

def include_transactions
  @include_transactions
end

#insight_guid ⇒ Object

Returns the value of attribute insight_guid.



36
37
38
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 36

def insight_guid
  @insight_guid
end

#is_mobile_webview ⇒ Object

Returns the value of attribute is_mobile_webview.



38
39
40
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 38

def is_mobile_webview
  @is_mobile_webview
end

#microwidget_instance_id ⇒ Object

Returns the value of attribute microwidget_instance_id.



40
41
42
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 40

def microwidget_instance_id
  @microwidget_instance_id
end

#mode ⇒ Object

Returns the value of attribute mode.



42
43
44
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 42

def mode
  @mode
end

#oauth_referral_source ⇒ Object

Returns the value of attribute oauth_referral_source.



44
45
46
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 44

def oauth_referral_source
  @oauth_referral_source
end

#ui_message_version ⇒ Object

Returns the value of attribute ui_message_version.



46
47
48
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 46

def ui_message_version
  @ui_message_version
end

#ui_message_webview_url_scheme ⇒ Object

Returns the value of attribute ui_message_webview_url_scheme.



48
49
50
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 48

def ui_message_webview_url_scheme
  @ui_message_webview_url_scheme
end

#update_credentials ⇒ Object

Returns the value of attribute update_credentials.



50
51
52
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 50

def update_credentials
  @update_credentials
end

#widget_type ⇒ Object

Returns the value of attribute widget_type.



52
53
54
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 52

def widget_type
  @widget_type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 287

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = MxPlatformRuby.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 55

def self.attribute_map
  {
    :'client_redirect_url' => :'client_redirect_url',
    :'color_scheme' => :'color_scheme',
    :'current_institution_code' => :'current_institution_code',
    :'current_institution_guid' => :'current_institution_guid',
    :'current_member_guid' => :'current_member_guid',
    :'disable_background_agg' => :'disable_background_agg',
    :'disable_institution_search' => :'disable_institution_search',
    :'include_identity' => :'include_identity',
    :'include_transactions' => :'include_transactions',
    :'insight_guid' => :'insight_guid',
    :'is_mobile_webview' => :'is_mobile_webview',
    :'microwidget_instance_id' => :'microwidget_instance_id',
    :'mode' => :'mode',
    :'oauth_referral_source' => :'oauth_referral_source',
    :'ui_message_version' => :'ui_message_version',
    :'ui_message_webview_url_scheme' => :'ui_message_webview_url_scheme',
    :'update_credentials' => :'update_credentials',
    :'widget_type' => :'widget_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 263

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 108

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 84

def self.openapi_types
  {
    :'client_redirect_url' => :'String',
    :'color_scheme' => :'String',
    :'current_institution_code' => :'String',
    :'current_institution_guid' => :'String',
    :'current_member_guid' => :'String',
    :'disable_background_agg' => :'Boolean',
    :'disable_institution_search' => :'Boolean',
    :'include_identity' => :'Boolean',
    :'include_transactions' => :'Boolean',
    :'insight_guid' => :'String',
    :'is_mobile_webview' => :'Boolean',
    :'microwidget_instance_id' => :'String',
    :'mode' => :'String',
    :'oauth_referral_source' => :'String',
    :'ui_message_version' => :'Integer',
    :'ui_message_webview_url_scheme' => :'String',
    :'update_credentials' => :'Boolean',
    :'widget_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_redirect_url == o.client_redirect_url &&
      color_scheme == o.color_scheme &&
      current_institution_code == o.current_institution_code &&
      current_institution_guid == o.current_institution_guid &&
      current_member_guid == o.current_member_guid &&
      disable_background_agg == o.disable_background_agg &&
      disable_institution_search == o.disable_institution_search &&
      include_identity == o.include_identity &&
      include_transactions == o.include_transactions &&
      insight_guid == o.insight_guid &&
      is_mobile_webview == o.is_mobile_webview &&
      microwidget_instance_id == o.microwidget_instance_id &&
      mode == o.mode &&
      oauth_referral_source == o.oauth_referral_source &&
      ui_message_version == o.ui_message_version &&
      ui_message_webview_url_scheme == o.ui_message_webview_url_scheme &&
      update_credentials == o.update_credentials &&
      widget_type == o.widget_type
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 358

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


250
251
252
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 250

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



256
257
258
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 256

def hash
  [client_redirect_url, color_scheme, current_institution_code, current_institution_guid, current_member_guid, disable_background_agg, disable_institution_search, include_identity, include_transactions, insight_guid, is_mobile_webview, microwidget_instance_id, mode, oauth_referral_source, ui_message_version, ui_message_webview_url_scheme, update_credentials, widget_type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



205
206
207
208
209
210
211
212
213
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 205

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @widget_type.nil?
    invalid_properties.push('invalid value for "widget_type", widget_type cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 334

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 340

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



328
329
330
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 328

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



217
218
219
220
221
 
# File 'lib/mx-platform-ruby/models/widget_request.rb', line 217

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @widget_type.nil?
  true
end