payrix-api-sdk 1.0.0

data/lib/payrix/models/profit_share_rules_post_request.rb

@@ -0,0 +1,201 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # ProfitShareRulesPostRequest Model.
+  class ProfitShareRulesPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :profit_share
+
+    # The name of this ProfitShare Rule. 
+    # This field is stored as a text string and must be between 0 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the Profit Share Rules.
+    # @return [String]
+    attr_accessor :description
+
+    # The type of logic to apply with this ProfitShare Rule.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `less` - **The ProfitShare applies only if the entry amount is lower
+    # than the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `equal` - **The ProfitShare applies only if the entry amount is exactly
+    # the same as the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `notEqual` - **The ProfitShare applies only if the entry amount is not
+    # exactly equal to the amount set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `greater` - **The ProfitShare applies only if the entry amount is higher
+    # than the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `event` - **The ProfitShare applies only if the entry event is exactly
+    # the same as the event set in the 'value' field of the ProfitShare Rule.**
+    # - `notEvent` - **The ProfitShare applies only if the entry event is not
+    # exactly equal to the event set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `fee` - **The ProfitShare applies only if the entry fee is exactly the
+    # same as the fee set in the 'value' field of the ProfitShare Rule.**
+    # - `notFee` - **The ProfitShare applies only if the entry fee is not
+    # exactly equal to the fee set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `fromentity` - **The ProfitShare applies only if the entry fromentity
+    # (or opposingEntryfromentity) is exactly the same as the entity set in the
+    # 'value' field of the ProfitShare Rule.**
+    # - `notFromentity` - **The ProfitShare applies only if the entry fromentity
+    # (or opposingEntryfromentity) is not exactly equal to the entity set in the
+    # 'value' field of the ProfitShare Rule.**
+    # </details>
+    # @return [ProfitShareRuleTypeEnum]
+    attr_accessor :type
+
+    # The value to compare against when evaluating this ProfitShare Rule.
+    # @return [String]
+    attr_accessor :value
+
+    # A name for a group of rules to be applied in conjunction when evaluating
+    # this ProfitShare Rule. 
+    # When grouping is used the ProfitShare will be allowed to be processed if
+    # at least one of the rules are matched.
+    # @return [String]
+    attr_accessor :grouping
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['profit_share'] = 'profitShare'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['type'] = 'type'
+      @_hash['value'] = 'value'
+      @_hash['grouping'] = 'grouping'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+        grouping
+        inactive
+        frozen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(profit_share = nil, type = nil, value = nil, name = SKIP,
+                   description = SKIP, grouping = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN)
+      @profit_share = profit_share
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @type = type
+      @value = value
+      @grouping = grouping unless grouping == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      profit_share = hash.key?('profitShare') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ProfitShareRulesPostRequestProfitShare), hash['profitShare']
+      ) : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      value = hash.key?('value') ? hash['value'] : nil
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      grouping = hash.key?('grouping') ? hash['grouping'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+
+      # Create object from extracted values.
+      ProfitShareRulesPostRequest.new(profit_share,
+                                      type,
+                                      value,
+                                      name,
+                                      description,
+                                      grouping,
+                                      inactive,
+                                      frozen)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ProfitShareRulesPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:ProfitShareRulesPostRequestProfitShare)
+                         .validate(value.profit_share) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { ProfitShareRuleTypeEnum.validate(val) }) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:ProfitShareRulesPostRequestProfitShare)
+                       .validate(value['profitShare']) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { ProfitShareRuleTypeEnum.validate(val) }) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profit_share: #{@profit_share}, name: #{@name}, description:"\
+      " #{@description}, type: #{@type}, value: #{@value}, grouping: #{@grouping}, inactive:"\
+      " #{@inactive}, frozen: #{@frozen}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profit_share: #{@profit_share.inspect}, name: #{@name.inspect},"\
+      " description: #{@description.inspect}, type: #{@type.inspect}, value: #{@value.inspect},"\
+      " grouping: #{@grouping.inspect}, inactive: #{@inactive.inspect}, frozen:"\
+      " #{@frozen.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/profit_share_rules_put_request.rb

