unit_ruby_sdk 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a46692704b238a1ee794e61279bd26e2362d46758df062c6798654e420d07c9b
-  data.tar.gz: 15d22512500136bbcab8a1a8cd6053fa87c6caa3faf1aec7d42d90b9bc8a5242
+  metadata.gz: 00b359a8630b7687c710525b86d5faec0f30dc7771ed820538a12f18e3423d9d
+  data.tar.gz: 6ed3a97d6962f88810a0801e0f7f98a2e5cd8a850fb870b945bb06bc91229af4
 SHA512:
-  metadata.gz: d679b613f4d3d262f5a70523a1031a0fa7ab7ca07ce55530bd1bd2b8e8fe0f622f109e082db4df6b2ca0fb964e5ce0f96996975d21f7420c241ea436ed3d6589
-  data.tar.gz: 81bde72e0dc915f97f247edc4f96e41143a628d6f068d1e239edc27bdbd15b2f012ce78db3dbcd988fa28f223463bf8803191cf1a7379cb9026efe82b6546556
+  metadata.gz: cdc7b4d814b87313a2163176589d3c871f6986a9c39eb327a59596ef5ad7531645fe324703e105a0758a5d871da2a9d5cdc8ea30912a2a5983a77ff6d85949d0
+  data.tar.gz: 54884fbeb721faa5a5a8b2b78b91059a3b93af504f70d313e4b87963e33e6944c998d31c52412a61e2da198964bf9030872d39c22fab6db871f42a954c2681e3

data/README.md

@@ -14,6 +14,8 @@ gem install unit_ruby_sdk
 
 ## Usage
 
+ Bellow are a few exapmles of the Ruby SDK application. For full documentation of the Unit API please refer to the full documentation at https://docs.unit.co/
+
 ### Creating a Business Application
 
 ```ruby
@@ -58,6 +60,43 @@ customer = Unit::Customer.list_customers.first
 puts customer.id
 ```
 
