postfinancecheckout-ruby-sdk 3.0.2

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

@@ -0,0 +1,301 @@
+=begin
+The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module PostFinanceCheckout
+  # 
+  class ShopifyTransaction
+    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    attr_accessor :id
+
+    # The linked space id holds the ID of the space to which the entity belongs to.
+    attr_accessor :linked_space_id
+
+    # 
+    attr_accessor :linked_transaction
+
+    # 
+    attr_accessor :checkout_id
+
+    # The created on date indicates the date on which the entity was stored into the database.
+    attr_accessor :created_on
+
+    # 
+    attr_accessor :integration
+
+    # 
+    attr_accessor :order_id
+
+    # 
+    attr_accessor :order_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.
+    attr_accessor :planned_purge_date
+
+    # 
+    attr_accessor :state
+
+    # 
+    attr_accessor :transaction
+
+    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
+        :'checkout_id' => :'checkoutId',
+        :'created_on' => :'createdOn',
+        :'integration' => :'integration',
+        :'order_id' => :'orderId',
+        :'order_name' => :'orderName',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'state' => :'state',
+        :'transaction' => :'transaction',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
+        :'checkout_id' => :'String',
+        :'created_on' => :'DateTime',
+        :'integration' => :'ShopifyIntegration',
+        :'order_id' => :'String',
+        :'order_name' => :'String',
+        :'planned_purge_date' => :'DateTime',
+        :'state' => :'ShopifyTransactionState',
+        :'transaction' => :'Transaction',
+        :'version' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'linkedSpaceId')
+        self.linked_space_id = attributes[:'linkedSpaceId']
+      end
+
+      if attributes.has_key?(:'linkedTransaction')
+        self.linked_transaction = attributes[:'linkedTransaction']
+      end
+
+      if attributes.has_key?(:'checkoutId')
+        self.checkout_id = attributes[:'checkoutId']
+      end
+
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
+      if attributes.has_key?(:'integration')
+        self.integration = attributes[:'integration']
+      end
+
+      if attributes.has_key?(:'orderId')
+        self.order_id = attributes[:'orderId']
+      end
+
+      if attributes.has_key?(:'orderName')
+        self.order_name = attributes[:'orderName']
+      end
+
+      if attributes.has_key?(:'plannedPurgeDate')
+        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'transaction')
+        self.transaction = attributes[:'transaction']
+      end
+
+      if attributes.has_key?(:'version')
+        self.version = attributes[:'version']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
+          checkout_id == o.checkout_id &&
+          created_on == o.created_on &&
+          integration == o.integration &&
+          order_id == o.order_id &&
+          order_name == o.order_name &&
+          planned_purge_date == o.planned_purge_date &&
+          state == o.state &&
+          transaction == o.transaction &&
+          version == o.version
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, linked_space_id, linked_transaction, checkout_id, created_on, integration, order_id, order_name, planned_purge_date, state, transaction, version].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+end

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

