increase 0.3.2 → 1.0.0

data/lib/increase/resources/external_accounts.rb

@@ -1,19 +1,131 @@
 # frozen_string_literal: true
 
-require "increase/resource"
-
 module Increase
-  class ExternalAccounts < Resource
-    NAME = "External Accounts"
-    API_NAME = "external_accounts"
+  module Resources
+    class ExternalAccounts
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::ExternalAccountCreateParams} for more details.
+      #
+      # Create an External Account
+      #
+      # @overload create(account_number:, description:, routing_number:, account_holder: nil, funding: nil, request_options: {})
+      #
+      # @param account_number [String] The account number for the destination account.
+      #
+      # @param description [String] The name you choose for the Account.
+      #
+      # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
+      #
+      # @param account_holder [Symbol, Increase::Models::ExternalAccountCreateParams::AccountHolder] The type of entity that owns the External Account.
+      #
+      # @param funding [Symbol, Increase::Models::ExternalAccountCreateParams::Funding] The type of the destination account. Defaults to `checking`.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::ExternalAccount]
+      #
+      # @see Increase::Models::ExternalAccountCreateParams
+      def create(params)
+        parsed, options = Increase::ExternalAccountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "external_accounts",
+          body: parsed,
+          model: Increase::ExternalAccount,
+          options: options
+        )
+      end
+
+      # Retrieve an External Account
+      #
+      # @overload retrieve(external_account_id, request_options: {})
+      #
+      # @param external_account_id [String] The identifier of the External Account.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::ExternalAccount]
+      #
+      # @see Increase::Models::ExternalAccountRetrieveParams
+      def retrieve(external_account_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["external_accounts/%1$s", external_account_id],
+          model: Increase::ExternalAccount,
+          options: params[:request_options]
+        )
+      end
+
+      # Update an External Account
+      #
+      # @overload update(external_account_id, account_holder: nil, description: nil, funding: nil, status: nil, request_options: {})
+      #
+      # @param external_account_id [String] The external account identifier.
+      #
+      # @param account_holder [Symbol, Increase::Models::ExternalAccountUpdateParams::AccountHolder] The type of entity that owns the External Account.
+      #
+      # @param description [String] The description you choose to give the external account.
+      #
+      # @param funding [Symbol, Increase::Models::ExternalAccountUpdateParams::Funding] The funding type of the External Account.
+      #
+      # @param status [Symbol, Increase::Models::ExternalAccountUpdateParams::Status] The status of the External Account.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::ExternalAccount]
+      #
+      # @see Increase::Models::ExternalAccountUpdateParams
+      def update(external_account_id, params = {})
+        parsed, options = Increase::ExternalAccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["external_accounts/%1$s", external_account_id],
+          body: parsed,
+          model: Increase::ExternalAccount,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::ExternalAccountListParams} for more details.
+      #
+      # List External Accounts
+      #
+      # @overload list(cursor: nil, idempotency_key: nil, limit: nil, routing_number: nil, status: nil, request_options: {})
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param routing_number [String] Filter External Accounts to those with the specified Routing Number.
+      #
+      # @param status [Increase::Models::ExternalAccountListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::ExternalAccount>]
+      #
+      # @see Increase::Models::ExternalAccountListParams
+      def list(params = {})
+        parsed, options = Increase::ExternalAccountListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "external_accounts",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::ExternalAccount,
+          options: options
+        )
+      end
 
-    # Create an External Account
-    create
-    # List External Accounts
-    list
-    # Update an External Account
-    update
-    # Retrieve an External Account
-    retrieve
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
   end
 end

data/lib/increase/resources/file_links.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class FileLinks
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::FileLinkCreateParams} for more details.
+      #
+      # Create a File Link
+      #
+      # @overload create(file_id:, expires_at: nil, request_options: {})
+      #
+      # @param file_id [String] The File to create a File Link for.
+      #
+      # @param expires_at [Time] The time at which the File Link will expire. The default is 1 hour from the time
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::FileLink]
+      #
+      # @see Increase::Models::FileLinkCreateParams
+      def create(params)
+        parsed, options = Increase::FileLinkCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "file_links",
+          body: parsed,
+          model: Increase::FileLink,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/files.rb

@@ -1,17 +1,100 @@
 # frozen_string_literal: true
 
-require "increase/resource"
-
 module Increase
