payrix-api-sdk 1.0.0

data/lib/payrix/models/org_flow_actions_post_request.rb

@@ -0,0 +1,112 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowActionsPostRequest Model.
+  class OrgFlowActionsPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the orgFlow resource that this orgFlowActions resource
+    # is associated with.
+    # @return [String]
+    attr_accessor :org_flow
+
+    # The identifier of the orgFlow resource that this orgFlowActions resource
+    # is associated with.
+    # @return [Object]
+    attr_accessor :org
+
+    # The action to take in relation to the Entity being processed.
+    # <details>
+    # <summary>Valid Values</summary>
+    #   - `add` - **Add the referenced Entity to the referenced Org.**
+    #   - `remove` - **Remove the referenced Entity from the referenced Org.**
+    # </details>
+    # @return [OrgFlowActionEnum]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['org_flow'] = 'orgFlow'
+      @_hash['org'] = 'org'
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(org_flow = nil, org = nil, action = nil)
+      @org_flow = org_flow
+      @org = org
+      @action = action
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      org_flow = hash.key?('orgFlow') ? hash['orgFlow'] : nil
+      org = hash.key?('org') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OrgFlowActionsPostRequestOrg), hash['org']
+      ) : nil
+      action = hash.key?('action') ? hash['action'] : nil
+
+      # Create object from extracted values.
+      OrgFlowActionsPostRequest.new(org_flow,
+                                    org,
+                                    action)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrgFlowActionsPostRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.org_flow,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:OrgFlowActionsPostRequestOrg)
+                           .validate(value.org) and
+            APIHelper.valid_type?(value.action,
+                                  ->(val) { OrgFlowActionEnum.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['orgFlow'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:OrgFlowActionsPostRequestOrg)
+                         .validate(value['org']) and
+          APIHelper.valid_type?(value['action'],
+                                ->(val) { OrgFlowActionEnum.validate(val) })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} org_flow: #{@org_flow}, org: #{@org}, action: #{@action}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} org_flow: #{@org_flow.inspect}, org: #{@org.inspect}, action:"\
+      " #{@action.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/org_flow_actions_put_request.rb

@@ -0,0 +1,84 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowActionsPutRequest Model.
+  class OrgFlowActionsPutRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier of the orgFlow resource that this orgFlowActions resource
+    # is associated with.
+    # @return [String]
+    attr_accessor :org_flow
+
+    # The identifier of the Org resource that this orgFlowActions resource is
+    # associated with.
+    # @return [String]
+    attr_accessor :org
+
+    # The action to take in relation to the Entity being processed.
+    # <details>
+    # <summary>Valid Values</summary>
+    #   - `add` - **Add the referenced Entity to the referenced Org.**
+    #   - `remove` - **Remove the referenced Entity from the referenced Org.**
+    # </details>
+    # @return [OrgFlowActionEnum]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['org_flow'] = 'orgFlow'
+      @_hash['org'] = 'org'
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(org_flow = nil, org = nil, action = nil)
+      @org_flow = org_flow
+      @org = org
+      @action = action
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      org_flow = hash.key?('orgFlow') ? hash['orgFlow'] : nil
+      org = hash.key?('org') ? hash['org'] : nil
+      action = hash.key?('action') ? hash['action'] : nil
+
+      # Create object from extracted values.
+      OrgFlowActionsPutRequest.new(org_flow,
+                                   org,
+                                   action)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} org_flow: #{@org_flow}, org: #{@org}, action: #{@action}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} org_flow: #{@org_flow.inspect}, org: #{@org.inspect}, action:"\
+      " #{@action.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/org_flow_actions_response.rb

@@ -0,0 +1,154 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowActionsResponse Model.
+  class OrgFlowActionsResponse < 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 :org_flow
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :org
+
+    # The action to take in relation to the Entity being processed.
+    # <details>
+    # <summary>Valid Values</summary>
+    #   - `add` - **Add the referenced Entity to the referenced Org.**
+    #   - `remove` - **Remove the referenced Entity from the referenced Org.**
+    # </details>
+    # @return [OrgFlowActionEnum]
+    attr_accessor :action
+
+    # 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['org_flow'] = 'orgFlow'
+      @_hash['org'] = 'org'
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        org_flow
+        org
+        action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, org_flow = SKIP, org = SKIP, action = 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
+      @org_flow = org_flow unless org_flow == SKIP
+      @org = org unless org == SKIP
+      @action = action unless action == 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(:OrgFlowActionsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      org_flow = hash.key?('orgFlow') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OrgFlowActionsResponseOrgFlow), hash['orgFlow']
+      ) : SKIP
+      org = hash.key?('org') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OrgFlowActionsResponseOrg), hash['org']
+      ) : SKIP
+      action = hash.key?('action') ? hash['action'] : SKIP
+
+      # Create object from extracted values.
+      OrgFlowActionsResponse.new(id,
+                                 created,
+                                 modified,
+                                 creator,
+                                 modifier,
+                                 org_flow,
+                                 org,
+                                 action)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrgFlowActionsResponse | 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}, org_flow: #{@org_flow}, org: #{@org}, action:"\
+      " #{@action}>"
+    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},"\
+      " org_flow: #{@org_flow.inspect}, org: #{@org.inspect}, action: #{@action.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/org_flow_actions_response_item.rb

