Class: CityPayApiClient::PaylinkCustomParam

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/paylink_custom_param.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaylinkCustomParam

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 97

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#entry_mode ⇒ Object

The type of entry mode. A value of ‘pre’ will pre-render the custom parameter before the payment screen. Any other value will result in the custom parameter being displayed on the payment screen.



18
19
20
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 18

def entry_mode
  @entry_mode
end

#field_type ⇒ Object

the type of html5 field, defaults to ‘text’. Other options are ‘dob’ for a date of birth series of select list entry.



21
22
23
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 21

def field_type
  @field_type
end

#group ⇒ Object

a group the parameter is linked with, allows for grouping with a title.



24
25
26
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 24

def group
  @group
end

#label ⇒ Object

a label to show alongside the input.



27
28
29
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 27

def label
  @label
end

#locked ⇒ Object

whether the parameter is locked from entry.



30
31
32
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 30

def locked
  @locked
end

#name ⇒ Object

the name of the custom parameter used to converse with the submitter.



33
34
35
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 33

def name
  @name
end

#order ⇒ Object

an index order for the parameter.



36
37
38
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 36

def order
  @order
end

#pattern ⇒ Object

a regex pattern to validate the custom parameter with.



39
40
41
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 39

def pattern
  @pattern
end

#placeholder ⇒ Object

a placehold value to display in the input.



42
43
44
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 42

def placeholder
  @placeholder
end

#required ⇒ Object

whether the field is required.



45
46
47
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 45

def required
  @required
end

#value ⇒ Object

a default value for the field.



48
49
50
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 48

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 234

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



68
69
70
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 68

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 51

def self.attribute_map
  {
    :'entry_mode' => :'entry_mode',
    :'field_type' => :'field_type',
    :'group' => :'group',
    :'label' => :'label',
    :'locked' => :'locked',
    :'name' => :'name',
    :'order' => :'order',
    :'pattern' => :'pattern',
    :'placeholder' => :'placeholder',
    :'required' => :'required',
    :'value' => :'value'
  }
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 210

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



90
91
92
93
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 73

def self.openapi_types
  {
    :'entry_mode' => :'String',
    :'field_type' => :'String',
    :'group' => :'String',
    :'label' => :'String',
    :'locked' => :'Boolean',
    :'name' => :'String',
    :'order' => :'Integer',
    :'pattern' => :'String',
    :'placeholder' => :'String',
    :'required' => :'Boolean',
    :'value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      entry_mode == o.entry_mode &&
      field_type == o.field_type &&
      group == o.group &&
      label == o.label &&
      locked == o.locked &&
      name == o.name &&
      order == o.order &&
      pattern == o.pattern &&
      placeholder == o.placeholder &&
      required == o.required &&
      value == o.value
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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 305

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


197
198
199
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 203

def hash
  [entry_mode, field_type, group, label, locked, name, order, pattern, placeholder, required, value].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



159
160
161
162
163
164
165
166
167
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



281
282
283
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 281

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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 287

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



275
276
277
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 275

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



171
172
173
174
175
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 171

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