merge_accounting_client 1.0.0

data/lib/merge_accounting_client/models/credit_note.rb

@@ -0,0 +1,331 @@
+=begin
+#Merge Accounting API
+
+#The unified API for building rich integrations with multiple Accounting & Finance platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeAccountingClient
+  # # The CreditNote Object ### Description The `CreditNote` object is used to represent a refund or credit of payment.  ### Usage Example Fetch from the `LIST CreditNotes` endpoint and view a company's credit notes.
+  class CreditNote
+    attr_accessor :id
+
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    attr_accessor :remote_data
+
+    # The credit note's transaction date.
+    attr_accessor :transaction_date
+
+    # The credit note's status.
+    attr_accessor :status
+
+    # The credit note's total amount.
+    attr_accessor :total_amount
+
+    # The credit note's remaining credit.
+    attr_accessor :remaining_credit
+
+    # The credit note's currency.
+    attr_accessor :currency
+
+    # When the third party's credit note was created.
+    attr_accessor :remote_created_at
+
+    # When the third party's credit note was updated.
+    attr_accessor :remote_updated_at
+
+    # Array of `Payment` object IDs
+    attr_accessor :payments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'remote_id' => :'remote_id',
+        :'remote_data' => :'remote_data',
+        :'transaction_date' => :'transaction_date',
+        :'status' => :'status',
+        :'total_amount' => :'total_amount',
+        :'remaining_credit' => :'remaining_credit',
+        :'currency' => :'currency',
+        :'remote_created_at' => :'remote_created_at',
+        :'remote_updated_at' => :'remote_updated_at',
+        :'payments' => :'payments'
+      }
+    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',
+        :'remote_id' => :'String',
+        :'remote_data' => :'Array<RemoteData>',
+        :'transaction_date' => :'Time',
+        :'status' => :'CreditNoteStatusEnum',
+        :'total_amount' => :'Float',
+        :'remaining_credit' => :'Float',
+        :'currency' => :'CurrencyEnum',
+        :'remote_created_at' => :'Time',
+        :'remote_updated_at' => :'Time',
+        :'payments' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'remote_data',
+        :'transaction_date',
+        :'status',
+        :'total_amount',
+        :'remaining_credit',
+        :'currency',
+        :'remote_created_at',
+        :'remote_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 `MergeAccountingClient::CreditNote` 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 `MergeAccountingClient::CreditNote`. 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?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
+      if attributes.key?(:'remote_data')
+        if (value = attributes[:'remote_data']).is_a?(Array)
+          self.remote_data = value
+        end
+      end
+
+      if attributes.key?(:'transaction_date')
+        self.transaction_date = attributes[:'transaction_date']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'total_amount')
+        self.total_amount = attributes[:'total_amount']
+      end
+
+      if attributes.key?(:'remaining_credit')
+        self.remaining_credit = attributes[:'remaining_credit']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'remote_created_at')
+        self.remote_created_at = attributes[:'remote_created_at']
+      end
+
+      if attributes.key?(:'remote_updated_at')
+        self.remote_updated_at = attributes[:'remote_updated_at']
+      end
+
+      if attributes.key?(:'payments')
+        if (value = attributes[:'payments']).is_a?(Array)
+          self.payments = 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
+      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?
+      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 &&
+          remote_id == o.remote_id &&
+          remote_data == o.remote_data &&
+          transaction_date == o.transaction_date &&
+          status == o.status &&
+          total_amount == o.total_amount &&
+          remaining_credit == o.remaining_credit &&
+          currency == o.currency &&
+          remote_created_at == o.remote_created_at &&
+          remote_updated_at == o.remote_updated_at &&
+          payments == o.payments
+    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, remote_id, remote_data, transaction_date, status, total_amount, remaining_credit, currency, remote_created_at, remote_updated_at, payments].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value
+      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 = MergeAccountingClient.const_get(type)
+        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

data/lib/merge_accounting_client/models/credit_note_status_enum.rb

