postfinancecheckout-ruby-sdk 3.3.0 → 4.2.0

data/lib/postfinancecheckout-ruby-sdk/models/customer.rb

@@ -20,37 +20,37 @@ require 'date'
 module PostFinanceCheckout
   # 
   class Customer
-    # The created on date indicates the date on which the entity was stored into the database.
+    # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The customer's ID in the merchant's system.
     attr_accessor :customer_id
 
-    # 
+    # The customer's email address.
     attr_accessor :email_address
 
-    # 
+    # The customer's family or last name.
     attr_accessor :family_name
 
-    # 
+    # The customer's given or first name.
     attr_accessor :given_name
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The language that is linked to the object.
     attr_accessor :language
 
-    # The linked space id holds the ID of the space to which the entity belongs to.
+    # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # Meta data allow to store additional data along the object.
+    # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The customer's preferred currency.
     attr_accessor :preferred_currency
 
-    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_active.rb

@@ -20,25 +20,25 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerActive
-    # 
+    # The customer's ID in the merchant's system.
     attr_accessor :customer_id
 
-    # 
+    # The customer's email address.
     attr_accessor :email_address
 
-    # 
+    # The customer's family or last name.
     attr_accessor :family_name
 
-    # 
+    # The customer's given or first name.
     attr_accessor :given_name
 
-    # 
+    # The language that is linked to the object.
     attr_accessor :language
 
-    # Meta data allow to store additional data along the object.
+    # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The customer's preferred currency.
     attr_accessor :preferred_currency
 
     # The ID is the primary key of the entity. The ID identifies the entity uniquely.

data/lib/postfinancecheckout-ruby-sdk/models/customer_address.rb

@@ -20,28 +20,28 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerAddress
-    # 
+    # The actual postal address.
     attr_accessor :address
 
-    # 
+    # Whether the address is for billing or shipping or both.
     attr_accessor :address_type
 
-    # The created on date indicates the date on which the entity was stored into the database.
+    # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The customer that the object belongs to.
     attr_accessor :customer
 
-    # 
+    # Whether this is the customer's default address.
     attr_accessor :default_address
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # The linked space id holds the ID of the space to which the entity belongs to.
+    # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_address_active.rb

@@ -20,10 +20,10 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerAddressActive
-    # 
+    # The actual postal address.
     attr_accessor :address
 
-    # 
+    # Whether the address is for billing or shipping or both.
     attr_accessor :address_type
 
     # The ID is the primary key of the entity. The ID identifies the entity uniquely.

data/lib/postfinancecheckout-ruby-sdk/models/customer_address_create.rb

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerAddressCreate
-    # 
+    # The actual postal address.
     attr_accessor :address
 
-    # 
+    # Whether the address is for billing or shipping or both.
     attr_accessor :address_type
 
-    # 
+    # The customer that the object belongs to.
     attr_accessor :customer
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_comment.rb

@@ -20,34 +20,34 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerComment
-    # 
+    # The comment's actual content.
     attr_accessor :content
 
-    # 
+    # The ID of the user the comment was created by.
     attr_accessor :created_by
 
-    # The created on date indicates the date on which the entity was stored into the database.
+    # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The customer that the object belongs to.
     attr_accessor :customer
 
-    # 
+    # The ID of the user the comment was last updated by.
     attr_accessor :edited_by
 
-    # The date on which the comment was last edited.
+    # The date and time when the comment was last updated.
     attr_accessor :edited_on
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # The linked space id holds the ID of the space to which the entity belongs to.
+    # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # Whether the comment is pinned to the top.
     attr_accessor :pinned
 
-    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_comment_active.rb

@@ -20,7 +20,7 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerCommentActive
-    # 
+    # The comment's actual content.
     attr_accessor :content
 
     # The ID is the primary key of the entity. The ID identifies the entity uniquely.

data/lib/postfinancecheckout-ruby-sdk/models/customer_comment_create.rb

@@ -20,10 +20,10 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerCommentCreate
-    # 
+    # The comment's actual content.
     attr_accessor :content
 
