mx-platform-ruby 0.23.0 → 0.24.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -619,149 +619,6 @@ module MxPlatformRuby
619
619
  return data, status_code, headers
620
620
  end
621
621
 
622
- # Create spending plan
623
- # This endpoint creates a new `spending_plan` for the user.
624
- # @param user_guid [String] The unique id for a `user`.
625
- # @param [Hash] opts the optional parameters
626
- # @return [SpendingPlanResponse]
627
- def create_spending_plan(user_guid, opts = {})
628
- data, _status_code, _headers = create_spending_plan_with_http_info(user_guid, opts)
629
- data
630
- end
631
-
632
- # Create spending plan
633
- # This endpoint creates a new `spending_plan` for the user.
634
- # @param user_guid [String] The unique id for a `user`.
635
- # @param [Hash] opts the optional parameters
636
- # @return [Array<(SpendingPlanResponse, Integer, Hash)>] SpendingPlanResponse data, response status code and response headers
637
- def create_spending_plan_with_http_info(user_guid, opts = {})
638
- if @api_client.config.debugging
639
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_spending_plan ...'
640
- end
641
- # verify the required parameter 'user_guid' is set
642
- if @api_client.config.client_side_validation && user_guid.nil?
643
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_spending_plan"
644
- end
645
- # resource path
646
- local_var_path = '/users/{user_guid}/spending_plans'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
647
-
648
- # query parameters
649
- query_params = opts[:query_params] || {}
650
-
651
- # header parameters
652
- header_params = opts[:header_params] || {}
653
- # HTTP header 'Accept' (if needed)
654
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
655
-
656
- # form parameters
657
- form_params = opts[:form_params] || {}
658
-
659
- # http body (model)
660
- post_body = opts[:debug_body]
661
-
662
- # return_type
663
- return_type = opts[:debug_return_type] || 'SpendingPlanResponse'
664
-
665
- # auth_names
666
- auth_names = opts[:debug_auth_names] || ['basicAuth']
667
-
668
- new_options = opts.merge(
669
- :operation => :"MxPlatformApi.create_spending_plan",
670
- :header_params => header_params,
671
- :query_params => query_params,
672
- :form_params => form_params,
673
- :body => post_body,
674
- :auth_names => auth_names,
675
- :return_type => return_type
676
- )
677
-
678
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
679
- if @api_client.config.debugging
680
- @api_client.config.logger.debug "API called: MxPlatformApi#create_spending_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
681
- end
682
- return data, status_code, headers
683
- end
684
-
685
- # Create spending plan iteration item
686
- # This endpoint creates a new `spending_plan_iteration_item`.
687
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
688
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
689
- # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item to be created with required parameters (planned_amount)
690
- # @param [Hash] opts the optional parameters
691
- # @return [SpendingPlanIterationItemResponse]
692
- def create_spending_plan_iteration_item(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, opts = {})
693
- data, _status_code, _headers = create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, opts)
694
- data
695
- end
696
-
697
- # Create spending plan iteration item
698
- # This endpoint creates a new &#x60;spending_plan_iteration_item&#x60;.
699
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
700
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
701
- # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item to be created with required parameters (planned_amount)
702
- # @param [Hash] opts the optional parameters
703
- # @return [Array<(SpendingPlanIterationItemResponse, Integer, Hash)>] SpendingPlanIterationItemResponse data, response status code and response headers
704
- def create_spending_plan_iteration_item_with_http_info(spending_plan_guid, user_guid, spending_plan_iteration_item_create_request_body, opts = {})
705
- if @api_client.config.debugging
706
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.create_spending_plan_iteration_item ...'
707
- end
708
- # verify the required parameter 'spending_plan_guid' is set
709
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
710
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.create_spending_plan_iteration_item"
711
- end
712
- # verify the required parameter 'user_guid' is set
713
- if @api_client.config.client_side_validation && user_guid.nil?
714
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.create_spending_plan_iteration_item"
715
- end
716
- # verify the required parameter 'spending_plan_iteration_item_create_request_body' is set
717
- if @api_client.config.client_side_validation && spending_plan_iteration_item_create_request_body.nil?
718
- fail ArgumentError, "Missing the required parameter 'spending_plan_iteration_item_create_request_body' when calling MxPlatformApi.create_spending_plan_iteration_item"
719
- end
720
- # resource path
721
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items'.sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
722
-
723
- # query parameters
724
- query_params = opts[:query_params] || {}
725
-
726
- # header parameters
727
- header_params = opts[:header_params] || {}
728
- # HTTP header 'Accept' (if needed)
729
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
730
- # HTTP header 'Content-Type'
731
- content_type = @api_client.select_header_content_type(['application/json'])
732
- if !content_type.nil?
733
- header_params['Content-Type'] = content_type
734
- end
735
-
736
- # form parameters
737
- form_params = opts[:form_params] || {}
738
-
739
- # http body (model)
740
- post_body = opts[:debug_body] || @api_client.object_to_http_body(spending_plan_iteration_item_create_request_body)
741
-
742
- # return_type
743
- return_type = opts[:debug_return_type] || 'SpendingPlanIterationItemResponse'
744
-
745
- # auth_names
746
- auth_names = opts[:debug_auth_names] || ['basicAuth']
747
-
748
- new_options = opts.merge(
749
- :operation => :"MxPlatformApi.create_spending_plan_iteration_item",
750
- :header_params => header_params,
751
- :query_params => query_params,
752
- :form_params => form_params,
753
- :body => post_body,
754
- :auth_names => auth_names,
755
- :return_type => return_type
756
- )
757
-
758
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
759
- if @api_client.config.debugging
760
- @api_client.config.logger.debug "API called: MxPlatformApi#create_spending_plan_iteration_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
761
- end
762
- return data, status_code, headers
763
- end
764
-
765
622
  # Create tag
