unit_ruby_sdk 1.0.5 → 1.2.0

data/lib/unit/models/recurring_payment/create_recurring_debit_ach_payment_request.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Create a recurring debit ACH payment request
+# @see https://docs.unit.co/recurring-payments/#recurring-payment-debit-ach-payment
+module Unit
+  module RecurringPayment
+    class CreateRecurringDebitAchPaymentRequest
+      attr_reader :account_id, :counterparty_id, :amount, :description, :addenda, :schedule, :idempotency_key, :tags,
+                  :verify_counterparty_balance, :same_day
+
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      def initialize(account_id, counterparty_id, amount, description, schedule, addenda = nil, idempotency_key = nil, tags = nil,
+                     verify_counterparty_balance = nil, same_day = nil)
+        @account_id = account_id
+        @counterparty_id = counterparty_id
+        @amount = amount
+        @description = description
+        @addenda = addenda
+        @schedule = schedule
+        @idempotency_key = idempotency_key
+        @tags = tags
+        @verify_counterparty_balance = verify_counterparty_balance
+        @same_day = same_day
+      end
+
+      def to_json_api
+        payload = {
+          "data": {
+            "type": "recurringDebitAchPayment",
+            "attributes": {
+              "amount": amount,
+              "description": description,
+              "addenda": addenda,
+              "schedule": schedule&.represent,
+              "idempotencyKey": idempotency_key,
+              "tags": tags,
+              "verifyCounterpartyBalance": verify_counterparty_balance,
+              "sameDay": same_day
+            },
+            "relationships": {
+              account: Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              counterparty: Unit::Types::Relationship.new("counterparty", counterparty_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/list_recurring_payment_params.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Params for listing recurring payments
+# @see https://docs.unit.co/recurring-payments/#list-recurring-payments
+module Unit
+  module RecurringPayment
+    class ListRecurringPaymentParams
+      attr_reader :limit, :offset, :account_id, :customer_id, :status, :type,
+                  :from_start_time, :to_start_time, :from_end_time, :to_end_time, :sort
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array] - optional
+      # @param type [Array] - optional
+      # @param from_start_time [String] - optional
+      # @param to_start_time [String] - optional
+      # @param from_end_time [String] - optional
+      # @param to_end_time [String] - optional
+      # @param sort [String] - optional
+      def initialize(limit = RECURRING_PAYMENT_LIMIT, offset = RECURRING_PAYMENT_OFFSET, account_id = nil, customer_id = nil, status = nil, type = nil,
+                     from_start_time = nil, to_start_time = nil, from_end_time = nil, to_end_time = nil, sort = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @customer_id = customer_id
+        @status = status
+        @type = type
+        @from_start_date = from_start_time
+        @to_start_date = to_start_time
+        @from_end_date = from_end_time
+        @to_end_date = to_end_time
+        @sort = sort
+      end
+
+      def to_hash
+        payload = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[customerId]": customer_id,
+          "filter[fromStartTime]": from_start_time,
+          "filter[toStartTime]": to_start_time,
+          "filter[fromEndTime]": from_end_time,
+          "filter[toEndTime]": to_end_time,
+          "sort": sort
+        }
+        filters = %i[status type]
+        filters.each do |filter|
+          values = send(filter)
+          values&.each_with_index&.map do |val, index|
+            params.merge!({ "filter[#{filter}][#{index}]": val })
+          end
+        end
+        payload.compact!
+      end
+    end
+  end
+end

data/lib/unit/models/recurring_payment/recurring_payment.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Unit
+  module RecurringPayment
+    RECURRING_PAYMENT_LIMIT = 100
+    RECURRING_PAYMENT_OFFSET = 0
+    autoload :CreateRecurringCreditBookPaymentRequest, "unit/models/recurring_payment/create_recurring_credit_book_payment_request"
+    autoload :CreateRecurringCreditAchPaymentRequest, "unit/models/recurring_payment/create_recurring_credit_ach_payment_request"
+    autoload :CreateRecurringDebitAchPaymentRequest, "unit/models/recurring_payment/create_recurring_debit_ach_payment_request"
+    autoload :ListRecurringPaymentParams, "unit/models/recurring_payment/list_recurring_payment_params"
+
+    class << self
+      # Create a recurring credit book payment
+      # @see https://docs.unit.co/recurring-payments/#recurring-credit-book-payment
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param transaction_summary_override [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def create_recurring_credit_book_payment(account_id:, counterparty_id:, amount:, description:,
+                                               schedule:, transaction_summary_override: nil, idempotency_key: nil, tags: nil)
+        request = Unit::RecurringPayment::CreateRecurringCreditBookPaymentRequest.new(account_id, counterparty_id, amount, description, schedule,
+                                                                                      transaction_summary_override, idempotency_key, tags)
+        Unit::Resource::RecurringPaymentResource.create_recurring_payment(request)
+      end
+
+      # Create a recurring credit ACH payment
+      # @see https://docs.unit.co/recurring-payments/#recurring-payment-credit-ach-payment
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      def create_recurring_credit_ach_payment(account_id:, counterparty_id:, amount:, description:, schedule:, addenda: nil, idempotency_key: nil, tags: nil)
+        request = Unit::RecurringPayment::CreateRecurringCreditAchPaymentRequest.new(account_id, counterparty_id, amount, description, schedule, addenda, idempotency_key, tags)
+        Unit::Resource::RecurringPaymentResource.create_recurring_payment(request)
+      end
+
+      # Create a recurring debit ACH payment
+      # @see https://docs.unit.co/recurring-payments/#recurring-payment-debit-ach-payment
+      # @param account_id [String]
+      # @param counterparty_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param schedule [CreateSchedule]
+      # @param addenda [String] - optional
+      # @param idempotency_key [String] - optional
+      # @param tags [Hash] - optional
+      # @param verify_counterparty_balance [Boolean] - optional
+      # @param same_day [Boolean] - optional
+      def create_recurring_debit_ach_payment(account_id:, counterparty_id:, amount:, description:, schedule:, addenda: nil, idempotency_key: nil, tags: nil,
+                                             verify_counterparty_balance: nil, same_day: nil)
+        request = Unit::RecurringPayment::CreateRecurringDebitAchPaymentRequest.new(account_id, counterparty_id, amount, description, schedule, addenda, idempotency_key, tags,
+                                                                                    verify_counterparty_balance, same_day)
+        Unit::Resource::RecurringPaymentResource.create_recurring_payment(request)
+      end
+
+      # Enable a recurring payment
+      # @see https://docs.unit.co/recurring-payments/#enable-recurring-payment
+      # @param recurring_payment_id [String]
+      def enable_recurring_payment(recurring_payment_id:)
+        Unit::Resource::RecurringPaymentResource.enable_recurring_payment(recurring_payment_id)
+      end
+
+      # Disable a recurring payment
+      # @see https://docs.unit.co/recurring-payments/#disable-recurring-payment
+      # @param recurring_payment_id [String]
+      def disable_recurring_payment(recurring_payment_id:)
+        Unit::Resource::RecurringPaymentResource.disable_recurring_payment(recurring_payment_id)
+      end
+
+      # List recurring payments
+      # @see https://docs.unit.co/recurring-payments/#list-recurring-payments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [String] - optional
+      # @param type [String] - optional
+      # @param from_start_time [String] - optional
+      # @param to_start_time [String] - optional
+      # @param from_end_time [String] - optional
+      # @param to_end_time [String] - optional
+      # @param sort [String] - optional
+      def list_recurring_payment(limit: RECURRING_PAYMENT_LIMIT, offset: RECURRING_PAYMENT_OFFSET, account_id: nil, customer_id: nil, status: nil, type: nil,
+                                 from_start_time: nil, to_start_time: nil, from_end_time: nil, to_end_time: nil, sort: nil)
+        request = Unit::RecurringPayment::ListRecurringPaymentParams.new(limit, offset, account_id, customer_id, status, type,
+                                                                         from_start_time, to_start_time, from_end_time, to_end_time, sort)
+        Unit::Resource::RecurringPaymentResource.list_recurring_payment(request)
+      end
+
+      # Get a recurring payment
+      # @see https://docs.unit.co/recurring-payments/#get-specific-recurring-payment
+      # @param recurring_payment_id [String]
+      def get_recurring_payment(recurring_payment_id:)
+        Unit::Resource::RecurringPaymentResource.get_recurring_payment(recurring_payment_id)
+      end
+    end
+  end
+end

data/lib/unit/models/repayment/create_ach_repayment_request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Request to create an ach repayment
+# @see https://docs.unit.co/repayments/#create-ach-repayment
+module Unit
+  module Repayment
+    class CreateAchRepaymentRequest
+      attr_reader :account_id, :credit_account_id, :counterparty_id, :description,
+                  :amount, :addenda, :tags, :same_day, :idempotency_key
+
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param addenda [String] - optional
+      # @param tags [Hash] - optional
+      # @param same_day [Boolean] - optional
+      # @param idempotency_key [String] - optional
+      def initialize(account_id, credit_account_id, counterparty_id, description, amount, addenda = nil, tags = nil,
+                     idempotency_key = nil, same_day: false)
+        @account_id = account_id
+        @credit_account_id = credit_account_id
+        @counterparty_id = counterparty_id
+        @description = description
+        @amount = amount
+        @addenda = addenda
+        @tags = tags
+        @same_day = same_day
+        @idempotency_key = idempotency_key
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "achRepayment",
+            attributes: {
+              description: description,
+              amount: amount,
+              addenda: addenda,
+              tags: tags,
+              sameDay: same_day,
+              idempotencyKey: idempotency_key
+            },
+            "relationships": {
+              "account": Unit::Types::Relationship.new("depositAccount", account_id).to_hash,
+              "creditAccount": Unit::Types::Relationship.new("creditAccount", credit_account_id).to_hash,
+              "counterparty": Unit::Types::Relationship.new("counterparty", counterparty_id).to_hash
+            }
+          }
+        }
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/repayment/create_book_repayment_request.rb

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

data/lib/unit/models/repayment/list_repayment_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Params for listing repayments
+# @see https://docs.unit.co/repayments/#list-repayments
+module Unit
+  module Repayment
+    class ListRepaymentParams
+      attr_reader :limit, :offset, :account_id, :credit_account_id,
+                  :customer_id, :status, :type
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param credit_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param type [Array<String>] - optional
+      def initialize(limit = REPAYMENT_LIMIT, offset = REPAYMENT_OFFSET, account_id = nil,
+                     credit_account_id = nil, customer_id = nil, status = nil, type = nil)
+        @limit = limit
+        @offset = offset
+        @account_id = account_id
+        @credit_account_id = credit_account_id
+        @customer_id = customer_id
+        @status = status
+        @type = type
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[accountId]": account_id,
+          "filter[creditAccountId]": credit_account_id,
+          "filter[customerId]": customer_id
+        }
+        filters = %i[status type]
+        filters.each do |filter|
+          values = send(filter)
+          values&.each_with_index&.map do |val, index|
+            params.merge!({ "filter[#{filter}][#{index}]": val })
+          end
+        end
+        params.compact
+      end
+    end
+  end
+end

data/lib/unit/models/repayment/repayment.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Unit
+  module Repayment
+    REPAYMENT_LIMIT = 100
+    REPAYMENT_OFFSET = 0
+
+    autoload :CreateAchRepaymentRequest, "unit/models/repayment/create_ach_repayment_request"
+    autoload :CreateBookRepaymentRequest, "unit/models/repayment/create_book_repayment_request"
+    autoload :ListRepaymentParams, "unit/models/repayment/list_repayment_params"
+
+    class << self
+      # Get a repayment by calling Unit's API
+      # @see https://docs.unit.co/repayments#get-specific-repayment
+      # @param repayment_id [String]
+      def get_repayment(repayment_id:)
+        Unit::Resource::RepaymentResource.get(repayment_id)
+      end
+
+      # Create a book repayment by calling Unit's API
+      # @see https://docs.unit.co/repayments#book-repayment
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_account_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param transaction_summary_override [String]
+      # @param tags [Array<String>] - optional
+      # @param idempotency_key [String] - optional
+      def create_book_repayment(account_id:, credit_account_id:, counterparty_account_id:, description:, amount:, transaction_summary_override:, tags: nil, idempotency_key: nil)
+        request = Unit::Repayment::CreateBookRepaymentRequest.new(account_id, credit_account_id, counterparty_account_id, description, amount, transaction_summary_override, tags, idempotency_key)
+        Unit::Resource::RepaymentResource.create(request)
+      end
+
+      # Create an ach repayment by calling Unit's API
+      # @see https://docs.unit.co/repayments#create-ach-repayment
+      # @param account_id [String]
+      # @param credit_account_id [String]
+      # @param counterparty_id [String]
+      # @param description [String]
+      # @param amount [Integer]
+      # @param addenda [String] - optional
+      # @param tags [Hash] - optional
+      # @param same_day [Boolean] - optional
+      # @param idempotency_key [String] - optional
+      def create_ach_repayment(account_id:, credit_account_id:, counterparty_id:, description:, amount:, addenda: nil, tags: nil, idempotency_key: nil, same_day: false)
+        request = Unit::Repayment::CreateAchRepaymentRequest.new(account_id, credit_account_id, counterparty_id, description, amount, addenda, tags, idempotency_key, same_day: same_day)
+        Unit::Resource::RepaymentResource.create(request)
+      end
+
+      # List repayments by calling Unit's API
+      # @see https://docs.unit.co/repayments#list-repayments
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param account_id [String] - optional
+      # @param credit_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param type [Array<String>] - optional
+      def list_repayments(limit: REPAYMENT_LIMIT, offset: REPAYMENT_OFFSET, account_id: nil,
+                          credit_account_id: nil, customer_id: nil, status: nil, type: nil)
+        request = Unit::Repayment::ListRepaymentParams.new(limit, offset, account_id, credit_account_id, customer_id, status, type)
+        Unit::Resource::RepaymentResource.list(request)
+      end
+    end
+  end
+end

data/lib/unit/models/reward/create_reward_request.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Create a reward request
+# @see https://docs.unit.co/rewards/#create-reward
+module Unit
+  module Reward
+    class CreateRewardRequest
+      attr_reader :receiving_account_id, :funding_account_id, :rewarded_transaction_id, :amount, :description, :tags, :idempotency_key
+
+      # @param receiving_account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash]
+      # @param idempotency_key [String]
+      # @param funding_account_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      def initialize(receiving_account_id, amount, description, tags = nil, idempotency_key = nil, funding_account_id = nil, rewarded_transaction_id = nil)
+        @receiving_account_id = receiving_account_id
+        @amount = amount
+        @description = description
+        @tags = tags
+        @idempotency_key = idempotency_key
+        @funding_account_id = funding_account_id
+        @rewarded_transaction = rewarded_transaction_id
+      end
+
+      def to_json_api
+        payload = {
+          data: {
+            type: "reward",
+            attributes: {
+              amount: amount,
+              description: description,
+              tags: tags,
+              idempotencyKey: idempotency_key
+            },
+            relationships: {
+              receivingAccount: Unit::Types::Relationship.new("depositAccount", receiving_account_id).to_hash
+            }
+          }
+        }
+        payload[:data][:relationships][:funding_account] = Unit::Types::Relationship.new("fundingAccount", funding_account_id).to_hash if funding_account_id
+        payload[:data][:relationships][:rewardedTransaction] = Unit::Types::Relationship.new("rewardedTransaction", rewarded_transaction).to_hash if rewarded_transaction_id
+        payload[:data][:attributes].compact!
+        payload.to_json
+      end
+    end
+  end
+end

data/lib/unit/models/reward/get_request.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Get a reward by id request
+# @see https://docs.unit.co/rewards/#get-specific-reward
+module Unit
+  module Reward
+    class GetRequest
+      attr_reader :reward_id, :include
+
+      # @param reward_id [String]
+      # @param include [Array<String>] - optional
+      def initialize(reward_id, include = nil)
+        @reward_id = reward_id
+        @include = include
+      end
+
+      def to_hash
+        { include: include&.join(",") }.compact
+      end
+    end
+  end
+end

data/lib/unit/models/reward/list_reward_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# List reward params request
+# @see https://docs.unit.co/rewards/#list-rewards
+module Unit
+  module Reward
+    class ListRewardParams
+      attr_reader :limit, :offset, :transaction_id, :rewarded_transaction_id,
+                  :receiving_account_id, :customer_id, :card_id, :status, :since,
+                  :until_, :tags, :sort, :include
+
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param transaction_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      # @param receiving_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param card_id [String] - optional
+      # @param status [String] - optional
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def initialize(limit = REWARD_LIMIT, offset = REWARD_OFFSET, transaction_id = nil, rewarded_transaction_id = nil,
+                     receiving_account_id = nil, customer_id = nil, card_id = nil, status = nil, since = nil,
+                     until_ = nil, tags = nil, sort = nil, include = nil)
+        @limit = limit
+        @offset = offset
+        @transaction_id = transaction_id
+        @rewarded_transaction_id = rewarded_transaction_id
+        @receiving_account_id = receiving_account_id
+        @customer_id = customer_id
+        @card_id = card_id
+        @status = status
+        @since = since
+        @until_ = until_
+        @tags = tags
+        @sort = sort
+        @include = include
+      end
+
+      def to_hash
+        params = {
+          "page[limit]": limit,
+          "page[offset]": offset,
+          "filter[transactionId]": transaction_id,
+          "filter[rewardedTransactionId]": rewarded_transaction_id,
+          "filter[receivingAccountId]": receiving_account_id,
+          "filter[customerId]": customer_id,
+          "filter[cardId]": card_id,
+          "filter[since]": since,
+          "filter[until]": until_,
+          "filter[tags]": tags,
+          "sort": sort,
+          "include": include&.join(",")
+        }
+        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/reward/reward.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Unit
+  module Reward
+    REWARD_LIMIT = 100
+    REWARD_OFFSET = 0
+    autoload :GetRequest, "unit/models/reward/get_request"
+    autoload :CreateRewardRequest, "unit/models/reward/create_reward_request"
+    autoload :ListRewardParams, "unit/models/reward/list_reward_params"
+    class << self
+      # Get a reward by id
+      # @see https://docs.unit.co/rewards/#get-specific-reward
+      # @param reward_id [String]
+      # @param include [Array<String>] - optional
+      def get_reward(reward_id:, include: nil)
+        request = GetRequest.new(reward_id, include)
+        Resource::RewardResource.get_reward(request)
+      end
+
+      # Create a reward request
+      # @see https://docs.unit.co/rewards/#create-reward
+      # @param receiving_account_id [String]
+      # @param amount [Integer]
+      # @param description [String]
+      # @param tags [Hash]
+      # @param idempotency_key [String]
+      # @param funding_account_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      def create_reward(receiving_account_id:, amount:, description:, tags:, idempotency_key:, funding_account_id: nil, rewarded_transaction: nil)
+        request = CreateRewardRequest.new(receiving_account_id, amount, description, tags, idempotency_key, funding_account_id, rewarded_transaction)
+        Resource::RewardResource.create_reward(request)
+      end
+
+      # List reward params request
+      # @see https://docs.unit.co/rewards/#list-rewards
+      # @param limit [Integer] - optional
+      # @param offset [Integer] - optional
+      # @param transaction_id [String] - optional
+      # @param rewarded_transaction_id [String] - optional
+      # @param receiving_account_id [String] - optional
+      # @param customer_id [String] - optional
+      # @param card_id [String] - optional
+      # @param status [Array<String>] - optional
+      # @param since [String] - optional
+      # @param until_ [String] - optional
+      # @param tags [Hash] - optional
+      # @param sort [String] - optional
+      # @param include [Array<String>] - optional
+      def list_rewards(limit: REWARD_LIMIT, offset: REWARD_OFFSET, transaction_id: nil, rewarded_transaction_id: nil, receiving_account_id: nil, customer_id: nil, card_id: nil, status: nil, since: nil, until_: nil, tags: nil, sort: nil, include: nil)
+        request = ListRewardParams.new(limit, offset, transaction_id, rewarded_transaction_id, receiving_account_id, customer_id, card_id, status, since, until_, tags, sort, include)
+        Resource::RewardResource.list_rewards(request)
+      end
+    end
+  end
+end

data/lib/unit/models/unit_response.rb

@@ -3,7 +3,7 @@
 # Represents a response from Unit's API
 module Unit
   class UnitResponse
-    attr_reader :data, :included
+    attr_reader :data, :included, :meta
 
     # @param data [Hash] The JSON API payload
     # @param included [Array] The JSON API payload