checkbook 1.0.1

data/spec/api/payment_spec.rb

@@ -0,0 +1,249 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::Payment
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Payment' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::Payment.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Payment' do
+    it 'should create an instance of Payment' do
+      expect(@api_instance).to be_instance_of(Checkbook::Payment)
+    end
+  end
+
+  # unit tests for delete_check
+  # Void a payment
+  # Void the specified payment
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_check 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 get_check
+  # Get payment
+  # Get the specified payment
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckResponse]
+  describe 'get_check 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 get_check_attachment
+  # Get attachment for a payment
+  # Get the attachment for a payment
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_check_attachment 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 get_check_deposit
+  # Get deposit details
+  # Get details on a deposited payment
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckDepositedResponse]
+  describe 'get_check_deposit 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 get_check_fail
+  # Get details on failed payment
+  # Get details on a failed payment
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckFailedResponse]
+  describe 'get_check_fail 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 get_check_tracking
+  # Get tracking details on mailed check
+  # Get tracking details on a mailed check
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckTrackingResponseExpress]
+  describe 'get_check_tracking 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 get_check_verification
+  # Get verification code
+  # Get the verification code
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [VerifyCheckResponse]
+  describe 'get_check_verification 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 get_checks
+  # Get sent/received payments
+  # Return the sent/received payments
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :direction Direction
+  # @option opts [Date] :end_date End date
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Items per page
+  # @option opts [String] :q Query
+  # @option opts [String] :sort Sort
+  # @option opts [Date] :start_date Start date
+  # @option opts [String] :status Status
+  # @return [GetChecksResponse]
+  describe 'get_checks 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 post_check_deposit
+  # Deposit a payment
+  # Deposit a payment
+  # @param check_id 
+  # @param deposit_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckResponse]
+  describe 'post_check_deposit 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 post_check_digital
+  # Create a digital payment
+  # Create a digital payment  > [!NOTE] > **Common Errors** > > - **`Invalid deposit option`:** If deposit options do not include `PRINT`, `MAIL`, or `BANK`, please ensure the payment is funded by a wallet. If you still encounter this error, please contact support@checkbook.io to ensure the specified payment rails are enabled for your account. > - **`Amount is larger than $2000 and requires signature`:** Please add a signature to the sender using [`v3/user/signature`](#tag/user/post/v3/user/signature). A signature is required for users to send out payments over $2000.
+  # @param create_digital_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckResponse]
+  describe 'post_check_digital 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 post_check_endorse
+  # Endorse a multi-party payment
+  # Endorse a multi party payment
+  # @param check_id 
+  # @param endorse_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_check_endorse 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 post_check_multi
+  # Create a multi-party payment
+  # Create a new multi party payment
+  # @param create_multi_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckResponse]
+  describe 'post_check_multi 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 post_check_notify
+  # Resend payment notification
+  # Resend payment notification
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_check_notify 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 post_check_physical
+  # Create a physical check
+  # Create a new paper check
+  # @param create_physical_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckResponse]
+  describe 'post_check_physical 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 post_check_preview
+  # Preview payment
+  # Preview a new payment
+  # @param preview_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PreviewCheckResponse]
+  describe 'post_check_preview 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 post_check_print
+  # Print a payment
+  # Print a check
+  # @param check_id 
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'post_check_print 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 post_check_webhook
+  # Update a sandbox payment status
+  # Update a payment's status in sandbox. Triggers a sandbox check webhook notification.
+  # @param check_id 
+  # @param trigger_webhook_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_check_webhook test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/paypal_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::Paypal
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Paypal' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::Paypal.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Paypal' do
+    it 'should create an instance of Paypal' do
+      expect(@api_instance).to be_instance_of(Checkbook::Paypal)
+    end
+  end
+
+  # unit tests for add_paypal
+  # Create PayPal account
+  # Add a new Paypal account for a user
+  # @param create_paypal_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PaypalAccountResponse]
+  describe 'add_paypal 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 get_paypal
+  # Get PayPal accounts
+  # Return the Paypal accounts of a user
+  # @param [Hash] opts the optional parameters
+  # @return [GetPaypalResponse]
+  describe 'get_paypal 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 put_paypal
+  # Update PayPal account
+  # Update an existing Paypal account
+  # @param paypal_id 
+  # @param update_paypal_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_paypal 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 remove_paypal
+  # Remove PayPal account
+  # Remove an existing PayPal account
+  # @param paypal_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'remove_paypal test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/subscription_spec.rb