-    # 
+    # The customer that the object belongs to.
     attr_accessor :customer
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_create.rb

@@ -20,25 +20,25 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerCreate
-    # 
+    # The customer's ID in the merchant's system.
     attr_accessor :customer_id
 
-    # 
+    # The customer's email address.
     attr_accessor :email_address
 
-    # 
+    # The customer's family or last name.
     attr_accessor :family_name
 
-    # 
+    # The customer's given or first name.
     attr_accessor :given_name
 
-    # 
+    # The language that is linked to the object.
     attr_accessor :language
 
-    # Meta data allow to store additional data along the object.
+    # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The customer's preferred currency.
     attr_accessor :preferred_currency
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_postal_address.rb

@@ -20,64 +20,64 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerPostalAddress
-    # 
+    # The city, town or village.
     attr_accessor :city
 
-    # 
+    # The commercial registration number of the organization.
     attr_accessor :commercial_register_number
 
-    # 
+    # The two-letter country code (ISO 3166 format).
     attr_accessor :country
 
-    # 
+    # The date of birth.
     attr_accessor :date_of_birth
 
-    # 
+    # The dependent locality which is a sub-division of the state.
     attr_accessor :dependent_locality
 
-    # 
+    # The email address.
     attr_accessor :email_address
 
-    # 
+    # The family or last name.
     attr_accessor :family_name
 
-    # 
+    # The gender.
     attr_accessor :gender
 
-    # 
+    # The given or first name.
     attr_accessor :given_name
 
-    # 
+    # The legal form of the organization.
     attr_accessor :legal_organization_form
 
-    # 
+    # The phone number of a mobile phone.
     attr_accessor :mobile_phone_number
 
-    # 
+    # The organization's name.
     attr_accessor :organization_name
 
-    # 
+    # The phone number.
     attr_accessor :phone_number
 
-    # 
+    # The name of the region, typically a state, county, province or prefecture.
     attr_accessor :postal_state
 
-    # 
+    # The postal code, also known as ZIP, postcode, etc.
     attr_accessor :postcode
 
-    # 
+    # The sales tax number of the organization.
     attr_accessor :sales_tax_number
 
-    # 
+    # The salutation e.g. Mrs, Mr, Dr.
     attr_accessor :salutation
 
-    # 
+    # The social security number.
     attr_accessor :social_security_number
 
-    # The sorting code identifies the post office at which the post box is located in.
+    # The sorting code identifying the post office where the PO Box is located.
     attr_accessor :sorting_code
 
-    # 
+    # The street or PO Box.
     attr_accessor :street
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/customer_postal_address_create.rb

@@ -20,64 +20,64 @@ require 'date'
 module PostFinanceCheckout
   # 
   class CustomerPostalAddressCreate
-    # 
+    # The city, town or village.
     attr_accessor :city
 
-    # 
+    # The commercial registration number of the organization.
     attr_accessor :commercial_register_number
 
-    # 
+    # The two-letter country code (ISO 3166 format).
     attr_accessor :country
 
-    # 
+    # The date of birth.
     attr_accessor :date_of_birth
 
-    # 
+    # The dependent locality which is a sub-division of the state.
     attr_accessor :dependent_locality
 
-    # 
+    # The email address.
     attr_accessor :email_address
 
-    # 
+    # The family or last name.
     attr_accessor :family_name
 
-    # 
+    # The gender.
     attr_accessor :gender
 
-    # 
+    # The given or first name.
     attr_accessor :given_name
 
-    # 
+    # The legal form of the organization.
     attr_accessor :legal_organization_form
 
-    # 
+    # The phone number of a mobile phone.
     attr_accessor :mobile_phone_number
 
-    # 
+    # The organization's name.
     attr_accessor :organization_name
 
-    # 
+    # The phone number.
     attr_accessor :phone_number
 
-    # 
+    # The name of the region, typically a state, county, province or prefecture.
     attr_accessor :postal_state
 
