mx-platform-ruby 0.39.0 → 0.40.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (99) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/docs/BudgetCreateRequest.md +26 -0
  4. data/docs/BudgetCreateRequestBody.md +18 -0
  5. data/docs/BudgetResponse.md +48 -0
  6. data/docs/BudgetResponseBody.md +18 -0
  7. data/docs/BudgetUpdateRequest.md +22 -0
  8. data/docs/BudgetUpdateRequestBody.md +18 -0
  9. data/docs/BudgetsApi.md +444 -0
  10. data/docs/CreditCardProduct.md +8 -8
  11. data/docs/CreditCardProductResponse.md +2 -2
  12. data/docs/GoalRequest.md +38 -0
  13. data/docs/GoalRequestBody.md +18 -0
  14. data/docs/GoalResponse.md +48 -0
  15. data/docs/GoalResponseBody.md +18 -0
  16. data/docs/GoalsApi.md +450 -0
  17. data/docs/GoalsResponse.md +48 -0
  18. data/docs/GoalsResponseBody.md +20 -0
  19. data/docs/MonthlyCashFlowProfileRequest.md +20 -0
  20. data/docs/MonthlyCashFlowProfileRequestBody.md +18 -0
  21. data/docs/MonthlyCashFlowResponse.md +30 -0
  22. data/docs/MonthlyCashFlowResponseBody.md +18 -0
  23. data/docs/MxPlatformApi.md +291 -0
  24. data/docs/RepositionRequest.md +20 -0
  25. data/docs/RepositionRequestBody.md +18 -0
  26. data/docs/RepositionResponseBody.md +18 -0
  27. data/docs/RewardResponse.md +2 -0
  28. data/docs/RewardsResponse.md +2 -0
  29. data/docs/SplitTransactionRequest.md +24 -0
  30. data/docs/SplitTransactionRequestBody.md +18 -0
  31. data/docs/SplitTransactionsResponseBody.md +18 -0
  32. data/docs/UpdateGoalRequest.md +38 -0
  33. data/docs/UpdateGoalRequestBody.md +18 -0
  34. data/lib/mx-platform-ruby/api/budgets_api.rb +434 -0
  35. data/lib/mx-platform-ruby/api/goals_api.rb +455 -0
  36. data/lib/mx-platform-ruby/api/mx_platform_api.rb +278 -0
  37. data/lib/mx-platform-ruby/models/budget_create_request.rb +269 -0
  38. data/lib/mx-platform-ruby/models/budget_create_request_body.rb +214 -0
  39. data/lib/mx-platform-ruby/models/budget_response.rb +373 -0
  40. data/lib/mx-platform-ruby/models/budget_response_body.rb +214 -0
  41. data/lib/mx-platform-ruby/models/budget_update_request.rb +235 -0
  42. data/lib/mx-platform-ruby/models/budget_update_request_body.rb +214 -0
  43. data/lib/mx-platform-ruby/models/credit_card_product.rb +17 -21
  44. data/lib/mx-platform-ruby/models/credit_card_product_response.rb +7 -7
  45. data/lib/mx-platform-ruby/models/goal_request.rb +350 -0
  46. data/lib/mx-platform-ruby/models/goal_request_body.rb +214 -0
  47. data/lib/mx-platform-ruby/models/goal_response.rb +364 -0
  48. data/lib/mx-platform-ruby/models/goal_response_body.rb +214 -0
  49. data/lib/mx-platform-ruby/models/goals_response.rb +363 -0
  50. data/lib/mx-platform-ruby/models/goals_response_body.rb +225 -0
  51. data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request.rb +225 -0
  52. data/lib/mx-platform-ruby/models/monthly_cash_flow_profile_request_body.rb +214 -0
  53. data/lib/mx-platform-ruby/models/monthly_cash_flow_response.rb +274 -0
  54. data/lib/mx-platform-ruby/models/monthly_cash_flow_response_body.rb +214 -0
  55. data/lib/mx-platform-ruby/models/reposition_request.rb +239 -0
  56. data/lib/mx-platform-ruby/models/reposition_request_body.rb +216 -0
  57. data/lib/mx-platform-ruby/models/reposition_response_body.rb +216 -0
  58. data/lib/mx-platform-ruby/models/reward_response.rb +10 -1
  59. data/lib/mx-platform-ruby/models/rewards_response.rb +10 -1
  60. data/lib/mx-platform-ruby/models/split_transaction_request.rb +252 -0
  61. data/lib/mx-platform-ruby/models/split_transaction_request_body.rb +221 -0
  62. data/lib/mx-platform-ruby/models/split_transactions_response_body.rb +216 -0
  63. data/lib/mx-platform-ruby/models/update_goal_request.rb +315 -0
  64. data/lib/mx-platform-ruby/models/update_goal_request_body.rb +214 -0
  65. data/lib/mx-platform-ruby/version.rb +1 -1
  66. data/lib/mx-platform-ruby.rb +26 -0
  67. data/openapi/config.yml +1 -1
  68. data/spec/api/budgets_api_spec.rb +112 -0
  69. data/spec/api/goals_api_spec.rb +115 -0
  70. data/spec/api/mx_platform_api_spec.rb +51 -0
  71. data/spec/models/budget_create_request_body_spec.rb +34 -0
  72. data/spec/models/budget_create_request_spec.rb +58 -0
  73. data/spec/models/budget_response_body_spec.rb +34 -0
  74. data/spec/models/budget_response_spec.rb +124 -0
  75. data/spec/models/budget_update_request_body_spec.rb +34 -0
  76. data/spec/models/budget_update_request_spec.rb +46 -0
  77. data/spec/models/credit_card_product_response_spec.rb +1 -1
  78. data/spec/models/credit_card_product_spec.rb +2 -2
  79. data/spec/models/goal_request_body_spec.rb +34 -0
  80. data/spec/models/goal_request_spec.rb +94 -0
  81. data/spec/models/goal_response_body_spec.rb +34 -0
  82. data/spec/models/goal_response_spec.rb +124 -0
  83. data/spec/models/goals_response_body_spec.rb +40 -0
  84. data/spec/models/goals_response_spec.rb +124 -0
  85. data/spec/models/monthly_cash_flow_profile_request_body_spec.rb +34 -0
  86. data/spec/models/monthly_cash_flow_profile_request_spec.rb +40 -0
  87. data/spec/models/monthly_cash_flow_response_body_spec.rb +34 -0
  88. data/spec/models/monthly_cash_flow_response_spec.rb +70 -0
  89. data/spec/models/reposition_request_body_spec.rb +34 -0
  90. data/spec/models/reposition_request_spec.rb +40 -0
  91. data/spec/models/reposition_response_body_spec.rb +34 -0
  92. data/spec/models/reward_response_spec.rb +6 -0
  93. data/spec/models/rewards_response_spec.rb +6 -0
  94. data/spec/models/split_transaction_request_body_spec.rb +34 -0
  95. data/spec/models/split_transaction_request_spec.rb +52 -0
  96. data/spec/models/split_transactions_response_body_spec.rb +34 -0
  97. data/spec/models/update_goal_request_body_spec.rb +34 -0
  98. data/spec/models/update_goal_request_spec.rb +94 -0
  99. metadata +106 -2
