Sha256: e2d16c80f8446a1c3b86d0d78d5696a92fb97c8448407c1d6b41ee79948d5cd2

Contents?: true

Size: 1.91 KB

Versions: 39

Compression:

Stored size: 1.91 KB

Contents

# CybridApiBank::AssetsBankApi

All URIs are relative to *https://bank.sandbox.cybrid.app*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**list_assets**](AssetsBankApi.md#list_assets) | **GET** /api/assets | Get assets list |


## list_assets

> <AssetListBankModel> list_assets(opts)

Get assets list

Retrieves a listing of assets.

### Examples

```ruby
require 'time'
require 'cybrid_api_bank_ruby'

api_instance = CybridApiBank::AssetsBankApi.new
opts = {
  page: 56, # Integer | The page index to retrieve.
  per_page: 56, # Integer | The number of entities per page to return.
  code: 'code_example' # String | Comma separated codes to list assets for.
}

begin
  # Get assets list
  result = api_instance.list_assets(opts)
  p result
rescue CybridApiBank::ApiError => e
  puts "Error when calling AssetsBankApi->list_assets: #{e}"
end
```

#### Using the list_assets_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<AssetListBankModel>, Integer, Hash)> list_assets_with_http_info(opts)

```ruby
begin
  # Get assets list
  data, status_code, headers = api_instance.list_assets_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AssetListBankModel>
rescue CybridApiBank::ApiError => e
  puts "Error when calling AssetsBankApi->list_assets_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **page** | **Integer** | The page index to retrieve. | [optional] |
| **per_page** | **Integer** | The number of entities per page to return. | [optional] |
| **code** | **String** | Comma separated codes to list assets for. | [optional] |

### Return type

[**AssetListBankModel**](AssetListBankModel.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

39 entries across 39 versions & 1 rubygems

Version Path
cybrid_api_bank_ruby-0.123.291 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.290 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.289 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.288 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.287 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.286 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.285 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.284 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.283 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.282 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.280 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.278 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.277 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.276 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.275 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.274 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.273 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.272 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.271 docs/AssetsBankApi.md
cybrid_api_bank_ruby-0.123.268 docs/AssetsBankApi.md