-    # 
+    # The postal code, also known as ZIP, postcode, etc.
     attr_accessor :postcode
 
-    # 
+    # The sales tax number of the organization.
     attr_accessor :sales_tax_number
 
-    # 
+    # The salutation e.g. Mrs, Mr, Dr.
     attr_accessor :salutation
 
-    # 
+    # The social security number.
     attr_accessor :social_security_number
 
-    # The sorting code identifies the post office at which the post box is located in.
+    # The sorting code identifying the post office where the PO Box is located.
     attr_accessor :sorting_code
 
-    # 
+    # The street or PO Box.
     attr_accessor :street
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/delivery_indication.rb

@@ -20,10 +20,10 @@ require 'date'
 module PostFinanceCheckout
   # 
   class DeliveryIndication
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # The linked space id holds the ID of the space to which the entity belongs to.
+    # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
     # 
@@ -38,7 +38,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :completion
 
-    # The created on date indicates the date on which the entity was stored into the database.
+    # The date and time when the object was created.
     attr_accessor :created_on
 
     # 
@@ -50,10 +50,10 @@ module PostFinanceCheckout
     # 
     attr_accessor :manually_decided_on
 
-    # The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
+    # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     attr_accessor :planned_purge_date
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # 

data/lib/postfinancecheckout-ruby-sdk/models/delivery_indication_decision_reason.rb

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class DeliveryIndicationDecisionReason
-    # 
+    # The localized description of the object.
     attr_accessor :description
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The localized name of the object.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/document_template.rb

@@ -26,22 +26,22 @@ module PostFinanceCheckout
     # 
     attr_accessor :delivery_enabled
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # The linked space id holds the ID of the space to which the entity belongs to.
+    # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
     # 
     attr_accessor :name
 
-    # The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
+    # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     attr_accessor :planned_purge_date
 
     # 
     attr_accessor :space_id
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # 
@@ -50,7 +50,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :type
 
-    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/document_template_type.rb

@@ -29,7 +29,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :group
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
     # 

data/lib/postfinancecheckout-ruby-sdk/models/document_template_type_group.rb

@@ -20,7 +20,7 @@ require 'date'
 module PostFinanceCheckout
   # 
   class DocumentTemplateTypeGroup
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
     # 

data/lib/postfinancecheckout-ruby-sdk/models/external_transfer_bank_transaction.rb

@@ -32,13 +32,13 @@ module PostFinanceCheckout
     # 
     attr_accessor :external_bank_name
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # The linked space id holds the ID of the space to which the entity belongs to.
+    # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/failure_reason.rb

@@ -23,16 +23,16 @@ module PostFinanceCheckout
     # 
     attr_accessor :category
 
-    # 
+    # The localized description of the object.
     attr_accessor :description
 
     # 
     attr_accessor :features
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The localized name of the object.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/feature.rb

@@ -20,28 +20,28 @@ require 'date'
 module PostFinanceCheckout
   # 
   class Feature
-    # 
+    # Whether the feature is in beta stage and there may still be some issues.
     attr_accessor :beta
 
-    # 
+    # The category that the feature belongs to.
     attr_accessor :category
 
-    # 
+    # The localized description of the object.
     attr_accessor :description
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The path to the feature's logo image.
     attr_accessor :logo_path
 
-    # 
+    # The localized name of the object.
     attr_accessor :name
 
-    # 
+    # The features that must be enabled for this feature to work properly.
     attr_accessor :required_features
 
-    # 
+    # When listing features, they can be sorted by this number.
     attr_accessor :sort_order
 
     # 

data/lib/postfinancecheckout-ruby-sdk/models/feature_category.rb

@@ -20,16 +20,16 @@ require 'date'
 module PostFinanceCheckout
   # 
   class FeatureCategory
-    # 
+    # The localized description of the object.
     attr_accessor :description
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The localized name of the object.
     attr_accessor :name
 
-    # 
+    # When listing feature categories, they can be sorted by this number.
     attr_accessor :order_weight
 
     # Attribute mapping from ruby-style variable name to JSON key.