moneykit 0.1.9 → 0.1.11

data/lib/moneykit/api/transactions_api.rb

@@ -24,10 +24,10 @@ module MoneyKit
     # @param id [String] The unique ID for this link.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
-    # @option opts [Integer] :page The page number to return. (default to 1)
-    # @option opts [Integer] :size The number of items to return per page. (default to 50)
     # @option opts [Date] :start_date The earliest date for which data should be returned, formatted as YYYY-MM-DD.             Defaults to 90 days before the &#x60;end_date&#x60;.             &lt;p&gt;If you want to retrieve **all** transactions, use &#x60;1900-01-01&#x60;.
     # @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD.             Defaults to today.
+    # @option opts [Integer] :page The page number to return. (default to 1)
+    # @option opts [Integer] :size The number of items to return per page. (default to 50)
     # @return [GetTransactionsResponse]
     def get_transactions(id, opts = {})
       data, _status_code, _headers = get_transactions_with_http_info(id, opts)
@@ -39,10 +39,10 @@ module MoneyKit
     # @param id [String] The unique ID for this link.
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
-    # @option opts [Integer] :page The page number to return. (default to 1)
-    # @option opts [Integer] :size The number of items to return per page. (default to 50)
     # @option opts [Date] :start_date The earliest date for which data should be returned, formatted as YYYY-MM-DD.             Defaults to 90 days before the &#x60;end_date&#x60;.             &lt;p&gt;If you want to retrieve **all** transactions, use &#x60;1900-01-01&#x60;.
     # @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD.             Defaults to today.
+    # @option opts [Integer] :page The page number to return. (default to 1)
+    # @option opts [Integer] :size The number of items to return per page. (default to 50)
     # @return [Array<(GetTransactionsResponse, Integer, Hash)>] GetTransactionsResponse data, response status code and response headers
     def get_transactions_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -70,10 +70,10 @@ module MoneyKit
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
-      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
-      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
       query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -110,38 +110,38 @@ module MoneyKit
     end
 
     # /links/{id}/transactions/sync
-    # Provides a paginated feed of transactions, grouped into `created`, `updated`, and `removed` lists.         <p>Each call will also return a `cursor.next` value.  In subsequent calls, include that value to receive         only changes that have occurred since the previous call.         <p>Large numbers of transactions will be paginated, and the `has_more` field will be true.  You should         continue calling this endpoint with each new `cursor.next` value until `has_more` is false.         <p>**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns         transactions that have already been fetched, either because `prefetch` was requested when the link was created,         or because of scheduled or on-demand updates.         <p>MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the         update frequency can vary, depending on the downstream data provider, the institution, and whether one or both         provide webhook-based updates.         **To force a check for updated transactions, you can use the <a href=#operation/refresh_products>/products</a> endpoint.**         <p>Note also that the `transactions.updates_available` webhook will alert you when new data is available.
+    # Provides a paginated feed of transactions, grouped into `created`, `updated`, and `removed` lists.         <p>Each call will also return a `cursor.next` value.  In subsequent calls, include that value to receive         only changes that have occurred since the previous call.         <p>**Pending** transactions will only be reported as `created`.  Pending transactions are completely         removed and replaced with each transaction refresh or update; no attempt is made to track their removal or         modification.         <p>Large numbers of transactions will be paginated, and the `has_more` field will be true.  You should         continue calling this endpoint with each new `cursor.next` value until `has_more` is false.         <p>**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns         transactions that have already been fetched, either because `prefetch` was requested when the link was created,         or because of scheduled or on-demand updates.         <p>MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the         update frequency can vary, depending on the downstream data provider, the institution, and whether one or both         provide webhook-based updates.         **To force a check for updated transactions, you can use the <a href=#operation/refresh_products>/products</a> endpoint.**         <p>Note also that the `transactions.updates_available` webhook will alert you when new data is available.
     # @param id [String] The unique ID for this link.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor A cursor value representing the last update requested. If included, the response will only return         changes after this update. If omitted, a complete history of updates will be returned. This value must be stored         by the client as we do not keep track of app cursors.
     # @option opts [Integer] :size The number of items to return. (default to 50)
     # @return [TransactionSyncResponse]
-    def get_transactions_diff(id, opts = {})
-      data, _status_code, _headers = get_transactions_diff_with_http_info(id, opts)
+    def get_transactions_sync(id, opts = {})
+      data, _status_code, _headers = get_transactions_sync_with_http_info(id, opts)
       data
     end
 
     # /links/{id}/transactions/sync
