Sha256: 6b2ce343aa72a65222a4b42ca2b6076c3cc8d28b8d71caf8d64ef1de72fff456

Contents?: true

Size: 1.67 KB

Versions: 4

Compression:

Stored size: 1.67 KB

Contents

# SyncteraRubySdk::RelationshipIn

## Class instance methods

### `openapi_one_of`

Returns the list of classes defined in oneOf.

#### Example

```ruby
require 'synctera_ruby_sdk'

SyncteraRubySdk::RelationshipIn.openapi_one_of
# =>
# [
#   :'BusinessBusinessOwnerRelationship',
#   :'PayerPayeeRelationship',
#   :'PersonBusinessOwnerRelationship',
#   :'PersonBusinessRelationship'
# ]
```

### `openapi_discriminator_name`

Returns the discriminator's property name.

#### Example

```ruby
require 'synctera_ruby_sdk'

SyncteraRubySdk::RelationshipIn.openapi_discriminator_name
# => :'relationship_type'
```

### `openapi_discriminator_name`

Returns the discriminator's mapping.

#### Example

```ruby
require 'synctera_ruby_sdk'

SyncteraRubySdk::RelationshipIn.openapi_discriminator_mapping
# =>
# {
#   :'BENEFICIAL_OWNER_OF' => :'PersonBusinessOwnerRelationship',
#   :'MANAGING_PERSON_OF' => :'PersonBusinessRelationship',
#   :'OWNER_OF' => :'BusinessBusinessOwnerRelationship',
#   :'PAYER_PAYEE' => :'PayerPayeeRelationship'
# }
```

### build

Find the appropriate object from the `openapi_one_of` list and casts the data into it.

#### Example

```ruby
require 'synctera_ruby_sdk'

SyncteraRubySdk::RelationshipIn.build(data)
# => #<BusinessBusinessOwnerRelationship:0x00007fdd4aab02a0>

SyncteraRubySdk::RelationshipIn.build(data_that_doesnt_match)
# => nil
```

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| **data** | **Mixed** | data to be matched against the list of oneOf items |

#### Return type

- `BusinessBusinessOwnerRelationship`
- `PayerPayeeRelationship`
- `PersonBusinessOwnerRelationship`
- `PersonBusinessRelationship`
- `nil` (if no type matches)

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
synctera_ruby_sdk-1.1.3 docs/RelationshipIn.md
synctera_ruby_sdk-1.1.2 docs/RelationshipIn.md
synctera_ruby_sdk-1.1.1 docs/RelationshipIn.md
synctera_ruby_sdk-1.0.0 docs/RelationshipIn.md