increase 0.3.2 → 1.0.0

data/lib/increase/resources/transactions.rb

@@ -1,15 +1,70 @@
 # frozen_string_literal: true
 
-require "increase/resource"
-
 module Increase
-  class Transactions < Resource
-    NAME = "Transactions"
-    API_NAME = "transactions"
+  module Resources
+    class Transactions
+      # Retrieve a Transaction
+      #
+      # @overload retrieve(transaction_id, request_options: {})
+      #
+      # @param transaction_id [String] The identifier of the Transaction to retrieve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Transaction]
+      #
+      # @see Increase::Models::TransactionRetrieveParams
+      def retrieve(transaction_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["transactions/%1$s", transaction_id],
+          model: Increase::Transaction,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::TransactionListParams} for more details.
+      #
+      # List Transactions
+      #
+      # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Transactions for those belonging to the specified Account.
+      #
+      # @param category [Increase::Models::TransactionListParams::Category]
+      #
+      # @param created_at [Increase::Models::TransactionListParams::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 route_id [String] Filter Transactions for those belonging to the specified route. This could be a
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::Transaction>]
+      #
+      # @see Increase::Models::TransactionListParams
+      def list(params = {})
+        parsed, options = Increase::TransactionListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "transactions",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::Transaction,
+          options: options
+        )
+      end
 
-    # List Transactions
-    list
-    # Retrieve a Transaction
-    retrieve
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
   end
 end

data/lib/increase/resources/wire_drawdown_requests.rb

@@ -1,17 +1,115 @@
 # frozen_string_literal: true
 
-require "increase/resource"
-
 module Increase
-  class WireDrawdownRequests < Resource
-    NAME = "Wire Drawdown Requests"
-    API_NAME = "wire_drawdown_requests"
+  module Resources
+    class WireDrawdownRequests
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::WireDrawdownRequestCreateParams} for more details.
+      #
+      # Create a Wire Drawdown Request
+      #
+      # @overload create(account_number_id:, amount:, message_to_recipient:, recipient_account_number:, recipient_name:, recipient_routing_number:, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, recipient_address_line1: nil, recipient_address_line2: nil, recipient_address_line3: nil, request_options: {})
+      #
+      # @param account_number_id [String] The Account Number to which the recipient should send funds.
+      #
+      # @param amount [Integer] The amount requested from the recipient, in USD cents.
+      #
+      # @param message_to_recipient [String] A message the recipient will see as part of the request.
+      #
+      # @param recipient_account_number [String] The drawdown request's recipient's account number.
+      #
+      # @param recipient_name [String] The drawdown request's recipient's name.
+      #
+      # @param recipient_routing_number [String] The drawdown request's recipient's routing number.
+      #
+      # @param originator_address_line1 [String] The drawdown request originator's address line 1. This is only necessary if you'
+      #
+      # @param originator_address_line2 [String] The drawdown request originator's address line 2. This is only necessary if you'
+      #
+      # @param originator_address_line3 [String] The drawdown request originator's address line 3. This is only necessary if you'
+      #
+      # @param originator_name [String] The drawdown request originator's name. This is only necessary if you're request
+      #
+      # @param recipient_address_line1 [String] Line 1 of the drawdown request's recipient's address.
+      #
+      # @param recipient_address_line2 [String] Line 2 of the drawdown request's recipient's address.
+      #
+      # @param recipient_address_line3 [String] Line 3 of the drawdown request's recipient's address.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::WireDrawdownRequest]
+      #
+      # @see Increase::Models::WireDrawdownRequestCreateParams
+      def create(params)
+        parsed, options = Increase::WireDrawdownRequestCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "wire_drawdown_requests",
+          body: parsed,
+          model: Increase::WireDrawdownRequest,
+          options: options
+        )
+      end
+
+      # Retrieve a Wire Drawdown Request
+      #
+      # @overload retrieve(wire_drawdown_request_id, request_options: {})
+      #
+      # @param wire_drawdown_request_id [String] The identifier of the Wire Drawdown Request to retrieve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::WireDrawdownRequest]
+      #
+      # @see Increase::Models::WireDrawdownRequestRetrieveParams
+      def retrieve(wire_drawdown_request_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["wire_drawdown_requests/%1$s", wire_drawdown_request_id],
+          model: Increase::WireDrawdownRequest,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::WireDrawdownRequestListParams} for more details.
+      #
+      # List Wire Drawdown Requests
+      #
+      # @overload list(cursor: nil, idempotency_key: nil, limit: 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 status [Increase::Models::WireDrawdownRequestListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::WireDrawdownRequest>]
+      #
+      # @see Increase::Models::WireDrawdownRequestListParams
+      def list(params = {})
+        parsed, options = Increase::WireDrawdownRequestListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "wire_drawdown_requests",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::WireDrawdownRequest,
+          options: options
+        )
+      end
 
