unit_ruby_sdk 1.0.5 → 1.2.0

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

@@ -5,7 +5,8 @@
 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
+      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, :expiry_date, :type
 
       # @param account_id [String]
       # @param full_name [FullName]
@@ -20,8 +21,9 @@ module Unit
       # @param tags [Hash] - optional
       # @param limits [Hash] - optional
       # @param print_only_business_name [Boolean] - optional
+      # @param expiry_date [String] - 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)
+                     additional_embossed_text = nil, idempotency_key = nil, tags = nil, limits = nil, print_only_business_name = nil, expiry_date = nil)
         @account_id = account_id
         @full_name = full_name
         @date_of_birth = date_of_birth
@@ -35,12 +37,14 @@ module Unit
         @tags = tags
         @limits = limits
         @print_only_business_name = print_only_business_name
+        @expiry_date = expiry_date
+        @type = "businessDebitCard"
       end
 
       def to_json_api
         payload = {
           "data": {
-            "type": "businessDebitCard",
+            "type": type,
             "attributes": {
               "fullName": full_name&.represent,
               "dateOfBirth": date_of_birth,
@@ -53,14 +57,14 @@ module Unit
               "idempotencyKey": idempotency_key,
               "tags": tags,
               "limits": limits,
-              "printOnlyBusinessName": print_only_business_name
-            },
+              "printOnlyBusinessName": print_only_business_name,
+              "expiryDate": expiry_date
+            }.compact!,
             "relationships": {
               "account": Unit::Types::Relationship.new("account", account_id).to_hash
             }
           }
         }
-        payload[:data][:attributes].compact!
         payload.to_json
       end
     end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Request to create business virtual credit card request
+# @see https://guides.unit.co/business-charge-cards/
+module Unit
+  module Card
+    # @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
+    # @param expiry_date [String] - optional
+    class CreateBusinessVirtualCreditCardRequest < CreateBusinessVirtualDebitCardRequest
+      def initialize(account_id, full_name, date_of_birth, address, phone = nil, email = nil,
+                     idempotency_key = nil, tags = nil, limits = nil, expiry_date = nil)
+        super
+        @type = "businessVirtualCreditCard"
+      end
+    end
+  end
+end

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

@@ -5,7 +5,8 @@
 module Unit
   module Card
     class CreateBusinessVirtualDebitCardRequest
-      attr_reader :account_id, :full_name, :date_of_birth, :address, :phone, :email, :idempotency_key, :tags, :limits
+      attr_reader :account_id, :full_name, :date_of_birth, :address, :phone, :email,
+                  :idempotency_key, :tags, :limits, :expiry_date, :type
 
       # @param account_id [String]
       # @param full_name [FullName]
@@ -16,8 +17,9 @@ module Unit
       # @param idempotency_key [String] - optional
       # @param tags [Hash] - optional
       # @param limits [Hash] - optional
+      # @param expiry_date [String] - optional
       def initialize(account_id, full_name, date_of_birth, address, phone, email,
-                     idempotency_key, tags, limits)
+                     idempotency_key = nil, tags = nil, limits = nil, expiry_date = nil)
         @account_id = account_id
         @full_name = full_name
         @date_of_birth = date_of_birth
@@ -27,12 +29,14 @@ module Unit
         @idempotency_key = idempotency_key
         @tags = tags
         @limits = limits
+        @expiry_date = expiry_date
+        @type = "businessVirtualDebitCard"
       end
 
       def to_json_api
         payload = {
           "data": {
-            "type": "businessVirtualDebitCard",
+            "type": type,
             "attributes": {
               "fullName": full_name&.represent,
               "dateOfBirth": date_of_birth,
@@ -41,14 +45,14 @@ module Unit
               "email": email,
               "idempotencyKey": idempotency_key,
               "tags": tags,
-              "limits": limits
-            },
+              "limits": limits,
+              "expiryDate": expiry_date
+            }.compact!,
             "relationships": {
               "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash
             }
           }
         }
-        payload[:data][:attributes].compact!
         payload.to_json
       end
     end

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

@@ -5,7 +5,8 @@
 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