@@ -0,0 +1,101 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowActionsResponseItem Model.
+  class OrgFlowActionsResponseItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The data object that the API returns for this request.
+    # @return [Array[OrgFlowActionsResponse]]
+    attr_accessor :data
+
+    # An object describing the response, including the request ID and pagination
+    # indicators.
+    # @return [Details]
+    attr_accessor :details
+
+    # An array of zero or more errors that occurred when the API processed the
+    # request.
+    # @return [Array[ErrorItem]]
+    attr_accessor :errors
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash['details'] = 'details'
+      @_hash['errors'] = 'errors'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data
+        details
+        errors
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data = SKIP, details = SKIP, errors = SKIP)
+      @data = data unless data == SKIP
+      @details = details unless details == SKIP
+      @errors = errors unless errors == 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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (OrgFlowActionsResponse.from_hash(structure) if structure)
+        end
+      end
+
+      data = SKIP unless hash.key?('data')
+      details = Details.from_hash(hash['details']) if hash['details']
+      # Parameter is an array, so we need to iterate through it
+      errors = nil
+      unless hash['errors'].nil?
+        errors = []
+        hash['errors'].each do |structure|
+          errors << (ErrorItem.from_hash(structure) if structure)
+        end
+      end
+
+      errors = SKIP unless hash.key?('errors')
+
+      # Create object from extracted values.
+      OrgFlowActionsResponseItem.new(data,
+                                     details,
+                                     errors)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data}, details: #{@details}, errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data: #{@data.inspect}, details: #{@details.inspect}, errors:"\
+      " #{@errors.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/org_flow_actions_response_result.rb

@@ -0,0 +1,62 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowActionsResponseResult Model.
+  class OrgFlowActionsResponseResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [OrgFlowActionsResponseItem]
+    attr_accessor :response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response'] = 'response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response = SKIP)
+      @response = response unless response == 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.
+      response = OrgFlowActionsResponseItem.from_hash(hash['response']) if hash['response']
+
+      # Create object from extracted values.
+      OrgFlowActionsResponseResult.new(response)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response: #{@response.inspect}>"
+    end
+  end
+end

data/lib/payrix/models/org_flow_rules_post_request.rb

@@ -0,0 +1,163 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # OrgFlowRulesPostRequest Model.
+  class OrgFlowRulesPostRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :org_flow
+
+    # The name of the orgFlowRules resource.
+    # @return [String]
+    attr_accessor :name
+
+    # The description of the orgFlowRules resource.
+    # @return [String]
+    attr_accessor :description
+
+    # The type of logic to apply with this OrgFlow Rule.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `MCC` - **Type MCC.** The Orgflow applies based on the MCC properties of
+    # the merchants.
+    # - `Custom` - **Type Custom.** The Orgflow applies based on the custom
+    # properties of the entities.
+    # </details>
+    # @return [OrgFlowRulesTypeEnum]
+    attr_accessor :type
+
+    # The value to compare against when evaluating this OrgFlowRule.
+    # @return [String]
+    attr_accessor :value
+
+    # A name for a group of rules to be applied in conjunction when evaluating
+    # this OrgFlow Rule. \nWhen grouping is used the OrgFlow 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['org_flow'] = 'orgFlow'
+      @_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[
+        org_flow
+        name
+        description
+        type
+        value
+        grouping
+        inactive
+        frozen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(org_flow = SKIP, name = SKIP, description = SKIP,
+                   type = SKIP, value = SKIP, grouping = SKIP,
+                   inactive = InactiveEnum::ACTIVE,
+                   frozen = FrozenEnum::NOTFROZEN)
+      @org_flow = org_flow unless org_flow == 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.
+      org_flow = hash.key?('orgFlow') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OrgFlowRulesPostRequestOrgFlow), hash['orgFlow']
+      ) : 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.
+      OrgFlowRulesPostRequest.new(org_flow,
+                                  name,
+                                  description,
+                                  type,
+                                  value,
+                                  grouping,
+                                  inactive,
+                                  frozen)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrgFlowRulesPostRequest | 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} org_flow: #{@org_flow}, 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} org_flow: #{@org_flow.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