Class: MergeAccountingClient::AccountIntegration

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/models/account_integration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountIntegration

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
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
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 90

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#api_endpoints_to_documentation_urls ⇒ Object

Mapping of API endpoints to documentation urls for support. Example: [[‘/common-model-scopes’, ‘docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve’],[‘/common-model-actions’, ‘docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve’]], ‘POST’: []



39
40
41
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 39

def api_endpoints_to_documentation_urls
  @api_endpoints_to_documentation_urls
end

#categories ⇒ Object

Category or categories this integration belongs to. Multiple categories should be comma separated, i.e. [ats, hris].



22
23
24
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 22

def categories
  @categories
end

#color ⇒ Object

The color of this integration used for buttons and text throughout the app and landing pages. Choose a darker, saturated color.



31
32
33
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 31

def color
  @color
end

#image ⇒ Object

Company logo in rectangular shape. Upload an image with a clear background.



25
26
27
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 25

def image
  @image
end

#is_in_beta ⇒ Object

If checked, this integration will not appear in the linking flow, and will appear elsewhere with a Beta tag.



36
37
38
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 36

def is_in_beta
  @is_in_beta
end

#name ⇒ Object

Company name.



19
20
21
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 19

def name
  @name
end

#slug ⇒ Object

Returns the value of attribute slug.



33
34
35
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 33

def slug
  @slug
end

#square_image ⇒ Object

Company logo in square shape. Upload an image with a white background.



28
29
30
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 28

def square_image
  @square_image
end

#webhook_setup_guide_url ⇒ Object

Setup guide URL for third party webhook creation. Exposed in Merge Docs.



42
43
44
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 42

def webhook_setup_guide_url
  @webhook_setup_guide_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 45

def self.attribute_map
  {
    :'name' => :'name',
    :'categories' => :'categories',
    :'image' => :'image',
    :'square_image' => :'square_image',
    :'color' => :'color',
    :'slug' => :'slug',
    :'is_in_beta' => :'is_in_beta',
    :'api_endpoints_to_documentation_urls' => :'api_endpoints_to_documentation_urls',
    :'webhook_setup_guide_url' => :'webhook_setup_guide_url'
  }
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



219
220
221
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 219

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
84
85
86
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 80

def self.openapi_nullable
  Set.new([
    :'image',
    :'square_image',
    :'webhook_setup_guide_url'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 65

def self.openapi_types
  {
    :'name' => :'String',
    :'categories' => :'Array<CategoriesEnum>',
    :'image' => :'String',
    :'square_image' => :'String',
    :'color' => :'String',
    :'slug' => :'String',
    :'is_in_beta' => :'Boolean',
    :'api_endpoints_to_documentation_urls' => :'Hash<String, Object>',
    :'webhook_setup_guide_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      categories == o.categories &&
      image == o.image &&
      square_image == o.square_image &&
      color == o.color &&
      slug == o.slug &&
      is_in_beta == o.is_in_beta &&
      api_endpoints_to_documentation_urls == o.api_endpoints_to_documentation_urls &&
      webhook_setup_guide_url == o.webhook_setup_guide_url
end

#_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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 249

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeAccountingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 320

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 226

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 212

def hash
  [name, categories, image, square_image, color, slug, is_in_beta, api_endpoints_to_documentation_urls, webhook_setup_guide_url].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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if !@color.nil? && @color.to_s.length > 18
    invalid_properties.push('invalid value for "color", the character length must be smaller than or equal to 18.')
  end

  pattern = Regexp.new(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
  if !@color.nil? && @color.to_s !~ pattern
    invalid_properties.push("invalid value for \"color\", must conform to the pattern #{pattern}.")
  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



296
297
298
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 302

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



290
291
292
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 290

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



166
167
168
169
170
171
 
# File 'lib/merge_accounting_client/models/account_integration.rb', line 166

def valid?
  return false if @name.nil?
  return false if !@color.nil? && @color.to_s.length > 18
  return false if !@color.nil? && @color.to_s !~ Regexp.new(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/)
  true
end