+      attr_reader :account_id, :customer_id, :shipping_address, :design, :additional_embossed_text, :idempotency_key,
+                  :tags, :limits, :print_only_business_name, :expiry_date
 
       # @param account_id [String]
       # @param customer_id [String] - optional
@@ -16,8 +17,9 @@ module Unit
       # @param tags [Hash] - optional
       # @param limits [Hash] - optional
       # @param print_only_business_name [Boolean] - optional
+      # @param expiry_date [String] - 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)
+                     idempotency_key = nil, tags = nil, limits = nil, print_only_business_name = nil, expiry_date = nil)
         @account_id = account_id
         @customer_id = customer_id
         @shipping_address = shipping_address
@@ -27,6 +29,7 @@ module Unit
         @tags = tags
         @limits = limits
         @print_only_business_name = print_only_business_name
+        @expiry_date = expiry_date
       end
 
       def to_json_api
@@ -40,7 +43,8 @@ module Unit
               "idempotencyKey": idempotency_key,
               "tags": tags,
               "limits": limits,
-              "printOnlyBusinessName": print_only_business_name
+              "printOnlyBusinessName": print_only_business_name,
+              "expiryDate": expiry_date
             },
             "relationships": {
               "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash

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

@@ -5,19 +5,21 @@
 module Unit
   module Card
     class CreateIndividualVirtualCardRequest
-      attr_reader :account_id, :customer_id, :idempotency_key, :tags, :limits
+      attr_reader :account_id, :customer_id, :idempotency_key, :tags, :limits, :expiry_date
 
       # @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)
+      # @param expiry_date [String] - optional
+      def initialize(account_id, customer_id = nil, idempotency_key = nil, tags = nil, limits = nil, expiry_date = nil)
         @account_id = account_id
         @customer_id = customer_id
         @idempotency_key = idempotency_key
         @tags = tags
         @limits = limits
+        @expiry_date = expiry_date
       end
 
       def to_json_api
@@ -27,7 +29,8 @@ module Unit
             "attributes": {
               "idempotencyKey": idempotency_key,
               "tags": tags,
-              "limits": limits
+              "limits": limits,
+              "expiryDate": expiry_date
             },
             "relationships": {
               "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Request to create business card request
+# @see https://docs.unit.co/cards/#update-business-debit-card
+module Unit
+  module Card
+    class PatchBusinessCardRequest
+      attr_reader :card_id, :shipping_address, :address, :phone, :email, :design, :tags, :limits, :type
+
+      # @param card_id [String]
+      # @param shipping_address [Address] - optional
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param design [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(card_id, shipping_address = nil, address = nil, phone = nil, email = nil, design = nil, tags = nil, limits = nil)
+        @card_id = card_id
+        @shipping_address = shipping_address
+        @address = address
+        @phone = phone
+        @email = email
+        @design = design
+        @tags = tags
+        @limits = limits
+        @type = "businessDebitCard"
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": type,
+            "attributes": {
+              "shippingAddress": shipping_address,
+              "address": address,
+              "phone": phone,
+              "email": email,
+              "design": design,
+              "tags": tags,
+              "limits": limits
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Request to create business credit card request
+# @see https://guides.unit.co/business-charge-cards/
+module Unit
+  module Card
+    class PatchBusinessCreditCardRequest < PatchBusinessCardRequest
+      # @param card_id [String]
+      # @param shipping_address [Address] - optional
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param design [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(card_id, shipping_address = nil, address = nil, phone = nil, email = nil, design = nil, tags = nil, limits = nil)
+        super
+        @type = "businessCreditCard"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Request to update a business virtual debit card
+# @see https://docs.unit.co/cards/#update-business-virtual-debit-card
+module Unit
+  module Card
+    class PatchBusinessVirtualCardRequest
+      attr_reader :card_id, :address, :phone, :email, :tags, :limits, :type
+
+      # @param card_id [String]
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(card_id, address = nil, phone = nil, email = nil, tags = nil, limits = nil)
+        @card_id = card_id
+        @address = address
+        @phone = phone
+        @email = email
+        @tags = tags
+        @limits = limits
+        @type = "businessVirtualDebitCard"
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": type,
+            "attributes": {
+              "address": address,
+              "phone": phone,
+              "email": email,
+              "tags": tags,
+              "limits": limits
+            }.compact
+          }
+        }
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Request to update a business virtual credit card
+# @see https://guides.unit.co/business-charge-cards/
+module Unit
+  module Card
+    class PatchBusinessVirtualCreditCardRequest < PatchBusinessVirtualCardRequest
+      # @param card_id [String]
+      # @param address [Address] - optional
+      # @param phone [Phone] - optional
+      # @param email [String] - optional
+      # @param tags [Hash] - optional
+      # @param limits [Hash] - optional
+      def initialize(card_id, address = nil, phone = nil, email = nil, tags = nil, limits = nil)
+        super
+        @type = "businessVirtualCreditCard"
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module Unit
       # @param query [String] - optional
       # @param email [String] - optional
       # @param tags [Hash] - optional
-      # @param status [String] - optional
+      # @param status [Array<String>] - optional
       # @param sort [String] - optional
       def initialize(limit = CUSTOMER_LIST_LIMIT, offset = CUSTOMER_LIST_OFFSET, query = nil, email = nil, tags = nil, status = nil,
                      sort = nil)
@@ -31,8 +31,10 @@ module Unit
                    "filter[query]": query,
                    "filter[email]": email,
                    "filter[tags]": tags,
-                   "filter[status]": status,
                    "sort": sort }
+        status&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[status][#{index}]": val })
+        end
         params.compact
       end
     end

data/lib/unit/models/event/event.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Unit
+  module Event
+    EVENT_LIST_LIMIT = 100
+    EVENT_LIST_OFFSET = 0
+
+    autoload :ListEventParams, "unit/models/event/list_event_params"
+    class << self
+      # Get event by id
+      # @see https://docs.unit.co/events#get-event
+      # @param event_id [String]
+      def get_event(event_id:)
+        Unit::Resource::EventResource.get(event_id)
+      end
+
+      # List events
+      # @see https://docs.unit.co/events#list-events
+      # @param limit [Integer]
+      # @param offset [Integer]
+      # @param type [Array<String>] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      def list_events(limit: EVENT_LIST_LIMIT, offset: EVENT_LIST_OFFSET, type: nil, since: nil, _until: nil)
+        params = ListEventParams.new(limit, offset, type, since, _until)
+        Unit::Resource::EventResource.list(params)
+      end
+
+      # Fire event
+      # @see https://docs.unit.co/events#fire-event
+      # @param event_id [String]
+      def fire_event(event_id:)
+        Unit::Resource::EventResource.fire(event_id)
+      end
+    end
+  end
+end

data/lib/unit/models/event/list_event_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# params for listing events
+# https://docs.unit.co/events#list-events
+module Unit
+  module Event
+    class ListEventParams
+      attr_reader :limit, :offset, :type, :since, :_until
+
+      # @param limit [Integer]
+      # @param offset [Integer]
+      # @param type [Array<String>] - optional
+      # @param since [String] - optional
+      # @param _until [String] - optional
+      def initialize(limit = EVENT_LIST_LIMIT, offset = EVENT_LIST_OFFSET, type = nil, since = nil, _until = nil)
+        @limit = limit
+        @offset = offset
+        @type = type
+        @since = since
+        @_until = _until
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[since]": since,
+          "filter[until]": _until
+        }
+        type&.each_with_index&.map do |val, index|
+          params.merge!({ "filter[type][#{index}]": val })
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/fee/create_fee_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Request to create fee
+# @see https://docs.unit.co/fees/#create-fee
+module Unit
+  module Fee
+    class CreateFeeRequest
+      attr_reader :account_id, :amount, :description, :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, amount, description, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @amount = amount
+        @description = description
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "fee",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "tags": tags,
+              "idempotencyKey": idempotency_key
+            },
+            "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/fee/fee.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Unit
+  module Fee
+    autoload :CreateFeeRequest, "unit/models/fee/create_fee_request"
+    autoload :ReverseFeeRequest, "unit/models/fee/reverse_fee_request"
+
+    class << self
+      # Request to create fee
+      # @see https://docs.unit.co/fees/#create-fee
+      # @param account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def create_fee(account_id:, amount:, description:, tags: nil, idempotency_key: nil)
+        request = CreateFeeRequest.new(account_id, amount, description, tags, idempotency_key)
+        Unit::Resource::FeeResource.create_fee(request)
+      end
+
+      # Request to reverse a fee
+      # @see https://docs.unit.co/fees/#reverse-fee
+      # @param account_id [String]
+      # @param transaction_id [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def reverse_fee(account_id:, transaction_id:, description:, tags: nil, idempotency_key: nil)
+        request = ReverseFeeRequest.new(account_id, transaction_id, description, tags, idempotency_key)
+        Unit::Resource::FeeResource.reverse_fee(request)
+      end
+    end
+  end
+end

data/lib/unit/models/fee/reverse_fee_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Request to reverse a fee
+# @see https://docs.unit.co/fees/#reverse-fee
+module Unit
+  module Fee
+    class ReverseFeeRequest
+      attr_reader :account_id, :transaction_id, :description, :tags, :idempotency_key
+
+      # @param account_id [String]
+      # @param transaction_id [Integer]
+      # @param description [String]
+      # @param tags [Hash] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, transaction_id, description, tags = nil, idempotency_key = nil)
+        @account_id = account_id
+        @transaction_id = transaction_id
+        @description = description
+        @tags = tags
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "feeReversal",
+            "attributes": {
+              "description": description,
+              "tags": tags,
+              "idempotencyKey": idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              "transaction": Unit::Types::Relationship.new("transaction", transaction_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# class to create a batch release using
+module Unit
+  module Payment
+    class BatchReleaseRequestBuilder
+      def initialize
+        @requests = []
+      end
+
+      def add_request(account_id, batch_account_id, amount, description, sender_name, sender_address, sender_account_number, tags = nil, idempotency_key = nil)
+        request = Unit::Payment::CreateBatchReleaseRequest.new(account_id, batch_account_id, amount, description, sender_name, sender_address, sender_account_number, tags, idempotency_key)
+        @requests << request.to_hash
+      end
+
+      def to_hash
+        { "data": @requests }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json"
+
+# class for serializing payment requests
+module Unit
+  module Payment
+    class BulkPaymentRequest
+      def self.serialize(requests)
+        payload = requests.map(&:change_attributes)
+        { "data": payload }.to_json
+      end
+    end
+  end
+end

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

@@ -18,8 +18,8 @@ module Unit
       # @param tags [Hash] - optional
       # @param same_day [Boolean] - optional
       # @param sec_code [String] - optional
-      def initialize(account_id, amount, direction, counterparty, description,
-                     addenda = nil, idempotency_key = nil, tags = nil, same_day = nil, sec_code = nil)
+      def initialize(account_id:, amount:, direction:, counterparty:, description:,
+                     addenda: nil, idempotency_key: nil, tags: nil, same_day: nil, sec_code: nil)
         @account_id = account_id
         @amount = amount
         @direction = direction
@@ -34,27 +34,37 @@ module Unit
 
       def to_json_api
         payload = {
-          "data": {
-            "type": "achPayment",
-            "attributes": {
-              amount: amount,
-              direction: direction,
-              counterparty: counterparty.represent,
-              description: description,
-              addenda: addenda,
-              idempotencyKey: idempotency_key,
-              tags: tags,
-              sameDay: same_day,
-              secCode: sec_code
-            },
-            "relationships": {
-              "account": Unit::Types::Relationship.new("account", account_id).to_hash
-            }
-          }
+          "data": to_hash
         }
         payload[:data][:attributes].compact!
         payload.to_json
       end
+
+      def to_hash
+        {
+          "type": "achPayment",
+          "attributes": {
+            amount: amount,
+            direction: direction,
+            counterparty: counterparty.represent,
+            description: description,
+            addenda: addenda,
+            idempotencyKey: idempotency_key,
+            tags: tags,
+            sameDay: same_day,
+            secCode: sec_code
+          },
+          "relationships": {
+            "account": Unit::Types::Relationship.new("account", account_id).to_hash
+          }
+        }
+      end
+
+      def change_attributes
+        payload = to_hash
+        payload[:attributes].compact!
+        payload
+      end
     end
   end
 end