@@ -0,0 +1,30 @@
1
+ # MxPlatformRuby::MonthlyCashFlowResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | Unique identifier for the monthly cash flow profile. Defined by MX. | [optional] |
8
+ | **user_guid** | **String** | Unique identifier for the user the monthly cash flow profile is attached to. Defined by MX. | [optional] |
9
+ | **budgeted_income** | **Float** | The amount of the budgeted income for the user. | [optional] |
10
+ | **budgeted_expenses** | **Float** | The amount of the budgeted expenses for the user. | [optional] |
11
+ | **goals_contribution** | **Float** | The monthly dollar amount allocated for goals. | [optional] |
12
+ | **estimated_goals_contribution** | **Integer** | The estimated monthly dollar amount allocated for goals calculated from income and budgets. | [optional] |
13
+ | **uses_estimated_goals_contribution** | **Boolean** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'mx-platform-ruby'
19
+
20
+ instance = MxPlatformRuby::MonthlyCashFlowResponse.new(
21
+ guid: MCF-4e431124-4a29-abf9-f059-ab232ac14dbf,
22
+ user_guid: USR-6c83f63c-efcc-0189-3f14-100f0bad378a,
23
+ budgeted_income: 1200.12,
24
+ budgeted_expenses: 1000.0,
25
+ goals_contribution: 150.0,
26
+ estimated_goals_contribution: null,
27
+ uses_estimated_goals_contribution: false
28
+ )
29
+ ```
30
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::MonthlyCashFlowResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **monthly_cash_flow_profile** | [**MonthlyCashFlowResponse**](MonthlyCashFlowResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::MonthlyCashFlowResponseBody.new(
15
+ monthly_cash_flow_profile: null
16
+ )
17
+ ```
18
+
@@ -106,6 +106,10 @@ All URIs are relative to *https://api.mx.com*
106
106
  | [**update_transaction**](MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction |
107
107
  | [**update_transaction_rule**](MxPlatformApi.md#update_transaction_rule) | **PUT** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Update transaction_rule |
108
108
  | [**update_user**](MxPlatformApi.md#update_user) | **PUT** /users/{user_guid} | Update user |
109
+ | [**users_user_guid_monthly_cash_flow_profile_get**](MxPlatformApi.md#users_user_guid_monthly_cash_flow_profile_get) | **GET** /users/{user_guid}/monthly_cash_flow_profile | Read monthly cash flow profile |
110
+ | [**users_user_guid_monthly_cash_flow_profile_put**](MxPlatformApi.md#users_user_guid_monthly_cash_flow_profile_put) | **PUT** /users/{user_guid}/monthly_cash_flow_profile | Update monthly cash flow profile |
111
+ | [**users_user_guid_transactions_transaction_guid_split_delete**](MxPlatformApi.md#users_user_guid_transactions_transaction_guid_split_delete) | **DELETE** /users/{user_guid}/transactions/{transaction_guid}/split | Delete split transactions |
112
+ | [**users_user_guid_transactions_transaction_guid_split_post**](MxPlatformApi.md#users_user_guid_transactions_transaction_guid_split_post) | **POST** /users/{user_guid}/transactions/{transaction_guid}/split | Create split transactions |
109
113
  | [**verify_member**](MxPlatformApi.md#verify_member) | **POST** /users/{user_guid}/members/{member_guid}/verify | Verify member |
110
114
 
111
115
 
@@ -7695,6 +7699,293 @@ end
7695
7699
  - **Accept**: application/vnd.mx.api.v1+json
7696
7700
 
7697
7701
 
7702
+ ## users_user_guid_monthly_cash_flow_profile_get
7703
+
7704
+ > <MonthlyCashFlowResponseBody> users_user_guid_monthly_cash_flow_profile_get(user_guid)
7705
+
7706
+ Read monthly cash flow profile
7707
+
7708
+ ### Examples
7709
+
7710
+ ```ruby
7711
+ require 'time'
7712
+ require 'mx-platform-ruby'
7713
+ # setup authorization
7714
+ MxPlatformRuby.configure do |config|
7715
+ # Configure HTTP basic authorization: basicAuth
7716
+ config.username = 'YOUR USERNAME'
7717
+ config.password = 'YOUR PASSWORD'
7718
+ end
7719
+
7720
+ api_instance = MxPlatformRuby::MxPlatformApi.new
7721
+ user_guid = 'user_guid_example' # String | The unique identifier for the user.
7722
+
7723
+ begin
7724
+ # Read monthly cash flow profile
7725
+ result = api_instance.users_user_guid_monthly_cash_flow_profile_get(user_guid)
7726
+ p result
7727
+ rescue MxPlatformRuby::ApiError => e
7728
+ puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_get: #{e}"
7729
+ end
7730
+ ```
7731
+
7732
+ #### Using the users_user_guid_monthly_cash_flow_profile_get_with_http_info variant
7733
+
7734
+ This returns an Array which contains the response data, status code and headers.
7735
+
7736
+ > <Array(<MonthlyCashFlowResponseBody>, Integer, Hash)> users_user_guid_monthly_cash_flow_profile_get_with_http_info(user_guid)
7737
+
7738
+ ```ruby
7739
+ begin
7740
+ # Read monthly cash flow profile
7741
+ data, status_code, headers = api_instance.users_user_guid_monthly_cash_flow_profile_get_with_http_info(user_guid)
7742
+ p status_code # => 2xx
7743
+ p headers # => { ... }
7744
+ p data # => <MonthlyCashFlowResponseBody>
7745
+ rescue MxPlatformRuby::ApiError => e
7746
+ puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_get_with_http_info: #{e}"
7747
+ end
7748
+ ```
7749
+
7750
+ ### Parameters
7751
+
7752
+ | Name | Type | Description | Notes |
7753
+ | ---- | ---- | ----------- | ----- |
7754
+ | **user_guid** | **String** | The unique identifier for the user. | |
7755
+
7756
+ ### Return type
7757
+
7758
+ [**MonthlyCashFlowResponseBody**](MonthlyCashFlowResponseBody.md)
7759
+
7760
+ ### Authorization
7761
+
7762
+ [basicAuth](../README.md#basicAuth)
7763
+
7764
+ ### HTTP request headers
7765
+
7766
+ - **Content-Type**: Not defined
7767
+ - **Accept**: application/json
7768
+
7769
+
7770
+ ## users_user_guid_monthly_cash_flow_profile_put
7771
+
7772
+ > <MonthlyCashFlowResponseBody> users_user_guid_monthly_cash_flow_profile_put(user_guid, monthly_cash_flow_profile_request_body)
7773
+
7774
+ Update monthly cash flow profile
7775
+
7776
+ Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.
7777
+
7778
+ ### Examples
7779
+
7780
+ ```ruby
7781
+ require 'time'
7782
+ require 'mx-platform-ruby'
7783
+ # setup authorization
7784
+ MxPlatformRuby.configure do |config|
7785
+ # Configure HTTP basic authorization: basicAuth
7786
+ config.username = 'YOUR USERNAME'
7787
+ config.password = 'YOUR PASSWORD'
7788
+ end
7789
+
7790
+ api_instance = MxPlatformRuby::MxPlatformApi.new
7791
+ user_guid = 'user_guid_example' # String | The unique identifier for the user.
7792
+ monthly_cash_flow_profile_request_body = MxPlatformRuby::MonthlyCashFlowProfileRequestBody.new # MonthlyCashFlowProfileRequestBody |
7793
+
7794
+ begin
7795
+ # Update monthly cash flow profile
7796
+ result = api_instance.users_user_guid_monthly_cash_flow_profile_put(user_guid, monthly_cash_flow_profile_request_body)
7797
+ p result
7798
+ rescue MxPlatformRuby::ApiError => e
7799
+ puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_put: #{e}"
7800
+ end
7801
+ ```
7802
+
7803
+ #### Using the users_user_guid_monthly_cash_flow_profile_put_with_http_info variant
7804
+
7805
+ This returns an Array which contains the response data, status code and headers.
7806
+
7807
+ > <Array(<MonthlyCashFlowResponseBody>, Integer, Hash)> users_user_guid_monthly_cash_flow_profile_put_with_http_info(user_guid, monthly_cash_flow_profile_request_body)
7808
+
7809
+ ```ruby
7810
+ begin
7811
+ # Update monthly cash flow profile
7812
+ data, status_code, headers = api_instance.users_user_guid_monthly_cash_flow_profile_put_with_http_info(user_guid, monthly_cash_flow_profile_request_body)
7813
+ p status_code # => 2xx
7814
+ p headers # => { ... }
7815
+ p data # => <MonthlyCashFlowResponseBody>
7816
+ rescue MxPlatformRuby::ApiError => e
7817
+ puts "Error when calling MxPlatformApi->users_user_guid_monthly_cash_flow_profile_put_with_http_info: #{e}"
7818
+ end
7819
+ ```
7820
+
7821
+ ### Parameters
7822
+
7823
+ | Name | Type | Description | Notes |
7824
+ | ---- | ---- | ----------- | ----- |
7825
+ | **user_guid** | **String** | The unique identifier for the user. | |
7826
+ | **monthly_cash_flow_profile_request_body** | [**MonthlyCashFlowProfileRequestBody**](MonthlyCashFlowProfileRequestBody.md) | | |
7827
+
7828
+ ### Return type
7829
+
7830
+ [**MonthlyCashFlowResponseBody**](MonthlyCashFlowResponseBody.md)
7831
+
7832
+ ### Authorization
7833
+
7834
+ [basicAuth](../README.md#basicAuth)
7835
+
7836
+ ### HTTP request headers
7837
+
7838
+ - **Content-Type**: application/json
7839
+ - **Accept**: application/json
7840
+
7841
+
7842
+ ## users_user_guid_transactions_transaction_guid_split_delete
7843
+
7844
+ > users_user_guid_transactions_transaction_guid_split_delete(transaction_guid, user_guid)
7845
+
7846
+ Delete split transactions
7847
+
7848
+ This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
7849
+
7850
+ ### Examples
7851
+
7852
+ ```ruby
7853
+ require 'time'
7854
+ require 'mx-platform-ruby'
7855
+ # setup authorization
7856
+ MxPlatformRuby.configure do |config|
7857
+ # Configure HTTP basic authorization: basicAuth
7858
+ config.username = 'YOUR USERNAME'
7859
+ config.password = 'YOUR PASSWORD'
7860
+ end
7861
+
7862
+ api_instance = MxPlatformRuby::MxPlatformApi.new
7863
+ transaction_guid = 'TRN-810828b0-5210-4878-9bd3-f4ce514f90c4' # String | The unique id for a `transaction`.
7864
+ user_guid = 'USR-85628b0-5210-4878-9bd3-f4ce154f90c4' # String | The unique id for a `user`.
7865
+
7866
+ begin
7867
+ # Delete split transactions
7868
+ api_instance.users_user_guid_transactions_transaction_guid_split_delete(transaction_guid, user_guid)
7869
+ rescue MxPlatformRuby::ApiError => e
7870
+ puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_delete: #{e}"
7871
+ end
7872
+ ```
7873
+
7874
+ #### Using the users_user_guid_transactions_transaction_guid_split_delete_with_http_info variant
7875
+
7876
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
7877
+
7878
+ > <Array(nil, Integer, Hash)> users_user_guid_transactions_transaction_guid_split_delete_with_http_info(transaction_guid, user_guid)
7879
+
7880
+ ```ruby
7881
+ begin
7882
+ # Delete split transactions
7883
+ data, status_code, headers = api_instance.users_user_guid_transactions_transaction_guid_split_delete_with_http_info(transaction_guid, user_guid)
7884
+ p status_code # => 2xx
7885
+ p headers # => { ... }
7886
+ p data # => nil
7887
+ rescue MxPlatformRuby::ApiError => e
7888
+ puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_delete_with_http_info: #{e}"
7889
+ end
7890
+ ```
7891
+
7892
+ ### Parameters
7893
+
7894
+ | Name | Type | Description | Notes |
7895
+ | ---- | ---- | ----------- | ----- |
7896
+ | **transaction_guid** | **String** | The unique id for a &#x60;transaction&#x60;. | |
7897
+ | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
7898
+
7899
+ ### Return type
7900
+
7901
+ nil (empty response body)
7902
+
7903
+ ### Authorization
7904
+
7905
+ [basicAuth](../README.md#basicAuth)
7906
+
7907
+ ### HTTP request headers
7908
+
7909
+ - **Content-Type**: Not defined
7910
+ - **Accept**: Not defined
7911
+
7912
+
7913
+ ## users_user_guid_transactions_transaction_guid_split_post
7914
+
7915
+ > <SplitTransactionsResponseBody> users_user_guid_transactions_transaction_guid_split_post(user_guid, transaction_guid, opts)
7916
+
7917
+ Create split transactions
7918
+
7919
+ This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction. When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again. In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
7920
+
7921
+ ### Examples
7922
+
7923
+ ```ruby
7924
+ require 'time'
7925
+ require 'mx-platform-ruby'
7926
+ # setup authorization
7927
+ MxPlatformRuby.configure do |config|
7928
+ # Configure HTTP basic authorization: basicAuth
7929
+ config.username = 'YOUR USERNAME'
7930
+ config.password = 'YOUR PASSWORD'
7931
+ end
7932
+
7933
+ api_instance = MxPlatformRuby::MxPlatformApi.new
7934
+ user_guid = 'user_guid_example' # String | The unique identifier for the user. Defined by MX.
7935
+ transaction_guid = 'transaction_guid_example' # String | The unique identifier for the transaction. Defined by MX.
7936
+ opts = {
7937
+ split_transaction_request_body: MxPlatformRuby::SplitTransactionRequestBody.new({transactions: MxPlatformRuby::SplitTransactionRequest.new({amount: 54.19})}) # SplitTransactionRequestBody |
7938
+ }
7939
+
7940
+ begin
7941
+ # Create split transactions
7942
+ result = api_instance.users_user_guid_transactions_transaction_guid_split_post(user_guid, transaction_guid, opts)
7943
+ p result
7944
+ rescue MxPlatformRuby::ApiError => e
7945
+ puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_post: #{e}"
7946
+ end
7947
+ ```
7948
+
7949
+ #### Using the users_user_guid_transactions_transaction_guid_split_post_with_http_info variant
7950
+
7951
+ This returns an Array which contains the response data, status code and headers.
7952
+
7953
+ > <Array(<SplitTransactionsResponseBody>, Integer, Hash)> users_user_guid_transactions_transaction_guid_split_post_with_http_info(user_guid, transaction_guid, opts)
7954
+
7955
+ ```ruby
7956
+ begin
7957
+ # Create split transactions
7958
+ data, status_code, headers = api_instance.users_user_guid_transactions_transaction_guid_split_post_with_http_info(user_guid, transaction_guid, opts)
7959
+ p status_code # => 2xx
7960
+ p headers # => { ... }
7961
+ p data # => <SplitTransactionsResponseBody>
7962
+ rescue MxPlatformRuby::ApiError => e
7963
+ puts "Error when calling MxPlatformApi->users_user_guid_transactions_transaction_guid_split_post_with_http_info: #{e}"
7964
+ end
7965
+ ```
7966
+
7967
+ ### Parameters
7968
+
7969
+ | Name | Type | Description | Notes |
7970
+ | ---- | ---- | ----------- | ----- |
7971
+ | **user_guid** | **String** | The unique identifier for the user. Defined by MX. | |
7972
+ | **transaction_guid** | **String** | The unique identifier for the transaction. Defined by MX. | |
7973
+ | **split_transaction_request_body** | [**SplitTransactionRequestBody**](SplitTransactionRequestBody.md) | | [optional] |
7974
+
7975
+ ### Return type
7976
+
7977
+ [**SplitTransactionsResponseBody**](SplitTransactionsResponseBody.md)
7978
+
7979
+ ### Authorization
7980
+
7981
+ [basicAuth](../README.md#basicAuth)
7982
+
7983
+ ### HTTP request headers
7984
+
7985
+ - **Content-Type**: application/json
7986
+ - **Accept**: application/vnd.mx.api.v1+json
7987
+
7988
+
7698
7989
  ## verify_member
7699
7990
 
7700
7991
  > <MemberResponseBody> verify_member(member_guid, user_guid)
@@ -0,0 +1,20 @@
1
+ # MxPlatformRuby::RepositionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **guid** | **String** | The unique identifier for the goal. Defined by MX. | |
8
+ | **position** | **Integer** | The priority of the goal in relation to multiple goals. | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'mx-platform-ruby'
14
+
15
+ instance = MxPlatformRuby::RepositionRequest.new(
16
+ guid: GOL-97665947-235c-b213-ca25-8cf0174774f5,
17
+ position: 1
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::RepositionRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **goals** | [**Array&lt;RepositionRequest&gt;**](RepositionRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::RepositionRequestBody.new(
15
+ goals: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::RepositionResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **goals** | [**Array&lt;GoalsResponse&gt;**](GoalsResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::RepositionResponseBody.new(
15
+ goals: null
16
+ )
17
+ ```
18
+
@@ -13,6 +13,7 @@
13
13
  | **guid** | **String** | | [optional] |
14
14
  | **member_guid** | **String** | | [optional] |
15
15
  | **unit_type** | **String** | | [optional] |
16
+ | **updated_at** | **String** | | [optional] |
16
17
  | **user_guid** | **String** | | [optional] |
17
18
 
18
19
  ## Example
@@ -30,6 +31,7 @@ instance = MxPlatformRuby::RewardResponse.new(
30
31
  guid: RWD-1234,
31
32
  member_guid: MBR-4567,
32
33
  unit_type: POINTS,
34
+ updated_at: 2023-06-01T19:18:06Z,
33
35
  user_guid: USR-1234
34
36
  )
35
37
  ```
@@ -13,6 +13,7 @@
13
13
  | **guid** | **String** | | [optional] |
14
14
  | **member_guid** | **String** | | [optional] |
15
15
  | **unit_type** | **String** | | [optional] |
16
+ | **updated_at** | **String** | | [optional] |
16
17
  | **user_guid** | **String** | | [optional] |
17
18
 
18
19
  ## Example
@@ -30,6 +31,7 @@ instance = MxPlatformRuby::RewardsResponse.new(
30
31
  guid: RWD-1234,
31
32
  member_guid: MBR-4567,
32
33
  unit_type: POINTS,
34
+ updated_at: 2023-06-01T19:18:06Z,
33
35
  user_guid: USR-1234
34
36
  )
35
37
  ```
@@ -0,0 +1,24 @@
1
+ # MxPlatformRuby::SplitTransactionRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **amount** | **Float** | Amount of money you want to re-categorize. | |
8
+ | **description** | **String** | Description for the split transaction. | [optional] |
9
+ | **category_guid** | **String** | Unique identifier of the category. | [optional] |
10
+ | **memo** | **String** | Memo for the split transaction | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'mx-platform-ruby'
16
+
17
+ instance = MxPlatformRuby::SplitTransactionRequest.new(
18
+ amount: 54.19,
19
+ description: Chevron Gas,
20
+ category_guid: CAT-b6d61a19-30a7-e852-2703-bdfb4072289e,
21
+ memo: Chips and Soda
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::SplitTransactionRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transactions** | [**SplitTransactionRequest**](SplitTransactionRequest.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::SplitTransactionRequestBody.new(
15
+ transactions: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::SplitTransactionsResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **transactions** | [**Array&lt;TransactionResponse&gt;**](TransactionResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::SplitTransactionsResponseBody.new(
15
+ transactions: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,38 @@
1
+ # MxPlatformRuby::UpdateGoalRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_guid** | **String** | Unique identifier of the account for the goal. | [optional] |
8
+ | **amount** | **Float** | Amount of the goal. | [optional] |
9
+ | **goal_type_name** | **String** | The goal type. | [optional] |
10
+ | **meta_type_name** | **String** | The category of the goal. | [optional] |
11
+ | **name** | **String** | The name of the goal. | [optional] |
12
+ | **completed_at** | **String** | Date and time the goal was completed. | [optional] |
13
+ | **has_been_spent** | **Boolean** | Determines if the goal has been spent. | [optional] |
14
+ | **is_complete** | **Boolean** | Determines if the goal is complete. | [optional] |
15
+ | **metadata** | **String** | Additional information a partner can store on the goal. | [optional] |
16
+ | **position** | **Integer** | The priority of the goal in relation to multiple goals. | [optional] |
17
+ | **targeted_to_complete_at** | **String** | Date and time the goal is to complete. Intended for users to set their own goal completion dates. | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'mx-platform-ruby'
23
+
24
+ instance = MxPlatformRuby::UpdateGoalRequest.new(
25
+ account_guid: ACT-4e431124-4a29-abf9-f059-ab232ac14dbf,
26
+ amount: 4500.5,
27
+ goal_type_name: PAYOFF,
28
+ meta_type_name: VACATION,
29
+ name: Save for Europe,
30
+ completed_at: 2015-06-19T10:37:04-06:00,
31
+ has_been_spent: false,
32
+ is_complete: false,
33
+ metadata: Additional information,
34
+ position: 3,
35
+ targeted_to_complete_at: 2026-12-08 00:00:00.000000
36
+ )
37
+ ```
38
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::UpdateGoalRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **goal** | [**UpdateGoalRequest**](UpdateGoalRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::UpdateGoalRequestBody.new(
15
+ goal: null
16
+ )
17
+ ```
18
+