-  class Files < Resource
-    NAME = "Files"
-    API_NAME = "files"
+  module Resources
+    class Files
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::FileCreateParams} for more details.
+      #
+      # To upload a file to Increase, you'll need to send a request of Content-Type
+      # `multipart/form-data`. The request should contain the file you would like to
+      # upload, as well as the parameters for creating a file.
+      #
+      # @overload create(file:, purpose:, description: nil, request_options: {})
+      #
+      # @param file [Pathname, StringIO, IO, String, Increase::FilePart] The file contents. This should follow the specifications of [RFC 7578](https://d
+      #
+      # @param purpose [Symbol, Increase::Models::FileCreateParams::Purpose] What the File will be used for in Increase's systems.
+      #
+      # @param description [String] The description you choose to give the File.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::File]
+      #
+      # @see Increase::Models::FileCreateParams
+      def create(params)
+        parsed, options = Increase::FileCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "files",
+          headers: {"content-type" => "multipart/form-data"},
+          body: parsed,
+          model: Increase::File,
+          options: options
+        )
+      end
+
+      # Retrieve a File
+      #
+      # @overload retrieve(file_id, request_options: {})
+      #
+      # @param file_id [String] The identifier of the File.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::File]
+      #
+      # @see Increase::Models::FileRetrieveParams
+      def retrieve(file_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["files/%1$s", file_id],
+          model: Increase::File,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::FileListParams} for more details.
+      #
+      # List Files
+      #
+      # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, purpose: nil, request_options: {})
+      #
+      # @param created_at [Increase::Models::FileListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param purpose [Increase::Models::FileListParams::Purpose]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::File>]
+      #
+      # @see Increase::Models::FileListParams
+      def list(params = {})
+        parsed, options = Increase::FileListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "files",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::File,
+          options: options
+        )
+      end
 
-    # Create a File
-    endpoint :create, :post, with: :file_upload
-    # List Files
-    list
-    # Retrieve a File
-    retrieve
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
   end
 end

data/lib/increase/resources/groups.rb

@@ -1,13 +1,32 @@
 # frozen_string_literal: true
 
-require "increase/resource"
-
 module Increase
-  class Groups < Resource
-    NAME = "Groups"
-    API_NAME = "groups"
+  module Resources
+    class Groups
+      # Returns details for the currently authenticated Group.
+      #
+      # @overload retrieve(request_options: {})
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Group]
+      #
+      # @see Increase::Models::GroupRetrieveParams
+      def retrieve(params = {})
+        @client.request(
+          method: :get,
+          path: "groups/current",
+          model: Increase::Group,
+          options: params[:request_options]
+        )
+      end
 
-    # Retrieve Group details
-    endpoint :current, :get, path: "current"
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
   end
 end

