Sha256: f74b1411b748cbb6580a43178b0820ebdc42bd9c4e7ea7df844f6bcf82a27b8b

Contents?: true

Size: 1.47 KB

Versions: 11

Compression:

Stored size: 1.47 KB

Contents

# MxPlatformRuby::GoalRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_guid** | **String** | Unique identifier of the account for the goal. |  |
| **amount** | **Float** | Amount of the goal. |  |
| **goal_type_name** | **String** | The goal type. |  |
| **meta_type_name** | **String** | The category of the goal. |  |
| **name** | **String** | The name of the goal. |  |
| **completed_at** | **String** | Date and time the goal was completed. | [optional] |
| **has_been_spent** | **Boolean** | Determines if the goal has been spent. | [optional] |
| **is_complete** | **Boolean** | Determines if the goal is complete. | [optional] |
| **metadata** | **String** | Additional information a partner can store on the goal. | [optional] |
| **position** | **Integer** | The priority of the goal in relation to multiple goals. | [optional] |
| **targeted_to_complete_at** | **String** | Date and time the goal is to complete. Intended for users to set their own goal completion dates. | [optional] |

## Example

```ruby
require 'mx-platform-ruby'

instance = MxPlatformRuby::GoalRequest.new(
  account_guid: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf,
  amount: 4500.5,
  goal_type_name: PAYOFF,
  meta_type_name: VACATION,
  name: Save for Europe,
  completed_at: 2015-06-19T10:37:04-06:00,
  has_been_spent: false,
  is_complete: false,
  metadata: Additional information,
  position: 3,
  targeted_to_complete_at: 2026-12-08 00:00:00.000000
)
```

Version data entries

11 entries across 11 versions & 1 rubygems

Version Path
mx-platform-ruby-1.2.0 docs/GoalRequest.md
mx-platform-ruby-1.1.0 docs/GoalRequest.md
mx-platform-ruby-1.0.0 docs/GoalRequest.md
mx-platform-ruby-0.46.0 docs/GoalRequest.md
mx-platform-ruby-0.45.0 docs/GoalRequest.md
mx-platform-ruby-0.44.1 docs/GoalRequest.md
mx-platform-ruby-0.44.0 docs/GoalRequest.md
mx-platform-ruby-0.43.0 docs/GoalRequest.md
mx-platform-ruby-0.42.0 docs/GoalRequest.md
mx-platform-ruby-0.41.0 docs/GoalRequest.md
mx-platform-ruby-0.40.0 docs/GoalRequest.md