-    # Provides a paginated feed of transactions, grouped into &#x60;created&#x60;, &#x60;updated&#x60;, and &#x60;removed&#x60; lists.         &lt;p&gt;Each call will also return a &#x60;cursor.next&#x60; value.  In subsequent calls, include that value to receive         only changes that have occurred since the previous call.         &lt;p&gt;Large numbers of transactions will be paginated, and the &#x60;has_more&#x60; field will be true.  You should         continue calling this endpoint with each new &#x60;cursor.next&#x60; value until &#x60;has_more&#x60; is false.         &lt;p&gt;**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns         transactions that have already been fetched, either because &#x60;prefetch&#x60; was requested when the link was created,         or because of scheduled or on-demand updates.         &lt;p&gt;MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the         update frequency can vary, depending on the downstream data provider, the institution, and whether one or both         provide webhook-based updates.         **To force a check for updated transactions, you can use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.**         &lt;p&gt;Note also that the &#x60;transactions.updates_available&#x60; webhook will alert you when new data is available.
+    # Provides a paginated feed of transactions, grouped into &#x60;created&#x60;, &#x60;updated&#x60;, and &#x60;removed&#x60; lists.         &lt;p&gt;Each call will also return a &#x60;cursor.next&#x60; value.  In subsequent calls, include that value to receive         only changes that have occurred since the previous call.         &lt;p&gt;**Pending** transactions will only be reported as &#x60;created&#x60;.  Pending transactions are completely         removed and replaced with each transaction refresh or update; no attempt is made to track their removal or         modification.         &lt;p&gt;Large numbers of transactions will be paginated, and the &#x60;has_more&#x60; field will be true.  You should         continue calling this endpoint with each new &#x60;cursor.next&#x60; value until &#x60;has_more&#x60; is false.         &lt;p&gt;**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns         transactions that have already been fetched, either because &#x60;prefetch&#x60; was requested when the link was created,         or because of scheduled or on-demand updates.         &lt;p&gt;MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the         update frequency can vary, depending on the downstream data provider, the institution, and whether one or both         provide webhook-based updates.         **To force a check for updated transactions, you can use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.**         &lt;p&gt;Note also that the &#x60;transactions.updates_available&#x60; webhook will alert you when new data is available.
     # @param id [String] The unique ID for this link.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor A cursor value representing the last update requested. If included, the response will only return         changes after this update. If omitted, a complete history of updates will be returned. This value must be stored         by the client as we do not keep track of app cursors.
     # @option opts [Integer] :size The number of items to return. (default to 50)
     # @return [Array<(TransactionSyncResponse, Integer, Hash)>] TransactionSyncResponse data, response status code and response headers
-    def get_transactions_diff_with_http_info(id, opts = {})
+    def get_transactions_sync_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transactions_diff ...'
+        @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transactions_sync ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.get_transactions_diff"
+        fail ArgumentError, "Missing the required parameter 'id' when calling TransactionsApi.get_transactions_sync"
       end
       if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 500
-        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_transactions_diff, must be smaller than or equal to 500.'
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_transactions_sync, must be smaller than or equal to 500.'
       end
 
       if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
-        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_transactions_diff, must be greater than or equal to 1.'
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_transactions_sync, must be greater than or equal to 1.'
       end
 
       # resource path
