merge_accounting_client 1.0.9 → 1.1.0

data/lib/merge_accounting_client/models/account_integration.rb

@@ -38,6 +38,9 @@ module MergeAccountingClient
     # Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}
     attr_accessor :api_endpoints_to_documentation_urls
 
+    # Setup guide URL for third party webhook creation. Exposed in Merge Docs.
+    attr_accessor :webhook_setup_guide_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -48,7 +51,8 @@ module MergeAccountingClient
         :'color' => :'color',
         :'slug' => :'slug',
         :'is_in_beta' => :'is_in_beta',
-        :'api_endpoints_to_documentation_urls' => :'api_endpoints_to_documentation_urls'
+        :'api_endpoints_to_documentation_urls' => :'api_endpoints_to_documentation_urls',
+        :'webhook_setup_guide_url' => :'webhook_setup_guide_url'
       }
     end
 
@@ -67,7 +71,8 @@ module MergeAccountingClient
         :'color' => :'String',
         :'slug' => :'String',
         :'is_in_beta' => :'Boolean',
-        :'api_endpoints_to_documentation_urls' => :'Hash<String, Object>'
+        :'api_endpoints_to_documentation_urls' => :'Hash<String, Object>',
+        :'webhook_setup_guide_url' => :'String'
       }
     end
 
@@ -76,6 +81,7 @@ module MergeAccountingClient
       Set.new([
         :'image',
         :'square_image',
+        :'webhook_setup_guide_url'
       ])
     end
 
@@ -129,6 +135,10 @@ module MergeAccountingClient
           self.api_endpoints_to_documentation_urls = value
         end
       end
+
+      if attributes.key?(:'webhook_setup_guide_url')
+        self.webhook_setup_guide_url = attributes[:'webhook_setup_guide_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -187,7 +197,8 @@ module MergeAccountingClient
           color == o.color &&
           slug == o.slug &&
           is_in_beta == o.is_in_beta &&
-          api_endpoints_to_documentation_urls == o.api_endpoints_to_documentation_urls
+          api_endpoints_to_documentation_urls == o.api_endpoints_to_documentation_urls &&
+          webhook_setup_guide_url == o.webhook_setup_guide_url
     end
 
     # @see the `==` method
@@ -199,7 +210,7 @@ module MergeAccountingClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, categories, image, square_image, color, slug, is_in_beta, api_endpoints_to_documentation_urls].hash
+      [name, categories, image, square_image, color, slug, is_in_beta, api_endpoints_to_documentation_urls, webhook_setup_guide_url].hash
     end
 
     # Builds the object from hash

data/lib/merge_accounting_client/models/account_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module MergeAccountingClient
-  # # The Account Object ### Description The `Account` object is what companies use to track transactions. They can be both bank accounts or a general ledger account (also called a chart of accounts).  ### Usage Example Fetch from the `LIST Accounts` endpoint and view a company's accounts.
+  # # The Account Object ### Description An `Account` represents a category in a company’s ledger in which a financial transaction is recorded against. The aggregation of each `Account` object is often referred to as the **Chart of Accounts**.  An `Account` can be classified into one of the following categories, determined through the `classification` field: * __Asset:__ Accounts Receivable and Bank Accounts * __Liability:__ Accounts Payable and Credit Card Accounts * __Equity:__ Treasury Accounts and Retained Earnings * __Revenue:__ Income and Other Income * __Expense:__ Cost of Goods Sold and Office Expenses  ### Usage Example Fetch from the `LIST Accounts` endpoint and view a company's accounts.
   class AccountRequest
     # The account's name.
     attr_accessor :name

data/lib/merge_accounting_client/models/accounting_attachment.rb

@@ -30,9 +30,11 @@ module MergeAccountingClient
     # The company the accounting attachment belongs to.
     attr_accessor :company
 
-    # Indicates whether or not this object has been deleted by third party webhooks.
+    # Indicates whether or not this object has been deleted in the third party platform.
     attr_accessor :remote_was_deleted
 
+    attr_accessor :created_at
+
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
@@ -49,6 +51,7 @@ module MergeAccountingClient
         :'file_url' => :'file_url',
         :'company' => :'company',
         :'remote_was_deleted' => :'remote_was_deleted',
+        :'created_at' => :'created_at',
         :'modified_at' => :'modified_at',
         :'field_mappings' => :'field_mappings',
         :'remote_data' => :'remote_data'
@@ -69,6 +72,7 @@ module MergeAccountingClient
         :'file_url' => :'String',
         :'company' => :'String',
         :'remote_was_deleted' => :'Boolean',
+        :'created_at' => :'Time',
         :'modified_at' => :'Time',
         :'field_mappings' => :'Hash<String, Object>',
         :'remote_data' => :'Array<RemoteData>'
@@ -126,6 +130,10 @@ module MergeAccountingClient
         self.remote_was_deleted = attributes[:'remote_was_deleted']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'modified_at')
         self.modified_at = attributes[:'modified_at']
       end
@@ -182,6 +190,7 @@ module MergeAccountingClient
           file_url == o.file_url &&
           company == o.company &&
           remote_was_deleted == o.remote_was_deleted &&
+          created_at == o.created_at &&
           modified_at == o.modified_at &&
           field_mappings == o.field_mappings &&
           remote_data == o.remote_data
@@ -196,7 +205,7 @@ module MergeAccountingClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, remote_id, file_name, file_url, company, remote_was_deleted, modified_at, field_mappings, remote_data].hash
+      [id, remote_id, file_name, file_url, company, remote_was_deleted, created_at, modified_at, field_mappings, remote_data].hash
     end
 
     # Builds the object from hash