+### 
+### Creating a Payment
+    
+```ruby
+require 'unit_ruby_sdk'
+
+response = Unit::Payment.create_book_payment(
+  amount: 10000,
+  description: 'Payment for order #123',
+  relationships: { account: Unit::Types::Relationship.new("depositAccount", "12345").to_hash,
+                   counterpartyAccount: Unit::Types::Relationship.new("depositAccount", "36221").to_hash }
+)
+payment = response.data
+puts payment.id
+```
+
+### Get a transaction by id
+
+```ruby
+response = Unit::Transaction.get_transaction(transaction_id: '12345', account_id: '72345')
+transaction = response.data
+puts transaction.id
+```
+
+### Creating an individual debit card
+```ruby
+response = Unit::Card.create_individual_debit_card(
+  account_id: '1234',
+  type: "depositAccount",
+  shipping_address: address,
+  design: "default",
+  additional_embossed_text: "Second Cardholder"
+)
+card = response.data
+puts card.id
+```
+
 ### Logging Errors
 
 ```ruby

data/lib/unit/api_resources/api_token_resource.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+
+# class for creating new API tokens' requests
+# @see https://docs.unit.co/org-api-tokens
+# @see https://docs.unit.co/customer-api-tokens
+module Unit
+  module Resource
+    class ApiTokenResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new Org API api_token by calling Unit's API
+        # @param request [CreateApiTokenRequest]
+        # @return [UnitResponse, UnitError]
+        def create_org_api_token(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/users/#{request.user_id}/api-tokens", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get Org API tokens by calling Unit's API
+        # @param user_id [String]
+        # @return [UnitResponse, UnitError]
+        def list_org_tokens(user_id)
+          response = HttpHelper.get("#{api_url}/users/#{user_id}/api-tokens", headers: headers)
+          response_handler(response)
+        end
+
+        # Revoke Org API api_token by calling Unit's API
+        # @param user_id [String]
+        # @param token_id [String]
+        # @return [UnitResponse, UnitError]
+        def revoke_org_token(user_id, token_id)
+          response = HttpHelper.delete("#{api_url}/users/#{user_id}/api-tokens/#{token_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # Create customer token by calling Unit's API
+        # @param [CreateCustomerTokenRequest, CreateCustomerTokenUsingJwtRequest] request
+        # @return [UnitResponse, UnitError]
+        def create_customer_token(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/customers/#{request.customer_id}/token", headers: headers, body: payload)
+          response_handler(response)
+        end
+
+        # Create customer token verification by calling Unit's API
+        # @param [CreateCustomerTokenVerification] request
+        # @return [UnitResponse, UnitError]
+        def create_token_verification(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/customers/#{request.customer_id}/token/verification", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/base_resource.rb

@@ -11,6 +11,10 @@ module Unit
           handler.from_json_api(response)
         end
 
+        def file_response_handler(response)
+          response.code.to_i.between?(200, 299) ? response.body : Unit::UnitError
+        end
+
         protected
 
         def api_url
@@ -25,7 +29,7 @@ module Unit
           {
             "Content-Type" => "application/vnd.api+json",
             "Authorization" => "Bearer #{Unit.config[:token]}",
-            "User-Agent" => "unit-ruby-sdk"
+            "X-UNIT-SDK" => "unit-ruby-sdk@v#{Unit::VERSION}"
           }
         end
       end

data/lib/unit/api_resources/card_resource.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+# class for creating requests for cards to Unit API and parsing responses
+# @see https://docs.unit.co/cards
+module Unit
+  module Resource
+    class CardResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new card by calling Unit's API
+        # @param [CreateIndividualDebitCardRequest, CreateIndividualVirtualCardRequest] request
+        # @return [UnitResponse, UnitError]
+        def create_card(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/cards", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get pin status by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_pin_status(card_id)
+          response = HttpHelper.get("#{api_url}/cards/#{card_id}/secure-data/pin/status", headers: headers)
+          response_handler(response)
+        end
+
+        # Report a card as a stolen by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def report_stolen(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/report-stolen", headers: headers)
+          response_handler(response)
+        end
+
+        # Report a card as a lost by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def report_lost(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/report-lost", headers: headers)
+          response_handler(response)
+        end
+
+        # Close a card by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def close_card(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/close", headers: headers)
+          response_handler(response)
+        end
+
+        # Freeze a card by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def freeze_card(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/freeze", headers: headers)
+          response_handler(response)
+        end
+
+        # Unfreeze a card by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def unfreeze_card(card_id)
+          response = HttpHelper.post("#{api_url}/cards/#{card_id}/unfreeze", headers: headers)
+          response_handler(response)
+        end
+
+        # Replace a card by calling Unit's API
+        # @param request [ReplaceCardRequest]
+        # @return [UnitResponse, UnitError]
+        def replace_card(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/cards/#{request.card_id}/replace", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a card by id by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def get_card(card_id)
+          response = HttpHelper.get("#{api_url}/cards/#{card_id}", headers: headers)
+          response_handler(response)
+        end
+
+        # List cards by calling Unit's API
+        # @param params [ListCardParams]
+        # @return [UnitResponse, UnitError]
+        def list_cards(params = nil)
+          response = HttpHelper.get("#{api_url}/cards", params: params&.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get card limits by calling Unit's API
+        # @param card_id [String]
+        # @return [UnitResponse, UnitError]
+        def limits(card_id)
+          response = HttpHelper.get("#{api_url}/cards/#{card_id}/limits", headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/payment_resource.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+
+# class for creating requests for book payments to Unit API and parsing responses
+# @see https://docs.unit.co/book-payments#book-payments
+module Unit
+  module Resource
+    class PaymentResource < Unit::Resource::BaseResource
+      class << self
+        # Create a new book payment by calling Unit's API
+        # @param request [CreatePaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def create_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.post("#{api_url}/payments", body: payload, headers: headers)
+          response_handler(response)
+        end
+
+        # Update a book payment by calling Unit's API
+        # @param request [PatchBookPaymentRequest]
+        # @return [UnitResponse, UnitError]
+        def update_payment(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/payments/#{request.payment_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/statement_resource.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+# class for creating requests for statements to Unit API and parsing responses
+# @see https://docs.unit.co/cards
+module Unit
+  module Resource
+    class StatementResource < Unit::Resource::BaseResource
+      class << self
+        # Get statements by calling Unit's API
+        # @param params [ListStatementParams]
+        # @return [UnitResponse, UnitError]
+        def list(params = nil)
+          response = HttpHelper.get("#{api_url}/statements", params: params&.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get a html statement by id by calling Unit's API
+        # @param params [GetHtmlByIdRequest]
+        # @return [UnitResponse, UnitError]
+        def get_html_by_id(request)
+          response = HttpHelper.get("#{api_url}/statements/#{request.statement_id}/html", params: request.to_hash, headers: headers)
+          file_response_handler(response)
+        end
+
+        # Get a pdf statement by id by calling Unit's API
+        # @param request [GetPdfByIdRequest]
+        # @return [UnitResponse, UnitError]
+        def get_pdf_by_id(request)
+          response = HttpHelper.get("#{api_url}/statements/#{request.statement_id}/pdf", params: request.to_hash, headers: headers)
+          file_response_handler(response)
+        end
+
+        # Get bank verification by calling Unit's API
+        # @param request [GetBankVerificationRequest]
+        # @return [UnitResponse, UnitError]
+        def get_bank_verification(request)
+          response = HttpHelper.get("#{api_url}/statements/#{request.account_id}/bank/pdf", params: request&.to_hash, headers: headers)
+          file_response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/api_resources/transaction_resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "./base_resource"
+require_relative "../utils/http_helper"
+require "json"
+
+# class for creating requests for transactions to Unit API and parsing responses
+# @see https://docs.unit.co/transactions
+module Unit
+  module Resource
+    class TransactionResource < Unit::Resource::BaseResource
+      class << self
+        # Get a transaction by id by calling Unit's API
+        # @param params [GetTransactionParams]
+        # @return [UnitResponse, UnitError]
+        def get_transaction(params)
+          response = HttpHelper.get("#{api_url}/accounts/#{params.account_id}/transactions/#{params.transaction_id}", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Get transactions by calling Unit's API
+        # @param params [ListTransactionParams]
+        # @return [UnitResponse, UnitError]
+        def list_transactions(params = nil)
+          response = HttpHelper.get("#{api_url}/transactions", params: params.to_hash, headers: headers)
+          response_handler(response)
+        end
+
+        # Update a transaction by calling Unit's API
+        # @param request [PatchTagsRequest]
+        # @return [UnitResponse, UnitError]
+        def update_tags(request)
+          payload = request.to_json_api
+          response = HttpHelper.patch("#{api_url}/accounts/#{request.account_id}/transactions/#{request.transaction_id}", body: payload, headers: headers)
+          response_handler(response)
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/account/deposit/balance_history_request.rb

@@ -31,7 +31,7 @@ module Unit
                      "filter[customerId]": customer_id,
                      "filter[since]": since,
                      "filter[until]": _until }
-          params.compact!
+          params.compact
         end
       end
     end

data/lib/unit/models/api_token/api_token.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Unit
+  module ApiToken
+    module Org
+      autoload :CreateApiTokenRequest, "unit/models/api_token/org/create_api_token_request"
+
+      class << self
+        # Create a new Org API api_token by calling Unit's API
+        # @see https://docs.unit.co/org-api-tokens#create-org-api-token
+        # @param user_id [String]
+        # @param description [String]
+        # @param scope [Array<String>]
+        # @param expiration [Datetime]
+        # @param source_ip [String] - optional
+        # @param resources [Array<RestrictedResource>] - optional
+        # @return [UnitResponse, UnitError]
+        def create_api_token(user_id:, description:, scope:, expiration:, source_ip: nil, resources: nil)
+          request = CreateApiTokenRequest.new(user_id, description, scope, expiration, source_ip, resources)
+          Unit::Resource::ApiTokenResource.create_org_api_token(request)
+        end
+
+        # Get Org API tokens by calling Unit's API
+        # @see https://docs.unit.co/org-api-tokens#list-org-api-tokens
+        # @param user_id [String]
+        # @return [UnitResponse, UnitError]
+        def list_tokens(user_id:)
+          Unit::Resource::ApiTokenResource.list_org_tokens(user_id)
+        end
+
+        # Revoke Org API api_token by calling Unit's API
+        # @see https://docs.unit.co/org-api-tokens#revoke-org-api-token
+        # @param user_id [String]
+        # @param token_id [String]
+        # @return [UnitResponse, UnitError]
+        def revoke_token(user_id:, token_id:)
+          Unit::Resource::ApiTokenResource.revoke_org_token(user_id, token_id)
+        end
+      end
+    end
+
+    module Customer
+      autoload :CreateCustomerTokenRequest, "unit/models/api_token/customer/create_customer_token_request"
+      autoload :CreateTokenUsingJwtRequest, "unit/models/api_token/customer/create_token_using_jwt_request"
+      autoload :CreateCustomerTokenVerification, "unit/models/api_token/customer/create_customer_token_verification"
+
+      class << self
+        # Create customer token by calling Unit's API
+        # @see https://docs.unit.co/customer-api-tokens#customers-create-customer-bearer-token
+        # @param customer_id [String]
+        # @param scope [Array<String>]
+        # @param verification_token [String]
+        # @param verification_code [String] - optional
+        # @param expires_in [Integer] - optional
+        # @param resources [Array<RestrictedResource>] - optional
+        # @return [UnitResponse, UnitError]
+        def create_customer_token(customer_id:, scope:, verification_token:, verification_code: nil, expires_in: nil,
+                                  resources: nil)
+          request = CreateCustomerTokenRequest.new(customer_id, scope, verification_token, verification_code, expires_in, resources)
+          Unit::Resource::ApiTokenResource.create_customer_token(request)
+        end
+
+        # Create customer token using JWT by calling Unit's API
+        # @see https://docs.unit.co/customer-api-tokens#customers-create-customer-bearer-token-jwt
+        # @param customer_id [String]
+        # @param scope [Array<String>]
+        # @param jwt_token [String] - optional
+        # @return [UnitResponse, UnitError]
+        def create_customer_token_with_jwt(customer_id:, scope:, jwt_token: nil)
+          request = CreateTokenUsingJwtRequest.new(customer_id, scope, jwt_token)
+          Unit::Resource::ApiTokenResource.create_customer_token(request)
+        end
+
+        # Create customer token verification by calling Unit's API
+        # @see https://docs.unit.co/customer-api-tokens#customers-customer-token-verification
+        # @param customer_id [String]
+        # @param channel [String]
+        # @param phone [Phone] - optional
+        # @param app_hash [String] - optional
+        # @param language [String] - optional
+        # @return [UnitResponse, UnitError]
+        def create_customer_token_verification(customer_id:, channel:, phone: nil, app_hash: nil, language: nil)
+          request = CreateCustomerTokenVerification.new(customer_id, channel, phone, app_hash, language)
+          Unit::Resource::ApiTokenResource.create_token_verification(request)
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/api_token/customer/create_customer_token_request.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Request to create a customer token
+# @see https://docs.unit.co/customer-api-tokens#customers-create-customer-bearer-token
+module Unit
+  module ApiToken
+    module Customer
+      class CreateCustomerTokenRequest
+        attr_reader :customer_id, :scope, :verification_token, :verification_code, :expires_in, :resources
+
+        # @param customer_id [String]
+        # @param scope [Array<String>]
+        # @param verification_token [String] - optional
+        # @param verification_code [String] - optional
+        # @param expires_in [Integer] - optional
+        # @param resources [Array<RestrictedResource>] - optional
+        def initialize(customer_id, scope, verification_token, verification_code = nil,
+                       expires_in = nil, resources = nil)
+          @customer_id = customer_id
+          @scope = scope
+          @verification_token = verification_token
+          @verification_code = verification_code
+          @expires_in = expires_in
+          @resources = resources
+        end
+
+        def to_json_api
+          result = { data: { type: "customerToken",
+                             attributes:
+                               { scope: scope&.join(" "),
+                                 verificationToken: verification_token,
+                                 verificationCode: verification_code,
+                                 expiresIn: expires_in,
+                                 resources: resources } } }
+          result[:data][:attributes].compact!
+          result.to_json
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/api_token/customer/create_customer_token_verification.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Request to create a customer token verification
+# @see https://docs.unit.co/customer-api-tokens#customers-customer-token-verification
+module Unit
+  module ApiToken
+    module Customer
+      class CreateCustomerTokenVerification
+        attr_reader :customer_id, :channel, :phone, :app_hash, :language
+
+        # @param customer_id [String]
+        # @param channel [String]
+        # @param phone [Phone] - optional
+        # @param app_hash [String] - optional
+        # @param language [String] - optional
+        def initialize(customer_id, channel, phone = nil, app_hash = nil, language = nil)
+          @customer_id = customer_id
+          @channel = channel
+          @phone = phone
+          @app_hash = app_hash
+          @language = language
+        end
+
+        def to_json_api
+          result = { data: { type: "customerTokenVerification",
+                             attributes:
+                               { channel: channel,
+                                 phone: phone&.represent,
+                                 appHash: app_hash,
+                                 language: language } } }
+          result[:data][:attributes].compact!
+          result.to_json
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/api_token/customer/create_token_using_jwt_request.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Request to create Customer token using JWT
+# @see https://docs.unit.co/customer-api-tokens#customers-create-customer-bearer-token-jwt
+module Unit
+  module ApiToken
+    module Customer
+      class CreateTokenUsingJwtRequest
+        attr_reader :customer_id, :scope, :jwt_token
+
+        # @param scope [Array<String>]
+        # @param jwt_token [String]
+        def initialize(customer_id, scope, jwt_token = nil)
+          @customer_id = customer_id
+          @scope = scope
+          @jwt_token = jwt_token
+        end
+
+        def to_json_api
+          result = { data: { type: "customerToken",
+                             attributes:
+                               { scope: scope&.join(" "),
+                                 jwtToken: jwt_token } } }
+          result[:data][:attributes].compact!
+          result.to_json
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/api_token/org/create_api_token_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Request to create an org API token
+# @see https://docs.unit.co/org-api-tokens#create-org-api-token
+module Unit
+  module ApiToken
+    module Org
+      class CreateApiTokenRequest
+        attr_reader :user_id, :description, :scope, :expiration, :source_ip, :resources
+
+        # @param user_id [String]
+        # @param description [String]
+        # @param scope [Array<String>]
+        # @param expiration [String]
+        # @param source_ip [String] - optional
+        # @param resources [Array<RestrictedResource>] - optional
+        def initialize(user_id, description, scope, expiration, source_ip = nil, resources = nil)
+          @user_id = user_id
+          @description = description
+          @scope = scope
+          @expiration = expiration
+          @source_ip = source_ip
+          @resources = resources
+        end
+
+        def to_json_api
+          result = { data: { type: "apiToken",
+                             attributes:
+                               { description: description,
+                                 scope: scope.join(" "),
+                                 expiration: expiration,
+                                 sourceIp: source_ip,
+                                 resources: resources } } }
+          result[:data][:attributes].compact!
+          result.to_json
+        end
+      end
+    end
+  end
+end

data/lib/unit/models/application/list_application_params.rb

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