766
623
  # Use this endpoint to create a new custom tag.
767
624
  # @param user_guid [String] The unique id for a &#x60;user&#x60;.
@@ -1472,219 +1329,6 @@ module MxPlatformRuby
1472
1329
  return data, status_code, headers
1473
1330
  end
1474
1331
 
1475
- # Delete spending plan
1476
- # Use this endpoint to delete a user's `spending_plan`.
1477
- # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
1478
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
1479
- # @param [Hash] opts the optional parameters
1480
- # @return [nil]
1481
- def delete_spending_plan(user_guid, spending_plan_guid, opts = {})
1482
- delete_spending_plan_with_http_info(user_guid, spending_plan_guid, opts)
1483
- nil
1484
- end
1485
-
1486
- # Delete spending plan
1487
- # Use this endpoint to delete a user&#39;s &#x60;spending_plan&#x60;.
1488
- # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
1489
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
1490
- # @param [Hash] opts the optional parameters
1491
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1492
- def delete_spending_plan_with_http_info(user_guid, spending_plan_guid, opts = {})
1493
- if @api_client.config.debugging
1494
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_spending_plan ...'
1495
- end
1496
- # verify the required parameter 'user_guid' is set
1497
- if @api_client.config.client_side_validation && user_guid.nil?
1498
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_spending_plan"
1499
- end
1500
- # verify the required parameter 'spending_plan_guid' is set
1501
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
1502
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.delete_spending_plan"
1503
- end
1504
- # resource path
1505
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s))
1506
-
1507
- # query parameters
1508
- query_params = opts[:query_params] || {}
1509
-
1510
- # header parameters
1511
- header_params = opts[:header_params] || {}
1512
-
1513
- # form parameters
1514
- form_params = opts[:form_params] || {}
1515
-
1516
- # http body (model)
1517
- post_body = opts[:debug_body]
1518
-
1519
- # return_type
1520
- return_type = opts[:debug_return_type]
1521
-
1522
- # auth_names
1523
- auth_names = opts[:debug_auth_names] || ['basicAuth']
1524
-
1525
- new_options = opts.merge(
1526
- :operation => :"MxPlatformApi.delete_spending_plan",
1527
- :header_params => header_params,
1528
- :query_params => query_params,
1529
- :form_params => form_params,
1530
- :body => post_body,
1531
- :auth_names => auth_names,
1532
- :return_type => return_type
1533
- )
1534
-
1535
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1536
- if @api_client.config.debugging
1537
- @api_client.config.logger.debug "API called: MxPlatformApi#delete_spending_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1538
- end
1539
- return data, status_code, headers
1540
- end
1541
-
1542
- # Delete spending plan account
1543
- # Use this endpoint to delete a `spending_plan_account`.
1544
- # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
1545
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
1546
- # @param spending_plan_account_guid [String] The unique ID for the specified account.
1547
- # @param [Hash] opts the optional parameters
1548
- # @return [nil]
1549
- def delete_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts = {})
1550
- delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
1551
- nil
1552
- end
1553
-
1554
- # Delete spending plan account
1555
- # Use this endpoint to delete a &#x60;spending_plan_account&#x60;.
1556
- # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
1557
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
1558
- # @param spending_plan_account_guid [String] The unique ID for the specified account.
1559
- # @param [Hash] opts the optional parameters
1560
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1561
- def delete_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts = {})
1562
- if @api_client.config.debugging
1563
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_spending_plan_account ...'
1564
- end
1565
- # verify the required parameter 'user_guid' is set
1566
- if @api_client.config.client_side_validation && user_guid.nil?
1567
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_spending_plan_account"
1568
- end
1569
- # verify the required parameter 'spending_plan_guid' is set
1570
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
1571
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.delete_spending_plan_account"
1572
- end
1573
- # verify the required parameter 'spending_plan_account_guid' is set
1574
- if @api_client.config.client_side_validation && spending_plan_account_guid.nil?
1575
- fail ArgumentError, "Missing the required parameter 'spending_plan_account_guid' when calling MxPlatformApi.delete_spending_plan_account"
1576
- end
1577
- # resource path
1578
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'spending_plan_account_guid' + '}', CGI.escape(spending_plan_account_guid.to_s))
1579
-
1580
- # query parameters
1581
- query_params = opts[:query_params] || {}
1582
-
1583
- # header parameters
1584
- header_params = opts[:header_params] || {}
1585
-
1586
- # form parameters
1587
- form_params = opts[:form_params] || {}
1588
-
1589
- # http body (model)
1590
- post_body = opts[:debug_body]
1591
-
1592
- # return_type
1593
- return_type = opts[:debug_return_type]
1594
-
1595
- # auth_names
1596
- auth_names = opts[:debug_auth_names] || ['basicAuth']
1597
-
1598
- new_options = opts.merge(
1599
- :operation => :"MxPlatformApi.delete_spending_plan_account",
1600
- :header_params => header_params,
1601
- :query_params => query_params,
1602
- :form_params => form_params,
1603
- :body => post_body,
1604
- :auth_names => auth_names,
1605
- :return_type => return_type
1606
- )
1607
-
1608
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1609
- if @api_client.config.debugging
1610
- @api_client.config.logger.debug "API called: MxPlatformApi#delete_spending_plan_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1611
- end
1612
- return data, status_code, headers
1613
- end
1614
-
1615
- # Delete spending plan iteration item
1616
- # Use this endpoint to delete a spending plan `iteration_item`.
1617
- # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
1618
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
1619
- # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
1620
- # @param [Hash] opts the optional parameters
1621
- # @return [nil]
1622
- def delete_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts = {})
1623
- delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
1624
- nil
1625
- end
1626
-
1627
- # Delete spending plan iteration item
1628
- # Use this endpoint to delete a spending plan &#x60;iteration_item&#x60;.
1629
- # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
1630
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
1631
- # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
1632
- # @param [Hash] opts the optional parameters
1633
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1634
- def delete_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts = {})
1635
- if @api_client.config.debugging
1636
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.delete_spending_plan_iteration_item ...'
1637
- end
1638
- # verify the required parameter 'user_guid' is set
1639
- if @api_client.config.client_side_validation && user_guid.nil?
1640
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.delete_spending_plan_iteration_item"
1641
- end
1642
- # verify the required parameter 'spending_plan_guid' is set
1643
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
1644
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.delete_spending_plan_iteration_item"
1645
- end
1646
- # verify the required parameter 'iteration_item_guid' is set
1647
- if @api_client.config.client_side_validation && iteration_item_guid.nil?
1648
- fail ArgumentError, "Missing the required parameter 'iteration_item_guid' when calling MxPlatformApi.delete_spending_plan_iteration_item"
1649
- end
1650
- # resource path
1651
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'iteration_item_guid' + '}', CGI.escape(iteration_item_guid.to_s))
1652
-
1653
- # query parameters
1654
- query_params = opts[:query_params] || {}
1655
-
1656
- # header parameters
1657
- header_params = opts[:header_params] || {}
1658
-
1659
- # form parameters
1660
- form_params = opts[:form_params] || {}
1661
-
1662
- # http body (model)
1663
- post_body = opts[:debug_body]
1664
-
1665
- # return_type
1666
- return_type = opts[:debug_return_type]
1667
-
1668
- # auth_names
1669
- auth_names = opts[:debug_auth_names] || ['basicAuth']
1670
-
1671
- new_options = opts.merge(
1672
- :operation => :"MxPlatformApi.delete_spending_plan_iteration_item",
1673
- :header_params => header_params,
1674
- :query_params => query_params,
1675
- :form_params => form_params,
1676
- :body => post_body,
1677
- :auth_names => auth_names,
1678
- :return_type => return_type
1679
- )
1680
-
1681
- data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1682
- if @api_client.config.debugging
1683
- @api_client.config.logger.debug "API called: MxPlatformApi#delete_spending_plan_iteration_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1684
- end
1685
- return data, status_code, headers
1686
- end
1687
-
1688
1332
  # Delete tag
