Class: PostfinancecheckoutRubySdk::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.

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#default_template ⇒ Object

Whether this is the default document template which is used whenever no specific template is specified for the same template type.



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

def default_template
  @default_template
end

#delivery_enabled ⇒ Object

Whether documents of this template should be delivered.



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

def delivery_enabled
  @delivery_enabled
end

#id ⇒ Object

A unique identifier for the object.



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

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

The name used to identify the document template.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#space_id ⇒ Object

The ID of the space this object belongs to.



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

def space_id
  @space_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#template_resource ⇒ Object

The resource path to a custom template to be used to generate PDF documents.



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.



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

def type
  @type
end

#version ⇒ Object

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



58
59
60
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 58

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



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
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 284

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



100
101
102
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 100

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 105

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 83

def self.attribute_map
  {
    :'delivery_enabled' => :'deliveryEnabled',
    :'linked_space_id' => :'linkedSpaceId',
    :'space_id' => :'spaceId',
    :'default_template' => :'defaultTemplate',
    :'name' => :'name',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'template_resource' => :'templateResource',
    :'id' => :'id',
    :'state' => :'state',
    :'type' => :'type',
    :'version' => :'version'
  }
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 260

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



127
128
129
130
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 110

def self.openapi_types
  {
    :'delivery_enabled' => :'Boolean',
    :'linked_space_id' => :'Integer',
    :'space_id' => :'Integer',
    :'default_template' => :'Boolean',
    :'name' => :'String',
    :'planned_purge_date' => :'Time',
    :'template_resource' => :'String',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'type' => :'DocumentTemplateType',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 229

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 355

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


247
248
249
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 253

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



195
196
197
198
199
200
201
202
203
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 195

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



331
332
333
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 331

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 337

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



325
326
327
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 325

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



207
208
209
210
211
 
# File 'lib/postfinancecheckout-ruby-sdk/models/document_template.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 100
  true
end