Class: Kickflow::ExternalApiSetting

Inherits:
Object
  • Object
show all
Defined in:
lib/kickflow/models/external_api_setting.rb

Overview

外部API設定

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalApiSetting

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
160
 
# File 'lib/kickflow/models/external_api_setting.rb', line 102

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

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

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

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

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

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

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

Instance Attribute Details

#array_json_path ⇒ Object

複数レコードを含む場合の配列へのJSONPath



35
36
37
 
# File 'lib/kickflow/models/external_api_setting.rb', line 35

def array_json_path
  @array_json_path
end

#headers ⇒ Object

リクエストヘッダー



29
30
31
 
# File 'lib/kickflow/models/external_api_setting.rb', line 29

def headers
  @headers
end

#http_method ⇒ Object

HTTPメソッド



23
24
25
 
# File 'lib/kickflow/models/external_api_setting.rb', line 23

def http_method
  @http_method
end

#id ⇒ Object

UUID



20
21
22
 
# File 'lib/kickflow/models/external_api_setting.rb', line 20

def id
  @id
end

#mappings ⇒ Object

フィールドへのマッピング設定



38
39
40
 
# File 'lib/kickflow/models/external_api_setting.rb', line 38

def mappings
  @mappings
end

#response_array ⇒ Object

レスポンスが複数レコードを含む場合true



32
33
34
 
# File 'lib/kickflow/models/external_api_setting.rb', line 32

def response_array
  @response_array
end

#url ⇒ Object

URL



26
27
28
 
# File 'lib/kickflow/models/external_api_setting.rb', line 26

def url
  @url
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



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
304
305
306
307
308
309
 
# File 'lib/kickflow/models/external_api_setting.rb', line 272

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



76
77
78
 
# File 'lib/kickflow/models/external_api_setting.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/kickflow/models/external_api_setting.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'http_method' => :'httpMethod',
    :'url' => :'url',
    :'headers' => :'headers',
    :'response_array' => :'responseArray',
    :'array_json_path' => :'arrayJsonPath',
    :'mappings' => :'mappings'
  }
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/kickflow/models/external_api_setting.rb', line 248

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



94
95
96
97
98
 
# File 'lib/kickflow/models/external_api_setting.rb', line 94

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/kickflow/models/external_api_setting.rb', line 81

def self.openapi_types
  {
    :'id' => :'String',
    :'http_method' => :'String',
    :'url' => :'String',
    :'headers' => :'Array<ExternalApiSettingHeadersInner>',
    :'response_array' => :'Boolean',
    :'array_json_path' => :'String',
    :'mappings' => :'Array<ExternalApiSettingMappingsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/kickflow/models/external_api_setting.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      http_method == o.http_method &&
      url == o.url &&
      headers == o.headers &&
      response_array == o.response_array &&
      array_json_path == o.array_json_path &&
      mappings == o.mappings
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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/kickflow/models/external_api_setting.rb', line 343

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


235
236
237
 
# File 'lib/kickflow/models/external_api_setting.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/kickflow/models/external_api_setting.rb', line 241

def hash
  [id, http_method, url, headers, response_array, array_json_path, mappings].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



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
 
# File 'lib/kickflow/models/external_api_setting.rb', line 164

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 @http_method.nil?
    invalid_properties.push('invalid value for "http_method", http_method cannot be nil.')
  end

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

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

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

  if @mappings.nil?
    invalid_properties.push('invalid value for "mappings", mappings 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



319
320
321
 
# File 'lib/kickflow/models/external_api_setting.rb', line 319

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/kickflow/models/external_api_setting.rb', line 325

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



313
314
315
 
# File 'lib/kickflow/models/external_api_setting.rb', line 313

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



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/kickflow/models/external_api_setting.rb', line 196

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @http_method.nil?
  http_method_validator = EnumAttributeValidator.new('String', ["get", "post", "put", "delete", "patch"])
  return false unless http_method_validator.valid?(@http_method)
  return false if @url.nil?
  return false if @headers.nil?
  return false if @response_array.nil?
  return false if @mappings.nil?
  true
end