data/lib/increase/resources/inbound_ach_transfers.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class InboundACHTransfers
+      # Retrieve an Inbound ACH Transfer
+      #
+      # @overload retrieve(inbound_ach_transfer_id, request_options: {})
+      #
+      # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to get details for.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundACHTransfer]
+      #
+      # @see Increase::Models::InboundACHTransferRetrieveParams
+      def retrieve(inbound_ach_transfer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["inbound_ach_transfers/%1$s", inbound_ach_transfer_id],
+          model: Increase::InboundACHTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundACHTransferListParams} for more details.
+      #
+      # List Inbound ACH Transfers
+      #
+      # @overload list(account_id: nil, account_number_id: nil, created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account.
+      #
+      # @param account_number_id [String] Filter Inbound ACH Transfers to ones belonging to the specified Account Number.
+      #
+      # @param created_at [Increase::Models::InboundACHTransferListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::InboundACHTransferListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::InboundACHTransfer>]
+      #
+      # @see Increase::Models::InboundACHTransferListParams
+      def list(params = {})
+        parsed, options = Increase::InboundACHTransferListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inbound_ach_transfers",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::InboundACHTransfer,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundACHTransferCreateNotificationOfChangeParams} for more
+      # details.
+      #
+      # Create a notification of change for an Inbound ACH Transfer
+      #
+      # @overload create_notification_of_change(inbound_ach_transfer_id, updated_account_number: nil, updated_routing_number: nil, request_options: {})
+      #
+      # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer for which to create a notification of
+      #
+      # @param updated_account_number [String] The updated account number to send in the notification of change.
+      #
+      # @param updated_routing_number [String] The updated routing number to send in the notification of change.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundACHTransfer]
+      #
+      # @see Increase::Models::InboundACHTransferCreateNotificationOfChangeParams
+      def create_notification_of_change(inbound_ach_transfer_id, params = {})
+        parsed, options = Increase::InboundACHTransferCreateNotificationOfChangeParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["inbound_ach_transfers/%1$s/create_notification_of_change", inbound_ach_transfer_id],
+          body: parsed,
+          model: Increase::InboundACHTransfer,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundACHTransferDeclineParams} for more details.
+      #
+      # Decline an Inbound ACH Transfer
+      #
+      # @overload decline(inbound_ach_transfer_id, reason: nil, request_options: {})
+      #
+      # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to decline.
+      #
+      # @param reason [Symbol, Increase::Models::InboundACHTransferDeclineParams::Reason] The reason why this transfer will be returned. If this parameter is unset, the r
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundACHTransfer]
+      #
+      # @see Increase::Models::InboundACHTransferDeclineParams
+      def decline(inbound_ach_transfer_id, params = {})
+        parsed, options = Increase::InboundACHTransferDeclineParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["inbound_ach_transfers/%1$s/decline", inbound_ach_transfer_id],
+          body: parsed,
+          model: Increase::InboundACHTransfer,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundACHTransferTransferReturnParams} for more details.
+      #
+      # Return an Inbound ACH Transfer
+      #
+      # @overload transfer_return(inbound_ach_transfer_id, reason:, request_options: {})
+      #
+      # @param inbound_ach_transfer_id [String] The identifier of the Inbound ACH Transfer to return to the originating financia
+      #
+      # @param reason [Symbol, Increase::Models::InboundACHTransferTransferReturnParams::Reason] The reason why this transfer will be returned. The most usual return codes are `
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundACHTransfer]
+      #
+      # @see Increase::Models::InboundACHTransferTransferReturnParams
+      def transfer_return(inbound_ach_transfer_id, params)
+        parsed, options = Increase::InboundACHTransferTransferReturnParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["inbound_ach_transfers/%1$s/transfer_return", inbound_ach_transfer_id],
+          body: parsed,
+          model: Increase::InboundACHTransfer,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/inbound_check_deposits.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class InboundCheckDeposits
+      # Retrieve an Inbound Check Deposit
+      #
+      # @overload retrieve(inbound_check_deposit_id, request_options: {})
+      #
+      # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to get details for.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundCheckDeposit]
+      #
+      # @see Increase::Models::InboundCheckDepositRetrieveParams
+      def retrieve(inbound_check_deposit_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["inbound_check_deposits/%1$s", inbound_check_deposit_id],
+          model: Increase::InboundCheckDeposit,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundCheckDepositListParams} for more details.
+      #
+      # List Inbound Check Deposits
+      #
+      # @overload list(account_id: nil, check_transfer_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Inbound Check Deposits to those belonging to the specified Account.
+      #
+      # @param check_transfer_id [String] Filter Inbound Check Deposits to those belonging to the specified Check Transfer
+      #
+      # @param created_at [Increase::Models::InboundCheckDepositListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::InboundCheckDeposit>]
+      #
+      # @see Increase::Models::InboundCheckDepositListParams
+      def list(params = {})
+        parsed, options = Increase::InboundCheckDepositListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inbound_check_deposits",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::InboundCheckDeposit,
+          options: options
+        )
+      end
+
+      # Decline an Inbound Check Deposit
+      #
+      # @overload decline(inbound_check_deposit_id, request_options: {})
+      #
+      # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to decline.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundCheckDeposit]
+      #
+      # @see Increase::Models::InboundCheckDepositDeclineParams
+      def decline(inbound_check_deposit_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["inbound_check_deposits/%1$s/decline", inbound_check_deposit_id],
+          model: Increase::InboundCheckDeposit,
+          options: params[:request_options]
+        )
+      end
+
+      # Return an Inbound Check Deposit
+      #
+      # @overload return_(inbound_check_deposit_id, reason:, request_options: {})
+      #
+      # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to return.
+      #
+      # @param reason [Symbol, Increase::Models::InboundCheckDepositReturnParams::Reason] The reason to return the Inbound Check Deposit.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundCheckDeposit]
+      #
+      # @see Increase::Models::InboundCheckDepositReturnParams
+      def return_(inbound_check_deposit_id, params)
+        parsed, options = Increase::InboundCheckDepositReturnParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["inbound_check_deposits/%1$s/return", inbound_check_deposit_id],
+          body: parsed,
+          model: Increase::InboundCheckDeposit,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/inbound_mail_items.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class InboundMailItems
+      # Retrieve an Inbound Mail Item
+      #
+      # @overload retrieve(inbound_mail_item_id, request_options: {})
+      #
+      # @param inbound_mail_item_id [String] The identifier of the Inbound Mail Item to retrieve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundMailItem]
+      #
+      # @see Increase::Models::InboundMailItemRetrieveParams
+      def retrieve(inbound_mail_item_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["inbound_mail_items/%1$s", inbound_mail_item_id],
+          model: Increase::InboundMailItem,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::InboundMailItemListParams} for more details.
+      #
+      # List Inbound Mail Items
+      #
+      # @overload list(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {})
+      #
+      # @param created_at [Increase::Models::InboundMailItemListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param lockbox_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::InboundMailItem>]
+      #
+      # @see Increase::Models::InboundMailItemListParams
+      def list(params = {})
+        parsed, options = Increase::InboundMailItemListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "inbound_mail_items",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::InboundMailItem,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end