postfinancecheckout-ruby-sdk 3.3.0 → 4.2.0

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

@@ -20,30 +20,30 @@ require 'date'
 module PostFinanceCheckout
   # 
   class RestCountry
-    # The ISO code 2 letter identifies the country by two chars as defined in ISO 3166-1 (e.g. US, DE, CH).
-    attr_accessor :iso_code2_letter
+    # Specifies the country's way of formatting addresses.
+    attr_accessor :address_format
 
-    # The ISO code 3 letter identifies the country by three chars as defined in ISO 3166-1 (e.g. CHE, USA, GBR).
-    attr_accessor :iso_code3_letter
+    # The country's two-letter code (ISO 3166-1 alpha-2 format).
+    attr_accessor :iso_code2
 
-    # The address format of the country indicates how an address has to look like for the country.
-    attr_accessor :address_format
+    # The country's three-letter code (ISO 3166-1 alpha-3 format).
+    attr_accessor :iso_code3
 
-    # The name labels the country by a name in English.
+    # The name of the country.
     attr_accessor :name
 
-    # The numeric code identifies the country by a three digit number as defined in ISO 3166-1 (e.g. 840, 826, 756).
+    # The country's three-digit code (ISO 3166-1 numeric format).
     attr_accessor :numeric_code
 
-    # The state codes field is a list of all states associated with this country. The list contains the identifiers of the states. The identifiers corresponds to the ISO 3166-2 subdivision identifier.
+    # The codes of all regions (e.g. states, provinces) of the country (ISO 3166-2 format).
     attr_accessor :state_codes
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'iso_code2_letter' => :'ISOCode2Letter',
-        :'iso_code3_letter' => :'ISOCode3Letter',
         :'address_format' => :'addressFormat',
+        :'iso_code2' => :'isoCode2',
+        :'iso_code3' => :'isoCode3',
         :'name' => :'name',
         :'numeric_code' => :'numericCode',
         :'state_codes' => :'stateCodes'
@@ -53,9 +53,9 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'iso_code2_letter' => :'String',
-        :'iso_code3_letter' => :'String',
         :'address_format' => :'RestAddressFormat',
+        :'iso_code2' => :'String',
+        :'iso_code3' => :'String',
         :'name' => :'String',
         :'numeric_code' => :'String',
         :'state_codes' => :'Array<String>'
@@ -70,16 +70,16 @@ module PostFinanceCheckout
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'ISOCode2Letter')
-        self.iso_code2_letter = attributes[:'ISOCode2Letter']
+      if attributes.has_key?(:'addressFormat')
+        self.address_format = attributes[:'addressFormat']
       end
 
-      if attributes.has_key?(:'ISOCode3Letter')
-        self.iso_code3_letter = attributes[:'ISOCode3Letter']
+      if attributes.has_key?(:'isoCode2')
+        self.iso_code2 = attributes[:'isoCode2']
       end
 
-      if attributes.has_key?(:'addressFormat')
-        self.address_format = attributes[:'addressFormat']
+      if attributes.has_key?(:'isoCode3')
+        self.iso_code3 = attributes[:'isoCode3']
       end
 
       if attributes.has_key?(:'name')
@@ -115,9 +115,9 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          iso_code2_letter == o.iso_code2_letter &&
-          iso_code3_letter == o.iso_code3_letter &&
           address_format == o.address_format &&
+          iso_code2 == o.iso_code2 &&
+          iso_code3 == o.iso_code3 &&
           name == o.name &&
           numeric_code == o.numeric_code &&
           state_codes == o.state_codes
@@ -132,7 +132,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [iso_code2_letter, iso_code3_letter, address_format, name, numeric_code, state_codes].hash
+      [address_format, iso_code2, iso_code3, name, numeric_code, state_codes].hash
     end
 
     # Builds the object from hash

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

@@ -20,22 +20,26 @@ require 'date'
 module PostFinanceCheckout
   # 
   class RestCountryState
-    # The code of the state identifies the state. The code is typically used within addresses. Some countries may not provide a code. For those the field is null.
+    # The state's code used within addresses.
     attr_accessor :code
 
-    # The country code in ISO two letter format (e.g. UK, DE, CH, US).
+    # 
+    attr_accessor :country
+
+    # The two-letter code of the state's country (ISO 3166-1 alpha-2 format).
     attr_accessor :country_code
 
-    # The ID of the state corresponds to the subdivision identifier defined in ISO 3166-2. The format consists of the country code followed by a dash and a subdivision identifier.
+    # The state's code in ISO 3166-2 format.
     attr_accessor :id
 
-    # The name is a human readable label of the state in the language of the region.
+    # The name of the state.
     attr_accessor :name
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'code' => :'code',
+        :'country' => :'country',
         :'country_code' => :'countryCode',
         :'id' => :'id',
         :'name' => :'name'