1689
1333
  # Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
1690
1334
  # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
@@ -4030,310 +3674,16 @@ module MxPlatformRuby
4030
3674
  return data, status_code, headers
4031
3675
  end
4032
3676
 
4033
- # List spending plan accounts
4034
- # Use this endpoint to list all the spending plan accounts associated with the spending plan.
3677
+ # List statements by member
3678
+ # Use this endpoint to get an array of available statements.
3679
+ # @param member_guid [String] The unique id for a &#x60;member&#x60;.
4035
3680
  # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4036
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
4037
3681
  # @param [Hash] opts the optional parameters
4038
3682
  # @option opts [Integer] :page Specify current page.
4039
3683
  # @option opts [Integer] :records_per_page Specify records per page.
4040
- # @return [SpendingPlanAccountsResponse]
4041
- def list_spending_plan_accounts(user_guid, spending_plan_guid, opts = {})
4042
- data, _status_code, _headers = list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts)
4043
- data
4044
- end
4045
-
4046
- # List spending plan accounts
4047
- # Use this endpoint to list all the spending plan accounts associated with the spending plan.
4048
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4049
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
4050
- # @param [Hash] opts the optional parameters
4051
- # @option opts [Integer] :page Specify current page.
4052
- # @option opts [Integer] :records_per_page Specify records per page.
4053
- # @return [Array<(SpendingPlanAccountsResponse, Integer, Hash)>] SpendingPlanAccountsResponse data, response status code and response headers
4054
- def list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts = {})
4055
- if @api_client.config.debugging
4056
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_spending_plan_accounts ...'
4057
- end
4058
- # verify the required parameter 'user_guid' is set
4059
- if @api_client.config.client_side_validation && user_guid.nil?
4060
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_spending_plan_accounts"
4061
- end
4062
- # verify the required parameter 'spending_plan_guid' is set
4063
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
4064
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.list_spending_plan_accounts"
4065
- end
4066
- # resource path
4067
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s))
4068
-
4069
- # query parameters
4070
- query_params = opts[:query_params] || {}
4071
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
4072
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
4073
-
4074
- # header parameters
4075
- header_params = opts[:header_params] || {}
4076
- # HTTP header 'Accept' (if needed)
4077
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
4078
-
4079
- # form parameters
4080
- form_params = opts[:form_params] || {}
4081
-
4082
- # http body (model)
4083
- post_body = opts[:debug_body]
4084
-
4085
- # return_type
4086
- return_type = opts[:debug_return_type] || 'SpendingPlanAccountsResponse'
4087
-
4088
- # auth_names
4089
- auth_names = opts[:debug_auth_names] || ['basicAuth']
4090
-
4091
- new_options = opts.merge(
4092
- :operation => :"MxPlatformApi.list_spending_plan_accounts",
4093
- :header_params => header_params,
4094
- :query_params => query_params,
4095
- :form_params => form_params,
4096
- :body => post_body,
4097
- :auth_names => auth_names,
4098
- :return_type => return_type
4099
- )
4100
-
4101
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4102
- if @api_client.config.debugging
4103
- @api_client.config.logger.debug "API called: MxPlatformApi#list_spending_plan_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4104
- end
4105
- return data, status_code, headers
4106
- end
4107
-
4108
- # List spending plan iteration items
4109
- # Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
4110
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4111
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
4112
- # @param [Hash] opts the optional parameters
4113
- # @option opts [Integer] :page Specify current page.
4114
- # @option opts [Integer] :records_per_page Specify records per page.
4115
- # @return [SpendingPlanIterationItemsResponseBody]
4116
- def list_spending_plan_iteration_items(user_guid, spending_plan_guid, opts = {})
4117
- data, _status_code, _headers = list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts)
4118
- data
4119
- end
4120
-
4121
- # List spending plan iteration items
4122
- # Use this endpoint to list all the spending plan &#x60;iteration_items&#x60; associated with the &#x60;iteration&#x60;.
4123
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4124
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
4125
- # @param [Hash] opts the optional parameters
4126
- # @option opts [Integer] :page Specify current page.
4127
- # @option opts [Integer] :records_per_page Specify records per page.
4128
- # @return [Array<(SpendingPlanIterationItemsResponseBody, Integer, Hash)>] SpendingPlanIterationItemsResponseBody data, response status code and response headers
4129
- def list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts = {})
4130
- if @api_client.config.debugging
4131
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_spending_plan_iteration_items ...'
4132
- end
4133
- # verify the required parameter 'user_guid' is set
4134
- if @api_client.config.client_side_validation && user_guid.nil?
4135
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_spending_plan_iteration_items"
4136
- end
4137
- # verify the required parameter 'spending_plan_guid' is set
4138
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
4139
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.list_spending_plan_iteration_items"
4140
- end
4141
- # resource path
4142
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s))
4143
-
4144
- # query parameters
4145
- query_params = opts[:query_params] || {}
4146
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
4147
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
4148
-
4149
- # header parameters
4150
- header_params = opts[:header_params] || {}
4151
- # HTTP header 'Accept' (if needed)
4152
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
4153
-
4154
- # form parameters
4155
- form_params = opts[:form_params] || {}
4156
-
4157
- # http body (model)
4158
- post_body = opts[:debug_body]
4159
-
4160
- # return_type
4161
- return_type = opts[:debug_return_type] || 'SpendingPlanIterationItemsResponseBody'
4162
-
4163
- # auth_names
4164
- auth_names = opts[:debug_auth_names] || ['basicAuth']
4165
-
4166
- new_options = opts.merge(
4167
- :operation => :"MxPlatformApi.list_spending_plan_iteration_items",
4168
- :header_params => header_params,
4169
- :query_params => query_params,
4170
- :form_params => form_params,
4171
- :body => post_body,
4172
- :auth_names => auth_names,
4173
- :return_type => return_type
4174
- )
4175
-
4176
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4177
- if @api_client.config.debugging
4178
- @api_client.config.logger.debug "API called: MxPlatformApi#list_spending_plan_iteration_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4179
- end
4180
- return data, status_code, headers
4181
- end
4182
-
4183
- # List spending plan iterations
4184
- # Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
4185
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4186
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
4187
- # @param [Hash] opts the optional parameters
4188
- # @option opts [Integer] :page Specify current page.
4189
- # @option opts [Integer] :records_per_page Specify records per page.
4190
- # @return [SpendingPlanIterationsResponse]
4191
- def list_spending_plan_iterations(user_guid, spending_plan_guid, opts = {})
4192
- data, _status_code, _headers = list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts)
4193
- data
4194
- end
4195
-
4196
- # List spending plan iterations
4197
- # Use this endpoint to list all the spending plan &#x60;iterations&#x60; associated with the &#x60;spending_plan&#x60;.
4198
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4199
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
4200
- # @param [Hash] opts the optional parameters
4201
- # @option opts [Integer] :page Specify current page.
4202
- # @option opts [Integer] :records_per_page Specify records per page.
4203
- # @return [Array<(SpendingPlanIterationsResponse, Integer, Hash)>] SpendingPlanIterationsResponse data, response status code and response headers
4204
- def list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts = {})
4205
- if @api_client.config.debugging
4206
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_spending_plan_iterations ...'
4207
- end
4208
- # verify the required parameter 'user_guid' is set
4209
- if @api_client.config.client_side_validation && user_guid.nil?
4210
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_spending_plan_iterations"
4211
- end
4212
- # verify the required parameter 'spending_plan_guid' is set
4213
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
4214
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.list_spending_plan_iterations"
4215
- end
4216
- # resource path
4217
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s))
4218
-
4219
- # query parameters
4220
- query_params = opts[:query_params] || {}
4221
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
4222
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
4223
-
4224
- # header parameters
4225
- header_params = opts[:header_params] || {}
4226
- # HTTP header 'Accept' (if needed)
4227
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
4228
-
4229
- # form parameters
4230
- form_params = opts[:form_params] || {}
4231
-
4232
- # http body (model)
4233
- post_body = opts[:debug_body]
4234
-
4235
- # return_type
4236
- return_type = opts[:debug_return_type] || 'SpendingPlanIterationsResponse'
4237
-
4238
- # auth_names
4239
- auth_names = opts[:debug_auth_names] || ['basicAuth']
4240
-
4241
- new_options = opts.merge(
4242
- :operation => :"MxPlatformApi.list_spending_plan_iterations",
4243
- :header_params => header_params,
4244
- :query_params => query_params,
4245
- :form_params => form_params,
4246
- :body => post_body,
4247
- :auth_names => auth_names,
4248
- :return_type => return_type
4249
- )
4250
-
4251
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4252
- if @api_client.config.debugging
4253
- @api_client.config.logger.debug "API called: MxPlatformApi#list_spending_plan_iterations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4254
- end
4255
- return data, status_code, headers
4256
- end
4257
-
4258
- # List spending plans
4259
- # Use this endpoint to list all the spending plans associated with the user.
4260
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4261
- # @param [Hash] opts the optional parameters
4262
- # @option opts [Integer] :page Specify current page.
4263
- # @option opts [Integer] :records_per_page Specify records per page.
4264
- # @return [SpendingPlansResponseBody]
4265
- def list_spending_plans(user_guid, opts = {})
4266
- data, _status_code, _headers = list_spending_plans_with_http_info(user_guid, opts)
4267
- data
4268
- end
4269
-
4270
- # List spending plans
4271
- # Use this endpoint to list all the spending plans associated with the user.
4272
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4273
- # @param [Hash] opts the optional parameters
4274
- # @option opts [Integer] :page Specify current page.
4275
- # @option opts [Integer] :records_per_page Specify records per page.
4276
- # @return [Array<(SpendingPlansResponseBody, Integer, Hash)>] SpendingPlansResponseBody data, response status code and response headers
4277
- def list_spending_plans_with_http_info(user_guid, opts = {})
4278
- if @api_client.config.debugging
4279
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_spending_plans ...'
4280
- end
4281
- # verify the required parameter 'user_guid' is set
4282
- if @api_client.config.client_side_validation && user_guid.nil?
4283
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_spending_plans"
4284
- end
4285
- # resource path
4286
- local_var_path = '/users/{user_guid}/spending_plans'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
4287
-
4288
- # query parameters
4289
- query_params = opts[:query_params] || {}
4290
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
4291
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
4292
-
4293
- # header parameters
4294
- header_params = opts[:header_params] || {}
4295
- # HTTP header 'Accept' (if needed)
4296
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
4297
-
4298
- # form parameters
4299
- form_params = opts[:form_params] || {}
4300
-
4301
- # http body (model)
4302
- post_body = opts[:debug_body]
4303
-
4304
- # return_type
4305
- return_type = opts[:debug_return_type] || 'SpendingPlansResponseBody'
4306
-
4307
- # auth_names
4308
- auth_names = opts[:debug_auth_names] || ['basicAuth']
4309
-
4310
- new_options = opts.merge(
4311
- :operation => :"MxPlatformApi.list_spending_plans",
4312
- :header_params => header_params,
4313
- :query_params => query_params,
4314
- :form_params => form_params,
4315
- :body => post_body,
4316
- :auth_names => auth_names,
4317
- :return_type => return_type
4318
- )
4319
-
4320
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
4321
- if @api_client.config.debugging
4322
- @api_client.config.logger.debug "API called: MxPlatformApi#list_spending_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4323
- end
4324
- return data, status_code, headers
4325
- end
4326
-
4327
- # List statements by member
4328
- # Use this endpoint to get an array of available statements.
4329
- # @param member_guid [String] The unique id for a &#x60;member&#x60;.
4330
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
4331
- # @param [Hash] opts the optional parameters
4332
- # @option opts [Integer] :page Specify current page.
4333
- # @option opts [Integer] :records_per_page Specify records per page.
4334
- # @return [StatementsResponseBody]
4335
- def list_statements_by_member(member_guid, user_guid, opts = {})
4336
- data, _status_code, _headers = list_statements_by_member_with_http_info(member_guid, user_guid, opts)
3684
+ # @return [StatementsResponseBody]
3685
+ def list_statements_by_member(member_guid, user_guid, opts = {})
3686
+ data, _status_code, _headers = list_statements_by_member_with_http_info(member_guid, user_guid, opts)
4337
3687
  data