@@ -0,0 +1,38 @@
+=begin
+#Merge Accounting API
+
+#The unified API for building rich integrations with multiple Accounting & Finance platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeAccountingClient
+  class CreditNoteStatusEnum
+    SUBMITTED = "SUBMITTED".freeze
+    AUTHORIZED = "AUTHORIZED".freeze
+    PAID = "PAID".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = CreditNoteStatusEnum.constants.select { |c| CreditNoteStatusEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CreditNoteStatusEnum" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/merge_accounting_client/models/currency_enum.rb

@@ -0,0 +1,341 @@
+=begin
+#Merge Accounting API
+
+#The unified API for building rich integrations with multiple Accounting & Finance platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeAccountingClient
+  class CurrencyEnum
+    XUA = "XUA".freeze
+    AFN = "AFN".freeze
+    AFA = "AFA".freeze
+    ALL = "ALL".freeze
+    ALK = "ALK".freeze
+    DZD = "DZD".freeze
+    ADP = "ADP".freeze
+    AOA = "AOA".freeze
+    AOK = "AOK".freeze
+    AON = "AON".freeze
+    AOR = "AOR".freeze
+    ARA = "ARA".freeze
+    ARS = "ARS".freeze
+    ARM = "ARM".freeze
+    ARP = "ARP".freeze
+    ARL = "ARL".freeze
+    AMD = "AMD".freeze
+    AWG = "AWG".freeze
+    AUD = "AUD".freeze
+    ATS = "ATS".freeze
+    AZN = "AZN".freeze
+    AZM = "AZM".freeze
+    BSD = "BSD".freeze
+    BHD = "BHD".freeze
+    BDT = "BDT".freeze
+    BBD = "BBD".freeze
+    BYN = "BYN".freeze
+    BYB = "BYB".freeze
+    BYR = "BYR".freeze
+    BEF = "BEF".freeze
+    BEC = "BEC".freeze
+    BEL = "BEL".freeze
+    BZD = "BZD".freeze
+    BMD = "BMD".freeze
+    BTN = "BTN".freeze
+    BOB = "BOB".freeze
+    BOL = "BOL".freeze
+    BOV = "BOV".freeze
+    BOP = "BOP".freeze
+    BAM = "BAM".freeze
+    BAD = "BAD".freeze
+    BAN = "BAN".freeze
+    BWP = "BWP".freeze
+    BRC = "BRC".freeze
+    BRZ = "BRZ".freeze
+    BRE = "BRE".freeze
+    BRR = "BRR".freeze
+    BRN = "BRN".freeze
+    BRB = "BRB".freeze
+    BRL = "BRL".freeze
+    GBP = "GBP".freeze
+    BND = "BND".freeze
+    BGL = "BGL".freeze
+    BGN = "BGN".freeze
+    BGO = "BGO".freeze
+    BGM = "BGM".freeze
+    BUK = "BUK".freeze
+    BIF = "BIF".freeze
+    XPF = "XPF".freeze
+    KHR = "KHR".freeze
+    CAD = "CAD".freeze
+    CVE = "CVE".freeze
+    KYD = "KYD".freeze
+    XAF = "XAF".freeze
+    CLE = "CLE".freeze
+    CLP = "CLP".freeze
+    CLF = "CLF".freeze
+    CNX = "CNX".freeze
+    CNY = "CNY".freeze
+    CNH = "CNH".freeze
+    COP = "COP".freeze
+    COU = "COU".freeze
+    KMF = "KMF".freeze
+    CDF = "CDF".freeze
+    CRC = "CRC".freeze
+    HRD = "HRD".freeze
+    HRK = "HRK".freeze
+    CUC = "CUC".freeze
+    CUP = "CUP".freeze
+    CYP = "CYP".freeze
+    CZK = "CZK".freeze
+    CSK = "CSK".freeze
+    DKK = "DKK".freeze
+    DJF = "DJF".freeze
+    DOP = "DOP".freeze
+    NLG = "NLG".freeze
+    XCD = "XCD".freeze
+    DDM = "DDM".freeze
+    ECS = "ECS".freeze
+    ECV = "ECV".freeze
+    EGP = "EGP".freeze
+    GQE = "GQE".freeze
+    ERN = "ERN".freeze
+    EEK = "EEK".freeze
+    ETB = "ETB".freeze
+    EUR = "EUR".freeze
+    XBA = "XBA".freeze
+    XEU = "XEU".freeze
+    XBB = "XBB".freeze
+    XBC = "XBC".freeze
+    XBD = "XBD".freeze
+    FKP = "FKP".freeze
+    FJD = "FJD".freeze
+    FIM = "FIM".freeze
+    FRF = "FRF".freeze
+    XFO = "XFO".freeze
+    XFU = "XFU".freeze
+    GMD = "GMD".freeze
+    GEK = "GEK".freeze
+    GEL = "GEL".freeze
+    DEM = "DEM".freeze
+    GHS = "GHS".freeze
+    GHC = "GHC".freeze
+    GIP = "GIP".freeze
+    XAU = "XAU".freeze
+    GRD = "GRD".freeze
+    GTQ = "GTQ".freeze
+    GWP = "GWP".freeze
+    GNF = "GNF".freeze
+    GNS = "GNS".freeze
+    GYD = "GYD".freeze
+    HTG = "HTG".freeze
+    HNL = "HNL".freeze
+    HKD = "HKD".freeze
+    HUF = "HUF".freeze
+    IMP = "IMP".freeze
+    ISK = "ISK".freeze
+    ISJ = "ISJ".freeze
+    INR = "INR".freeze
+    IDR = "IDR".freeze
+    IRR = "IRR".freeze
+    IQD = "IQD".freeze
+    IEP = "IEP".freeze
+    ILS = "ILS".freeze
+    ILP = "ILP".freeze
+    ILR = "ILR".freeze
+    ITL = "ITL".freeze
+    JMD = "JMD".freeze
+    JPY = "JPY".freeze
+    JOD = "JOD".freeze
+    KZT = "KZT".freeze
+    KES = "KES".freeze
+    KWD = "KWD".freeze
+    KGS = "KGS".freeze
+    LAK = "LAK".freeze
+    LVL = "LVL".freeze
+    LVR = "LVR".freeze
+    LBP = "LBP".freeze
+    LSL = "LSL".freeze
+    LRD = "LRD".freeze
+    LYD = "LYD".freeze
+    LTL = "LTL".freeze
+    LTT = "LTT".freeze
+    LUL = "LUL".freeze
+    LUC = "LUC".freeze
+    LUF = "LUF".freeze
+    MOP = "MOP".freeze
+    MKD = "MKD".freeze
+    MKN = "MKN".freeze
+    MGA = "MGA".freeze
+    MGF = "MGF".freeze
+    MWK = "MWK".freeze
+    MYR = "MYR".freeze
+    MVR = "MVR".freeze
+    MVP = "MVP".freeze
+    MLF = "MLF".freeze
+    MTL = "MTL".freeze
+    MTP = "MTP".freeze
+    MRU = "MRU".freeze
+    MRO = "MRO".freeze
+    MUR = "MUR".freeze
+    MXV = "MXV".freeze
+    MXN = "MXN".freeze
+    MXP = "MXP".freeze
+    MDC = "MDC".freeze
+    MDL = "MDL".freeze
+    MCF = "MCF".freeze
+    MNT = "MNT".freeze
+    MAD = "MAD".freeze
+    MAF = "MAF".freeze
+    MZE = "MZE".freeze
+    MZN = "MZN".freeze
+    MZM = "MZM".freeze
+    MMK = "MMK".freeze
+    NAD = "NAD".freeze
+    NPR = "NPR".freeze
+    ANG = "ANG".freeze
+    TWD = "TWD".freeze
+    NZD = "NZD".freeze
+    NIO = "NIO".freeze
+    NIC = "NIC".freeze
+    NGN = "NGN".freeze
+    KPW = "KPW".freeze
+    NOK = "NOK".freeze
+    OMR = "OMR".freeze
+    PKR = "PKR".freeze
+    XPD = "XPD".freeze
+    PAB = "PAB".freeze
+    PGK = "PGK".freeze
+    PYG = "PYG".freeze
+    PEI = "PEI".freeze
+    PEN = "PEN".freeze
+    PES = "PES".freeze
+    PHP = "PHP".freeze
+    XPT = "XPT".freeze
+    PLN = "PLN".freeze
+    PLZ = "PLZ".freeze
+    PTE = "PTE".freeze
+    GWE = "GWE".freeze
+    QAR = "QAR".freeze
+    XRE = "XRE".freeze
+    RHD = "RHD".freeze
+    RON = "RON".freeze
+    ROL = "ROL".freeze
+    RUB = "RUB".freeze
+    RUR = "RUR".freeze
+    RWF = "RWF".freeze
+    SVC = "SVC".freeze
+    WST = "WST".freeze
+    SAR = "SAR".freeze
+    RSD = "RSD".freeze
+    CSD = "CSD".freeze
+    SCR = "SCR".freeze
+    SLL = "SLL".freeze
+    XAG = "XAG".freeze
+    SGD = "SGD".freeze
+    SKK = "SKK".freeze
+    SIT = "SIT".freeze
+    SBD = "SBD".freeze
+    SOS = "SOS".freeze
+    ZAR = "ZAR".freeze
+    ZAL = "ZAL".freeze
+    KRH = "KRH".freeze
+    KRW = "KRW".freeze
+    KRO = "KRO".freeze
+    SSP = "SSP".freeze
+    SUR = "SUR".freeze
+    ESP = "ESP".freeze
+    ESA = "ESA".freeze
+    ESB = "ESB".freeze
+    XDR = "XDR".freeze
+    LKR = "LKR".freeze
+    SHP = "SHP".freeze
+    XSU = "XSU".freeze
+    SDD = "SDD".freeze
+    SDG = "SDG".freeze
+    SDP = "SDP".freeze
+    SRD = "SRD".freeze
+    SRG = "SRG".freeze
+    SZL = "SZL".freeze
+    SEK = "SEK".freeze
+    CHF = "CHF".freeze
+    SYP = "SYP".freeze
+    STN = "STN".freeze
+    STD = "STD".freeze
+    TVD = "TVD".freeze
+    TJR = "TJR".freeze
+    TJS = "TJS".freeze
+    TZS = "TZS".freeze
+    XTS = "XTS".freeze
+    THB = "THB".freeze
+    XXX = "XXX".freeze
+    TPE = "TPE".freeze
+    TOP = "TOP".freeze
+    TTD = "TTD".freeze
+    TND = "TND".freeze
+    TRY = "TRY".freeze
+    TRL = "TRL".freeze
+    TMT = "TMT".freeze
+    TMM = "TMM".freeze
+    USD = "USD".freeze
+    USN = "USN".freeze
+    USS = "USS".freeze
+    UGX = "UGX".freeze
+    UGS = "UGS".freeze
+    UAH = "UAH".freeze
+    UAK = "UAK".freeze
+    AED = "AED".freeze
+    UYW = "UYW".freeze
+    UYU = "UYU".freeze
+    UYP = "UYP".freeze
+    UYI = "UYI".freeze
+    UZS = "UZS".freeze
+    VUV = "VUV".freeze
+    VES = "VES".freeze
+    VEB = "VEB".freeze
+    VEF = "VEF".freeze
+    VND = "VND".freeze
+    VNN = "VNN".freeze
+    CHE = "CHE".freeze
+    CHW = "CHW".freeze
+    XOF = "XOF".freeze
+    YDD = "YDD".freeze
+    YER = "YER".freeze
+    YUN = "YUN".freeze
+    YUD = "YUD".freeze
+    YUM = "YUM".freeze
+    YUR = "YUR".freeze
+    ZWN = "ZWN".freeze
+    ZRN = "ZRN".freeze
+    ZRZ = "ZRZ".freeze
+    ZMW = "ZMW".freeze
+    ZMK = "ZMK".freeze
+    ZWD = "ZWD".freeze
+    ZWR = "ZWR".freeze
+    ZWL = "ZWL".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = CurrencyEnum.constants.select { |c| CurrencyEnum::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CurrencyEnum" if constantValues.empty?
+      value
+    end
+  end
+end