payzu-pix 2.0.0

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

@@ -0,0 +1,588 @@
+=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
+  # Unified transaction representation used by all endpoints.
+  class Transaction < ApiModelBase
+    # Identifier of the transaction at PayZu.
+    attr_accessor :id
+
+    # PENDING, COMPLETED, CANCELED, WAITING_FOR_REFUND, REFUNDED, EXPIRED, ERROR
+    attr_accessor :status
+
+    # Amount of the transaction, before the fee.
+    attr_accessor :amount
+
+    # Transaction type: DEPOSIT, WITHDRAW, COMMISSION, LIQUIDATION or ADJUSTMENT.
+    attr_accessor :type
+
+    # Copy-and-paste Pix code.
+    attr_accessor :qr_code_text
+
+    # PNG image of the QR Code in base64, without the data: prefix.
+    attr_accessor :qr_code_base64
+
+    # Authenticated route that returns the PNG of the QR Code.
+    attr_accessor :qr_code_url
+
+    # Name used to build the charge.
+    attr_accessor :generated_name
+
+    # CPF or CNPJ used as the debtor of the charge.
+    attr_accessor :generated_document
+
+    # Email used to build the charge.
+    attr_accessor :generated_email
+
+    # Name of the holder of the account that sent the Pix, as reported by the originating institution.
+    attr_accessor :payer_name
+
+    # CPF or CNPJ of the payer of the Pix, reported by the originating institution.
+    attr_accessor :payer_document
+
+    # ISPB code of the institution the Pix was sent from.
+    attr_accessor :payer_institution_ispb
+
+    # Name of the institution the Pix was sent from.
+    attr_accessor :payer_institution_name
+
+    # Payer's PayZu account number (6 digits). Present on withdraw, internal-transfer and commission transactions.
+    attr_accessor :payer_account_number
+
+    # PayZu fee charged on the operation, in reais. It may carry more than two decimal places — do not round when reconciling.
+    attr_accessor :service_fee_charged
+
+    # Destination Pix key of the withdrawal, already normalized.
+    attr_accessor :withdraw_pix_key
+
+    # Type of the destination key of the withdrawal, with evp being the random key.
+    attr_accessor :withdraw_pix_type
+
+    # Name of the holder of the receiving account.
+    attr_accessor :receiver_name
+
+    # CPF or CNPJ of the receiver.
+    attr_accessor :receiver_document
+
+    # ISPB code of the institution that receives the Pix.
+    attr_accessor :receiver_institution_ispb
+
+    # Name of the institution that receives the Pix.
+    attr_accessor :receiver_institution_name
+
+    # Receiver's PayZu account number (6 digits). Present on deposit, internal-transfer and commission transactions.
+    attr_accessor :receiver_account_number
+
+    # Identifier of the Pix in the Bacen arrangement, used to track the settlement and request a return.
+    attr_accessor :end_to_end_id
+
+    # Date and time the transaction was recorded.
+    attr_accessor :created_at
+
+    # Date and time of the last change.
+    attr_accessor :updated_at
+
+    # Date and time the Pix was settled, reported by the institution.
+    attr_accessor :paid_at
+
+    # Your identifier of the transaction, returned in queries and callbacks.
+    attr_accessor :client_reference
+
+    # End-to-end ID of the refund transaction
+    attr_accessor :refund_end_to_end_id
+
+    # Amount refunded
+    attr_accessor :refund_amount
+
+    # Refund status: PENDING, COMPLETED or CANCELED.
+    attr_accessor :refund_status
+
+    # Reason for the refund
+    attr_accessor :refund_reason
+
+    # Description of the refund
+    attr_accessor :refund_description
+
+    # Date and time when the refund was processed
+    attr_accessor :refunded_at
+
+    # Reason for cancellation (if cancelled)
+    attr_accessor :cancellation_reason
+
+    # Virtual sub-account provided at creation.
+    attr_accessor :virtual_account
+
+    # Transaction method/rail.
+    attr_accessor :method
+
+    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',
+        :'status' => :'status',
+        :'amount' => :'amount',
+        :'type' => :'type',
+        :'qr_code_text' => :'qrCodeText',
+        :'qr_code_base64' => :'qrCodeBase64',
+        :'qr_code_url' => :'qrCodeUrl',
+        :'generated_name' => :'generatedName',
+        :'generated_document' => :'generatedDocument',
+        :'generated_email' => :'generatedEmail',
+        :'payer_name' => :'payerName',
+        :'payer_document' => :'payerDocument',
+        :'payer_institution_ispb' => :'payerInstitutionIspb',
+        :'payer_institution_name' => :'payerInstitutionName',
+        :'payer_account_number' => :'payerAccountNumber',
+        :'service_fee_charged' => :'serviceFeeCharged',
+        :'withdraw_pix_key' => :'withdrawPixKey',
+        :'withdraw_pix_type' => :'withdrawPixType',
+        :'receiver_name' => :'receiverName',
+        :'receiver_document' => :'receiverDocument',
+        :'receiver_institution_ispb' => :'receiverInstitutionIspb',
+        :'receiver_institution_name' => :'receiverInstitutionName',
+        :'receiver_account_number' => :'receiverAccountNumber',
+        :'end_to_end_id' => :'endToEndId',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'paid_at' => :'paidAt',
+        :'client_reference' => :'clientReference',
+        :'refund_end_to_end_id' => :'refundEndToEndId',
+        :'refund_amount' => :'refundAmount',
+        :'refund_status' => :'refundStatus',
+        :'refund_reason' => :'refundReason',
+        :'refund_description' => :'refundDescription',
+        :'refunded_at' => :'refundedAt',
+        :'cancellation_reason' => :'cancellationReason',
+        :'virtual_account' => :'virtualAccount',
+        :'method' => :'method'
+      }
+    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',
+        :'status' => :'String',
+        :'amount' => :'Float',
+        :'type' => :'String',
+        :'qr_code_text' => :'String',
+        :'qr_code_base64' => :'String',
+        :'qr_code_url' => :'String',
+        :'generated_name' => :'String',
+        :'generated_document' => :'String',
+        :'generated_email' => :'String',
+        :'payer_name' => :'String',
+        :'payer_document' => :'String',
+        :'payer_institution_ispb' => :'String',
+        :'payer_institution_name' => :'String',
+        :'payer_account_number' => :'String',
+        :'service_fee_charged' => :'Float',
+        :'withdraw_pix_key' => :'String',
+        :'withdraw_pix_type' => :'String',
+        :'receiver_name' => :'String',
+        :'receiver_document' => :'String',
+        :'receiver_institution_ispb' => :'String',
+        :'receiver_institution_name' => :'String',
+        :'receiver_account_number' => :'String',
+        :'end_to_end_id' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'String',
+        :'paid_at' => :'String',
+        :'client_reference' => :'String',
+        :'refund_end_to_end_id' => :'String',
+        :'refund_amount' => :'Float',
+        :'refund_status' => :'String',
+        :'refund_reason' => :'String',
+        :'refund_description' => :'String',
+        :'refunded_at' => :'String',
+        :'cancellation_reason' => :'String',
+        :'virtual_account' => :'String',
+        :'method' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'qr_code_text',
+        :'qr_code_base64',
+        :'qr_code_url',
+        :'generated_name',
+        :'generated_document',
+        :'generated_email',
+        :'payer_name',
+        :'payer_document',
+        :'payer_institution_ispb',
+        :'payer_institution_name',
+        :'payer_account_number',
+        :'service_fee_charged',
+        :'withdraw_pix_key',
+        :'withdraw_pix_type',
+        :'receiver_name',
+        :'receiver_document',
+        :'receiver_institution_ispb',
+        :'receiver_institution_name',
+        :'receiver_account_number',
+        :'end_to_end_id',
+        :'paid_at',
+        :'client_reference',
+        :'refund_end_to_end_id',
+        :'refund_amount',
+        :'refund_status',
+        :'refund_reason',
+        :'refund_description',
+        :'refunded_at',
+        :'cancellation_reason',
+        :'virtual_account',
+      ])
+    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::Transaction` 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::Transaction`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'qr_code_text')
+        self.qr_code_text = attributes[:'qr_code_text']
+      end
+
+      if attributes.key?(:'qr_code_base64')
+        self.qr_code_base64 = attributes[:'qr_code_base64']
+      end
+
+      if attributes.key?(:'qr_code_url')
+        self.qr_code_url = attributes[:'qr_code_url']
+      end
+
+      if attributes.key?(:'generated_name')
+        self.generated_name = attributes[:'generated_name']
+      end
+
+      if attributes.key?(:'generated_document')
+        self.generated_document = attributes[:'generated_document']
+      end
+
+      if attributes.key?(:'generated_email')
+        self.generated_email = attributes[:'generated_email']
+      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?(:'payer_institution_ispb')
+        self.payer_institution_ispb = attributes[:'payer_institution_ispb']
+      end
+
+      if attributes.key?(:'payer_institution_name')
+        self.payer_institution_name = attributes[:'payer_institution_name']
+      end
+
+      if attributes.key?(:'payer_account_number')
+        self.payer_account_number = attributes[:'payer_account_number']
+      end
+
+      if attributes.key?(:'service_fee_charged')
+        self.service_fee_charged = attributes[:'service_fee_charged']
+      end
+
+      if attributes.key?(:'withdraw_pix_key')
+        self.withdraw_pix_key = attributes[:'withdraw_pix_key']
+      end
+
+      if attributes.key?(:'withdraw_pix_type')
+        self.withdraw_pix_type = attributes[:'withdraw_pix_type']
+      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?(:'receiver_institution_ispb')
+        self.receiver_institution_ispb = attributes[:'receiver_institution_ispb']
+      end
+
+      if attributes.key?(:'receiver_institution_name')
+        self.receiver_institution_name = attributes[:'receiver_institution_name']
+      end
+
+      if attributes.key?(:'receiver_account_number')
+        self.receiver_account_number = attributes[:'receiver_account_number']
+      end
+
+      if attributes.key?(:'end_to_end_id')
+        self.end_to_end_id = attributes[:'end_to_end_id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'paid_at')
+        self.paid_at = attributes[:'paid_at']
+      end
+
+      if attributes.key?(:'client_reference')
+        self.client_reference = attributes[:'client_reference']
+      end
+
+      if attributes.key?(:'refund_end_to_end_id')
+        self.refund_end_to_end_id = attributes[:'refund_end_to_end_id']
+      end
+
+      if attributes.key?(:'refund_amount')
+        self.refund_amount = attributes[:'refund_amount']
+      end
+
+      if attributes.key?(:'refund_status')
+        self.refund_status = attributes[:'refund_status']
+      end
+
+      if attributes.key?(:'refund_reason')
+        self.refund_reason = attributes[:'refund_reason']
+      end
+
+      if attributes.key?(:'refund_description')
+        self.refund_description = attributes[:'refund_description']
+      end
+
+      if attributes.key?(:'refunded_at')
+        self.refunded_at = attributes[:'refunded_at']
+      end
+
+      if attributes.key?(:'cancellation_reason')
+        self.cancellation_reason = attributes[:'cancellation_reason']
+      end
+
+      if attributes.key?(:'virtual_account')
+        self.virtual_account = attributes[:'virtual_account']
+      end
+
+      if attributes.key?(:'method')
+        self.method = attributes[:'method']
+      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
+      if !@virtual_account.nil? && @virtual_account.to_s.length > 50
+        invalid_properties.push('invalid value for "virtual_account", the character length must be smaller than or equal to 50.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      status_validator = EnumAttributeValidator.new('String', ["PENDING", "COMPLETED", "CANCELED", "WAITING_FOR_REFUND", "REFUNDED", "EXPIRED", "ERROR"])
+      return false unless status_validator.valid?(@status)
+      type_validator = EnumAttributeValidator.new('String', ["DEPOSIT", "WITHDRAW", "COMMISSION", "LIQUIDATION", "ADJUSTMENT"])
+      return false unless type_validator.valid?(@type)
+      withdraw_pix_type_validator = EnumAttributeValidator.new('String', ["cpf", "cnpj", "email", "phone", "evp"])
+      return false unless withdraw_pix_type_validator.valid?(@withdraw_pix_type)
+      refund_status_validator = EnumAttributeValidator.new('String', ["PENDING", "COMPLETED", "CANCELED"])
+      return false unless refund_status_validator.valid?(@refund_status)
+      refund_reason_validator = EnumAttributeValidator.new('String', ["CUSTOMER_REQUEST", "INFRACTION"])
+      return false unless refund_reason_validator.valid?(@refund_reason)
+      return false if !@virtual_account.nil? && @virtual_account.to_s.length > 50
+      method_validator = EnumAttributeValidator.new('String', ["PIX", "INTERNAL_TRANSFER"])
+      return false unless method_validator.valid?(@method)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] virtual_account Value to be assigned
+    def virtual_account=(virtual_account)
+      if !virtual_account.nil? && virtual_account.to_s.length > 50
+        fail ArgumentError, 'invalid value for "virtual_account", the character length must be smaller than or equal to 50.'
+      end
+
+      @virtual_account = virtual_account
+    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 &&
+          status == o.status &&
+          amount == o.amount &&
+          type == o.type &&
+          qr_code_text == o.qr_code_text &&
+          qr_code_base64 == o.qr_code_base64 &&
+          qr_code_url == o.qr_code_url &&
+          generated_name == o.generated_name &&
+          generated_document == o.generated_document &&
+          generated_email == o.generated_email &&
+          payer_name == o.payer_name &&
+          payer_document == o.payer_document &&
+          payer_institution_ispb == o.payer_institution_ispb &&
+          payer_institution_name == o.payer_institution_name &&
+          payer_account_number == o.payer_account_number &&
+          service_fee_charged == o.service_fee_charged &&
+          withdraw_pix_key == o.withdraw_pix_key &&
+          withdraw_pix_type == o.withdraw_pix_type &&
+          receiver_name == o.receiver_name &&
+          receiver_document == o.receiver_document &&
+          receiver_institution_ispb == o.receiver_institution_ispb &&
+          receiver_institution_name == o.receiver_institution_name &&
+          receiver_account_number == o.receiver_account_number &&
+          end_to_end_id == o.end_to_end_id &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          paid_at == o.paid_at &&
+          client_reference == o.client_reference &&
+          refund_end_to_end_id == o.refund_end_to_end_id &&
+          refund_amount == o.refund_amount &&
+          refund_status == o.refund_status &&
+          refund_reason == o.refund_reason &&
+          refund_description == o.refund_description &&
+          refunded_at == o.refunded_at &&
+          cancellation_reason == o.cancellation_reason &&
+          virtual_account == o.virtual_account &&
+          method == o.method
+    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, status, amount, type, qr_code_text, qr_code_base64, qr_code_url, generated_name, generated_document, generated_email, payer_name, payer_document, payer_institution_ispb, payer_institution_name, payer_account_number, service_fee_charged, withdraw_pix_key, withdraw_pix_type, receiver_name, receiver_document, receiver_institution_ispb, receiver_institution_name, receiver_account_number, end_to_end_id, created_at, updated_at, paid_at, client_reference, refund_end_to_end_id, refund_amount, refund_status, refund_reason, refund_description, refunded_at, cancellation_reason, virtual_account, method].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