mx-platform-ruby 0.23.0 → 0.24.0

data/lib/mx-platform-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.0.1
 =end
 
 module MxPlatformRuby
-  VERSION = '0.23.0'
+  VERSION = '0.24.0'
 end

data/lib/mx-platform-ruby.rb

@@ -150,6 +150,7 @@ require 'mx-platform-ruby/models/widget_response_body'
 
 # APIs
 require 'mx-platform-ruby/api/mx_platform_api'
+require 'mx-platform-ruby/api/spending_plan_api'
 
 module MxPlatformRuby
   class << self

data/openapi/config.yml

@@ -6,6 +6,6 @@ gemHomepage: https://github.com/mxenabled/mx-platform-ruby
 gemLicense: MIT
 gemName: mx-platform-ruby
 gemRequiredRubyVersion: ">= 2.6"
-gemVersion: 0.23.0
+gemVersion: 0.24.0
 library: faraday
 moduleName: MxPlatformRuby

data/spec/api/mx_platform_api_spec.rb

@@ -139,32 +139,6 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for create_spending_plan
-  # Create spending plan
-  # This endpoint creates a new `spending_plan` for the user.
-  # @param user_guid The unique id for a `user`.
-  # @param [Hash] opts the optional parameters
-  # @return [SpendingPlanResponse]
-  describe 'create_spending_plan test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for create_spending_plan_iteration_item
-  # Create spending plan iteration item
-  # This endpoint creates a new `spending_plan_iteration_item`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_iteration_item_create_request_body Iteration item to be created with required parameters (planned_amount)
-  # @param [Hash] opts the optional parameters
-  # @return [SpendingPlanIterationItemResponse]
-  describe 'create_spending_plan_iteration_item test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for create_tag
   # Create tag
   # Use this endpoint to create a new custom tag.
@@ -297,47 +271,6 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for delete_spending_plan
-  # Delete spending plan
-  # Use this endpoint to delete a user's `spending_plan`.
-  # @param user_guid The unique ID for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'delete_spending_plan test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for delete_spending_plan_account
-  # Delete spending plan account
-  # Use this endpoint to delete a `spending_plan_account`.
-  # @param user_guid The unique ID for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param spending_plan_account_guid The unique ID for the specified account.
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'delete_spending_plan_account test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for delete_spending_plan_iteration_item
-  # Delete spending plan iteration item
-  # Use this endpoint to delete a spending plan `iteration_item`.
-  # @param user_guid The unique ID for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param iteration_item_guid The unique ID for the `iteration_item`.
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'delete_spending_plan_iteration_item test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for delete_tag
   # Delete tag
   # Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
@@ -805,65 +738,6 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for list_spending_plan_accounts
-  # List spending plan accounts
-  # Use this endpoint to list all the spending plan accounts associated with the spending plan.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanAccountsResponse]
-  describe 'list_spending_plan_accounts test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for list_spending_plan_iteration_items
-  # List spending plan iteration items
-  # Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanIterationItemsResponseBody]
-  describe 'list_spending_plan_iteration_items test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for list_spending_plan_iterations
-  # List spending plan iterations
-  # Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanIterationsResponse]
-  describe 'list_spending_plan_iterations test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for list_spending_plans
-  # List spending plans
-  # Use this endpoint to list all the spending plans associated with the user.
-  # @param user_guid The unique id for a `user`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlansResponseBody]
-  describe 'list_spending_plans test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for list_statements_by_member
   # List statements by member
   # Use this endpoint to get an array of available statements.
@@ -1204,69 +1078,6 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for read_spending_plan_account
-  # Read spending plan account
-  # Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param spending_plan_account_guid The unique ID for the specified account.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanAccountResponse]
-  describe 'read_spending_plan_account test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for read_spending_plan_iteration
-  # Read a spending plan iteration
-  # Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param iteration_number The current iteration number for the spending plan `iteration``.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanIterationResponse]
-  describe 'read_spending_plan_iteration test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for read_spending_plan_iteration_item
-  # Read a spending plan iteration item
-  # Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param iteration_item_guid The unique ID for the `iteration_item`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanIterationItemResponse]
-  describe 'read_spending_plan_iteration_item test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-  # unit tests for read_spending_plan_user
-  # Read a spending plan for a user
-  # Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page Specify current page.
-  # @option opts [Integer] :records_per_page Specify records per page.
-  # @return [SpendingPlanResponse]
-  describe 'read_spending_plan_user test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for read_statement_by_member
   # Read statement by member
   # Use this endpoint to read a JSON representation of the statement.
@@ -1518,21 +1329,6 @@ describe 'MxPlatformApi' do
     end
   end
 
-  # unit tests for update_spending_plan_iteration_item
-  # Update a spending plan iteration item
-  # Use this endpoint to update an existing `spending_plan_iteration_item`.
-  # @param user_guid The unique id for a `user`.
-  # @param spending_plan_guid The unique ID for the `spending_plan`.
-  # @param iteration_item_guid The unique ID for the `iteration_item`.
-  # @param spending_plan_iteration_item_create_request_body Iteration item object to be updated with required parameter (iteration_item_guid)
-  # @param [Hash] opts the optional parameters
-  # @return [SpendingPlanIterationItemResponse]
-  describe 'update_spending_plan_iteration_item test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
   # unit tests for update_tag
   # Update tag
   # Use this endpoint to update the name of a specific tag according to its unique GUID.