@@ -46,6 +50,7 @@ module PostFinanceCheckout
     def self.swagger_types
       {
         :'code' => :'String',
+        :'country' => :'String',
         :'country_code' => :'String',
         :'id' => :'String',
         :'name' => :'String'
@@ -64,6 +69,10 @@ module PostFinanceCheckout
         self.code = attributes[:'code']
       end
 
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
       if attributes.has_key?(:'countryCode')
         self.country_code = attributes[:'countryCode']
       end
@@ -96,6 +105,7 @@ module PostFinanceCheckout
       return true if self.equal?(o)
       self.class == o.class &&
           code == o.code &&
+          country == o.country &&
           country_code == o.country_code &&
           id == o.id &&
           name == o.name
@@ -110,7 +120,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [code, country_code, id, name].hash
+      [code, country, country_code, id, name].hash
     end
 
     # Builds the object from hash

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

@@ -20,13 +20,16 @@ require 'date'
 module PostFinanceCheckout
   # 
   class RestCurrency
-    # The currency code identifies the currency with the three char long ISO 4217 code (e.g. USD, CHF, EUR).
+    # The currency's three-letter code (ISO 4217 format).
     attr_accessor :currency_code
 
-    # The fraction digits indicates how many places the currency has. This also indicates with which precision we calculate internally when we do calculations with this currency.
+    # The currency's number of decimals. When calculating amounts in this currency, the fraction digits determine the accuracy.
     attr_accessor :fraction_digits
 
-    # The numeric code identifies the currency with the three digit long ISO 4217 code (e.g. 978, 756, 840).
+    # The name of the currency.
+    attr_accessor :name
+
+    # The currency's three-digit code (ISO 4217 format).
     attr_accessor :numeric_code
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -34,6 +37,7 @@ module PostFinanceCheckout
       {
         :'currency_code' => :'currencyCode',
         :'fraction_digits' => :'fractionDigits',
+        :'name' => :'name',
         :'numeric_code' => :'numericCode'
       }
     end
@@ -43,6 +47,7 @@ module PostFinanceCheckout
       {
         :'currency_code' => :'String',
         :'fraction_digits' => :'Integer',
+        :'name' => :'String',
         :'numeric_code' => :'Integer'
       }
     end
@@ -63,6 +68,10 @@ module PostFinanceCheckout
         self.fraction_digits = attributes[:'fractionDigits']
       end
 
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.has_key?(:'numericCode')
         self.numeric_code = attributes[:'numericCode']
       end
@@ -88,6 +97,7 @@ module PostFinanceCheckout
       self.class == o.class &&
           currency_code == o.currency_code &&
           fraction_digits == o.fraction_digits &&
+          name == o.name &&
           numeric_code == o.numeric_code
     end
 
@@ -100,7 +110,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [currency_code, fraction_digits, numeric_code].hash
+      [currency_code, fraction_digits, name, numeric_code].hash
     end
 
     # Builds the object from hash

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

@@ -20,22 +20,25 @@ require 'date'
 module PostFinanceCheckout
   # 
   class RestLanguage
-    # The country code represents the region of the language as a 2 letter ISO code.
+    # The two-letter code of the language's region (ISO 3166-1 alpha-2 format).
     attr_accessor :country_code
 
-    # The IETF code represents the language as the two letter ISO code including the region (e.g. en-US).
+    # The language's IETF tag consisting of the two-letter ISO code and region e.g. en-US, de-CH.
     attr_accessor :ietf_code
 
-    # The ISO 2 letter code represents the language with two letters.
+    # The language's two-letter code (ISO 639-1 format).
     attr_accessor :iso2_code
 
-    # The ISO 3 letter code represents the language with three letters.
+    # The language's three-letter code (ISO 639-2/T format).
     attr_accessor :iso3_code
 
-    # The plural expression defines how to map a plural into the language index. This expression is used to determine the plural form for the translations.
+    # The name of the language.
+    attr_accessor :name
+
+    # The expression to determine the plural index for a given number of items used to find the proper plural form for translations.
     attr_accessor :plural_expression
 
-    # The primary language of a group indicates whether a language is the primary language of a group of languages. The group is determine by the ISO 2 letter code.
+    # Whether this is the primary language in a group of languages.
     attr_accessor :primary_of_group
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -45,6 +48,7 @@ module PostFinanceCheckout
         :'ietf_code' => :'ietfCode',
         :'iso2_code' => :'iso2Code',
         :'iso3_code' => :'iso3Code',
+        :'name' => :'name',
         :'plural_expression' => :'pluralExpression',
         :'primary_of_group' => :'primaryOfGroup'
       }
@@ -57,6 +61,7 @@ module PostFinanceCheckout
         :'ietf_code' => :'String',
         :'iso2_code' => :'String',
         :'iso3_code' => :'String',
+        :'name' => :'String',
         :'plural_expression' => :'String',
         :'primary_of_group' => :'BOOLEAN'
       }
@@ -86,6 +91,10 @@ module PostFinanceCheckout
         self.iso3_code = attributes[:'iso3Code']
       end
 
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
       if attributes.has_key?(:'pluralExpression')
         self.plural_expression = attributes[:'pluralExpression']
       end
@@ -117,6 +126,7 @@ module PostFinanceCheckout
           ietf_code == o.ietf_code &&
           iso2_code == o.iso2_code &&
           iso3_code == o.iso3_code &&
