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



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
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 108

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
  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 `CityPayApiClient::PaylinkCustomParam`. 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?(:'auth_meta_data')
    self.auth_meta_data = attributes[:'auth_meta_data']
  end

  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

#auth_meta_data ⇒ Object

Determines if the custom parameter is stored as meta data against an authorisation allowing for that authorisation to be searched and queried by the result of this value. Defaults to false.



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

def auth_meta_data
  @auth_meta_data
end

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



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

def entry_mode
  @entry_mode
end

#field_type ⇒ Object

The type of html field, defaulting to ‘text`. Options are: - `dob` A date of birth field as a series of select list entries - `text` Allows the user to enter any text. - `password` A field where the characters are masked to protect the input, typically used for passwords. - `email` Used for input fields that should contain an email address. - `number` For numeric input, can include controls for incrementing or decrementing the number. - `tel` For telephone numbers. - `url` A text field for entering a URL. - `hidden` Not visible to the user, but its value is sent when the form is submitted. - `checkbox` A check box allowing single values to be selected/deselected. - `radio` Allows the user to select one of a limited number of choices. - `select` Renders as select items Select Options: Select options are constructed by providing a list of values in the value custom parameter field. Each value is delimited by a pipe character `|`. Value items can also be delimited with `:` as a value label pair. For instance, a sports club requires identifying it’s age group for membership entry: <CodeGroup title="Select Examples" label="ProcessBatchRequest"> “‘json title: ’Basic Values’ } { "label" : "Age Group", "fieldType": "select", "value" : "Under 18|18-30|30-50|50+" }… <select> <option value="Under 18">Under 18</option> <option value="18-30">18-30</option> <option value="30-50">30-50</option> <option value="50+">50+</option> </select> “‘ “`json title: ’Label and Values’ } { "label" : "Age Group", "fieldType": "select", "value" : "0:Under 18|1:18-30|2:30-50|3:50+" }… <select> <option value="0">Under 18</option> <option value="1">18-30</option> <option value="2">30-50</option> <option value="3">50+</option> </select> “‘ </CodeGroup> Fields may be requested as optional. If a select is required to be optional, provide a value such as `:Select an Option|options…` at the front of the list.



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

def field_type
  @field_type
end

#group ⇒ Object

A value which groups items for layout. The value should be a string title for rendering such as "Your Account Info". If no value is provided, the parameter is added to a default parameter group. Group names are ordered alphabetically when rendered.



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

def group
  @group
end

#label ⇒ Object

A label to show alongside the input. If this value is not supplied, the name value will be used.



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

def label
  @label
end

#locked ⇒ Object

States whether the field is locked, preventing entry or amendment by the person completing the form.



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

def locked
  @locked
end

#name ⇒ Object

Refers to the rendered HTML form element name. The value of this field is used in the postback and redirect dataset.



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

def name
  @name
end

#order ⇒ Object

A value which allows you to order the position of elements in a grouping. Values will order in ascending order. Negative values are possible.



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

def order
  @order
end

#pattern ⇒ Object

A string value which specifies the validation logic of the form element, for example a value of QA3,4 will require a value such as QA221 or QA4433.



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

def pattern
  @pattern
end

#placeholder ⇒ Object

A value to set as the placeholder attribute which will render in the browser.



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

def placeholder
  @placeholder
end

#required ⇒ Object

A boolean value that states whether the field is required or optional. When an element is required, validation will be performed on the end user’s input form.



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

def required
  @required
end

#value ⇒ Object

An initial value for the parameter as it appears on the Form. If your parameter is hidden, the value will be required.



52
53
54
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 52

def value
  @value
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



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

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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 78

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 55

def self.attribute_map
  {
    :'auth_meta_data' => :'auth_meta_data',
    :'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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 227

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



101
102
103
104
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 83

def self.openapi_types
  {
    :'auth_meta_data' => :'Boolean',
    :'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.



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auth_meta_data == o.auth_meta_data &&
      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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 322

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

See Also:

  • `==` method


214
215
216
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



220
221
222
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 220

def hash
  [auth_meta_data, 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?



175
176
177
178
179
180
181
182
183
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 175

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)



298
299
300
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 298

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



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

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



292
293
294
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 292

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



187
188
189
190
191
 
# File 'lib/citypay_api_client/models/paylink_custom_param.rb', line 187

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