{"id":20064363,"url":"https://github.com/playpasshq/telleroo","last_synced_at":"2025-07-12T13:41:31.516Z","repository":{"id":59157441,"uuid":"95438772","full_name":"playpasshq/telleroo","owner":"playpasshq","description":"A Ruby interface to the Telleroo API.","archived":false,"fork":false,"pushed_at":"2022-09-06T16:00:56.000Z","size":33,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-31T15:14:25.331Z","etag":null,"topics":["api-wrapper","gem","ruby"],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/playpasshq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-26T11:15:30.000Z","updated_at":"2018-11-29T15:54:17.000Z","dependencies_parsed_at":"2022-09-13T20:10:55.584Z","dependency_job_id":null,"html_url":"https://github.com/playpasshq/telleroo","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playpasshq%2Ftelleroo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playpasshq%2Ftelleroo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playpasshq%2Ftelleroo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playpasshq%2Ftelleroo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/playpasshq","download_url":"https://codeload.github.com/playpasshq/telleroo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224458411,"owners_count":17314658,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-wrapper","gem","ruby"],"created_at":"2024-11-13T13:45:53.107Z","updated_at":"2024-11-13T13:45:53.697Z","avatar_url":"https://github.com/playpasshq.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telleroo\n\nThis is a simple wrapper for the Telleroo API. API Documentation is [available here](http://docs.telleroo.com). This gem uses `MultiJson` to parse responses which are otherwise returned unadulterated.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'telleroo'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install telleroo\n\n## Configuration\n\n`Telleroo::Client` can be configured from an initializer:\n\n```ruby\nTelleroo.configure do |config|\n  config.authorization_token = \"YOUR_AUTH_TOKEN\"\n  config.endpoint = 'https://sandbox.telleroo.com'\nend\n```\n\nor by passing an options block to `Telleroo::Client.new`\n\n```ruby\nclient = Telleroo::Client.new do |config|\n  config.authorization_token = \"YOUR_AUTH_TOKEN\"\n  config.endpoint = 'https://sandbox.telleroo.com'\nend\n```\n\nThe `http_adapter` option can be used to set the underlying HTTP adapter for Faraday:\n\n```ruby\nconfig.http_adapter = :typhoeus\n```\n\nUse an array to pass further options to the HTTP adapter itself:\n\n```ruby\nconfig.http_adapter = [:typhoeus, timeout_ms: 100]\n```\n\n## Usage\n\nAfter configuring a `client`, the following calls are available to you:\n\n**List Accounts**\n\nRetrieves all bank accounts assigned to your company\n\n```ruby\nclient.accounts()\n\n```\n\n**List Recipients**\n\nRetrieves all recipients under your company.\n\n```ruby\nclient.recipients()\n\n```\n\n**Get Recipient**\n\nRetrieves a single recipient given a recipient_id.\n\n```ruby\nclient.get_recipient(\"ff17b231-2bc4-485e-967e-231867e15fd6\")\n\n```\n\n**Create Recipient**\n\nCreates a single recipient.\n\nNote: `GBP` Recipients require `account_no` and `sort_code` passed in `options` while `EUR` require `iban` and `bic`.\n\n```ruby\nclient.create_recipient(\n  name: 'Nick Lloyd',\n  currency_code: 'GBP',\n  options: {\n    account_no: '72345678',\n    sort_code: '623456'\n  }\n)\n```\n\n**Delete Recipient**\n\nRetrieves a single recipient given a recipient_id.\n\n```ruby\nclient.delete_recipient(\"ff17b231-2bc4-485e-967e-231867e15fd6\")\n\n```\n\n**Create Bank Transfer to Recipient**\n\nTriggers an instantaneous bank transfer to a existing recipient from your account. [See docs](http://docs.telleroo.com/#bank-transfers-to-recipient-id) for additional available params to pass into options.\n\n```ruby\nclient.create_transfer(\n  account_id: 'a6a2b79c-33b5-4ed5-90fd-bfb8f1d4085a',\n  currency_code: 'GBP',\n  amount: 10000,\n  recipient_id: 'ff17b231-2bc4-485e-967e-231867e15fd6',\n  idempotent_key: 'abcd-123456789-efgh',\n  options: {\n    reference: 'foobar'\n  }\n)\n```\n\n**Create an Adhoc Bank Transfer**\n\nSend all params required to both create a Recipient and transfer funds in a single call.\n\n```ruby\nclient.create_adhoc_transfer(\n  account_id: 'a6a2b77c-33b5-4ed5-90fd-bfb8f1d4085a',\n  currency_code: 'GBP',\n  amount: 10000,\n  recipient_name: 'Rick Floyd',\n  account_no: 12345678,\n  sort_code: 665544,\n  idempotent_key: 'abcd-123456789-efgh',\n  reference: 'foo',\n  tag: 'bar',\n  reconciliation: 'baz'\n)\n\n```\n\n**List Transactions**\n\nReturns all activity on a specified bank account. [See docs](http://docs.telleroo.com/#transactions-list) for additional available params to pass into options.\n\n```ruby\nclient.transactions(\n  account_id: 'a6a2b77c-33b5-4ed5-90fd-bfb8f1d4085a',\n  start_date: '09-06-2017',\n  end_date: '09-07-2017'\n)\n\n```\n\n**Get Transaction**\n\nRetrieves all relevant data of a single transaction including the transfer status.\n\n```ruby\nclient.get_transaction(id)\n\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/playpasshq/telleroo.\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaypasshq%2Ftelleroo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplaypasshq%2Ftelleroo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaypasshq%2Ftelleroo/lists"}