@@ -0,0 +1,38 @@
+=begin
+The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module PostFinanceCheckout
+  class ShopifyTransactionState
+    
+    PENDING = 'PENDING'.freeze
+    AUTHORIZED = 'AUTHORIZED'.freeze
+    COMPLETED = 'COMPLETED'.freeze
+    FAILED = 'FAILED'.freeze
+    CONFLICTING = 'CONFLICTING'.freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = ShopifyTransactionState.constants.select { |c| ShopifyTransactionState::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #ShopifyTransactionState" if constantValues.empty?
+      value
+    end
+  end
+end

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

@@ -0,0 +1,407 @@
+=begin
+The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout web service.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module PostFinanceCheckout
+  # 
+  class Space
+    # The account to which the space belongs to.
+    attr_accessor :account
+
+    # Active means that this account and all accounts in the hierarchy are active.
+    attr_accessor :active
+
+    # This property is true when all accounts in the hierarchy are active or restricted active.
+    attr_accessor :active_or_restricted_active
+
+    # The ID of the user who created this entity.
+    attr_accessor :created_by
+
+    # The date and time when this entity was created.
+    attr_accessor :created_on
+
+    # The database in which the space's data are stored in.
+    attr_accessor :database
+
+    # The ID of a user that deleted this entity.
+    attr_accessor :deleted_by
+
+    # The date and time when this entity was deleted.
+    attr_accessor :deleted_on
+
+    # The ID is the primary key of the entity. The ID identifies the entity uniquely.
+    attr_accessor :id
+
+    # 
+    attr_accessor :last_modified_date
+
+    # The space name is used internally to identify the space in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
+    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.
+    attr_accessor :planned_purge_date
+
+    # The address to use in communication with clients for example in email, documents etc.
+    attr_accessor :postal_address
+
+    # This is the currency that is used to display aggregated amounts in the space.
+    attr_accessor :primary_currency
+
+    # The request limit defines the maximum number of API request accepted within 2 minutes for this space. This limit can only be changed with special privileges.
+    attr_accessor :request_limit
+
+    # Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.
+    attr_accessor :restricted_active
+
+    # 
+    attr_accessor :state
+
+    # The email address provided as contact addresses will be informed about technical issues or errors triggered by the space.
+    attr_accessor :technical_contact_addresses
+
+    # The time zone assigned to the space determines the time offset for calculating dates within the space. This is typically used for background processed which needs to be triggered on a specific hour within the day. Changing the space time zone will not change the display of dates.
+    attr_accessor :time_zone
+
+    # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account' => :'account',
+        :'active' => :'active',
+        :'active_or_restricted_active' => :'activeOrRestrictedActive',
+        :'created_by' => :'createdBy',
+        :'created_on' => :'createdOn',
+        :'database' => :'database',
+        :'deleted_by' => :'deletedBy',
+        :'deleted_on' => :'deletedOn',
+        :'id' => :'id',
+        :'last_modified_date' => :'lastModifiedDate',
+        :'name' => :'name',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'postal_address' => :'postalAddress',
+        :'primary_currency' => :'primaryCurrency',
+        :'request_limit' => :'requestLimit',
+        :'restricted_active' => :'restrictedActive',
+        :'state' => :'state',
+        :'technical_contact_addresses' => :'technicalContactAddresses',
+        :'time_zone' => :'timeZone',
+        :'version' => :'version'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'account' => :'Account',
+        :'active' => :'BOOLEAN',
+        :'active_or_restricted_active' => :'BOOLEAN',
+        :'created_by' => :'Integer',
+        :'created_on' => :'DateTime',
+        :'database' => :'TenantDatabase',
+        :'deleted_by' => :'Integer',
+        :'deleted_on' => :'DateTime',
+        :'id' => :'Integer',
+        :'last_modified_date' => :'DateTime',
+        :'name' => :'String',
+        :'planned_purge_date' => :'DateTime',
+        :'postal_address' => :'SpaceAddress',
+        :'primary_currency' => :'String',
+        :'request_limit' => :'Integer',
+        :'restricted_active' => :'BOOLEAN',
+        :'state' => :'CreationEntityState',
+        :'technical_contact_addresses' => :'Array<String>',
+        :'time_zone' => :'String',
+        :'version' => :'Integer'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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?(:'account')
+        self.account = attributes[:'account']
+      end
+
+      if attributes.has_key?(:'active')
+        self.active = attributes[:'active']
+      end
+
+      if attributes.has_key?(:'activeOrRestrictedActive')
+        self.active_or_restricted_active = attributes[:'activeOrRestrictedActive']
+      end
+
+      if attributes.has_key?(:'createdBy')
+        self.created_by = attributes[:'createdBy']
+      end
+
+      if attributes.has_key?(:'createdOn')
+        self.created_on = attributes[:'createdOn']
+      end
+
+      if attributes.has_key?(:'database')
+        self.database = attributes[:'database']
+      end
+
+      if attributes.has_key?(:'deletedBy')
+        self.deleted_by = attributes[:'deletedBy']
+      end
+
+      if attributes.has_key?(:'deletedOn')
+        self.deleted_on = attributes[:'deletedOn']
+      end
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'lastModifiedDate')
+        self.last_modified_date = attributes[:'lastModifiedDate']
+      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?(:'postalAddress')
+        self.postal_address = attributes[:'postalAddress']
+      end
+
+      if attributes.has_key?(:'primaryCurrency')
+        self.primary_currency = attributes[:'primaryCurrency']
+      end
+
+      if attributes.has_key?(:'requestLimit')
+        self.request_limit = attributes[:'requestLimit']
+      end
+
+      if attributes.has_key?(:'restrictedActive')
+        self.restricted_active = attributes[:'restrictedActive']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.has_key?(:'technicalContactAddresses')
+        if (value = attributes[:'technicalContactAddresses']).is_a?(Array)
+          self.technical_contact_addresses = value
+        end
+      end
+
+      if attributes.has_key?(:'timeZone')
+        self.time_zone = attributes[:'timeZone']
+      end
+
+      if attributes.has_key?(:'version')
+        self.version = attributes[:'version']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@name.nil? && @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@name.nil? && @name.to_s.length < 3
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 3.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@name.nil? && @name.to_s.length > 200
+      return false if !@name.nil? && @name.to_s.length < 3
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      end
+
+      if !name.nil? && name.to_s.length < 3
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 3.'
+      end
+
+      @name = name
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          account == o.account &&
+          active == o.active &&
+          active_or_restricted_active == o.active_or_restricted_active &&
+          created_by == o.created_by &&
+          created_on == o.created_on &&
+          database == o.database &&
+          deleted_by == o.deleted_by &&
+          deleted_on == o.deleted_on &&
+          id == o.id &&
+          last_modified_date == o.last_modified_date &&
+          name == o.name &&
+          planned_purge_date == o.planned_purge_date &&
+          postal_address == o.postal_address &&
+          primary_currency == o.primary_currency &&
+          request_limit == o.request_limit &&
+          restricted_active == o.restricted_active &&
+          state == o.state &&
+          technical_contact_addresses == o.technical_contact_addresses &&
+          time_zone == o.time_zone &&
+          version == o.version
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [account, active, active_or_restricted_active, created_by, created_on, database, deleted_by, deleted_on, id, last_modified_date, name, planned_purge_date, postal_address, primary_currency, request_limit, restricted_active, state, technical_contact_addresses, time_zone, version].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+end