unit_ruby_sdk 0.1.3 → 0.1.5

data/lib/unit/models/card/card.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Unit
+  module Card
+    CARD_LIST_LIMIT = 100
+    CARD_LIST_OFFSET = 0
+    autoload :CreateIndividualDebitCardRequest, "unit/models/card/create_individual_debit_card_request"
+    autoload :CreateBusinessDebitCardRequest, "unit/models/card/create_business_debit_card_request"
+    autoload :CreateBusinessVirtualDebitCardRequest, "unit/models/card/create_business_virtual_debit_card_request"
+    autoload :CreateIndividualVirtualCardRequest, "unit/models/card/create_individual_virtual_card_request"
+    autoload :ReplaceCardRequest, "unit/models/card/replace_card_request"
+    autoload :ListCardParams, "unit/models/card/list_card_params"
+
+    class << self
+      # Create a new individual debit card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-individual-debit-card
+      # @param account_id [String]
+      # @param shipping_address [Address] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [String] - optional
+      def create_individual_debit_card(account_id:, customer_id: nil, shipping_address: nil, design: nil, additional_embossed_text: nil,
+                                       idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil)
+        request = CreateIndividualDebitCardRequest.new(account_id, customer_id, shipping_address, design, additional_embossed_text,
+                                                       idempotency_key, tags, limits, print_only_business_name)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Create a new business debit card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-business-debit-card
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param shipping_address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [Boolean] - optional
+      def create_business_debit_card(account_id:, full_name:, date_of_birth:, address:, phone:, email:, shipping_address: nil,
+                                     design: nil, additional_embossed_text: nil, idempotency_key: nil, tags: nil, limits: nil, print_only_business_name: nil)
+        request = CreateBusinessDebitCardRequest.new(account_id, full_name, date_of_birth, address, shipping_address, phone, email, design, additional_embossed_text,
+                                                     idempotency_key, tags, limits, print_only_business_name)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Create a new individual virtual card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-individual-virtual-debit-card
+      # @param account_id [String]
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def create_individual_virtual_card(account_id:, customer_id: nil, idempotency_key: nil, tags: nil, limits: nil)
+        request = CreateIndividualVirtualCardRequest.new(account_id, customer_id, idempotency_key, tags, limits)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Create a new business virtual card by calling Unit's API
+      # @see https://docs.unit.co/cards#create-business-virtual-debit-card
+      # @param account_id [String]
+      # @param type [String]
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def create_business_virtual_card(account_id:, full_name:, date_of_birth:, address:, phone: nil, email: nil, idempotency_key: nil, tags: nil, limits: nil)
+        request = CreateBusinessVirtualDebitCardRequest.new(account_id, full_name, date_of_birth, address, phone, email, idempotency_key, tags, limits)
+        Unit::Resource::CardResource.create_card(request)
+      end
+
+      # Get pin status by calling Unit's API
+      # @see https://docs.unit.co/cards#get-pin-status
+      # @param card_id [String]
+      def get_pin_status(card_id:)
+        Unit::Resource::CardResource.get_pin_status(card_id)
+      end
+
+      # Report a card as a stolen by calling Unit's API
+      # @param card_id [String]
+      def report_stolen(card_id:)
+        Unit::Resource::CardResource.report_stolen(card_id)
+      end
+
+      # Report a card as a lost by calling Unit's API
+      # @param card_id [String]
+      def report_lost(card_id:)
+        Unit::Resource::CardResource.report_lost(card_id)
+      end
+
+      # Close a card by calling Unit's API
+      # @param card_id [String]
+      def close_card(card_id:)
+        Unit::Resource::CardResource.close_card(card_id)
+      end
+
+      # Freeze a card by calling Unit's API
+      # @param card_id [String]
+      def freeze_card(card_id:)
+        Unit::Resource::CardResource.freeze_card(card_id)
+      end
+
+      # Unfreeze a card by calling Unit's API
+      # @param card_id [String]
+      def unfreeze_card(card_id:)
+        Unit::Resource::CardResource.unfreeze_card(card_id)
+      end
+
+      # Replace a card by calling Unit's API
+      # @param card_id [String]
+      # @param shipping_address [Address] - optional
+      def replace_card(card_id:, shipping_address: nil)
+        request = ReplaceCardRequest.new(card_id, shipping_address)
+        Unit::Resource::CardResource.replace_card(request)
+      end
+
+      # Get a card by id by calling Unit's API
+      # @param card_id [String]
+      def get_card(card_id:)
+        Unit::Resource::CardResource.get_card(card_id)
+      end
+
+      # List cards by calling Unit's API
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [Hash] - optional
+      # @param status [Array<String>] - optional
+      # @param include [Array] - optional
+      # @param sort [String] - optional
+      def list_cards(limit: CARD_LIST_LIMIT, offset: CARD_LIST_OFFSET, account_id: nil,
+                     customer_id: nil, tags: nil, status: nil, include: nil, sort: nil)
+        request = ListCardParams.new(limit, offset, account_id, customer_id, tags, status, include, sort)
+        Unit::Resource::CardResource.list_cards(request)
+      end
+
+      # Get a card limits by calling Unit's API
+      # @param card_id [String]
+      def limits(card_id:)
+        Unit::Resource::CardResource.limits(card_id)
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_business_debit_card_request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Request to create business debit card request
+# @see https://docs.unit.co/cards#create-business-debit-card
+module Unit
+  module Card
+    class CreateBusinessDebitCardRequest
+      attr_reader :account_id, :full_name, :date_of_birth, :address, :shipping_address, :phone, :email, :design, :additional_embossed_text, :idempotency_key, :tags, :limits, :print_only_business_name
+
+      # @param account_id [String]
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param shipping_address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [Boolean] - optional
+      def initialize(account_id, full_name, date_of_birth, address, shipping_address = nil, phone = nil, email = nil, design = nil,
+                     additional_embossed_text = nil, idempotency_key = nil, tags = nil, limits = nil, print_only_business_name = nil)
+        @account_id = account_id
+        @full_name = full_name
+        @date_of_birth = date_of_birth
+        @address = address
+        @shipping_address = shipping_address
+        @phone = phone
+        @email = email
+        @design = design
+        @additional_embossed_text = additional_embossed_text
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+        @print_only_business_name = print_only_business_name
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "businessDebitCard",
+            "attributes": {
+              "fullName": full_name&.represent,
+              "dateOfBirth": date_of_birth,
+              "address": address&.represent,
+              "shippingAddress": shipping_address,
+              "phone": phone&.represent,
+              "email": email,
+              "design": design,
+              "additionalEmbossedText": additional_embossed_text,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits,
+              "printOnlyBusinessName": print_only_business_name
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("account", account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_business_virtual_debit_card_request.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Request to create a business virtual debit card
+# @see https://docs.unit.co/cards#create-business-virtual-debit-card
+module Unit
+  module Card
+    class CreateBusinessVirtualDebitCardRequest
+      attr_reader :account_id, :full_name, :date_of_birth, :address, :phone, :email, :idempotency_key, :tags, :limits
+
+      # @param account_id [String]
+      # @param full_name [FullName]
+      # @param date_of_birth [Date]
+      # @param address [Address]
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(account_id, full_name, date_of_birth, address, phone, email,
+                     idempotency_key, tags, limits)
+        @account_id = account_id
+        @full_name = full_name
+        @date_of_birth = date_of_birth
+        @address = address
+        @phone = phone
+        @email = email
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "businessVirtualDebitCard",
+            "attributes": {
+              "fullName": full_name&.represent,
+              "dateOfBirth": date_of_birth,
+              "address": address&.represent,
+              "phone": phone&.represent,
+              "email": email,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_individual_debit_card_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Request to create individual debit card request
+# @see https://docs.unit.co/cards#create-individual-debit-card
+module Unit
+  module Card
+    class CreateIndividualDebitCardRequest
+      attr_reader :account_id, :customer_id, :shipping_address, :design, :additional_embossed_text, :idempotency_key, :tags, :limits, :print_only_business_name
+
+      # @param account_id [String]
+      # @param customer_id [String] - optional
+      # @param shipping_address [Address] - optional
+      # @param design [String] - optional
+      # @param additional_embossed_text [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      # @param print_only_business_name [Boolean] - optional
+      def initialize(account_id, customer_id = nil, shipping_address = nil, design = nil, additional_embossed_text = nil,
+                     idempotency_key = nil, tags = nil, limits = nil, print_only_business_name = nil)
+        @account_id = account_id
+        @customer_id = customer_id
+        @shipping_address = shipping_address
+        @design = design
+        @additional_embossed_text = additional_embossed_text
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+        @print_only_business_name = print_only_business_name
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "individualDebitCard",
+            "attributes": {
+              "shippingAddress": shipping_address&.represent,
+              "design": design,
+              "additionalEmbossedText": additional_embossed_text,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits,
+              "printOnlyBusinessName": print_only_business_name
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        customer = { "customer": Unit::Types::Relationship.new("customer", customer_id).to_hash } unless customer_id.nil?
+        payload[:data][:relationships].merge!(customer) unless customer.nil?
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/create_individual_virtual_card_request.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Request to create individual virtual card
+# @see https://docs.unit.co/cards#create-individual-virtual-debit-card
+module Unit
+  module Card
+    class CreateIndividualVirtualCardRequest
+      attr_reader :account_id, :customer_id, :idempotency_key, :tags, :limits
+
+      # @param account_id [String]
+      # @param customer_id [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(account_id, customer_id = nil, idempotency_key = nil, tags = nil, limits = nil)
+        @account_id = account_id
+        @customer_id = customer_id
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @limits = limits
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "individualVirtualDebitCard",
+            "attributes": {
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "limits": limits
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
+            }
+          }
+        }
+        customer = { "customer": Unit::Types::Relationship.new("customer", customer_id).to_hash } unless customer_id.nil?
+        payload[:data][:relationships].merge!(customer) unless customer.nil?
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/card/list_card_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Request to list cards
+# @see https://docs.unit.co/cards#list-cards
+module Unit
+  module Card
+    class ListCardParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :tags, :status, :include, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param tags [String] - optional
+      # @param status [Array<String>] - optional
+      # @param include [Array] - optional
+      # @param sort [String] - optional
+      def initialize(limit = CARD_LIST_LIMIT, offset = CARD_LIST_OFFSET, account_id = nil,
+                     customer_id = nil, tags = nil, status = nil, include = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @tags = tags
+        @status = status
+        @include = include
+        @sort = sort
+      end
+
+      def to_hash
+        params = { "page[limit]": limit,
+                   "page[offset]": offset,
+                   "filter[accountId]": account_id,
+                   "filter[customerId]": customer_id,
+                   "filter[tags]": tags,
+                   "include": include&.join(","),
+                   "sort": sort }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/card/replace_card_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to replace a card
+# @see https://docs.unit.co/cards#replace-card
+module Unit
+  module Card
+    class ReplaceCardRequest
+      attr_reader :card_id, :shipping_address
+
+      # @param card_id [String]
+      # @param shipping_address [Address] - optional
+      def initialize(card_id, shipping_address = nil)
+        @card_id = card_id
+        @shipping_address = shipping_address
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "replaceCard",
+            "attributes": {
+              "shippingAddress": shipping_address&.represent
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/customer/list_customer_params.rb

@@ -33,7 +33,7 @@ module Unit
                    "filter[tags]": tags,
                    "filter[status]": status,
                    "sort": sort }
-        params.compact!
+        params.compact
       end
     end
   end

data/lib/unit/models/payment/create_book_payment_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Request to create a book payment
+# @see https://docs.unit.co/book-payments#book-payments
+module Unit
+  module Payment
+    class CreateBookPaymentRequest
+      attr_reader :amount, :description, :account_id, :counterparty_account_id, :transaction_summary_override, :idempotency_key, :tags, :relationships
+
+      # @param amount [Integer]
+      # @param description [String]
+      # @param account_id [String]
+      # @param counterparty_account_id [String]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def initialize(amount, description, account_id, counterparty_account_id, relationships, transaction_summary_override = nil,
+                     idempotency_key = nil, tags = nil)
+        @amount = amount
+        @description = description
+        @account_id = account_id
+        @counterparty_account_id = counterparty_account_id
+        @relationships = relationships
+        @transaction_summary_override = transaction_summary_override
+        @idempotency_key = idempotency_key
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "bookPayment",
+            attributes: {
+              amount: amount,
+              description: description,
+              transactionSummaryOverride: transaction_summary_override,
+              idempotencyKey: idempotency_key,
+              tags: tags
+            },
+            relationships: { account: Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+                             counterpartyAccount: Unit::Types::Relationship.new("depositAccount", counterparty_account_id).to_hash }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/payment/patch_book_payment_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Request to update a book payment
+# @see https://docs.unit.co/book-payments#update-book-payment
+module Unit
+  module Payment
+    class PatchBookPaymentRequest
+      attr_reader :payment_id, :tags
+
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      def initialize(payment_id, tags = nil)
+        @payment_id = payment_id
+        @tags = tags
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "bookPayment",
+            attributes: {
+              tags: tags
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/payment/payment.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Unit
+  module Payment
+    autoload :CreateBookPaymentRequest, "unit/models/payment/create_book_payment_request"
+    autoload :PatchBookPaymentRequest, "unit/models/payment/patch_book_payment_request"
+
+    class << self
+      # Create a new book payment by calling Unit's API
+      # @see https://docs.unit.co/book-payments#book-payments
+      # @param amount [Integer]
+      # @param description [String]
+      # @param account_id [String]
+      # @param counterparty_account_id [String]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @return [UnitResponse, UnitError]
+      def create_book_payment(amount:, description:, account_id:, counterparty_account_id:, transaction_summary_override: nil,
+                              idempotency_key: nil, tags: nil)
+        request = Unit::Payment::CreateBookPaymentRequest.new(amount, description, account_id, counterparty_account_id, transaction_summary_override,
+                                                              idempotency_key, tags)
+        Unit::Resource::PaymentResource.create_payment(request)
+      end
+
+      # Update a book payment by calling Unit's API
+      # @see https://docs.unit.co/book-payments#update-book-payment
+      # @param payment_id [String]
+      # @param tags [Hash] - optional
+      # @return [UnitResponse, UnitError]
+      def update_book_payment(payment_id:, tags: nil)
+        request = Unit::Payment::PatchBookPaymentRequest.new(payment_id, tags)
+        Unit::Resource::PaymentResource.update_payment(request)
+      end
+    end
+  end
+end

data/lib/unit/models/statement/get_bank_verification_pdf.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Request to get bank verification pdf
+# @see https://docs.unit.co/statements#get-bank-verification-pdf
+module Unit
+  module Statement
+    class GetBankVerificationPdf
+      attr_accessor :account_id, :include_proof_of_funds
+
+      # @param account_id [String]
+      # @param include_proof_of_funds [Boolean]
+      def initialize(account_id, include_proof_of_funds: false)
+        @account_id = account_id
+        @include_proof_of_funds = include_proof_of_funds
+      end
+
+      def to_hash
+        params = { "includeProofOfFunds": include_proof_of_funds }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/statement/get_html_by_id_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Request to get html by id
+# @see https://docs.unit.co/statements#get-statement-html
+module Unit
+  module Statement
+    class GetHtmlByIdRequest
+      attr_accessor :statement_id, :customer_id, :language
+
+      # @param statement_id [String]
+      # @param customer_id [String]
+      # @param language [String]
+      def initialize(statement_id, customer_id, language = nil)
+        @statement_id = statement_id
+        @customer_id = customer_id
+        @language = language
+      end
+
+      def to_hash
+        params = { "filter[customerId]": customer_id,
+                   "language": language }
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/statement/get_pdf_by_id_request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Request to get pdf by id
+# @see https://docs.unit.co/statements#get-statement-pdf
+module Unit
+  module Statement
+    class GetPdfByIdRequest
+      attr_accessor :statement_id, :customer_id, :language
+
+      # @param statement_id [String]
+      # @param customer_id [String]
+      # @param language [String]
+      def initialize(statement_id, customer_id, language = nil)
+        @statement_id = statement_id
+        @customer_id = customer_id
+        @language = language
+      end
+
+      def to_hash
+        params = { "filter[customerId]": customer_id,
+                   "language": language }
+        params.compact
+      end
+    end
+  end
+end