mx-platform-ruby 0.23.0 → 0.24.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/docs/MxPlatformApi.md +506 -1585
- data/docs/SpendingPlanApi.md +1086 -0
- data/lib/mx-platform-ruby/api/mx_platform_api.rb +6 -1060
- data/lib/mx-platform-ruby/api/spending_plan_api.rb +1076 -0
- data/lib/mx-platform-ruby/version.rb +1 -1
- data/lib/mx-platform-ruby.rb +1 -0
- data/openapi/config.yml +1 -1
- data/spec/api/mx_platform_api_spec.rb +0 -204
- data/spec/api/spending_plan_api_spec.rb +239 -0
- metadata +5 -1
@@ -0,0 +1,1086 @@
|
|
1
|
+
# MxPlatformRuby::SpendingPlanApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mx.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_spending_plan**](SpendingPlanApi.md#create_spending_plan) | **POST** /users/{user_guid}/spending_plans | Create spending plan |
|
8
|
+
| [**create_spending_plan_iteration_item**](SpendingPlanApi.md#create_spending_plan_iteration_item) | **POST** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | Create spending plan iteration item |
|
9
|
+
| [**delete_spending_plan**](SpendingPlanApi.md#delete_spending_plan) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid} | Delete spending plan |
|
10
|
+
| [**delete_spending_plan_account**](SpendingPlanApi.md#delete_spending_plan_account) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Delete spending plan account |
|
11
|
+
| [**delete_spending_plan_iteration_item**](SpendingPlanApi.md#delete_spending_plan_iteration_item) | **DELETE** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Delete spending plan iteration item |
|
12
|
+
| [**list_spending_plan_accounts**](SpendingPlanApi.md#list_spending_plan_accounts) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts | List spending plan accounts |
|
13
|
+
| [**list_spending_plan_iteration_items**](SpendingPlanApi.md#list_spending_plan_iteration_items) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items | List spending plan iteration items |
|
14
|
+
| [**list_spending_plan_iterations**](SpendingPlanApi.md#list_spending_plan_iterations) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations | List spending plan iterations |
|
15
|
+
| [**list_spending_plans**](SpendingPlanApi.md#list_spending_plans) | **GET** /users/{user_guid}/spending_plans | List spending plans |
|
16
|
+
| [**read_spending_plan_account**](SpendingPlanApi.md#read_spending_plan_account) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid} | Read spending plan account |
|
17
|
+
| [**read_spending_plan_iteration**](SpendingPlanApi.md#read_spending_plan_iteration) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number} | Read a spending plan iteration |
|
18
|
+
| [**read_spending_plan_iteration_item**](SpendingPlanApi.md#read_spending_plan_iteration_item) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Read a spending plan iteration item |
|
19
|
+
| [**read_spending_plan_user**](SpendingPlanApi.md#read_spending_plan_user) | **GET** /users/{user_guid}/spending_plans/{spending_plan_guid} | Read a spending plan for a user |
|
20
|
+
| [**update_spending_plan_iteration_item**](SpendingPlanApi.md#update_spending_plan_iteration_item) | **PUT** /users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid} | Update a spending plan iteration item |
|
21
|
+
|
22
|
+
|
23
|
+
## create_spending_plan
|
24
|
+
|
25
|
+
> <SpendingPlanResponse> create_spending_plan(user_guid)
|
26
|
+
|
27
|
+
Create spending plan
|
28
|
+
|
29
|
+
This endpoint creates a new `spending_plan` for the user.
|
30
|
+
|
31
|
+
### Examples
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'time'
|
35
|
+
require 'mx-platform-ruby'
|
36
|
+
# setup authorization
|
37
|
+
MxPlatformRuby.configure do |config|
|
38
|
+
# Configure HTTP basic authorization: basicAuth
|
39
|
+
config.username = 'YOUR USERNAME'
|
40
|
+
config.password = 'YOUR PASSWORD'
|
41
|
+
end
|
42
|
+
|
43
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
44
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
45
|
+
|
46
|
+
begin
|
47
|
+
# Create spending plan
|
48
|
+
result = api_instance.create_spending_plan(user_guid)
|
49
|
+
p result
|
50
|
+
rescue MxPlatformRuby::ApiError => e
|
51
|
+
puts "Error when calling SpendingPlanApi->create_spending_plan: #{e}"
|
52
|
+
end
|
53
|
+
```
|
54
|
+
|
55
|
+
#### Using the create_spending_plan_with_http_info variant
|
56
|
+
|
57
|
+
This returns an Array which contains the response data, status code and headers.
|
58
|
+
|
59
|
+
> <Array(<SpendingPlanResponse>, Integer, Hash)> create_spending_plan_with_http_info(user_guid)
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
begin
|
63
|
+
# Create spending plan
|
64
|
+
data, status_code, headers = api_instance.create_spending_plan_with_http_info(user_guid)
|
65
|
+
p status_code # => 2xx
|
66
|
+
p headers # => { ... }
|
67
|
+
p data # => <SpendingPlanResponse>
|
68
|
+
rescue MxPlatformRuby::ApiError => e
|
69
|
+
puts "Error when calling SpendingPlanApi->create_spending_plan_with_http_info: #{e}"
|
70
|
+
end
|
71
|
+
```
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
| Name | Type | Description | Notes |
|
76
|
+
| ---- | ---- | ----------- | ----- |
|
77
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
78
|
+
|
79
|
+
### Return type
|
80
|
+
|
81
|
+
[**SpendingPlanResponse**](SpendingPlanResponse.md)
|
82
|
+
|
83
|
+
### Authorization
|
84
|
+
|
85
|
+
[basicAuth](../README.md#basicAuth)
|
86
|
+
|
87
|
+
### HTTP request headers
|
88
|
+
|
89
|
+
- **Content-Type**: Not defined
|
90
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
91
|
+
|
92
|
+
|
93
|
+
## create_spending_plan_iteration_item
|
94
|
+
|
95
|
+
> <SpendingPlanIterationItemResponse> create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
96
|
+
|
97
|
+
Create spending plan iteration item
|
98
|
+
|
99
|
+
This endpoint creates a new `spending_plan_iteration_item`.
|
100
|
+
|
101
|
+
### Examples
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
require 'time'
|
105
|
+
require 'mx-platform-ruby'
|
106
|
+
# setup authorization
|
107
|
+
MxPlatformRuby.configure do |config|
|
108
|
+
# Configure HTTP basic authorization: basicAuth
|
109
|
+
config.username = 'YOUR USERNAME'
|
110
|
+
config.password = 'YOUR PASSWORD'
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
114
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
115
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
116
|
+
spending_plan_iteration_item_create_request_body = MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody.new({planned_amount: 110}) # SpendingPlanIterationItemCreateRequestBody | Iteration item to be created with required parameters (planned_amount)
|
117
|
+
|
118
|
+
begin
|
119
|
+
# Create spending plan iteration item
|
120
|
+
result = api_instance.create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
121
|
+
p result
|
122
|
+
rescue MxPlatformRuby::ApiError => e
|
123
|
+
puts "Error when calling SpendingPlanApi->create_spending_plan_iteration_item: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
#### Using the create_spending_plan_iteration_item_with_http_info variant
|
128
|
+
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
130
|
+
|
131
|
+
> <Array(<SpendingPlanIterationItemResponse>, Integer, Hash)> create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
132
|
+
|
133
|
+
```ruby
|
134
|
+
begin
|
135
|
+
# Create spending plan iteration item
|
136
|
+
data, status_code, headers = api_instance.create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body)
|
137
|
+
p status_code # => 2xx
|
138
|
+
p headers # => { ... }
|
139
|
+
p data # => <SpendingPlanIterationItemResponse>
|
140
|
+
rescue MxPlatformRuby::ApiError => e
|
141
|
+
puts "Error when calling SpendingPlanApi->create_spending_plan_iteration_item_with_http_info: #{e}"
|
142
|
+
end
|
143
|
+
```
|
144
|
+
|
145
|
+
### Parameters
|
146
|
+
|
147
|
+
| Name | Type | Description | Notes |
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
149
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
150
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
151
|
+
| **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md) | Iteration item to be created with required parameters (planned_amount) | |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md)
|
156
|
+
|
157
|
+
### Authorization
|
158
|
+
|
159
|
+
[basicAuth](../README.md#basicAuth)
|
160
|
+
|
161
|
+
### HTTP request headers
|
162
|
+
|
163
|
+
- **Content-Type**: application/json
|
164
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
165
|
+
|
166
|
+
|
167
|
+
## delete_spending_plan
|
168
|
+
|
169
|
+
> delete_spending_plan(user_guid, spending_plan_guid)
|
170
|
+
|
171
|
+
Delete spending plan
|
172
|
+
|
173
|
+
Use this endpoint to delete a user's `spending_plan`.
|
174
|
+
|
175
|
+
### Examples
|
176
|
+
|
177
|
+
```ruby
|
178
|
+
require 'time'
|
179
|
+
require 'mx-platform-ruby'
|
180
|
+
# setup authorization
|
181
|
+
MxPlatformRuby.configure do |config|
|
182
|
+
# Configure HTTP basic authorization: basicAuth
|
183
|
+
config.username = 'YOUR USERNAME'
|
184
|
+
config.password = 'YOUR PASSWORD'
|
185
|
+
end
|
186
|
+
|
187
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
188
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique ID for a `user`.
|
189
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
190
|
+
|
191
|
+
begin
|
192
|
+
# Delete spending plan
|
193
|
+
api_instance.delete_spending_plan(user_guid, spending_plan_guid)
|
194
|
+
rescue MxPlatformRuby::ApiError => e
|
195
|
+
puts "Error when calling SpendingPlanApi->delete_spending_plan: #{e}"
|
196
|
+
end
|
197
|
+
```
|
198
|
+
|
199
|
+
#### Using the delete_spending_plan_with_http_info variant
|
200
|
+
|
201
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
202
|
+
|
203
|
+
> <Array(nil, Integer, Hash)> delete_spending_plan_with_http_info(user_guid, spending_plan_guid)
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
begin
|
207
|
+
# Delete spending plan
|
208
|
+
data, status_code, headers = api_instance.delete_spending_plan_with_http_info(user_guid, spending_plan_guid)
|
209
|
+
p status_code # => 2xx
|
210
|
+
p headers # => { ... }
|
211
|
+
p data # => nil
|
212
|
+
rescue MxPlatformRuby::ApiError => e
|
213
|
+
puts "Error when calling SpendingPlanApi->delete_spending_plan_with_http_info: #{e}"
|
214
|
+
end
|
215
|
+
```
|
216
|
+
|
217
|
+
### Parameters
|
218
|
+
|
219
|
+
| Name | Type | Description | Notes |
|
220
|
+
| ---- | ---- | ----------- | ----- |
|
221
|
+
| **user_guid** | **String** | The unique ID for a `user`. | |
|
222
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
223
|
+
|
224
|
+
### Return type
|
225
|
+
|
226
|
+
nil (empty response body)
|
227
|
+
|
228
|
+
### Authorization
|
229
|
+
|
230
|
+
[basicAuth](../README.md#basicAuth)
|
231
|
+
|
232
|
+
### HTTP request headers
|
233
|
+
|
234
|
+
- **Content-Type**: Not defined
|
235
|
+
- **Accept**: Not defined
|
236
|
+
|
237
|
+
|
238
|
+
## delete_spending_plan_account
|
239
|
+
|
240
|
+
> delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid)
|
241
|
+
|
242
|
+
Delete spending plan account
|
243
|
+
|
244
|
+
Use this endpoint to delete a `spending_plan_account`.
|
245
|
+
|
246
|
+
### Examples
|
247
|
+
|
248
|
+
```ruby
|
249
|
+
require 'time'
|
250
|
+
require 'mx-platform-ruby'
|
251
|
+
# setup authorization
|
252
|
+
MxPlatformRuby.configure do |config|
|
253
|
+
# Configure HTTP basic authorization: basicAuth
|
254
|
+
config.username = 'YOUR USERNAME'
|
255
|
+
config.password = 'YOUR PASSWORD'
|
256
|
+
end
|
257
|
+
|
258
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
259
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique ID for a `user`.
|
260
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
261
|
+
spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # String | The unique ID for the specified account.
|
262
|
+
|
263
|
+
begin
|
264
|
+
# Delete spending plan account
|
265
|
+
api_instance.delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid)
|
266
|
+
rescue MxPlatformRuby::ApiError => e
|
267
|
+
puts "Error when calling SpendingPlanApi->delete_spending_plan_account: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
#### Using the delete_spending_plan_account_with_http_info variant
|
272
|
+
|
273
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
274
|
+
|
275
|
+
> <Array(nil, Integer, Hash)> delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid)
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
begin
|
279
|
+
# Delete spending plan account
|
280
|
+
data, status_code, headers = api_instance.delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid)
|
281
|
+
p status_code # => 2xx
|
282
|
+
p headers # => { ... }
|
283
|
+
p data # => nil
|
284
|
+
rescue MxPlatformRuby::ApiError => e
|
285
|
+
puts "Error when calling SpendingPlanApi->delete_spending_plan_account_with_http_info: #{e}"
|
286
|
+
end
|
287
|
+
```
|
288
|
+
|
289
|
+
### Parameters
|
290
|
+
|
291
|
+
| Name | Type | Description | Notes |
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
293
|
+
| **user_guid** | **String** | The unique ID for a `user`. | |
|
294
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
295
|
+
| **spending_plan_account_guid** | **String** | The unique ID for the specified account. | |
|
296
|
+
|
297
|
+
### Return type
|
298
|
+
|
299
|
+
nil (empty response body)
|
300
|
+
|
301
|
+
### Authorization
|
302
|
+
|
303
|
+
[basicAuth](../README.md#basicAuth)
|
304
|
+
|
305
|
+
### HTTP request headers
|
306
|
+
|
307
|
+
- **Content-Type**: Not defined
|
308
|
+
- **Accept**: Not defined
|
309
|
+
|
310
|
+
|
311
|
+
## delete_spending_plan_iteration_item
|
312
|
+
|
313
|
+
> delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid)
|
314
|
+
|
315
|
+
Delete spending plan iteration item
|
316
|
+
|
317
|
+
Use this endpoint to delete a spending plan `iteration_item`.
|
318
|
+
|
319
|
+
### Examples
|
320
|
+
|
321
|
+
```ruby
|
322
|
+
require 'time'
|
323
|
+
require 'mx-platform-ruby'
|
324
|
+
# setup authorization
|
325
|
+
MxPlatformRuby.configure do |config|
|
326
|
+
# Configure HTTP basic authorization: basicAuth
|
327
|
+
config.username = 'YOUR USERNAME'
|
328
|
+
config.password = 'YOUR PASSWORD'
|
329
|
+
end
|
330
|
+
|
331
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
332
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique ID for a `user`.
|
333
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
334
|
+
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
335
|
+
|
336
|
+
begin
|
337
|
+
# Delete spending plan iteration item
|
338
|
+
api_instance.delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid)
|
339
|
+
rescue MxPlatformRuby::ApiError => e
|
340
|
+
puts "Error when calling SpendingPlanApi->delete_spending_plan_iteration_item: #{e}"
|
341
|
+
end
|
342
|
+
```
|
343
|
+
|
344
|
+
#### Using the delete_spending_plan_iteration_item_with_http_info variant
|
345
|
+
|
346
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
347
|
+
|
348
|
+
> <Array(nil, Integer, Hash)> delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid)
|
349
|
+
|
350
|
+
```ruby
|
351
|
+
begin
|
352
|
+
# Delete spending plan iteration item
|
353
|
+
data, status_code, headers = api_instance.delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid)
|
354
|
+
p status_code # => 2xx
|
355
|
+
p headers # => { ... }
|
356
|
+
p data # => nil
|
357
|
+
rescue MxPlatformRuby::ApiError => e
|
358
|
+
puts "Error when calling SpendingPlanApi->delete_spending_plan_iteration_item_with_http_info: #{e}"
|
359
|
+
end
|
360
|
+
```
|
361
|
+
|
362
|
+
### Parameters
|
363
|
+
|
364
|
+
| Name | Type | Description | Notes |
|
365
|
+
| ---- | ---- | ----------- | ----- |
|
366
|
+
| **user_guid** | **String** | The unique ID for a `user`. | |
|
367
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
368
|
+
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
369
|
+
|
370
|
+
### Return type
|
371
|
+
|
372
|
+
nil (empty response body)
|
373
|
+
|
374
|
+
### Authorization
|
375
|
+
|
376
|
+
[basicAuth](../README.md#basicAuth)
|
377
|
+
|
378
|
+
### HTTP request headers
|
379
|
+
|
380
|
+
- **Content-Type**: Not defined
|
381
|
+
- **Accept**: Not defined
|
382
|
+
|
383
|
+
|
384
|
+
## list_spending_plan_accounts
|
385
|
+
|
386
|
+
> <SpendingPlanAccountsResponse> list_spending_plan_accounts(user_guid, spending_plan_guid, opts)
|
387
|
+
|
388
|
+
List spending plan accounts
|
389
|
+
|
390
|
+
Use this endpoint to list all the spending plan accounts associated with the spending plan.
|
391
|
+
|
392
|
+
### Examples
|
393
|
+
|
394
|
+
```ruby
|
395
|
+
require 'time'
|
396
|
+
require 'mx-platform-ruby'
|
397
|
+
# setup authorization
|
398
|
+
MxPlatformRuby.configure do |config|
|
399
|
+
# Configure HTTP basic authorization: basicAuth
|
400
|
+
config.username = 'YOUR USERNAME'
|
401
|
+
config.password = 'YOUR PASSWORD'
|
402
|
+
end
|
403
|
+
|
404
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
405
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
406
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
407
|
+
opts = {
|
408
|
+
page: 1, # Integer | Specify current page.
|
409
|
+
records_per_page: 10 # Integer | Specify records per page.
|
410
|
+
}
|
411
|
+
|
412
|
+
begin
|
413
|
+
# List spending plan accounts
|
414
|
+
result = api_instance.list_spending_plan_accounts(user_guid, spending_plan_guid, opts)
|
415
|
+
p result
|
416
|
+
rescue MxPlatformRuby::ApiError => e
|
417
|
+
puts "Error when calling SpendingPlanApi->list_spending_plan_accounts: #{e}"
|
418
|
+
end
|
419
|
+
```
|
420
|
+
|
421
|
+
#### Using the list_spending_plan_accounts_with_http_info variant
|
422
|
+
|
423
|
+
This returns an Array which contains the response data, status code and headers.
|
424
|
+
|
425
|
+
> <Array(<SpendingPlanAccountsResponse>, Integer, Hash)> list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts)
|
426
|
+
|
427
|
+
```ruby
|
428
|
+
begin
|
429
|
+
# List spending plan accounts
|
430
|
+
data, status_code, headers = api_instance.list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts)
|
431
|
+
p status_code # => 2xx
|
432
|
+
p headers # => { ... }
|
433
|
+
p data # => <SpendingPlanAccountsResponse>
|
434
|
+
rescue MxPlatformRuby::ApiError => e
|
435
|
+
puts "Error when calling SpendingPlanApi->list_spending_plan_accounts_with_http_info: #{e}"
|
436
|
+
end
|
437
|
+
```
|
438
|
+
|
439
|
+
### Parameters
|
440
|
+
|
441
|
+
| Name | Type | Description | Notes |
|
442
|
+
| ---- | ---- | ----------- | ----- |
|
443
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
444
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
445
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
446
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
447
|
+
|
448
|
+
### Return type
|
449
|
+
|
450
|
+
[**SpendingPlanAccountsResponse**](SpendingPlanAccountsResponse.md)
|
451
|
+
|
452
|
+
### Authorization
|
453
|
+
|
454
|
+
[basicAuth](../README.md#basicAuth)
|
455
|
+
|
456
|
+
### HTTP request headers
|
457
|
+
|
458
|
+
- **Content-Type**: Not defined
|
459
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
460
|
+
|
461
|
+
|
462
|
+
## list_spending_plan_iteration_items
|
463
|
+
|
464
|
+
> <SpendingPlanIterationItemsResponseBody> list_spending_plan_iteration_items(user_guid, spending_plan_guid, opts)
|
465
|
+
|
466
|
+
List spending plan iteration items
|
467
|
+
|
468
|
+
Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
|
469
|
+
|
470
|
+
### Examples
|
471
|
+
|
472
|
+
```ruby
|
473
|
+
require 'time'
|
474
|
+
require 'mx-platform-ruby'
|
475
|
+
# setup authorization
|
476
|
+
MxPlatformRuby.configure do |config|
|
477
|
+
# Configure HTTP basic authorization: basicAuth
|
478
|
+
config.username = 'YOUR USERNAME'
|
479
|
+
config.password = 'YOUR PASSWORD'
|
480
|
+
end
|
481
|
+
|
482
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
483
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
484
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
485
|
+
opts = {
|
486
|
+
page: 1, # Integer | Specify current page.
|
487
|
+
records_per_page: 10 # Integer | Specify records per page.
|
488
|
+
}
|
489
|
+
|
490
|
+
begin
|
491
|
+
# List spending plan iteration items
|
492
|
+
result = api_instance.list_spending_plan_iteration_items(user_guid, spending_plan_guid, opts)
|
493
|
+
p result
|
494
|
+
rescue MxPlatformRuby::ApiError => e
|
495
|
+
puts "Error when calling SpendingPlanApi->list_spending_plan_iteration_items: #{e}"
|
496
|
+
end
|
497
|
+
```
|
498
|
+
|
499
|
+
#### Using the list_spending_plan_iteration_items_with_http_info variant
|
500
|
+
|
501
|
+
This returns an Array which contains the response data, status code and headers.
|
502
|
+
|
503
|
+
> <Array(<SpendingPlanIterationItemsResponseBody>, Integer, Hash)> list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts)
|
504
|
+
|
505
|
+
```ruby
|
506
|
+
begin
|
507
|
+
# List spending plan iteration items
|
508
|
+
data, status_code, headers = api_instance.list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts)
|
509
|
+
p status_code # => 2xx
|
510
|
+
p headers # => { ... }
|
511
|
+
p data # => <SpendingPlanIterationItemsResponseBody>
|
512
|
+
rescue MxPlatformRuby::ApiError => e
|
513
|
+
puts "Error when calling SpendingPlanApi->list_spending_plan_iteration_items_with_http_info: #{e}"
|
514
|
+
end
|
515
|
+
```
|
516
|
+
|
517
|
+
### Parameters
|
518
|
+
|
519
|
+
| Name | Type | Description | Notes |
|
520
|
+
| ---- | ---- | ----------- | ----- |
|
521
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
522
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
523
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
524
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
525
|
+
|
526
|
+
### Return type
|
527
|
+
|
528
|
+
[**SpendingPlanIterationItemsResponseBody**](SpendingPlanIterationItemsResponseBody.md)
|
529
|
+
|
530
|
+
### Authorization
|
531
|
+
|
532
|
+
[basicAuth](../README.md#basicAuth)
|
533
|
+
|
534
|
+
### HTTP request headers
|
535
|
+
|
536
|
+
- **Content-Type**: Not defined
|
537
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
538
|
+
|
539
|
+
|
540
|
+
## list_spending_plan_iterations
|
541
|
+
|
542
|
+
> <SpendingPlanIterationsResponse> list_spending_plan_iterations(user_guid, spending_plan_guid, opts)
|
543
|
+
|
544
|
+
List spending plan iterations
|
545
|
+
|
546
|
+
Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
|
547
|
+
|
548
|
+
### Examples
|
549
|
+
|
550
|
+
```ruby
|
551
|
+
require 'time'
|
552
|
+
require 'mx-platform-ruby'
|
553
|
+
# setup authorization
|
554
|
+
MxPlatformRuby.configure do |config|
|
555
|
+
# Configure HTTP basic authorization: basicAuth
|
556
|
+
config.username = 'YOUR USERNAME'
|
557
|
+
config.password = 'YOUR PASSWORD'
|
558
|
+
end
|
559
|
+
|
560
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
561
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
562
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
563
|
+
opts = {
|
564
|
+
page: 1, # Integer | Specify current page.
|
565
|
+
records_per_page: 10 # Integer | Specify records per page.
|
566
|
+
}
|
567
|
+
|
568
|
+
begin
|
569
|
+
# List spending plan iterations
|
570
|
+
result = api_instance.list_spending_plan_iterations(user_guid, spending_plan_guid, opts)
|
571
|
+
p result
|
572
|
+
rescue MxPlatformRuby::ApiError => e
|
573
|
+
puts "Error when calling SpendingPlanApi->list_spending_plan_iterations: #{e}"
|
574
|
+
end
|
575
|
+
```
|
576
|
+
|
577
|
+
#### Using the list_spending_plan_iterations_with_http_info variant
|
578
|
+
|
579
|
+
This returns an Array which contains the response data, status code and headers.
|
580
|
+
|
581
|
+
> <Array(<SpendingPlanIterationsResponse>, Integer, Hash)> list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts)
|
582
|
+
|
583
|
+
```ruby
|
584
|
+
begin
|
585
|
+
# List spending plan iterations
|
586
|
+
data, status_code, headers = api_instance.list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts)
|
587
|
+
p status_code # => 2xx
|
588
|
+
p headers # => { ... }
|
589
|
+
p data # => <SpendingPlanIterationsResponse>
|
590
|
+
rescue MxPlatformRuby::ApiError => e
|
591
|
+
puts "Error when calling SpendingPlanApi->list_spending_plan_iterations_with_http_info: #{e}"
|
592
|
+
end
|
593
|
+
```
|
594
|
+
|
595
|
+
### Parameters
|
596
|
+
|
597
|
+
| Name | Type | Description | Notes |
|
598
|
+
| ---- | ---- | ----------- | ----- |
|
599
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
600
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
601
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
602
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
603
|
+
|
604
|
+
### Return type
|
605
|
+
|
606
|
+
[**SpendingPlanIterationsResponse**](SpendingPlanIterationsResponse.md)
|
607
|
+
|
608
|
+
### Authorization
|
609
|
+
|
610
|
+
[basicAuth](../README.md#basicAuth)
|
611
|
+
|
612
|
+
### HTTP request headers
|
613
|
+
|
614
|
+
- **Content-Type**: Not defined
|
615
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
616
|
+
|
617
|
+
|
618
|
+
## list_spending_plans
|
619
|
+
|
620
|
+
> <SpendingPlansResponseBody> list_spending_plans(user_guid, opts)
|
621
|
+
|
622
|
+
List spending plans
|
623
|
+
|
624
|
+
Use this endpoint to list all the spending plans associated with the user.
|
625
|
+
|
626
|
+
### Examples
|
627
|
+
|
628
|
+
```ruby
|
629
|
+
require 'time'
|
630
|
+
require 'mx-platform-ruby'
|
631
|
+
# setup authorization
|
632
|
+
MxPlatformRuby.configure do |config|
|
633
|
+
# Configure HTTP basic authorization: basicAuth
|
634
|
+
config.username = 'YOUR USERNAME'
|
635
|
+
config.password = 'YOUR PASSWORD'
|
636
|
+
end
|
637
|
+
|
638
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
639
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
640
|
+
opts = {
|
641
|
+
page: 1, # Integer | Specify current page.
|
642
|
+
records_per_page: 10 # Integer | Specify records per page.
|
643
|
+
}
|
644
|
+
|
645
|
+
begin
|
646
|
+
# List spending plans
|
647
|
+
result = api_instance.list_spending_plans(user_guid, opts)
|
648
|
+
p result
|
649
|
+
rescue MxPlatformRuby::ApiError => e
|
650
|
+
puts "Error when calling SpendingPlanApi->list_spending_plans: #{e}"
|
651
|
+
end
|
652
|
+
```
|
653
|
+
|
654
|
+
#### Using the list_spending_plans_with_http_info variant
|
655
|
+
|
656
|
+
This returns an Array which contains the response data, status code and headers.
|
657
|
+
|
658
|
+
> <Array(<SpendingPlansResponseBody>, Integer, Hash)> list_spending_plans_with_http_info(user_guid, opts)
|
659
|
+
|
660
|
+
```ruby
|
661
|
+
begin
|
662
|
+
# List spending plans
|
663
|
+
data, status_code, headers = api_instance.list_spending_plans_with_http_info(user_guid, opts)
|
664
|
+
p status_code # => 2xx
|
665
|
+
p headers # => { ... }
|
666
|
+
p data # => <SpendingPlansResponseBody>
|
667
|
+
rescue MxPlatformRuby::ApiError => e
|
668
|
+
puts "Error when calling SpendingPlanApi->list_spending_plans_with_http_info: #{e}"
|
669
|
+
end
|
670
|
+
```
|
671
|
+
|
672
|
+
### Parameters
|
673
|
+
|
674
|
+
| Name | Type | Description | Notes |
|
675
|
+
| ---- | ---- | ----------- | ----- |
|
676
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
677
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
678
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
679
|
+
|
680
|
+
### Return type
|
681
|
+
|
682
|
+
[**SpendingPlansResponseBody**](SpendingPlansResponseBody.md)
|
683
|
+
|
684
|
+
### Authorization
|
685
|
+
|
686
|
+
[basicAuth](../README.md#basicAuth)
|
687
|
+
|
688
|
+
### HTTP request headers
|
689
|
+
|
690
|
+
- **Content-Type**: Not defined
|
691
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
692
|
+
|
693
|
+
|
694
|
+
## read_spending_plan_account
|
695
|
+
|
696
|
+
> <SpendingPlanAccountResponse> read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
697
|
+
|
698
|
+
Read spending plan account
|
699
|
+
|
700
|
+
Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
|
701
|
+
|
702
|
+
### Examples
|
703
|
+
|
704
|
+
```ruby
|
705
|
+
require 'time'
|
706
|
+
require 'mx-platform-ruby'
|
707
|
+
# setup authorization
|
708
|
+
MxPlatformRuby.configure do |config|
|
709
|
+
# Configure HTTP basic authorization: basicAuth
|
710
|
+
config.username = 'YOUR USERNAME'
|
711
|
+
config.password = 'YOUR PASSWORD'
|
712
|
+
end
|
713
|
+
|
714
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
715
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
716
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
717
|
+
spending_plan_account_guid = 'ACT-e9f80fee-84da-7s7r-9a5e-0346g4279b4c' # String | The unique ID for the specified account.
|
718
|
+
opts = {
|
719
|
+
page: 1, # Integer | Specify current page.
|
720
|
+
records_per_page: 10 # Integer | Specify records per page.
|
721
|
+
}
|
722
|
+
|
723
|
+
begin
|
724
|
+
# Read spending plan account
|
725
|
+
result = api_instance.read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
726
|
+
p result
|
727
|
+
rescue MxPlatformRuby::ApiError => e
|
728
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_account: #{e}"
|
729
|
+
end
|
730
|
+
```
|
731
|
+
|
732
|
+
#### Using the read_spending_plan_account_with_http_info variant
|
733
|
+
|
734
|
+
This returns an Array which contains the response data, status code and headers.
|
735
|
+
|
736
|
+
> <Array(<SpendingPlanAccountResponse>, Integer, Hash)> read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
737
|
+
|
738
|
+
```ruby
|
739
|
+
begin
|
740
|
+
# Read spending plan account
|
741
|
+
data, status_code, headers = api_instance.read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
|
742
|
+
p status_code # => 2xx
|
743
|
+
p headers # => { ... }
|
744
|
+
p data # => <SpendingPlanAccountResponse>
|
745
|
+
rescue MxPlatformRuby::ApiError => e
|
746
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_account_with_http_info: #{e}"
|
747
|
+
end
|
748
|
+
```
|
749
|
+
|
750
|
+
### Parameters
|
751
|
+
|
752
|
+
| Name | Type | Description | Notes |
|
753
|
+
| ---- | ---- | ----------- | ----- |
|
754
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
755
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
756
|
+
| **spending_plan_account_guid** | **String** | The unique ID for the specified account. | |
|
757
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
758
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
759
|
+
|
760
|
+
### Return type
|
761
|
+
|
762
|
+
[**SpendingPlanAccountResponse**](SpendingPlanAccountResponse.md)
|
763
|
+
|
764
|
+
### Authorization
|
765
|
+
|
766
|
+
[basicAuth](../README.md#basicAuth)
|
767
|
+
|
768
|
+
### HTTP request headers
|
769
|
+
|
770
|
+
- **Content-Type**: Not defined
|
771
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
772
|
+
|
773
|
+
|
774
|
+
## read_spending_plan_iteration
|
775
|
+
|
776
|
+
> <SpendingPlanIterationResponse> read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, opts)
|
777
|
+
|
778
|
+
Read a spending plan iteration
|
779
|
+
|
780
|
+
Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
|
781
|
+
|
782
|
+
### Examples
|
783
|
+
|
784
|
+
```ruby
|
785
|
+
require 'time'
|
786
|
+
require 'mx-platform-ruby'
|
787
|
+
# setup authorization
|
788
|
+
MxPlatformRuby.configure do |config|
|
789
|
+
# Configure HTTP basic authorization: basicAuth
|
790
|
+
config.username = 'YOUR USERNAME'
|
791
|
+
config.password = 'YOUR PASSWORD'
|
792
|
+
end
|
793
|
+
|
794
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
795
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
796
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
797
|
+
iteration_number = 1 # Integer | The current iteration number for the spending plan `iteration``.
|
798
|
+
opts = {
|
799
|
+
page: 1, # Integer | Specify current page.
|
800
|
+
records_per_page: 10 # Integer | Specify records per page.
|
801
|
+
}
|
802
|
+
|
803
|
+
begin
|
804
|
+
# Read a spending plan iteration
|
805
|
+
result = api_instance.read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, opts)
|
806
|
+
p result
|
807
|
+
rescue MxPlatformRuby::ApiError => e
|
808
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_iteration: #{e}"
|
809
|
+
end
|
810
|
+
```
|
811
|
+
|
812
|
+
#### Using the read_spending_plan_iteration_with_http_info variant
|
813
|
+
|
814
|
+
This returns an Array which contains the response data, status code and headers.
|
815
|
+
|
816
|
+
> <Array(<SpendingPlanIterationResponse>, Integer, Hash)> read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts)
|
817
|
+
|
818
|
+
```ruby
|
819
|
+
begin
|
820
|
+
# Read a spending plan iteration
|
821
|
+
data, status_code, headers = api_instance.read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts)
|
822
|
+
p status_code # => 2xx
|
823
|
+
p headers # => { ... }
|
824
|
+
p data # => <SpendingPlanIterationResponse>
|
825
|
+
rescue MxPlatformRuby::ApiError => e
|
826
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_iteration_with_http_info: #{e}"
|
827
|
+
end
|
828
|
+
```
|
829
|
+
|
830
|
+
### Parameters
|
831
|
+
|
832
|
+
| Name | Type | Description | Notes |
|
833
|
+
| ---- | ---- | ----------- | ----- |
|
834
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
835
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
836
|
+
| **iteration_number** | **Integer** | The current iteration number for the spending plan `iteration``. | |
|
837
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
838
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
839
|
+
|
840
|
+
### Return type
|
841
|
+
|
842
|
+
[**SpendingPlanIterationResponse**](SpendingPlanIterationResponse.md)
|
843
|
+
|
844
|
+
### Authorization
|
845
|
+
|
846
|
+
[basicAuth](../README.md#basicAuth)
|
847
|
+
|
848
|
+
### HTTP request headers
|
849
|
+
|
850
|
+
- **Content-Type**: Not defined
|
851
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
852
|
+
|
853
|
+
|
854
|
+
## read_spending_plan_iteration_item
|
855
|
+
|
856
|
+
> <SpendingPlanIterationItemResponse> read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
857
|
+
|
858
|
+
Read a spending plan iteration item
|
859
|
+
|
860
|
+
Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
|
861
|
+
|
862
|
+
### Examples
|
863
|
+
|
864
|
+
```ruby
|
865
|
+
require 'time'
|
866
|
+
require 'mx-platform-ruby'
|
867
|
+
# setup authorization
|
868
|
+
MxPlatformRuby.configure do |config|
|
869
|
+
# Configure HTTP basic authorization: basicAuth
|
870
|
+
config.username = 'YOUR USERNAME'
|
871
|
+
config.password = 'YOUR PASSWORD'
|
872
|
+
end
|
873
|
+
|
874
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
875
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
876
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
877
|
+
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
878
|
+
opts = {
|
879
|
+
page: 1, # Integer | Specify current page.
|
880
|
+
records_per_page: 10 # Integer | Specify records per page.
|
881
|
+
}
|
882
|
+
|
883
|
+
begin
|
884
|
+
# Read a spending plan iteration item
|
885
|
+
result = api_instance.read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
886
|
+
p result
|
887
|
+
rescue MxPlatformRuby::ApiError => e
|
888
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_iteration_item: #{e}"
|
889
|
+
end
|
890
|
+
```
|
891
|
+
|
892
|
+
#### Using the read_spending_plan_iteration_item_with_http_info variant
|
893
|
+
|
894
|
+
This returns an Array which contains the response data, status code and headers.
|
895
|
+
|
896
|
+
> <Array(<SpendingPlanIterationItemResponse>, Integer, Hash)> read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
897
|
+
|
898
|
+
```ruby
|
899
|
+
begin
|
900
|
+
# Read a spending plan iteration item
|
901
|
+
data, status_code, headers = api_instance.read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
|
902
|
+
p status_code # => 2xx
|
903
|
+
p headers # => { ... }
|
904
|
+
p data # => <SpendingPlanIterationItemResponse>
|
905
|
+
rescue MxPlatformRuby::ApiError => e
|
906
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_iteration_item_with_http_info: #{e}"
|
907
|
+
end
|
908
|
+
```
|
909
|
+
|
910
|
+
### Parameters
|
911
|
+
|
912
|
+
| Name | Type | Description | Notes |
|
913
|
+
| ---- | ---- | ----------- | ----- |
|
914
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
915
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
916
|
+
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
917
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
918
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
919
|
+
|
920
|
+
### Return type
|
921
|
+
|
922
|
+
[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md)
|
923
|
+
|
924
|
+
### Authorization
|
925
|
+
|
926
|
+
[basicAuth](../README.md#basicAuth)
|
927
|
+
|
928
|
+
### HTTP request headers
|
929
|
+
|
930
|
+
- **Content-Type**: Not defined
|
931
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
932
|
+
|
933
|
+
|
934
|
+
## read_spending_plan_user
|
935
|
+
|
936
|
+
> <SpendingPlanResponse> read_spending_plan_user(user_guid, spending_plan_guid, opts)
|
937
|
+
|
938
|
+
Read a spending plan for a user
|
939
|
+
|
940
|
+
Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
|
941
|
+
|
942
|
+
### Examples
|
943
|
+
|
944
|
+
```ruby
|
945
|
+
require 'time'
|
946
|
+
require 'mx-platform-ruby'
|
947
|
+
# setup authorization
|
948
|
+
MxPlatformRuby.configure do |config|
|
949
|
+
# Configure HTTP basic authorization: basicAuth
|
950
|
+
config.username = 'YOUR USERNAME'
|
951
|
+
config.password = 'YOUR PASSWORD'
|
952
|
+
end
|
953
|
+
|
954
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
955
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
956
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
957
|
+
opts = {
|
958
|
+
page: 1, # Integer | Specify current page.
|
959
|
+
records_per_page: 10 # Integer | Specify records per page.
|
960
|
+
}
|
961
|
+
|
962
|
+
begin
|
963
|
+
# Read a spending plan for a user
|
964
|
+
result = api_instance.read_spending_plan_user(user_guid, spending_plan_guid, opts)
|
965
|
+
p result
|
966
|
+
rescue MxPlatformRuby::ApiError => e
|
967
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_user: #{e}"
|
968
|
+
end
|
969
|
+
```
|
970
|
+
|
971
|
+
#### Using the read_spending_plan_user_with_http_info variant
|
972
|
+
|
973
|
+
This returns an Array which contains the response data, status code and headers.
|
974
|
+
|
975
|
+
> <Array(<SpendingPlanResponse>, Integer, Hash)> read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts)
|
976
|
+
|
977
|
+
```ruby
|
978
|
+
begin
|
979
|
+
# Read a spending plan for a user
|
980
|
+
data, status_code, headers = api_instance.read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts)
|
981
|
+
p status_code # => 2xx
|
982
|
+
p headers # => { ... }
|
983
|
+
p data # => <SpendingPlanResponse>
|
984
|
+
rescue MxPlatformRuby::ApiError => e
|
985
|
+
puts "Error when calling SpendingPlanApi->read_spending_plan_user_with_http_info: #{e}"
|
986
|
+
end
|
987
|
+
```
|
988
|
+
|
989
|
+
### Parameters
|
990
|
+
|
991
|
+
| Name | Type | Description | Notes |
|
992
|
+
| ---- | ---- | ----------- | ----- |
|
993
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
994
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
995
|
+
| **page** | **Integer** | Specify current page. | [optional] |
|
996
|
+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
|
997
|
+
|
998
|
+
### Return type
|
999
|
+
|
1000
|
+
[**SpendingPlanResponse**](SpendingPlanResponse.md)
|
1001
|
+
|
1002
|
+
### Authorization
|
1003
|
+
|
1004
|
+
[basicAuth](../README.md#basicAuth)
|
1005
|
+
|
1006
|
+
### HTTP request headers
|
1007
|
+
|
1008
|
+
- **Content-Type**: Not defined
|
1009
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
1010
|
+
|
1011
|
+
|
1012
|
+
## update_spending_plan_iteration_item
|
1013
|
+
|
1014
|
+
> <SpendingPlanIterationItemResponse> update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
1015
|
+
|
1016
|
+
Update a spending plan iteration item
|
1017
|
+
|
1018
|
+
Use this endpoint to update an existing `spending_plan_iteration_item`.
|
1019
|
+
|
1020
|
+
### Examples
|
1021
|
+
|
1022
|
+
```ruby
|
1023
|
+
require 'time'
|
1024
|
+
require 'mx-platform-ruby'
|
1025
|
+
# setup authorization
|
1026
|
+
MxPlatformRuby.configure do |config|
|
1027
|
+
# Configure HTTP basic authorization: basicAuth
|
1028
|
+
config.username = 'YOUR USERNAME'
|
1029
|
+
config.password = 'YOUR PASSWORD'
|
1030
|
+
end
|
1031
|
+
|
1032
|
+
api_instance = MxPlatformRuby::SpendingPlanApi.new
|
1033
|
+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
|
1034
|
+
spending_plan_guid = 'SPL-e5f9a5bd-c5b3-4901-bdc0-62119b9db262' # String | The unique ID for the `spending_plan`.
|
1035
|
+
iteration_item_guid = 'SII-a4dc1549-da28-1245-9c9c-53eee4cdfbe3' # String | The unique ID for the `iteration_item`.
|
1036
|
+
spending_plan_iteration_item_create_request_body = MxPlatformRuby::SpendingPlanIterationItemCreateRequestBody.new({planned_amount: 110}) # SpendingPlanIterationItemCreateRequestBody | Iteration item object to be updated with required parameter (iteration_item_guid)
|
1037
|
+
|
1038
|
+
begin
|
1039
|
+
# Update a spending plan iteration item
|
1040
|
+
result = api_instance.update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
1041
|
+
p result
|
1042
|
+
rescue MxPlatformRuby::ApiError => e
|
1043
|
+
puts "Error when calling SpendingPlanApi->update_spending_plan_iteration_item: #{e}"
|
1044
|
+
end
|
1045
|
+
```
|
1046
|
+
|
1047
|
+
#### Using the update_spending_plan_iteration_item_with_http_info variant
|
1048
|
+
|
1049
|
+
This returns an Array which contains the response data, status code and headers.
|
1050
|
+
|
1051
|
+
> <Array(<SpendingPlanIterationItemResponse>, Integer, Hash)> update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
1052
|
+
|
1053
|
+
```ruby
|
1054
|
+
begin
|
1055
|
+
# Update a spending plan iteration item
|
1056
|
+
data, status_code, headers = api_instance.update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body)
|
1057
|
+
p status_code # => 2xx
|
1058
|
+
p headers # => { ... }
|
1059
|
+
p data # => <SpendingPlanIterationItemResponse>
|
1060
|
+
rescue MxPlatformRuby::ApiError => e
|
1061
|
+
puts "Error when calling SpendingPlanApi->update_spending_plan_iteration_item_with_http_info: #{e}"
|
1062
|
+
end
|
1063
|
+
```
|
1064
|
+
|
1065
|
+
### Parameters
|
1066
|
+
|
1067
|
+
| Name | Type | Description | Notes |
|
1068
|
+
| ---- | ---- | ----------- | ----- |
|
1069
|
+
| **user_guid** | **String** | The unique id for a `user`. | |
|
1070
|
+
| **spending_plan_guid** | **String** | The unique ID for the `spending_plan`. | |
|
1071
|
+
| **iteration_item_guid** | **String** | The unique ID for the `iteration_item`. | |
|
1072
|
+
| **spending_plan_iteration_item_create_request_body** | [**SpendingPlanIterationItemCreateRequestBody**](SpendingPlanIterationItemCreateRequestBody.md) | Iteration item object to be updated with required parameter (iteration_item_guid) | |
|
1073
|
+
|
1074
|
+
### Return type
|
1075
|
+
|
1076
|
+
[**SpendingPlanIterationItemResponse**](SpendingPlanIterationItemResponse.md)
|
1077
|
+
|
1078
|
+
### Authorization
|
1079
|
+
|
1080
|
+
[basicAuth](../README.md#basicAuth)
|
1081
|
+
|
1082
|
+
### HTTP request headers
|
1083
|
+
|
1084
|
+
- **Content-Type**: application/json
|
1085
|
+
- **Accept**: application/vnd.mx.api.v1+json
|
1086
|
+
|