+          name == o.name &&
           plural_expression == o.plural_expression &&
           primary_of_group == o.primary_of_group
     end
@@ -130,7 +140,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [country_code, ietf_code, iso2_code, iso3_code, plural_expression, primary_of_group].hash
+      [country_code, ietf_code, iso2_code, iso3_code, name, plural_expression, primary_of_group].hash
     end
 
     # Builds the object from hash

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

@@ -20,28 +20,28 @@ require 'date'
 module PostFinanceCheckout
   # 
   class Role
-    # The account to which this role belongs to. This role can only be assigned within the assigned account and the sub accounts of the assigned account.
+    # The account the role belongs to. The role can only be assigned within this account.
     attr_accessor :account
 
-    # 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 name of this role is used to identify the role within administrative interfaces.
+    # The name used to identify the role.
     attr_accessor :name
 
-    # Set of permissions that are granted to this role.
+    # The permissions granted to users with this role.
     attr_accessor :permissions
 
-    # 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
 
-    # Defines whether having been granted this role will force a user to use two-factor authentication.
+    # Whether users with this role are required to use two-factor authentication.
     attr_accessor :two_factor_required
 
-    # 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.
@@ -63,7 +63,7 @@ module PostFinanceCheckout
       {
         :'account' => :'Account',
         :'id' => :'Integer',
-        :'name' => :'DatabaseTranslatedString',
+        :'name' => :'Hash<String, String>',
         :'permissions' => :'Array<Permission>',
         :'planned_purge_date' => :'DateTime',
         :'state' => :'RoleState',
@@ -89,7 +89,9 @@ module PostFinanceCheckout
       end
 
       if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+        if (value = attributes[:'name']).is_a?(Hash)
+          self.name = value
+        end
       end
 
       if attributes.has_key?(:'permissions')

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

@@ -20,16 +20,16 @@ require 'date'
 module PostFinanceCheckout
   # 
   class SalesChannel
-    # 
+    # The localized description of the object.
     attr_accessor :description
 
     # 
     attr_accessor :icon
 
-    # 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
 
     # 

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

@@ -20,40 +20,40 @@ require 'date'
 module PostFinanceCheckout
   # 
   class Scope
-    # The domain name to which this scope is mapped to.
+    # The domain name that belongs to the scope.
     attr_accessor :domain_name
 
-    # 
+    # The list of features that are active in the scope.
     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 name identifying the scope in e.g. URLs.
     attr_accessor :machine_name
 
-    # The name of the scope is shown to the user where the user should select a scope.
+    # The name used to identify the scope.
     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
 
-    # The port number to which this scope is mapped to.
+    # The port where the scope can be accessed.
     attr_accessor :port
 
-    # Define whether the scope supports SSL.
+    # Whether the scope supports SSL.
     attr_accessor :ssl_active
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
-    # The themes determines how the application layout, look and feel is. By providing multiple themes you can fallback to other themes.
+    # The themes that determine the look and feel of the scope's user interface. A fall-through strategy is applied when building the actual theme.
     attr_accessor :themes
 
-    # 
+    # The URL where the scope can be accessed.
     attr_accessor :url
 
-    # 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/shopify_integration.rb

@@ -32,7 +32,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :currency
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
     # Enabling the integrated payment form will embed the payment form in the Shopify shop. The app needs to be installed for this to be possible.
@@ -56,7 +56,7 @@ module PostFinanceCheckout
     # Define the path of the proxy URL. This only needs to be changed if the apps proxy URL is overwritten in the Shopify store.
     attr_accessor :payment_proxy_path
 
-    # 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
 
     # 
@@ -77,7 +77,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :space_view_id
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # 
@@ -89,7 +89,7 @@ module PostFinanceCheckout
     # Define the path of the proxy URL. This only needs to be changed if the apps proxy URL is overwritten in the Shopify store.
     attr_accessor :subscription_proxy_path
 
-    # 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/shopify_recurring_order.rb

@@ -20,10 +20,10 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ShopifyRecurringOrder
-    # 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
 
     # 
@@ -50,7 +50,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :planned_execution_date
 
-    # 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
 
     # 
@@ -62,7 +62,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :started_processing_on
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # 

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

@@ -29,25 +29,25 @@ module PostFinanceCheckout
     # A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
     attr_accessor :external_id
 
-    # 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 :phone_number
 
-    # 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 :shop
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
-    # 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/shopify_subscription.rb

@@ -29,7 +29,7 @@ module PostFinanceCheckout
     # The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
     attr_accessor :external_id
 
-    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    # A unique identifier for the object.
     attr_accessor :id
 
     # 
@@ -41,10 +41,10 @@ module PostFinanceCheckout
     # 
     attr_accessor :initial_shopify_transaction
 
-    # 
+    # 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
 
     # 
@@ -53,7 +53,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :shop
 
-    # 
+    # The object's current state.
     attr_accessor :state
 
     # 
@@ -68,7 +68,7 @@ module PostFinanceCheckout
     # 
     attr_accessor :termination_request_date
 
-    # 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/shopify_subscription_address.rb

@@ -20,64 +20,64 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ShopifySubscriptionAddress
-    # 
+    # 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.