4338
3688
  end
4339
3689
 
@@ -6043,324 +5393,6 @@ module MxPlatformRuby
6043
5393
  return data, status_code, headers
6044
5394
  end
6045
5395
 
6046
- # Read spending plan account
6047
- # Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
6048
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6049
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6050
- # @param spending_plan_account_guid [String] The unique ID for the specified account.
6051
- # @param [Hash] opts the optional parameters
6052
- # @option opts [Integer] :page Specify current page.
6053
- # @option opts [Integer] :records_per_page Specify records per page.
6054
- # @return [SpendingPlanAccountResponse]
6055
- def read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts = {})
6056
- data, _status_code, _headers = read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
6057
- data
6058
- end
6059
-
6060
- # Read spending plan account
6061
- # Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
6062
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6063
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6064
- # @param spending_plan_account_guid [String] The unique ID for the specified account.
6065
- # @param [Hash] opts the optional parameters
6066
- # @option opts [Integer] :page Specify current page.
6067
- # @option opts [Integer] :records_per_page Specify records per page.
6068
- # @return [Array<(SpendingPlanAccountResponse, Integer, Hash)>] SpendingPlanAccountResponse data, response status code and response headers
6069
- def read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts = {})
6070
- if @api_client.config.debugging
6071
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_spending_plan_account ...'
6072
- end
6073
- # verify the required parameter 'user_guid' is set
6074
- if @api_client.config.client_side_validation && user_guid.nil?
6075
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_spending_plan_account"
6076
- end
6077
- # verify the required parameter 'spending_plan_guid' is set
6078
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
6079
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.read_spending_plan_account"
6080
- end
6081
- # verify the required parameter 'spending_plan_account_guid' is set
6082
- if @api_client.config.client_side_validation && spending_plan_account_guid.nil?
6083
- fail ArgumentError, "Missing the required parameter 'spending_plan_account_guid' when calling MxPlatformApi.read_spending_plan_account"
6084
- end
6085
- # resource path
6086
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/spending_plan_accounts/{spending_plan_account_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'spending_plan_account_guid' + '}', CGI.escape(spending_plan_account_guid.to_s))
6087
-
6088
- # query parameters
6089
- query_params = opts[:query_params] || {}
6090
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
6091
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
6092
-
6093
- # header parameters
6094
- header_params = opts[:header_params] || {}
6095
- # HTTP header 'Accept' (if needed)
6096
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
6097
-
6098
- # form parameters
6099
- form_params = opts[:form_params] || {}
6100
-
6101
- # http body (model)
6102
- post_body = opts[:debug_body]
6103
-
6104
- # return_type
6105
- return_type = opts[:debug_return_type] || 'SpendingPlanAccountResponse'
6106
-
6107
- # auth_names
6108
- auth_names = opts[:debug_auth_names] || ['basicAuth']
6109
-
6110
- new_options = opts.merge(
6111
- :operation => :"MxPlatformApi.read_spending_plan_account",
6112
- :header_params => header_params,
6113
- :query_params => query_params,
6114
- :form_params => form_params,
6115
- :body => post_body,
6116
- :auth_names => auth_names,
6117
- :return_type => return_type
6118
- )
6119
-
6120
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6121
- if @api_client.config.debugging
6122
- @api_client.config.logger.debug "API called: MxPlatformApi#read_spending_plan_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6123
- end
6124
- return data, status_code, headers
6125
- end
6126
-
6127
- # Read a spending plan iteration
6128
- # Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
6129
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6130
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6131
- # @param iteration_number [Integer] The current iteration number for the spending plan &#x60;iteration&#x60;&#x60;.
6132
- # @param [Hash] opts the optional parameters
6133
- # @option opts [Integer] :page Specify current page.
6134
- # @option opts [Integer] :records_per_page Specify records per page.
6135
- # @return [SpendingPlanIterationResponse]
6136
- def read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, opts = {})
6137
- data, _status_code, _headers = read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts)
6138
- data
6139
- end
6140
-
6141
- # Read a spending plan iteration
6142
- # Use this endpoint to read the attributes of a specific spending plan &#x60;iteration&#x60; according to its &#x60;iteration_number&#x60;.
6143
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6144
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6145
- # @param iteration_number [Integer] The current iteration number for the spending plan &#x60;iteration&#x60;&#x60;.
6146
- # @param [Hash] opts the optional parameters
6147
- # @option opts [Integer] :page Specify current page.
6148
- # @option opts [Integer] :records_per_page Specify records per page.
6149
- # @return [Array<(SpendingPlanIterationResponse, Integer, Hash)>] SpendingPlanIterationResponse data, response status code and response headers
6150
- def read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts = {})
6151
- if @api_client.config.debugging
6152
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_spending_plan_iteration ...'
6153
- end
6154
- # verify the required parameter 'user_guid' is set
6155
- if @api_client.config.client_side_validation && user_guid.nil?
6156
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_spending_plan_iteration"
6157
- end
6158
- # verify the required parameter 'spending_plan_guid' is set
6159
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
6160
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.read_spending_plan_iteration"
6161
- end
6162
- # verify the required parameter 'iteration_number' is set
6163
- if @api_client.config.client_side_validation && iteration_number.nil?
6164
- fail ArgumentError, "Missing the required parameter 'iteration_number' when calling MxPlatformApi.read_spending_plan_iteration"
6165
- end
6166
- # resource path
6167
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/{iteration_number}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'iteration_number' + '}', CGI.escape(iteration_number.to_s))
6168
-
6169
- # query parameters
6170
- query_params = opts[:query_params] || {}
6171
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
6172
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
6173
-
6174
- # header parameters
6175
- header_params = opts[:header_params] || {}
6176
- # HTTP header 'Accept' (if needed)
6177
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
6178
-
6179
- # form parameters
6180
- form_params = opts[:form_params] || {}
6181
-
6182
- # http body (model)
6183
- post_body = opts[:debug_body]
6184
-
6185
- # return_type
6186
- return_type = opts[:debug_return_type] || 'SpendingPlanIterationResponse'
6187
-
6188
- # auth_names
6189
- auth_names = opts[:debug_auth_names] || ['basicAuth']
6190
-
6191
- new_options = opts.merge(
6192
- :operation => :"MxPlatformApi.read_spending_plan_iteration",
6193
- :header_params => header_params,
6194
- :query_params => query_params,
6195
- :form_params => form_params,
6196
- :body => post_body,
6197
- :auth_names => auth_names,
6198
- :return_type => return_type
6199
- )
6200
-
6201
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6202
- if @api_client.config.debugging
6203
- @api_client.config.logger.debug "API called: MxPlatformApi#read_spending_plan_iteration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6204
- end
6205
- return data, status_code, headers
6206
- end
6207
-
6208
- # Read a spending plan iteration item
6209
- # Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
6210
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6211
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6212
- # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
6213
- # @param [Hash] opts the optional parameters
6214
- # @option opts [Integer] :page Specify current page.
6215
- # @option opts [Integer] :records_per_page Specify records per page.
6216
- # @return [SpendingPlanIterationItemResponse]
6217
- def read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts = {})
6218
- data, _status_code, _headers = read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
6219
- data
6220
- end
6221
-
6222
- # Read a spending plan iteration item
6223
- # Use this endpoint to read the attributes of a specific spending plan &#x60;iteration_item&#x60; according to its unique GUID.
6224
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6225
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6226
- # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
6227
- # @param [Hash] opts the optional parameters
6228
- # @option opts [Integer] :page Specify current page.
6229
- # @option opts [Integer] :records_per_page Specify records per page.
6230
- # @return [Array<(SpendingPlanIterationItemResponse, Integer, Hash)>] SpendingPlanIterationItemResponse data, response status code and response headers
6231
- def read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts = {})
6232
- if @api_client.config.debugging
6233
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_spending_plan_iteration_item ...'
6234
- end
6235
- # verify the required parameter 'user_guid' is set
6236
- if @api_client.config.client_side_validation && user_guid.nil?
6237
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_spending_plan_iteration_item"
6238
- end
6239
- # verify the required parameter 'spending_plan_guid' is set
6240
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
6241
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.read_spending_plan_iteration_item"
6242
- end
6243
- # verify the required parameter 'iteration_item_guid' is set
6244
- if @api_client.config.client_side_validation && iteration_item_guid.nil?
6245
- fail ArgumentError, "Missing the required parameter 'iteration_item_guid' when calling MxPlatformApi.read_spending_plan_iteration_item"
6246
- end
6247
- # resource path
6248
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'iteration_item_guid' + '}', CGI.escape(iteration_item_guid.to_s))
6249
-
6250
- # query parameters
6251
- query_params = opts[:query_params] || {}
6252
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
6253
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
6254
-
6255
- # header parameters
6256
- header_params = opts[:header_params] || {}
6257
- # HTTP header 'Accept' (if needed)
6258
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
6259
-
6260
- # form parameters
6261
- form_params = opts[:form_params] || {}
6262
-
6263
- # http body (model)
6264
- post_body = opts[:debug_body]
6265
-
6266
- # return_type
6267
- return_type = opts[:debug_return_type] || 'SpendingPlanIterationItemResponse'
6268
-
6269
- # auth_names
6270
- auth_names = opts[:debug_auth_names] || ['basicAuth']
6271
-
6272
- new_options = opts.merge(
6273
- :operation => :"MxPlatformApi.read_spending_plan_iteration_item",
6274
- :header_params => header_params,
6275
- :query_params => query_params,
6276
- :form_params => form_params,
6277
- :body => post_body,
6278
- :auth_names => auth_names,
6279
- :return_type => return_type
6280
- )
6281
-
6282
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6283
- if @api_client.config.debugging
6284
- @api_client.config.logger.debug "API called: MxPlatformApi#read_spending_plan_iteration_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6285
- end
6286
- return data, status_code, headers
6287
- end
6288
-
6289
- # Read a spending plan for a user
6290
- # Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
6291
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6292
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6293
- # @param [Hash] opts the optional parameters
6294
- # @option opts [Integer] :page Specify current page.
6295
- # @option opts [Integer] :records_per_page Specify records per page.
6296
- # @return [SpendingPlanResponse]
6297
- def read_spending_plan_user(user_guid, spending_plan_guid, opts = {})
6298
- data, _status_code, _headers = read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts)
6299
- data
6300
- end
6301
-
6302
- # Read a spending plan for a user
6303
- # Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
6304
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
6305
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
6306
- # @param [Hash] opts the optional parameters
6307
- # @option opts [Integer] :page Specify current page.
6308
- # @option opts [Integer] :records_per_page Specify records per page.
6309
- # @return [Array<(SpendingPlanResponse, Integer, Hash)>] SpendingPlanResponse data, response status code and response headers
6310
- def read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts = {})
6311
- if @api_client.config.debugging
6312
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_spending_plan_user ...'
6313
- end
6314
- # verify the required parameter 'user_guid' is set
6315
- if @api_client.config.client_side_validation && user_guid.nil?
6316
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_spending_plan_user"
6317
- end
6318
- # verify the required parameter 'spending_plan_guid' is set
6319
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
6320
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.read_spending_plan_user"
6321
- end
6322
- # resource path
6323
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s))
6324
-
6325
- # query parameters
6326
- query_params = opts[:query_params] || {}
6327
- query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
6328
- query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
6329
-
6330
- # header parameters
6331
- header_params = opts[:header_params] || {}
6332
- # HTTP header 'Accept' (if needed)
6333
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
6334
-
6335
- # form parameters
6336
- form_params = opts[:form_params] || {}
6337
-
6338
- # http body (model)
6339
- post_body = opts[:debug_body]
6340
-
6341
- # return_type
6342
- return_type = opts[:debug_return_type] || 'SpendingPlanResponse'
6343
-
6344
- # auth_names
6345
- auth_names = opts[:debug_auth_names] || ['basicAuth']
6346
-
6347
- new_options = opts.merge(
6348
- :operation => :"MxPlatformApi.read_spending_plan_user",
6349
- :header_params => header_params,
6350
- :query_params => query_params,
6351
- :form_params => form_params,
6352
- :body => post_body,
6353
- :auth_names => auth_names,
6354
- :return_type => return_type
6355
- )
6356
-
6357
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6358
- if @api_client.config.debugging
6359
- @api_client.config.logger.debug "API called: MxPlatformApi#read_spending_plan_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6360
- end
6361
- return data, status_code, headers
6362
- end
6363
-
6364
5396
  # Read statement by member
