Class: PostFinanceCheckout::DocumentTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/document_template.rb

Overview

A document template contains the customizations for a particular document template type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 92

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'defaultTemplate')
    self.default_template = attributes[:'defaultTemplate']
  end

  if attributes.has_key?(:'deliveryEnabled')
    self.delivery_enabled = attributes[:'deliveryEnabled']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'linkedSpaceId')
    self.linked_space_id = attributes[:'linkedSpaceId']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'plannedPurgeDate')
    self.planned_purge_date = attributes[:'plannedPurgeDate']
  end

  if attributes.has_key?(:'spaceId')
    self.space_id = attributes[:'spaceId']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'templateResource')
    self.template_resource = attributes[:'templateResource']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#default_template ⇒ Object

The default document template is used whenever no specific template is specified for a particular template type.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 24

def default_template
  @default_template
end

#delivery_enabled ⇒ Object

Returns the value of attribute delivery_enabled.



27
28
29
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 27

def delivery_enabled
  @delivery_enabled
end

#id ⇒ Object

A unique identifier for the object.



30
31
32
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 30

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



33
34
35
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 33

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

Returns the value of attribute name.



36
37
38
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 36

def name
  @name
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



39
40
41
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 39

def planned_purge_date
  @planned_purge_date
end

#space_id ⇒ Object

Returns the value of attribute space_id.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 42

def space_id
  @space_id
end

#state ⇒ Object

The object’s current state.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 45

def state
  @state
end

#template_resource ⇒ Object

Returns the value of attribute template_resource.



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 48

def template_resource
  @template_resource
end

#type ⇒ Object

Returns the value of attribute type.



51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 51

def type
  @type
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 54

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 57

def self.attribute_map
  {
    :'default_template' => :'defaultTemplate',
    :'delivery_enabled' => :'deliveryEnabled',
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'space_id' => :'spaceId',
    :'state' => :'state',
    :'template_resource' => :'templateResource',
    :'type' => :'type',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 74

def self.swagger_types
  {
    :'default_template' => :'BOOLEAN',
    :'delivery_enabled' => :'BOOLEAN',
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'name' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'space_id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'template_resource' => :'ResourcePath',
    :'type' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_template == o.default_template &&
      delivery_enabled == o.delivery_enabled &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      name == o.name &&
      planned_purge_date == o.planned_purge_date &&
      space_id == o.space_id &&
      state == o.state &&
      template_resource == o.template_resource &&
      type == o.type &&
      version == o.version
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



225
226
227
228
229
230
231
232
233
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 225

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = PostFinanceCheckout.const_get(type).new
    temp_model.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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 291

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 204

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 197

def hash
  [default_template, delivery_enabled, id, linked_space_id, name, planned_purge_date, space_id, state, template_resource, type, version].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



145
146
147
148
149
150
151
152
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  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



271
272
273
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 271

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



277
278
279
280
281
282
283
284
285
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 277

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



265
266
267
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 265

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



156
157
158
159
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 156

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  true
end