Class: Repull::ConnectProvider

Inherits:
ApiModelBase show all
Defined in:
lib/repull/models/connect_provider.rb

Overview

A channel the multi-channel Connect picker can show. Returned by ‘GET /v1/connect/providers` and consumed by SDKs that render their own picker UI.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ConnectProvider

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
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
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/repull/models/connect_provider.rb', line 92

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Repull::ConnectProvider` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Repull::ConnectProvider`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

  if attributes.key?(:'aliases')
    if (value = attributes[:'aliases']).is_a?(Array)
      self.aliases = value
    end
  end
end

Instance Attribute Details

#aliases ⇒ Object

Optional friendly aliases the picker’s search box can match.



41
42
43
 
# File 'lib/repull/models/connect_provider.rb', line 41

def aliases
  @aliases
end

#category ⇒ Object

Channel category — OTAs are listing marketplaces; PMSes are property management systems.



25
26
27
 
# File 'lib/repull/models/connect_provider.rb', line 25

def category
  @category
end

#connect_pattern ⇒ Object

How the host is connected. ‘oauth`: provider-side consent screen. `credentials`: hosted form collects API keys. `activation`: push-only handshake (Vrbo). `claim`: connectivity-provider designation in the channel’s Extranet (Booking.com).



28
29
30
 
# File 'lib/repull/models/connect_provider.rb', line 28

def connect_pattern
  @connect_pattern
end

#description ⇒ Object

Returns the value of attribute description.



36
37
38
 
# File 'lib/repull/models/connect_provider.rb', line 36

def description
  @description
end

#display_name ⇒ Object

Returns the value of attribute display_name.



22
23
24
 
# File 'lib/repull/models/connect_provider.rb', line 22

def display_name
  @display_name
end

#docs_url ⇒ Object

Returns the value of attribute docs_url.



38
39
40
 
# File 'lib/repull/models/connect_provider.rb', line 38

def docs_url
  @docs_url
end

#id ⇒ Object

Stable identifier passed back to /select-provider and used in /v1/connect/provider routes.



20
21
22
 
# File 'lib/repull/models/connect_provider.rb', line 20

def id
  @id
end

#logo_url ⇒ Object

Logo URL — Clearbit stand-in until self-hosted SVGs land.



34
35
36
 
# File 'lib/repull/models/connect_provider.rb', line 34

def logo_url
  @logo_url
end

#status ⇒ Object

Pickers should hide / disable ‘coming-soon` cards. `beta` cards are clickable but show a Beta pill.



31
32
33
 
# File 'lib/repull/models/connect_provider.rb', line 31

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/repull/models/connect_provider.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/repull/models/connect_provider.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/repull/models/connect_provider.rb', line 44

def self.attribute_map
  {
    :'id' => :'id',
    :'display_name' => :'displayName',
    :'category' => :'category',
    :'connect_pattern' => :'connectPattern',
    :'status' => :'status',
    :'logo_url' => :'logoUrl',
    :'description' => :'description',
    :'docs_url' => :'docsUrl',
    :'aliases' => :'aliases'
  }
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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/repull/models/connect_provider.rb', line 327

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



84
85
86
87
88
 
# File 'lib/repull/models/connect_provider.rb', line 84

def self.openapi_nullable
  Set.new([
    :'aliases'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/repull/models/connect_provider.rb', line 69

def self.openapi_types
  {
    :'id' => :'String',
    :'display_name' => :'String',
    :'category' => :'String',
    :'connect_pattern' => :'String',
    :'status' => :'String',
    :'logo_url' => :'String',
    :'description' => :'String',
    :'docs_url' => :'String',
    :'aliases' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/repull/models/connect_provider.rb', line 298

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      display_name == o.display_name &&
      category == o.category &&
      connect_pattern == o.connect_pattern &&
      status == o.status &&
      logo_url == o.logo_url &&
      description == o.description &&
      docs_url == o.docs_url &&
      aliases == o.aliases
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


314
315
316
 
# File 'lib/repull/models/connect_provider.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



320
321
322
 
# File 'lib/repull/models/connect_provider.rb', line 320

def hash
  [id, display_name, category, connect_pattern, status, logo_url, description, docs_url, aliases].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



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
 
# File 'lib/repull/models/connect_provider.rb', line 163

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

  if @display_name.nil?
    invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
  end

  if @category.nil?
    invalid_properties.push('invalid value for "category", category cannot be nil.')
  end

  if @connect_pattern.nil?
    invalid_properties.push('invalid value for "connect_pattern", connect_pattern cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @logo_url.nil?
    invalid_properties.push('invalid value for "logo_url", logo_url cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @docs_url.nil?
    invalid_properties.push('invalid value for "docs_url", docs_url cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/repull/models/connect_provider.rb', line 349

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/repull/models/connect_provider.rb', line 203

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @display_name.nil?
  return false if @category.nil?
  return false if @connect_pattern.nil?
  return false if @status.nil?
  return false if @logo_url.nil?
  return false if @description.nil?
  return false if @docs_url.nil?
  true
end