6365
5397
  # Use this endpoint to read a JSON representation of the statement.
6366
5398
  # @param member_guid [String] The unique id for a &#x60;member&#x60;.
@@ -7737,92 +6769,6 @@ module MxPlatformRuby
7737
6769
  return data, status_code, headers
7738
6770
  end
7739
6771
 
7740
- # Update a spending plan iteration item
7741
- # Use this endpoint to update an existing `spending_plan_iteration_item`.
7742
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
7743
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
7744
- # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
7745
- # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item object to be updated with required parameter (iteration_item_guid)
7746
- # @param [Hash] opts the optional parameters
7747
- # @return [SpendingPlanIterationItemResponse]
7748
- def update_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, opts = {})
7749
- data, _status_code, _headers = update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, opts)
7750
- data
7751
- end
7752
-
7753
- # Update a spending plan iteration item
7754
- # Use this endpoint to update an existing &#x60;spending_plan_iteration_item&#x60;.
7755
- # @param user_guid [String] The unique id for a &#x60;user&#x60;.
7756
- # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
7757
- # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
7758
- # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item object to be updated with required parameter (iteration_item_guid)
7759
- # @param [Hash] opts the optional parameters
7760
- # @return [Array<(SpendingPlanIterationItemResponse, Integer, Hash)>] SpendingPlanIterationItemResponse data, response status code and response headers
7761
- def update_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, spending_plan_iteration_item_create_request_body, opts = {})
7762
- if @api_client.config.debugging
7763
- @api_client.config.logger.debug 'Calling API: MxPlatformApi.update_spending_plan_iteration_item ...'
7764
- end
7765
- # verify the required parameter 'user_guid' is set
7766
- if @api_client.config.client_side_validation && user_guid.nil?
7767
- fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.update_spending_plan_iteration_item"
7768
- end
7769
- # verify the required parameter 'spending_plan_guid' is set
7770
- if @api_client.config.client_side_validation && spending_plan_guid.nil?
7771
- fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling MxPlatformApi.update_spending_plan_iteration_item"
7772
- end
7773
- # verify the required parameter 'iteration_item_guid' is set
7774
- if @api_client.config.client_side_validation && iteration_item_guid.nil?
7775
- fail ArgumentError, "Missing the required parameter 'iteration_item_guid' when calling MxPlatformApi.update_spending_plan_iteration_item"
7776
- end
7777
- # verify the required parameter 'spending_plan_iteration_item_create_request_body' is set
7778
- if @api_client.config.client_side_validation && spending_plan_iteration_item_create_request_body.nil?
7779
- fail ArgumentError, "Missing the required parameter 'spending_plan_iteration_item_create_request_body' when calling MxPlatformApi.update_spending_plan_iteration_item"
7780
- end
7781
- # resource path
7782
- local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current/iteration_items/{iteration_item_guid}'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s)).sub('{' + 'iteration_item_guid' + '}', CGI.escape(iteration_item_guid.to_s))
7783
-
7784
- # query parameters
7785
- query_params = opts[:query_params] || {}
7786
-
7787
- # header parameters
7788
- header_params = opts[:header_params] || {}
7789
- # HTTP header 'Accept' (if needed)
7790
- header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
7791
- # HTTP header 'Content-Type'
7792
- content_type = @api_client.select_header_content_type(['application/json'])
7793
- if !content_type.nil?
7794
- header_params['Content-Type'] = content_type
7795
- end
7796
-
7797
- # form parameters
7798
- form_params = opts[:form_params] || {}
7799
-
7800
- # http body (model)
7801
- post_body = opts[:debug_body] || @api_client.object_to_http_body(spending_plan_iteration_item_create_request_body)
7802
-
7803
- # return_type
7804
- return_type = opts[:debug_return_type] || 'SpendingPlanIterationItemResponse'
7805
-
7806
- # auth_names
7807
- auth_names = opts[:debug_auth_names] || ['basicAuth']
7808
-
7809
- new_options = opts.merge(
7810
- :operation => :"MxPlatformApi.update_spending_plan_iteration_item",
7811
- :header_params => header_params,
7812
- :query_params => query_params,
7813
- :form_params => form_params,
7814
- :body => post_body,
7815
- :auth_names => auth_names,
7816
- :return_type => return_type
7817
- )
7818
-
7819
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
7820
- if @api_client.config.debugging
7821
- @api_client.config.logger.debug "API called: MxPlatformApi#update_spending_plan_iteration_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7822
- end
7823
- return data, status_code, headers
7824
- end
7825
-
7826
6772
  # Update tag
7827
6773
  # Use this endpoint to update the name of a specific tag according to its unique GUID.
7828
6774
  # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.