@@ -0,0 +1,176 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # ProfitShareRulesPutRequest Model.
+  class ProfitShareRulesPutRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the ProfitShare that this ProfitShare Rule applies to.
+    # @return [String]
+    attr_accessor :profit_share
+
+    # The name of this ProfitShare Rule. 
+    # This field is stored as a text string and must be between 0 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the Profit Share Rules.
+    # @return [String]
+    attr_accessor :description
+
+    # The type of logic to apply with this ProfitShare Rule.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `less` - **The ProfitShare applies only if the entry amount is lower
+    # than the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `equal` - **The ProfitShare applies only if the entry amount is exactly
+    # the same as the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `notEqual` - **The ProfitShare applies only if the entry amount is not
+    # exactly equal to the amount set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `greater` - **The ProfitShare applies only if the entry amount is higher
+    # than the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `event` - **The ProfitShare applies only if the entry event is exactly
+    # the same as the event set in the 'value' field of the ProfitShare Rule.**
+    # - `notEvent` - **The ProfitShare applies only if the entry event is not
+    # exactly equal to the event set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `fee` - **The ProfitShare applies only if the entry fee is exactly the
+    # same as the fee set in the 'value' field of the ProfitShare Rule.**
+    # - `notFee` - **The ProfitShare applies only if the entry fee is not
+    # exactly equal to the fee set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `fromentity` - **The ProfitShare applies only if the entry fromentity
+    # (or opposingEntryfromentity) is exactly the same as the entity set in the
+    # 'value' field of the ProfitShare Rule.**
+    # - `notFromentity` - **The ProfitShare applies only if the entry fromentity
+    # (or opposingEntryfromentity) is not exactly equal to the entity set in the
+    # 'value' field of the ProfitShare Rule.**
+    # </details>
+    # @return [ProfitShareRuleTypeEnum]
+    attr_accessor :type
+
+    # The value to compare against when evaluating this ProfitShare Rule.
+    # @return [String]
+    attr_accessor :value
+
+    # A name for a group of rules to be applied in conjunction when evaluating
+    # this ProfitShare Rule. 
+    # When grouping is used the ProfitShare will be allowed to be processed if
+    # at least one of the rules are matched.
+    # @return [String]
+    attr_accessor :grouping
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['profit_share'] = 'profitShare'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['type'] = 'type'
+      @_hash['value'] = 'value'
+      @_hash['grouping'] = 'grouping'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        profit_share
+        name
+        description
+        type
+        value
+        grouping
+        inactive
+        frozen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(profit_share = SKIP, name = SKIP, description = SKIP,
+                   type = SKIP, value = SKIP, grouping = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN)
+      @profit_share = profit_share unless profit_share == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @type = type unless type == SKIP
+      @value = value unless value == SKIP
+      @grouping = grouping unless grouping == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      profit_share = hash.key?('profitShare') ? hash['profitShare'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      grouping = hash.key?('grouping') ? hash['grouping'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+
+      # Create object from extracted values.
+      ProfitShareRulesPutRequest.new(profit_share,
+                                     name,
+                                     description,
+                                     type,
+                                     value,
+                                     grouping,
+                                     inactive,
+                                     frozen)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profit_share: #{@profit_share}, name: #{@name}, description:"\
+      " #{@description}, type: #{@type}, value: #{@value}, grouping: #{@grouping}, inactive:"\
+      " #{@inactive}, frozen: #{@frozen}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} profit_share: #{@profit_share.inspect}, name: #{@name.inspect},"\
+      " description: #{@description.inspect}, type: #{@type.inspect}, value: #{@value.inspect},"\
+      " grouping: #{@grouping.inspect}, inactive: #{@inactive.inspect}, frozen:"\
+      " #{@frozen.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/profit_share_rules_response.rb

@@ -0,0 +1,256 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # ProfitShareRulesResponse Model.
+  class ProfitShareRulesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :profit_share
+
+    # The name of this ProfitShare Rule. 
+    # This field is stored as a text string and must be between 0 and 100
+    # characters long.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the Profit Share Rules.
+    # @return [String]
+    attr_accessor :description
+
+    # The type of logic to apply with this ProfitShare Rule.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `less` - **The ProfitShare applies only if the entry amount is lower
+    # than the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `equal` - **The ProfitShare applies only if the entry amount is exactly
+    # the same as the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `notEqual` - **The ProfitShare applies only if the entry amount is not
+    # exactly equal to the amount set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `greater` - **The ProfitShare applies only if the entry amount is higher
+    # than the amount set in the 'value' field of the ProfitShare Rule.**
+    # - `event` - **The ProfitShare applies only if the entry event is exactly
+    # the same as the event set in the 'value' field of the ProfitShare Rule.**
+    # - `notEvent` - **The ProfitShare applies only if the entry event is not
+    # exactly equal to the event set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `fee` - **The ProfitShare applies only if the entry fee is exactly the
+    # same as the fee set in the 'value' field of the ProfitShare Rule.**
+    # - `notFee` - **The ProfitShare applies only if the entry fee is not
+    # exactly equal to the fee set in the 'value' field of the ProfitShare
+    # Rule.**
+    # - `fromentity` - **The ProfitShare applies only if the entry fromentity
+    # (or opposingEntryfromentity) is exactly the same as the entity set in the
+    # 'value' field of the ProfitShare Rule.**
+    # - `notFromentity` - **The ProfitShare applies only if the entry fromentity
+    # (or opposingEntryfromentity) is not exactly equal to the entity set in the
+    # 'value' field of the ProfitShare Rule.**
+    # </details>
+    # @return [ProfitShareRuleTypeEnum]
+    attr_accessor :type
+
+    # The value to compare against when evaluating this ProfitShare Rule.
+    # @return [String]
+    attr_accessor :value
+
+    # A name for a group of rules to be applied in conjunction when evaluating
+    # this ProfitShare Rule. 
+    # When grouping is used the ProfitShare will be allowed to be processed if
+    # at least one of the rules are matched.
+    # @return [String]
+    attr_accessor :grouping
+
+    # Whether this resource is marked as inactive.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Active**
+    # - `1` - **Inactive**
+    # </details>
+    # @return [InactiveEnum]
+    attr_accessor :inactive
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FrozenEnum]
+    attr_accessor :frozen
+
+    # Whether this resource is marked as frozen.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `0` - **Not Frozen**
+    # - `1` - **Frozen**
+    # </details>
+    # @return [FeesResponse]
+    attr_accessor :fee
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['profit_share'] = 'profitShare'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['type'] = 'type'
+      @_hash['value'] = 'value'
+      @_hash['grouping'] = 'grouping'
+      @_hash['inactive'] = 'inactive'
+      @_hash['frozen'] = 'frozen'
+      @_hash['fee'] = 'fee'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        profit_share
+        name
+        description
+        type
+        value
+        grouping
+        inactive
+        frozen
+        fee
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, profit_share = SKIP, name = SKIP,
+                   description = SKIP, type = SKIP, value = SKIP,
+                   grouping = SKIP, inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN, fee = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @profit_share = profit_share unless profit_share == SKIP
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @type = type unless type == SKIP
+      @value = value unless value == SKIP
+      @grouping = grouping unless grouping == SKIP
+      @inactive = inactive unless inactive == SKIP
+      @frozen = frozen unless frozen == SKIP
+      @fee = fee unless fee == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ProfitShareRulesResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      profit_share = hash.key?('profitShare') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:ProfitShareRulesResponseProfitShare), hash['profitShare']
+      ) : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      grouping = hash.key?('grouping') ? hash['grouping'] : SKIP
+      inactive = hash['inactive'] ||= InactiveEnum::ACTIVE
+      frozen = hash['frozen'] ||= FrozenEnum::NOTFROZEN
+      fee = FeesResponse.from_hash(hash['fee']) if hash['fee']
+
+      # Create object from extracted values.
+      ProfitShareRulesResponse.new(id,
+                                   created,
+                                   modified,
+                                   creator,
+                                   modifier,
+                                   profit_share,
+                                   name,
+                                   description,
+                                   type,
+                                   value,
+                                   grouping,
+                                   inactive,
+                                   frozen,
+                                   fee)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ProfitShareRulesResponse | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, profit_share: #{@profit_share}, name: #{@name},"\
+      " description: #{@description}, type: #{@type}, value: #{@value}, grouping: #{@grouping},"\
+      " inactive: #{@inactive}, frozen: #{@frozen}, fee: #{@fee}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect},"\
+      " profit_share: #{@profit_share.inspect}, name: #{@name.inspect}, description:"\
+      " #{@description.inspect}, type: #{@type.inspect}, value: #{@value.inspect}, grouping:"\
+      " #{@grouping.inspect}, inactive: #{@inactive.inspect}, frozen: #{@frozen.inspect}, fee:"\
+      " #{@fee.inspect}>"
+    end
+  end
+end