-    # Create a Wire Drawdown Request
-    create
-    # List Wire Drawdown Requests
-    list
-    # Retrieve a Wire Drawdown Request
-    retrieve
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
   end
 end

data/lib/increase/resources/wire_transfers.rb

@@ -1,21 +1,165 @@
 # frozen_string_literal: true
 
-require "increase/resource"
-
 module Increase
-  class WireTransfers < Resource
-    NAME = "Wire Transfers"
-    API_NAME = "wire_transfers"
+  module Resources
+    class WireTransfers
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::WireTransferCreateParams} for more details.
+      #
+      # Create a Wire Transfer
+      #
+      # @overload create(account_id:, amount:, beneficiary_name:, message_to_recipient:, account_number: nil, beneficiary_address_line1: nil, beneficiary_address_line2: nil, beneficiary_address_line3: nil, external_account_id: nil, originator_address_line1: nil, originator_address_line2: nil, originator_address_line3: nil, originator_name: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
+      #
+      # @param account_id [String] The identifier for the account that will send the transfer.
+      #
+      # @param amount [Integer] The transfer amount in USD cents.
+      #
+      # @param beneficiary_name [String] The beneficiary's name.
+      #
+      # @param message_to_recipient [String] The message that will show on the recipient's bank statement.
+      #
+      # @param account_number [String] The account number for the destination account.
+      #
+      # @param beneficiary_address_line1 [String] The beneficiary's address line 1.
+      #
+      # @param beneficiary_address_line2 [String] The beneficiary's address line 2.
+      #
+      # @param beneficiary_address_line3 [String] The beneficiary's address line 3.
+      #
+      # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      #
+      # @param originator_address_line1 [String] The originator's address line 1. This is only necessary if you're transferring f
+      #
+      # @param originator_address_line2 [String] The originator's address line 2. This is only necessary if you're transferring f
+      #
+      # @param originator_address_line3 [String] The originator's address line 3. This is only necessary if you're transferring f
+      #
+      # @param originator_name [String] The originator's name. This is only necessary if you're transferring from a comm
+      #
+      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      #
+      # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
+      #
+      # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::WireTransfer]
+      #
+      # @see Increase::Models::WireTransferCreateParams
+      def create(params)
+        parsed, options = Increase::WireTransferCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "wire_transfers",
+          body: parsed,
+          model: Increase::WireTransfer,
+          options: options
+        )
+      end
+
+      # Retrieve a Wire Transfer
+      #
+      # @overload retrieve(wire_transfer_id, request_options: {})
+      #
+      # @param wire_transfer_id [String] The identifier of the Wire Transfer.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::WireTransfer]
+      #
+      # @see Increase::Models::WireTransferRetrieveParams
+      def retrieve(wire_transfer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["wire_transfers/%1$s", wire_transfer_id],
+          model: Increase::WireTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::WireTransferListParams} for more details.
+      #
+      # List Wire Transfers
+      #
+      # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Wire Transfers to those belonging to the specified Account.
+      #
+      # @param created_at [Increase::Models::WireTransferListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account.
+      #
+      # @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 request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::WireTransfer>]
+      #
+      # @see Increase::Models::WireTransferListParams
+      def list(params = {})
+        parsed, options = Increase::WireTransferListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "wire_transfers",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::WireTransfer,
+          options: options
+        )
+      end
+
+      # Approve a Wire Transfer
+      #
+      # @overload approve(wire_transfer_id, request_options: {})
+      #
+      # @param wire_transfer_id [String] The identifier of the Wire Transfer to approve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::WireTransfer]
+      #
+      # @see Increase::Models::WireTransferApproveParams
+      def approve(wire_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["wire_transfers/%1$s/approve", wire_transfer_id],
+          model: Increase::WireTransfer,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancel a pending Wire Transfer
+      #
+      # @overload cancel(wire_transfer_id, request_options: {})
+      #
+      # @param wire_transfer_id [String] The identifier of the pending Wire Transfer to cancel.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::WireTransfer]
+      #
+      # @see Increase::Models::WireTransferCancelParams
+      def cancel(wire_transfer_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["wire_transfers/%1$s/cancel", wire_transfer_id],
+          model: Increase::WireTransfer,
+          options: params[:request_options]
+        )
+      end
 
-    # Create a Wire Transfer
-    create
-    # List Wire Transfers
-    list
-    # Retrieve a Wire Transfer
-    retrieve
-    # Approve a Wire Transfer
-    endpoint :approve, :post, path: [:wire_transfer_id, "approve"]
-    # Cancel a pending Wire Transfer
-    endpoint :cancel, :post, path: [:wire_transfer_id, "cancel"]
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
   end
 end

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "0.3.2"
+  VERSION = "1.0.0"
 end