api-sdk-rb 1.11.66

data/lib/api-sdk-rb/models/partner_invoice.rb

@@ -0,0 +1,489 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ApiSdkRb
+  # An invoice issued to a partner. Money is in dollars (not cents). Administrator notes, billing-provider identifiers and Widgetic account ids are not part of what a partner is sent. 
+  class PartnerInvoice
+    attr_accessor :id
+
+    attr_accessor :partner_id
+
+    # The number printed on the invoice, once it has been issued
+    attr_accessor :number
+
+    # What the invoice is for
+    attr_accessor :description
+
+    # Total, in dollars. The price plus the tax (the same number as `total`)
+    attr_accessor :amount
+
+    # The price, before tax, in dollars
+    attr_accessor :subtotal
+
+    # The tax on the price, in dollars. 0 when there is none, for example under the EU reverse charge
+    attr_accessor :tax_amount
+
+    # What the partner pays, in dollars. The price plus the tax
+    attr_accessor :total
+
+    # What is still owed, in dollars
+    attr_accessor :amount_due
+
+    # What has been paid, in dollars
+    attr_accessor :amount_paid
+
+    attr_accessor :currency
+
+    # Why the last attempt to pay failed, in the payment provider's words for the card holder. Null unless the status is `failed`; the invoice stays payable from `hostedInvoiceUrl`
+    attr_accessor :failure_reason
+
+    # `open` waits for payment, `failed` waits for payment after an attempt was refused, `paid` is settled (a payment received outside the payment provider counts), `void` was cancelled and owes nothing, and `uncollectible` was written off 
+    attr_accessor :status
+
+    attr_accessor :invoice_date
+
+    attr_accessor :due_date
+
+    attr_accessor :paid_date
+
+    attr_accessor :period_start
+
+    attr_accessor :period_end
+
+    # How it was paid, once it was
+    attr_accessor :payment_method
+
+    # The page where the invoice can be viewed and paid, once it has been issued
+    attr_accessor :hosted_invoice_url
+
+    # A PDF of the invoice, once it has been issued
+    attr_accessor :pdf_url
+
+    attr_accessor :line_items
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    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',
+        :'partner_id' => :'partnerId',
+        :'number' => :'number',
+        :'description' => :'description',
+        :'amount' => :'amount',
+        :'subtotal' => :'subtotal',
+        :'tax_amount' => :'taxAmount',
+        :'total' => :'total',
+        :'amount_due' => :'amountDue',
+        :'amount_paid' => :'amountPaid',
+        :'currency' => :'currency',
+        :'failure_reason' => :'failureReason',
+        :'status' => :'status',
+        :'invoice_date' => :'invoiceDate',
+        :'due_date' => :'dueDate',
+        :'paid_date' => :'paidDate',
+        :'period_start' => :'periodStart',
+        :'period_end' => :'periodEnd',
+        :'payment_method' => :'paymentMethod',
+        :'hosted_invoice_url' => :'hostedInvoiceUrl',
+        :'pdf_url' => :'pdfUrl',
+        :'line_items' => :'lineItems',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'partner_id' => :'String',
+        :'number' => :'String',
+        :'description' => :'String',
+        :'amount' => :'Float',
+        :'subtotal' => :'Float',
+        :'tax_amount' => :'Float',
+        :'total' => :'Float',
+        :'amount_due' => :'Float',
+        :'amount_paid' => :'Float',
+        :'currency' => :'String',
+        :'failure_reason' => :'String',
+        :'status' => :'String',
+        :'invoice_date' => :'Time',
+        :'due_date' => :'Time',
+        :'paid_date' => :'Time',
+        :'period_start' => :'Time',
+        :'period_end' => :'Time',
+        :'payment_method' => :'String',
+        :'hosted_invoice_url' => :'String',
+        :'pdf_url' => :'String',
+        :'line_items' => :'Array<Hash<String, Object>>',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'partner_id',
+        :'number',
+        :'description',
+        :'amount_due',
+        :'amount_paid',
+        :'currency',
+        :'failure_reason',
+        :'invoice_date',
+        :'due_date',
+        :'paid_date',
+        :'period_start',
+        :'period_end',
+        :'payment_method',
+        :'hosted_invoice_url',
+        :'pdf_url',
+        :'line_items',
+        :'created_at',
+        :'updated_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 `ApiSdkRb::PartnerInvoice` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::PartnerInvoice`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'partner_id')
+        self.partner_id = attributes[:'partner_id']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'subtotal')
+        self.subtotal = attributes[:'subtotal']
+      end
+
+      if attributes.key?(:'tax_amount')
+        self.tax_amount = attributes[:'tax_amount']
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'amount_due')
+        self.amount_due = attributes[:'amount_due']
+      end
+
+      if attributes.key?(:'amount_paid')
+        self.amount_paid = attributes[:'amount_paid']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'failure_reason')
+        self.failure_reason = attributes[:'failure_reason']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'invoice_date')
+        self.invoice_date = attributes[:'invoice_date']
+      end
+
+      if attributes.key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.key?(:'paid_date')
+        self.paid_date = attributes[:'paid_date']
+      end
+
+      if attributes.key?(:'period_start')
+        self.period_start = attributes[:'period_start']
+      end
+
+      if attributes.key?(:'period_end')
+        self.period_end = attributes[:'period_end']
+      end
+
+      if attributes.key?(:'payment_method')
+        self.payment_method = attributes[:'payment_method']
+      end
+
+      if attributes.key?(:'hosted_invoice_url')
+        self.hosted_invoice_url = attributes[:'hosted_invoice_url']
+      end
+
+      if attributes.key?(:'pdf_url')
+        self.pdf_url = attributes[:'pdf_url']
+      end
+
+      if attributes.key?(:'line_items')
+        if (value = attributes[:'line_items']).is_a?(Array)
+          self.line_items = value
+        end
+      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
+    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', ["draft", "open", "pending", "paid", "failed", "void", "uncollectible", "refunded", "canceled"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "open", "pending", "paid", "failed", "void", "uncollectible", "refunded", "canceled"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          partner_id == o.partner_id &&
+          number == o.number &&
+          description == o.description &&
+          amount == o.amount &&
+          subtotal == o.subtotal &&
+          tax_amount == o.tax_amount &&
+          total == o.total &&
+          amount_due == o.amount_due &&
+          amount_paid == o.amount_paid &&
+          currency == o.currency &&
+          failure_reason == o.failure_reason &&
+          status == o.status &&
+          invoice_date == o.invoice_date &&
+          due_date == o.due_date &&
+          paid_date == o.paid_date &&
+          period_start == o.period_start &&
+          period_end == o.period_end &&
+          payment_method == o.payment_method &&
+          hosted_invoice_url == o.hosted_invoice_url &&
+          pdf_url == o.pdf_url &&
+          line_items == o.line_items &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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, partner_id, number, description, amount, subtotal, tax_amount, total, amount_due, amount_paid, currency, failure_reason, status, invoice_date, due_date, paid_date, period_start, period_end, payment_method, hosted_invoice_url, pdf_url, line_items, created_at, updated_at].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = ApiSdkRb.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end