@@ -170,7 +170,7 @@ module MoneyKit
       auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']
 
       new_options = opts.merge(
-        :operation => :"TransactionsApi.get_transactions_diff",
+        :operation => :"TransactionsApi.get_transactions_sync",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -181,7 +181,7 @@ module MoneyKit
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: TransactionsApi#get_transactions_diff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: TransactionsApi#get_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/moneykit/models/account_balances.rb

@@ -15,6 +15,7 @@ require 'time'
 
 module MoneyKit
   class AccountBalances
+    # A three-character currency code (ISO-4217 or similar, *e.g.*, `USD`, `CAD`) for the account balances.
     attr_accessor :currency
 
     # The amount of funds available for use.  Not all institutions report the available balance.             <p>Note that the available balance typically does not include overdraft limits.
@@ -29,28 +30,6 @@ module MoneyKit
     # The date that the balance was captured at.  This may not include a time. When this field is null, the balance was captured at an unknown time.
     attr_accessor :balance_date
 
-    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
       {
@@ -70,7 +49,7 @@ module MoneyKit
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'currency' => :'Currency',
+        :'currency' => :'String',
         :'available' => :'Float',
         :'current' => :'Float',
         :'limit' => :'Float',
@@ -101,8 +80,6 @@ module MoneyKit
 
       if attributes.key?(:'currency')
         self.currency = attributes[:'currency']
-      else
-        self.currency = nil
       end
 
       if attributes.key?(:'available')
@@ -127,10 +104,6 @@ module MoneyKit
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @currency.nil?
-        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -138,7 +111,6 @@ module MoneyKit
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @currency.nil?
       true
     end
 

data/lib/moneykit/models/account_group.rb

@@ -36,7 +36,7 @@ module MoneyKit
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'accounts' => :'Array<Account>',
+        :'accounts' => :'Array<AccountResponse>',
         :'last_synced_at' => :'Time'
       }
     end

data/lib/moneykit/models/account_identity.rb

@@ -29,6 +29,9 @@ module MoneyKit
 
     attr_accessor :balances
 
+    # The original ID of this account, if supplied (by you) during an import.
+    attr_accessor :original_id
+
     attr_accessor :owners
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -39,6 +42,7 @@ module MoneyKit
         :'name' => :'name',
         :'account_mask' => :'account_mask',
         :'balances' => :'balances',
+        :'original_id' => :'original_id',
         :'owners' => :'owners'
       }
     end
@@ -56,6 +60,7 @@ module MoneyKit
         :'name' => :'String',
         :'account_mask' => :'String',
         :'balances' => :'AccountBalances',
+        :'original_id' => :'String',
         :'owners' => :'Array<Owner>'
       }
     end
@@ -109,6 +114,10 @@ module MoneyKit
         self.balances = nil
       end
 
+      if attributes.key?(:'original_id')
+        self.original_id = attributes[:'original_id']
+      end
+
       if attributes.key?(:'owners')
         if (value = attributes[:'owners']).is_a?(Array)
           self.owners = value
@@ -168,6 +177,7 @@ module MoneyKit
           name == o.name &&
           account_mask == o.account_mask &&
           balances == o.balances &&
+          original_id == o.original_id &&
           owners == o.owners
     end
 
@@ -180,7 +190,7 @@ module MoneyKit
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, account_type, name, account_mask, balances, owners].hash
+      [account_id, account_type, name, account_mask, balances, original_id, owners].hash
     end
 
     # Builds the object from hash

data/lib/moneykit/models/account_import_data.rb

@@ -0,0 +1,280 @@
+=begin
+#MoneyKit API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 2023-02-18
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.1.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MoneyKit
+  class AccountImportData
+    # Your internal ID for this account.  Must be unique within the imported account batch.
+    attr_accessor :account_id
+
+    # The account name.  This value may change if synced with a data provider later.
+    attr_accessor :name
+
+    # The account type.  It can have any initial value but it will be converted to a MoneyKit         account type (see <a href=/pages/account_types>Account Types</a>) upon output.  The account may change types if it is         synced with a data provider later.
+    attr_accessor :type
+
+    # The last four characters (usually digits) of the account number.  This field can be         omitted, but you are strongly encouraged to supply it because it is the most important factor for properly         connecting new data to this account if it is synced with a data provider later.
+    attr_accessor :mask
+
+    attr_accessor :balances
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'account_id',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'mask' => :'mask',
+        :'balances' => :'balances'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'name' => :'String',
+        :'type' => :'String',
+        :'mask' => :'String',
+        :'balances' => :'AccountBalances'
+      }
+    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 `MoneyKit::AccountImportData` 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 `MoneyKit::AccountImportData`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'mask')
+        self.mask = attributes[:'mask']
+      end
+
+      if attributes.key?(:'balances')
+        self.balances = attributes[:'balances']
+      else
+        self.balances = nil
+      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 @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @balances.nil?
+        invalid_properties.push('invalid value for "balances", balances cannot be nil.')
+      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 @account_id.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      return false if @balances.nil?
+      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 &&
+          account_id == o.account_id &&
+          name == o.name &&
+          type == o.type &&
+          mask == o.mask &&
+          balances == o.balances
+    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
+      [account_id, name, type, mask, balances].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 = MoneyKit.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