@@ -0,0 +1,115 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::Subscription
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Subscription' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::Subscription.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Subscription' do
+    it 'should create an instance of Subscription' do
+      expect(@api_instance).to be_instance_of(Checkbook::Subscription)
+    end
+  end
+
+  # unit tests for delete_subscription
+  # Remove subscription
+  # Remove the specified subscription
+  # @param subscription_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_subscription 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 get_subscription
+  # Get subscription
+  # Get the specified subscription
+  # @param subscription_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetSubscriptionResponse]
+  describe 'get_subscription 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 get_subscriptions
+  # Get subscriptions
+  # Return the subscriptions
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :direction Direction
+  # @option opts [Date] :end_date End date
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Items per page
+  # @option opts [String] :q Query
+  # @option opts [String] :sort Sort
+  # @option opts [Date] :start_date Start date
+  # @option opts [String] :status Status
+  # @return [GetSubscriptionsResponse]
+  describe 'get_subscriptions 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 post_subscription_check
+  # Create payment subscription
+  # Create a new payment subscription
+  # @param create_check_subscription_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubscriptionResponse]
+  describe 'post_subscription_check 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 post_subscription_invoice
+  # Create invoice subscription
+  # Create a new invoice subscription
+  # @param create_invoice_subscription_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubscriptionResponse]
+  describe 'post_subscription_invoice 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 put_subscription
+  # Update subscription
+  # Update the specified subscription
+  # @param subscription_id 
+  # @param update_subscription_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/user_spec.rb

@@ -0,0 +1,156 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::User
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'User' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::User.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of User' do
+    it 'should create an instance of User' do
+      expect(@api_instance).to be_instance_of(Checkbook::User)
+    end
+  end
+
+  # unit tests for delete_api_key
+  # Delete API key for user
+  # Delete API key for user
+  # @param key_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_api_key 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_user
+  # Remove marketplace user
+  # Delete a marketplace user.  > [!NOTE] > **Tip**   > The id that gets passed in needs to be the Checkbook system generated `id`, not the `user_id`.  > Users with active transactions may not be deleted.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_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 get_api_keys
+  # Get API keys for user
+  # Return the API keys for the user
+  # @param [Hash] opts the optional parameters
+  # @return [APIKeyListResponse]
+  describe 'get_api_keys 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 get_user
+  # Get user details
+  # Get user information
+  # @param [Hash] opts the optional parameters
+  # @return [GetUserResponse]
+  describe 'get_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 get_users
+  # Get marketplace users
+  # Return the marketplace users
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Items per page
+  # @option opts [String] :q Query
+  # @option opts [String] :sort Sort
+  # @return [UserQueryResponse]
+  describe 'get_users 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 new_api_key
+  # Generate new API Key for user
+  # Generate new API keys for the user
+  # @param new_api_key_request 
+  # @param [Hash] opts the optional parameters
+  # @return [NewApiKeyResponse]
+  describe 'new_api_key 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 post_user
+  # Create user
+  # Create a new marketplace user.   > [!NOTE] > **Common Errors** > > - **`403: FORBIDDEN`**: Please ensure you are using the Marketplace Owner's keys. If the `403` error persists, it may indicate that marketplace is not enabled for your account or you do not have an active billing bank account onboarded. Contact support@checkbook.io for more details.
+  # @param create_user_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateUserResponse]
+  describe 'post_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 post_user_signature
+  # Add signature for user
+  # Add signature
+  # @param signature_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_user_signature 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 put_user
+  # Update user
+  # Update existing user information.   > [!NOTE] > **Note**   > This endpoint is used for updating a user's KYB/KYC information. Checkbook validates this information asynchronously.
+  # @param update_user_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_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 put_user_webhook
+  # Update a sandbox user status
+  # Update a user's status in the sandbox environment.
+  # @param trigger_user_webhook_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_user_webhook test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end