payzu-pix 2.0.0

data/lib/payzu-pix/models/infraction_detail.rb

@@ -0,0 +1,293 @@
+=begin
+#PayZu Pix API
+
+#REST API for Pix operations on the PayZu platform, deposits, withdrawals, internal transfers, infractions, reports, and callback inspection. All amounts are in BRL (reais) unless explicitly noted. Authentication uses a Bearer token issued during onboarding.  ## SDKs oficiais  - Node.js: `npm install payzu-pix` - Python: `pip install payzu-pix` - PHP: `composer require payzu/pix` - Ruby: `gem install payzu-pix` - Java: `br.com.payzu:payzu-pix` (Maven Central) - Go: `go get github.com/PayZuAI/payzu-sdks/go/v2`  Repo: https://github.com/PayZuAI/payzu-sdks 
+
+The version of the OpenAPI document: 1.8.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PayZuPix
+  class InfractionDetail < ApiModelBase
+    # Identifier of the infraction inside PayZu, used in the query routes and when sending the defense.
+    attr_accessor :id
+
+    # Infraction code at Bacen.
+    attr_accessor :protocol
+
+    # Current state of the infraction.
+    attr_accessor :status
+
+    # Type of the infraction: REFUND_REQUEST, FRAUD or REFUND_CANCELLED.
+    attr_accessor :type
+
+    # Side that opened the infraction: DEBITED_PARTICIPANT or CREDITED_PARTICIPANT.
+    attr_accessor :reported_by
+
+    # Reason given by whoever opened the infraction, in the text sent by the partner bank.
+    attr_accessor :report_details
+
+    # Analysis outcome: AGREED or DISAGREED.
+    attr_accessor :analysis_result
+
+    # Additional text about the analysis decision, when the partner bank sends that information.
+    attr_accessor :analysis_details
+
+    # Moment the infraction was opened.
+    attr_accessor :reported_at
+
+    # Deadline to send the defense of this infraction.
+    attr_accessor :expires_at
+
+    attr_accessor :transaction
+
+    # Defenses already sent for this infraction, each with text, status and files.
+    attr_accessor :defense_history
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'protocol' => :'protocol',
+        :'status' => :'status',
+        :'type' => :'type',
+        :'reported_by' => :'reportedBy',
+        :'report_details' => :'reportDetails',
+        :'analysis_result' => :'analysisResult',
+        :'analysis_details' => :'analysisDetails',
+        :'reported_at' => :'reportedAt',
+        :'expires_at' => :'expiresAt',
+        :'transaction' => :'transaction',
+        :'defense_history' => :'defenseHistory'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'protocol' => :'String',
+        :'status' => :'String',
+        :'type' => :'String',
+        :'reported_by' => :'String',
+        :'report_details' => :'String',
+        :'analysis_result' => :'String',
+        :'analysis_details' => :'String',
+        :'reported_at' => :'Time',
+        :'expires_at' => :'Time',
+        :'transaction' => :'InfractionDetailTransaction',
+        :'defense_history' => :'Array<DefenseHistoryEntry>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'report_details',
+        :'analysis_result',
+        :'analysis_details',
+        :'expires_at',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PayZuPix::InfractionDetail` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PayZuPix::InfractionDetail`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'protocol')
+        self.protocol = attributes[:'protocol']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'reported_by')
+        self.reported_by = attributes[:'reported_by']
+      end
+
+      if attributes.key?(:'report_details')
+        self.report_details = attributes[:'report_details']
+      end
+
+      if attributes.key?(:'analysis_result')
+        self.analysis_result = attributes[:'analysis_result']
+      end
+
+      if attributes.key?(:'analysis_details')
+        self.analysis_details = attributes[:'analysis_details']
+      end
+
+      if attributes.key?(:'reported_at')
+        self.reported_at = attributes[:'reported_at']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'transaction')
+        self.transaction = attributes[:'transaction']
+      end
+
+      if attributes.key?(:'defense_history')
+        if (value = attributes[:'defense_history']).is_a?(Array)
+          self.defense_history = value
+        end
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      status_validator = EnumAttributeValidator.new('String', ["WAITING_PSP", "CLOSED", "OPEN", "CANCELLED", "ACKNOWLEDGED", "DEFENDED", "ANSWERED", "WAITING_ADJUSTMENTS"])
+      return false unless status_validator.valid?(@status)
+      type_validator = EnumAttributeValidator.new('String', ["REFUND_REQUEST", "FRAUD", "REFUND_CANCELLED"])
+      return false unless type_validator.valid?(@type)
+      reported_by_validator = EnumAttributeValidator.new('String', ["DEBITED_PARTICIPANT", "CREDITED_PARTICIPANT"])
+      return false unless reported_by_validator.valid?(@reported_by)
+      analysis_result_validator = EnumAttributeValidator.new('String', ["AGREED", "DISAGREED"])
+      return false unless analysis_result_validator.valid?(@analysis_result)
+      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 &&
+          protocol == o.protocol &&
+          status == o.status &&
+          type == o.type &&
+          reported_by == o.reported_by &&
+          report_details == o.report_details &&
+          analysis_result == o.analysis_result &&
+          analysis_details == o.analysis_details &&
+          reported_at == o.reported_at &&
+          expires_at == o.expires_at &&
+          transaction == o.transaction &&
+          defense_history == o.defense_history
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, protocol, status, type, reported_by, report_details, analysis_result, analysis_details, reported_at, expires_at, transaction, defense_history].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/payzu-pix/models/infraction_detail_transaction.rb

@@ -0,0 +1,213 @@
+=begin
+#PayZu Pix API
+
+#REST API for Pix operations on the PayZu platform, deposits, withdrawals, internal transfers, infractions, reports, and callback inspection. All amounts are in BRL (reais) unless explicitly noted. Authentication uses a Bearer token issued during onboarding.  ## SDKs oficiais  - Node.js: `npm install payzu-pix` - Python: `pip install payzu-pix` - PHP: `composer require payzu/pix` - Ruby: `gem install payzu-pix` - Java: `br.com.payzu:payzu-pix` (Maven Central) - Go: `go get github.com/PayZuAI/payzu-sdks/go/v2`  Repo: https://github.com/PayZuAI/payzu-sdks 
+
+The version of the OpenAPI document: 1.8.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PayZuPix
+  # Summary of the disputed Pix.
+  class InfractionDetailTransaction < ApiModelBase
+    attr_accessor :id
+
+    # Amount of the disputed transaction, in reais with decimal places.
+    attr_accessor :amount
+
+    # Name of the Pix payer, as reported by the provider.
+    attr_accessor :payer_name
+
+    # CPF or CNPJ of the Pix payer, as reported by the provider.
+    attr_accessor :payer_document
+
+    # Name of the Pix receiver, as reported by the provider.
+    attr_accessor :receiver_name
+
+    # CPF or CNPJ of the Pix receiver, as reported by the provider.
+    attr_accessor :receiver_document
+
+    # End-to-end identifier of the Pix, reported by the provider at settlement.
+    attr_accessor :end_to_end_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'amount' => :'amount',
+        :'payer_name' => :'payerName',
+        :'payer_document' => :'payerDocument',
+        :'receiver_name' => :'receiverName',
+        :'receiver_document' => :'receiverDocument',
+        :'end_to_end_id' => :'endToEndId'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'amount' => :'Float',
+        :'payer_name' => :'String',
+        :'payer_document' => :'String',
+        :'receiver_name' => :'String',
+        :'receiver_document' => :'String',
+        :'end_to_end_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'payer_name',
+        :'payer_document',
+        :'receiver_name',
+        :'receiver_document',
+        :'end_to_end_id'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PayZuPix::InfractionDetailTransaction` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PayZuPix::InfractionDetailTransaction`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'payer_name')
+        self.payer_name = attributes[:'payer_name']
+      end
+
+      if attributes.key?(:'payer_document')
+        self.payer_document = attributes[:'payer_document']
+      end
+
+      if attributes.key?(:'receiver_name')
+        self.receiver_name = attributes[:'receiver_name']
+      end
+
+      if attributes.key?(:'receiver_document')
+        self.receiver_document = attributes[:'receiver_document']
+      end
+
+      if attributes.key?(:'end_to_end_id')
+        self.end_to_end_id = attributes[:'end_to_end_id']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          amount == o.amount &&
+          payer_name == o.payer_name &&
+          payer_document == o.payer_document &&
+          receiver_name == o.receiver_name &&
+          receiver_document == o.receiver_document &&
+          end_to_end_id == o.end_to_end_id
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, amount, payer_name, payer_document, receiver_name, receiver_document, end_to_end_id].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/payzu-pix/models/infraction_list_response.rb

@@ -0,0 +1,159 @@
+=begin
+#PayZu Pix API
+
+#REST API for Pix operations on the PayZu platform, deposits, withdrawals, internal transfers, infractions, reports, and callback inspection. All amounts are in BRL (reais) unless explicitly noted. Authentication uses a Bearer token issued during onboarding.  ## SDKs oficiais  - Node.js: `npm install payzu-pix` - Python: `pip install payzu-pix` - PHP: `composer require payzu/pix` - Ruby: `gem install payzu-pix` - Java: `br.com.payzu:payzu-pix` (Maven Central) - Go: `go get github.com/PayZuAI/payzu-sdks/go/v2`  Repo: https://github.com/PayZuAI/payzu-sdks 
+
+The version of the OpenAPI document: 1.8.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PayZuPix
+  class InfractionListResponse < ApiModelBase
+    # Infractions of the requested page, each in the same format as the detail.
+    attr_accessor :infractions
+
+    attr_accessor :pagination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'infractions' => :'infractions',
+        :'pagination' => :'pagination'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'infractions' => :'Array<InfractionDetail>',
+        :'pagination' => :'InfractionListResponsePagination'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PayZuPix::InfractionListResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PayZuPix::InfractionListResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'infractions')
+        if (value = attributes[:'infractions']).is_a?(Array)
+          self.infractions = value
+        end
+      end
+
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          infractions == o.infractions &&
+          pagination == o.pagination
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [infractions, pagination].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end