data/spec/api/spending_plan_api_spec.rb

@@ -0,0 +1,239 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for MxPlatformRuby::SpendingPlanApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SpendingPlanApi' do
+  before do
+    # run before each test
+    @api_instance = MxPlatformRuby::SpendingPlanApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SpendingPlanApi' do
+    it 'should create an instance of SpendingPlanApi' do
+      expect(@api_instance).to be_instance_of(MxPlatformRuby::SpendingPlanApi)
+    end
+  end
+
+  # unit tests for create_spending_plan
+  # Create spending plan
+  # This endpoint creates a new `spending_plan` for the user.
+  # @param user_guid The unique id for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [SpendingPlanResponse]
+  describe 'create_spending_plan test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_spending_plan_iteration_item
+  # Create spending plan iteration item
+  # This endpoint creates a new `spending_plan_iteration_item`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_iteration_item_create_request_body Iteration item to be created with required parameters (planned_amount)
+  # @param [Hash] opts the optional parameters
+  # @return [SpendingPlanIterationItemResponse]
+  describe 'create_spending_plan_iteration_item test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_spending_plan
+  # Delete spending plan
+  # Use this endpoint to delete a user's `spending_plan`.
+  # @param user_guid The unique ID for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_spending_plan test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_spending_plan_account
+  # Delete spending plan account
+  # Use this endpoint to delete a `spending_plan_account`.
+  # @param user_guid The unique ID for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param spending_plan_account_guid The unique ID for the specified account.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_spending_plan_account test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_spending_plan_iteration_item
+  # Delete spending plan iteration item
+  # Use this endpoint to delete a spending plan `iteration_item`.
+  # @param user_guid The unique ID for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param iteration_item_guid The unique ID for the `iteration_item`.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_spending_plan_iteration_item test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_spending_plan_accounts
+  # List spending plan accounts
+  # Use this endpoint to list all the spending plan accounts associated with the spending plan.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanAccountsResponse]
+  describe 'list_spending_plan_accounts test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_spending_plan_iteration_items
+  # List spending plan iteration items
+  # Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanIterationItemsResponseBody]
+  describe 'list_spending_plan_iteration_items test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_spending_plan_iterations
+  # List spending plan iterations
+  # Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanIterationsResponse]
+  describe 'list_spending_plan_iterations test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_spending_plans
+  # List spending plans
+  # Use this endpoint to list all the spending plans associated with the user.
+  # @param user_guid The unique id for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlansResponseBody]
+  describe 'list_spending_plans test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_spending_plan_account
+  # Read spending plan account
+  # Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param spending_plan_account_guid The unique ID for the specified account.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanAccountResponse]
+  describe 'read_spending_plan_account test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_spending_plan_iteration
+  # Read a spending plan iteration
+  # Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param iteration_number The current iteration number for the spending plan `iteration``.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanIterationResponse]
+  describe 'read_spending_plan_iteration test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_spending_plan_iteration_item
+  # Read a spending plan iteration item
+  # Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param iteration_item_guid The unique ID for the `iteration_item`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanIterationItemResponse]
+  describe 'read_spending_plan_iteration_item test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_spending_plan_user
+  # Read a spending plan for a user
+  # Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [SpendingPlanResponse]
+  describe 'read_spending_plan_user test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_spending_plan_iteration_item
+  # Update a spending plan iteration item
+  # Use this endpoint to update an existing `spending_plan_iteration_item`.
+  # @param user_guid The unique id for a `user`.
+  # @param spending_plan_guid The unique ID for the `spending_plan`.
+  # @param iteration_item_guid The unique ID for the `iteration_item`.
+  # @param spending_plan_iteration_item_create_request_body Iteration item object to be updated with required parameter (iteration_item_guid)
+  # @param [Hash] opts the optional parameters
+  # @return [SpendingPlanIterationItemResponse]
+  describe 'update_spending_plan_iteration_item test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mx-platform-ruby
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - MX
@@ -157,6 +157,7 @@ files:
 - docs/PaymentProcessorAuthorizationCodeResponseBody.md
 - docs/SpendingPlanAccountResponse.md
 - docs/SpendingPlanAccountsResponse.md
+- docs/SpendingPlanApi.md
 - docs/SpendingPlanIterationItemCreateRequestBody.md
 - docs/SpendingPlanIterationItemResponse.md
 - docs/SpendingPlanIterationItemsResponseBody.md
@@ -209,6 +210,7 @@ files:
 - docs/WidgetResponseBody.md
 - lib/mx-platform-ruby.rb
 - lib/mx-platform-ruby/api/mx_platform_api.rb
+- lib/mx-platform-ruby/api/spending_plan_api.rb
 - lib/mx-platform-ruby/api_client.rb
 - lib/mx-platform-ruby/api_error.rb
 - lib/mx-platform-ruby/configuration.rb
@@ -348,6 +350,7 @@ files:
 - openapi/templates/README.mustache
 - openapitools.json
 - spec/api/mx_platform_api_spec.rb
+- spec/api/spending_plan_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/models/account_create_request_body_spec.rb
@@ -505,6 +508,7 @@ signing_key:
 specification_version: 4
 summary: MX Platform API Ruby Gem
 test_files:
+- spec/api/spending_plan_api_spec.rb
 - spec/api/mx_platform_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb