payzu-pix 2.0.0

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

@@ -0,0 +1,302 @@
+=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 PostWithdrawQrcodeRequest < ApiModelBase
+    # Pix QR Code payload (EMV format).
+    attr_accessor :qr_code
+
+    # Amount in BRL, with at most 2 decimal places. Optional: if not provided, uses the QR Code's embedded value.
+    attr_accessor :amount
+
+    # URL for transaction notifications (http or https).
+    attr_accessor :callback_url
+
+    # Optional description for the payment.
+    attr_accessor :description
+
+    # External reference for this withdrawal. Repeating it with the same amount and QR Code returns the existing withdrawal; with different data, the request is rejected with PZC210.
+    attr_accessor :client_reference
+
+    # Virtual sub-account (up to 50 characters) to correlate stores, branches, marketplaces. Returned in the callback.
+    attr_accessor :virtual_account
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'qr_code' => :'qrCode',
+        :'amount' => :'amount',
+        :'callback_url' => :'callbackUrl',
+        :'description' => :'description',
+        :'client_reference' => :'clientReference',
+        :'virtual_account' => :'virtualAccount'
+      }
+    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
+      {
+        :'qr_code' => :'String',
+        :'amount' => :'Float',
+        :'callback_url' => :'String',
+        :'description' => :'String',
+        :'client_reference' => :'String',
+        :'virtual_account' => :'String'
+      }
+    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::PostWithdrawQrcodeRequest` 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::PostWithdrawQrcodeRequest`. 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?(:'qr_code')
+        self.qr_code = attributes[:'qr_code']
+      else
+        self.qr_code = nil
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'callback_url')
+        self.callback_url = attributes[:'callback_url']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'client_reference')
+        self.client_reference = attributes[:'client_reference']
+      end
+
+      if attributes.key?(:'virtual_account')
+        self.virtual_account = attributes[:'virtual_account']
+      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 @qr_code.nil?
+        invalid_properties.push('invalid value for "qr_code", qr_code cannot be nil.')
+      end
+
+      if !@amount.nil? && @amount < 0.1
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.1.')
+      end
+
+      pattern = Regexp.new(/^https?:\/\//)
+      if !@callback_url.nil? && @callback_url !~ pattern
+        invalid_properties.push("invalid value for \"callback_url\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@client_reference.nil? && @client_reference.to_s.length > 64
+        invalid_properties.push('invalid value for "client_reference", the character length must be smaller than or equal to 64.')
+      end
+
+      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
+
+      if !@virtual_account.nil? && @virtual_account.to_s.length < 1
+        invalid_properties.push('invalid value for "virtual_account", the character length must be greater than or equal to 1.')
+      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'
+      return false if @qr_code.nil?
+      return false if !@amount.nil? && @amount < 0.1
+      return false if !@callback_url.nil? && @callback_url !~ Regexp.new(/^https?:\/\//)
+      return false if !@client_reference.nil? && @client_reference.to_s.length > 64
+      return false if !@virtual_account.nil? && @virtual_account.to_s.length > 50
+      return false if !@virtual_account.nil? && @virtual_account.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] qr_code Value to be assigned
+    def qr_code=(qr_code)
+      if qr_code.nil?
+        fail ArgumentError, 'qr_code cannot be nil'
+      end
+
+      @qr_code = qr_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, 'amount cannot be nil'
+      end
+
+      if amount < 0.1
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.1.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] callback_url Value to be assigned
+    def callback_url=(callback_url)
+      if callback_url.nil?
+        fail ArgumentError, 'callback_url cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https?:\/\//)
+      if callback_url !~ pattern
+        fail ArgumentError, "invalid value for \"callback_url\", must conform to the pattern #{pattern}."
+      end
+
+      @callback_url = callback_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] client_reference Value to be assigned
+    def client_reference=(client_reference)
+      if client_reference.nil?
+        fail ArgumentError, 'client_reference cannot be nil'
+      end
+
+      if client_reference.to_s.length > 64
+        fail ArgumentError, 'invalid value for "client_reference", the character length must be smaller than or equal to 64.'
+      end
+
+      @client_reference = client_reference
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] virtual_account Value to be assigned
+    def virtual_account=(virtual_account)
+      if virtual_account.nil?
+        fail ArgumentError, 'virtual_account cannot be nil'
+      end
+
+      if 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
+
+      if virtual_account.to_s.length < 1
+        fail ArgumentError, 'invalid value for "virtual_account", the character length must be greater than or equal to 1.'
+      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 &&
+          qr_code == o.qr_code &&
+          amount == o.amount &&
+          callback_url == o.callback_url &&
+          description == o.description &&
+          client_reference == o.client_reference &&
+          virtual_account == o.virtual_account
+    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
+      [qr_code, amount, callback_url, description, client_reference, virtual_account].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/post_withdraw_request.rb

@@ -0,0 +1,350 @@
+=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 PostWithdrawRequest < ApiModelBase
+    # Amount in BRL, with at most 2 decimal places. Must be >= 0.01.
+    attr_accessor :amount
+
+    # Destination Pix key in the format of pixType: CPF or CNPJ with valid check digits and no punctuation, phone as +55 followed by area code and number, email, or random key (EVP).
+    attr_accessor :pix_key
+
+    # Pix key type.
+    attr_accessor :pix_type
+
+    # URL for transaction notifications (http or https).
+    attr_accessor :callback_url
+
+    # External reference for this withdrawal. Repeating it with the same amount and key returns the existing withdrawal; with different data, the request is rejected with PZC210.
+    attr_accessor :client_reference
+
+    # Optional description.
+    attr_accessor :description
+
+    # Virtual sub-account (up to 50 characters) to correlate stores, branches, marketplaces. Returned in the callback.
+    attr_accessor :virtual_account
+
+    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
+      {
+        :'amount' => :'amount',
+        :'pix_key' => :'pixKey',
+        :'pix_type' => :'pixType',
+        :'callback_url' => :'callbackUrl',
+        :'client_reference' => :'clientReference',
+        :'description' => :'description',
+        :'virtual_account' => :'virtualAccount'
+      }
+    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
+      {
+        :'amount' => :'Float',
+        :'pix_key' => :'String',
+        :'pix_type' => :'String',
+        :'callback_url' => :'String',
+        :'client_reference' => :'String',
+        :'description' => :'String',
+        :'virtual_account' => :'String'
+      }
+    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::PostWithdrawRequest` 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::PostWithdrawRequest`. 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?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'pix_key')
+        self.pix_key = attributes[:'pix_key']
+      else
+        self.pix_key = nil
+      end
+
+      if attributes.key?(:'pix_type')
+        self.pix_type = attributes[:'pix_type']
+      else
+        self.pix_type = nil
+      end
+
+      if attributes.key?(:'callback_url')
+        self.callback_url = attributes[:'callback_url']
+      end
+
+      if attributes.key?(:'client_reference')
+        self.client_reference = attributes[:'client_reference']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'virtual_account')
+        self.virtual_account = attributes[:'virtual_account']
+      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 @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @amount < 0.01
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.01.')
+      end
+
+      if @pix_key.nil?
+        invalid_properties.push('invalid value for "pix_key", pix_key cannot be nil.')
+      end
+
+      if @pix_type.nil?
+        invalid_properties.push('invalid value for "pix_type", pix_type cannot be nil.')
+      end
+
+      pattern = Regexp.new(/^https?:\/\//)
+      if !@callback_url.nil? && @callback_url !~ pattern
+        invalid_properties.push("invalid value for \"callback_url\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@client_reference.nil? && @client_reference.to_s.length > 64
+        invalid_properties.push('invalid value for "client_reference", the character length must be smaller than or equal to 64.')
+      end
+
+      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
+
+      if !@virtual_account.nil? && @virtual_account.to_s.length < 1
+        invalid_properties.push('invalid value for "virtual_account", the character length must be greater than or equal to 1.')
+      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'
+      return false if @amount.nil?
+      return false if @amount < 0.01
+      return false if @pix_key.nil?
+      return false if @pix_type.nil?
+      pix_type_validator = EnumAttributeValidator.new('String', ["cpf", "cnpj", "phone", "email", "evp"])
+      return false unless pix_type_validator.valid?(@pix_type)
+      return false if !@callback_url.nil? && @callback_url !~ Regexp.new(/^https?:\/\//)
+      return false if !@client_reference.nil? && @client_reference.to_s.length > 64
+      return false if !@virtual_account.nil? && @virtual_account.to_s.length > 50
+      return false if !@virtual_account.nil? && @virtual_account.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, 'amount cannot be nil'
+      end
+
+      if amount < 0.01
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.01.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] pix_key Value to be assigned
+    def pix_key=(pix_key)
+      if pix_key.nil?
+        fail ArgumentError, 'pix_key cannot be nil'
+      end
+
+      @pix_key = pix_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] callback_url Value to be assigned
+    def callback_url=(callback_url)
+      if callback_url.nil?
+        fail ArgumentError, 'callback_url cannot be nil'
+      end
+
+      pattern = Regexp.new(/^https?:\/\//)
+      if callback_url !~ pattern
+        fail ArgumentError, "invalid value for \"callback_url\", must conform to the pattern #{pattern}."
+      end
+
+      @callback_url = callback_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] client_reference Value to be assigned
+    def client_reference=(client_reference)
+      if client_reference.nil?
+        fail ArgumentError, 'client_reference cannot be nil'
+      end
+
+      if client_reference.to_s.length > 64
+        fail ArgumentError, 'invalid value for "client_reference", the character length must be smaller than or equal to 64.'
+      end
+
+      @client_reference = client_reference
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] virtual_account Value to be assigned
+    def virtual_account=(virtual_account)
+      if virtual_account.nil?
+        fail ArgumentError, 'virtual_account cannot be nil'
+      end
+
+      if 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
+
+      if virtual_account.to_s.length < 1
+        fail ArgumentError, 'invalid value for "virtual_account", the character length must be greater than or equal to 1.'
+      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 &&
+          amount == o.amount &&
+          pix_key == o.pix_key &&
+          pix_type == o.pix_type &&
+          callback_url == o.callback_url &&
+          client_reference == o.client_reference &&
+          description == o.description &&
+          virtual_account == o.virtual_account
+    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
+      [amount, pix_key, pix_type, callback_url, client_reference, description, virtual_account].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