Sha256: c6f75df8f8b1888e8e48f9a1e300652cb3efb4cc4fdf251d986bbef0889464bf

Contents?: true

Size: 1.87 KB

Versions: 41

Compression:

Stored size: 1.87 KB

Contents

# SnapTrade::PartnerData

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **redirect_uri** | **String** | URI to redirect user back to after user is done adding brokerage connections | [optional] |
| **allowed_brokerages** | [**Array<Brokerage>**](Brokerage.md) | Brokerages that can be accessed by partners | [optional] |
| **name** | **String** | Name of Snaptrade Partner | [optional] |
| **slug** | **String** | Slug of Snaptrade Partner | [optional] |
| **logo_url** | **String** | URL to partner's logo | [optional] |
| **pin_required** | **Boolean** | Shows if pin is required by users to access connection page | [optional] |
| **can_access_trades** | **Boolean** | Shows if users of Snaptrade partners can access trade endpoints | [optional] |
| **can_access_holdings** | **Boolean** | Shows if Snaptrade partners can get user holdings data | [optional] |
| **can_access_account_history** | **Boolean** | Shows if Snaptrade partners can get users account history data | [optional] |
| **can_access_reference_data** | **Boolean** | Shows if Snaptrade partners can get users holdings data | [optional] |
| **can_access_portfolio_management** | **Boolean** | Shows if users Snaptrade partners can access portfolio group management features | [optional] |
| **can_access_orders** | **Boolean** | Shows if Snaptrade partners can get users account order history | [optional] |

## Example

```ruby
require 'snaptrade'

instance = SnapTrade::PartnerData.new(
  redirect_uri: https://example.com/oauth/snaptrade,
  allowed_brokerages: null,
  name: Wealthy Chimpmunk,
  slug: WEALTHYCHIPMUNK,
  logo_url: https://example.com/logo.png,
  pin_required: false,
  can_access_trades: true,
  can_access_holdings: true,
  can_access_account_history: true,
  can_access_reference_data: true,
  can_access_portfolio_management: true,
  can_access_orders: true
)
```

Version data entries

41 entries across 41 versions & 1 rubygems

Version Path
snaptrade-2.0.7 docs/PartnerData.md
snaptrade-2.0.6 docs/PartnerData.md
snaptrade-2.0.5 docs/PartnerData.md
snaptrade-2.0.4 docs/PartnerData.md
snaptrade-2.0.3 docs/PartnerData.md
snaptrade-2.0.2 docs/PartnerData.md
snaptrade-2.0.1 docs/PartnerData.md
snaptrade-2.0.0 docs/PartnerData.md
snaptrade-1.17.13 docs/PartnerData.md
snaptrade-1.17.12 docs/PartnerData.md
snaptrade-1.17.11 docs/PartnerData.md
snaptrade-1.17.10 docs/PartnerData.md
snaptrade-1.17.9 docs/PartnerData.md
snaptrade-1.17.8 docs/PartnerData.md
snaptrade-1.17.7 docs/PartnerData.md
snaptrade-1.17.6 docs/PartnerData.md
snaptrade-1.17.5 docs/PartnerData.md
snaptrade-1.17.4 docs/PartnerData.md
snaptrade-1.17.3 docs/PartnerData.md
snaptrade-1.17.2 docs/PartnerData.md