Class: MergeTicketingClient::DataPassthroughRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ticketing_client/models/data_passthrough_request.rb

Overview

# The DataPassthrough Object ### Description The ‘DataPassthrough` object is used to send information to an otherwise-unsupported third-party endpoint. ### Usage Example Create a `DataPassthrough` to get team hierarchies from your Rippling integration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataPassthroughRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
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
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 84

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

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

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

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

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

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

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

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

Instance Attribute Details

#base_url_override ⇒ Object

Returns the value of attribute base_url_override.



23
24
25
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 23

def base_url_override
  @base_url_override
end

#data ⇒ Object

Returns the value of attribute data.



25
26
27
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 25

def data
  @data
end

#headers ⇒ Object

The headers to use for the request (Merge will handle the account’s authorization headers). ‘Content-Type` header is required for passthrough. Choose content type corresponding to expected format of receiving server.



31
32
33
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 31

def headers
  @headers
end

#method ⇒ Object

Returns the value of attribute method.



19
20
21
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 19

def method
  @method
end

#multipart_form_data ⇒ Object

Pass an array of ‘MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`.



28
29
30
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 28

def multipart_form_data
  @multipart_form_data
end

#normalize_response ⇒ Object

Optional. If true, the response will always be an object of the form ‘T, "value": …` where `T` will be one of `string, boolean, number, null, array, object`.



36
37
38
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 36

def normalize_response
  @normalize_response
end

#path ⇒ Object

Returns the value of attribute path.



21
22
23
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 21

def path
  @path
end

#request_format ⇒ Object

Returns the value of attribute request_format.



33
34
35
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 33

def request_format
  @request_format
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 39

def self.attribute_map
  {
    :'method' => :'method',
    :'path' => :'path',
    :'base_url_override' => :'base_url_override',
    :'data' => :'data',
    :'multipart_form_data' => :'multipart_form_data',
    :'headers' => :'headers',
    :'request_format' => :'request_format',
    :'normalize_response' => :'normalize_response'
  }
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



236
237
238
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 236

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
76
77
78
79
80
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 72

def self.openapi_nullable
  Set.new([
    :'base_url_override',
    :'data',
    :'multipart_form_data',
    :'headers',
    :'request_format',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 58

def self.openapi_types
  {
    :'method' => :'MethodEnum',
    :'path' => :'String',
    :'base_url_override' => :'String',
    :'data' => :'String',
    :'multipart_form_data' => :'Array<MultipartFormFieldRequest>',
    :'headers' => :'Hash<String, Object>',
    :'request_format' => :'RequestFormatEnum',
    :'normalize_response' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      method == o.method &&
      path == o.path &&
      base_url_override == o.base_url_override &&
      data == o.data &&
      multipart_form_data == o.multipart_form_data &&
      headers == o.headers &&
      request_format == o.request_format &&
      normalize_response == o.normalize_response
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 266

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 = MergeTicketingClient.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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 337

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 243

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


223
224
225
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 229

def hash
  [method, path, base_url_override, data, multipart_form_data, headers, request_format, normalize_response].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



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/merge_ticketing_client/models/data_passthrough_request.rb', line 136

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

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

  if @path.to_s.length < 1
    invalid_properties.push('invalid value for "path", the character length must be great than or equal to 1.')
  end

  if !@base_url_override.nil? && @base_url_override.to_s.length < 1
    invalid_properties.push('invalid value for "base_url_override", the character length must be great than or equal to 1.')
  end

  if !@data.nil? && @data.to_s.length < 1
    invalid_properties.push('invalid value for "data", the character length must be great than or equal to 1.')
  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



313
314
315
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 319

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



307
308
309
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 307

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



163
164
165
166
167
168
169
170
 
# File 'lib/merge_ticketing_client/models/data_passthrough_request.rb', line 163

def valid?
  return false if @method.nil?
  return false if @path.nil?
  return false if @path.to_s.length < 1
  return false if !@base_url_override.nil? && @base_url_override.to_s.length < 1
  return false if !@data.nil? && @data.to_s.length < 1
  true
end