data/lib/merge_accounting_client/models/accounting_period.rb

@@ -0,0 +1,296 @@
+=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 AccountingPeriod Object ### Description The `AccountingPeriod` object is used to define a period of time in which events occurred.  ### Usage Example Common models like `Invoice` and `Transaction` will have `AccountingPeriod` objects which will denote when they occurred.
+  class AccountingPeriod
+    # Beginning date of the period
+    attr_accessor :start_date
+
+    # End date of the period
+    attr_accessor :end_date
+
+    attr_accessor :status
+
+    # Name of the accounting period.
+    attr_accessor :name
+
+    attr_accessor :id
+
+    attr_accessor :created_at
+
+    # This is the datetime that this object was last updated by Merge
+    attr_accessor :modified_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start_date' => :'start_date',
+        :'end_date' => :'end_date',
+        :'status' => :'status',
+        :'name' => :'name',
+        :'id' => :'id',
+        :'created_at' => :'created_at',
+        :'modified_at' => :'modified_at'
+      }
+    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
+      {
+        :'start_date' => :'Time',
+        :'end_date' => :'Time',
+        :'status' => :'AccountingPeriodStatusEnum',
+        :'name' => :'String',
+        :'id' => :'String',
+        :'created_at' => :'Time',
+        :'modified_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'start_date',
+        :'end_date',
+        :'status',
+        :'name',
+      ])
+    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::AccountingPeriod` 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::AccountingPeriod`. 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?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'modified_at')
+        self.modified_at = attributes[:'modified_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
+      invalid_properties = Array.new
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      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?
+      return false if !@name.nil? && @name.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    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 &&
+          start_date == o.start_date &&
+          end_date == o.end_date &&
+          status == o.status &&
+          name == o.name &&
+          id == o.id &&
+          created_at == o.created_at &&
+          modified_at == o.modified_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
+      [start_date, end_date, status, name, id, created_at, modified_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)
+      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/accounting_period_status_enum.rb

@@ -0,0 +1,45 @@
+=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 AccountingPeriodStatusEnum
+    ACTIVE = "ACTIVE".freeze
+    INACTIVE = "INACTIVE".freeze
+
+    MERGE_NONSTANDARD_VALUE = "MERGE_NONSTANDARD_VALUE".freeze
+
+    attr_accessor :value
+    attr_accessor :raw_value
+
+    # 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)
+      @raw_value = value
+      if ["ACTIVE", "INACTIVE", ].include? value
+        @value = value
+      else
+        @value = MERGE_NONSTANDARD_VALUE
+      end
+
+      self
+    end
+
+    def self.build_from_hash(value)
+      AccountingPeriodStatusEnum.new.build_from_hash(value)
+    end
+  end
+
+end

data/lib/merge_accounting_client/models/accounting_phone_number.rb

@@ -22,6 +22,8 @@ module MergeAccountingClient
     # The phone number's type.
     attr_accessor :type
 
+    attr_accessor :created_at
+
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
@@ -30,6 +32,7 @@ module MergeAccountingClient
       {
         :'number' => :'number',
         :'type' => :'type',
+        :'created_at' => :'created_at',
         :'modified_at' => :'modified_at'
       }
     end
@@ -44,6 +47,7 @@ module MergeAccountingClient
       {
         :'number' => :'String',
         :'type' => :'String',
+        :'created_at' => :'Time',
         :'modified_at' => :'Time'
       }
     end
@@ -79,6 +83,10 @@ module MergeAccountingClient
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'modified_at')
         self.modified_at = attributes[:'modified_at']
       end
@@ -104,6 +112,7 @@ module MergeAccountingClient
       self.class == o.class &&
           number == o.number &&
           type == o.type &&
+          created_at == o.created_at &&
           modified_at == o.modified_at
     end
 
@@ -116,7 +125,7 @@ module MergeAccountingClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [number, type, modified_at].hash
+      [number, type, created_at, modified_at].hash
     end
 
     # Builds the object from hash

data/lib/merge_accounting_client/models/address.rb

@@ -40,6 +40,8 @@ module MergeAccountingClient
     # The address's zip code.
     attr_accessor :zip_code
 
+    attr_accessor :created_at
+
     # This is the datetime that this object was last updated by Merge
     attr_accessor :modified_at
 
@@ -54,6 +56,7 @@ module MergeAccountingClient
         :'country_subdivision' => :'country_subdivision',
         :'country' => :'country',
         :'zip_code' => :'zip_code',
+        :'created_at' => :'created_at',
         :'modified_at' => :'modified_at'
       }
     end
@@ -74,6 +77,7 @@ module MergeAccountingClient
         :'country_subdivision' => :'String',
         :'country' => :'CountryEnum',
         :'zip_code' => :'String',
+        :'created_at' => :'Time',
         :'modified_at' => :'Time'
       }
     end
@@ -139,6 +143,10 @@ module MergeAccountingClient
         self.zip_code = attributes[:'zip_code']
       end
 
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
       if attributes.key?(:'modified_at')
         self.modified_at = attributes[:'modified_at']
       end
@@ -170,6 +178,7 @@ module MergeAccountingClient
           country_subdivision == o.country_subdivision &&
           country == o.country &&
           zip_code == o.zip_code &&
+          created_at == o.created_at &&
           modified_at == o.modified_at
     end
 
@@ -182,7 +191,7 @@ module MergeAccountingClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, street_1, street_2, city, state, country_subdivision, country, zip_code, modified_at].hash
+      [type, street_1, street_2, city, state, country_subdivision, country, zip_code, created_at, modified_at].hash
     end
 
     # Builds the object from hash