mx-platform-ruby 0.14.0 → 0.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +7 -7
  3. data/docs/AuthorizationCodeRequest.md +18 -0
  4. data/docs/AuthorizationCodeRequestBody.md +18 -0
  5. data/docs/AuthorizationCodeResponse.md +18 -0
  6. data/docs/AuthorizationCodeResponseBody.md +18 -0
  7. data/docs/MxPlatformApi.md +142 -0
  8. data/docs/PaymentProcessorAuthorizationCodeRequest.md +22 -0
  9. data/docs/PaymentProcessorAuthorizationCodeRequestBody.md +18 -0
  10. data/docs/PaymentProcessorAuthorizationCodeResponse.md +18 -0
  11. data/docs/PaymentProcessorAuthorizationCodeResponseBody.md +18 -0
  12. data/docs/WidgetRequest.md +2 -0
  13. data/lib/mx-platform-ruby/api/mx_platform_api.rb +136 -0
  14. data/lib/mx-platform-ruby/models/authorization_code_request.rb +219 -0
  15. data/lib/mx-platform-ruby/models/authorization_code_request_body.rb +218 -0
  16. data/lib/mx-platform-ruby/models/authorization_code_response.rb +219 -0
  17. data/lib/mx-platform-ruby/models/authorization_code_response_body.rb +220 -0
  18. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request.rb +239 -0
  19. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_request_body.rb +218 -0
  20. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response.rb +219 -0
  21. data/lib/mx-platform-ruby/models/payment_processor_authorization_code_response_body.rb +218 -0
  22. data/lib/mx-platform-ruby/models/widget_request.rb +10 -1
  23. data/lib/mx-platform-ruby/version.rb +1 -1
  24. data/lib/mx-platform-ruby.rb +8 -0
  25. data/openapi/config.yml +1 -1
  26. data/spec/api/mx_platform_api_spec.rb +24 -0
  27. data/spec/models/authorization_code_request_body_spec.rb +34 -0
  28. data/spec/models/authorization_code_request_spec.rb +34 -0
  29. data/spec/models/authorization_code_response_body_spec.rb +34 -0
  30. data/spec/models/authorization_code_response_spec.rb +34 -0
  31. data/spec/models/payment_processor_authorization_code_request_body_spec.rb +34 -0
  32. data/spec/models/payment_processor_authorization_code_request_spec.rb +46 -0
  33. data/spec/models/payment_processor_authorization_code_response_body_spec.rb +34 -0
  34. data/spec/models/payment_processor_authorization_code_response_spec.rb +34 -0
  35. data/spec/models/widget_request_spec.rb +6 -0
  36. metadata +124 -92
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 704300e7f4ab00b263d90b0534176702c0174116a0b16d1380f311b0f233b1d6
4
- data.tar.gz: 8c385328b97c554b1e939d414f980c97c809ff9d535b08fe9decf178123ccef1
3
+ metadata.gz: 55693fb537588fcbe04a8724028765d12c4a1f274582f6994541ea714b47983f
4
+ data.tar.gz: f2d4c03cf04e6975c46ebe5799a74cb4aad5546b1b56bd231360e65dcbe30c8e
5
5
  SHA512:
6
- metadata.gz: aa2c6669e3889a5cc23fca0aab572ce5fa5ef76455cfc2a0a079230584e5ec4e51a434908b707269c1db67391e1e46a4e5d56c79dba7ef6c53a2016230f1331e
7
- data.tar.gz: edcb7eae3c1e3bf4ba1309006b4ccbf525a36f7d0d6eb08faefb0efce7a3086256a1264d2def41c0b0dc793e8465ca44c4ede980b5e076a067892a4eb55d0de8
6
+ metadata.gz: 3bc58ecf7948f8049f53bfc19398bc199f5eaab921756b39d5133d48b5d656bed5d3acd415c6333f3990e24e1e30d1997081261fcb584edd7c8382a7d31a5adb
7
+ data.tar.gz: 7aacbe53f822f45aa7e90d2447ca2db5038cd13b9518b3331de6f9308967bf5b9fd52c42f69296313d0950a6b02dea7954abd306c72cb66f2be4fa7bb3321141
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mx-platform-ruby (0.14.0)
4
+ mx-platform-ruby (0.15.0)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -37,8 +37,8 @@ GEM
37
37
  jaro_winkler (1.5.4)
38
38
  method_source (1.0.0)
39
39
  multipart-post (2.3.0)
40
- parallel (1.22.1)
41
- parser (3.2.1.1)
40
+ parallel (1.23.0)
41
+ parser (3.2.2.0)
42
42
  ast (~> 2.4.1)
43
43
  pry (0.13.1)
44
44
  coderay (~> 1.1)
@@ -54,12 +54,12 @@ GEM
54
54
  rspec-core (~> 3.12.0)
55
55
  rspec-expectations (~> 3.12.0)
56
56
  rspec-mocks (~> 3.12.0)
57
- rspec-core (3.12.1)
57
+ rspec-core (3.12.2)
58
58
  rspec-support (~> 3.12.0)
59
59
  rspec-expectations (3.12.2)
60
60
  diff-lcs (>= 1.2.0, < 2.0)
61
61
  rspec-support (~> 3.12.0)
62
- rspec-mocks (3.12.4)
62
+ rspec-mocks (3.12.5)
63
63
  diff-lcs (>= 1.2.0, < 2.0)
64
64
  rspec-support (~> 3.12.0)
65
65
  rspec-support (3.12.0)
@@ -73,7 +73,7 @@ GEM
73
73
  unicode-display_width (>= 1.4.0, < 1.6)
74
74
  ruby-progressbar (1.13.0)
75
75
  ruby2_keywords (0.0.5)
76
- stringio (3.0.5)
76
+ stringio (3.0.6)
77
77
  unicode-display_width (1.5.0)
78
78
 
79
79
  PLATFORMS
@@ -87,4 +87,4 @@ DEPENDENCIES
87
87
  rubocop (~> 0.66.0)
88
88
 
89
89
  BUNDLED WITH
90
- 2.4.8
90
+ 2.4.12
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::AuthorizationCodeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **scope** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::AuthorizationCodeRequest.new(
15
+ scope: user-guid:USR-101ad774-288b-44ed-ad16-da87d522ea20 member-guid:MBR-54feffb9-8474-47bd-8442-de003910113a account-guid:ACT-32a64160-582a-4f00-ab34-5f49cc35ed35 read-protected
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::AuthorizationCodeRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **authorization_code** | [**AuthorizationCodeRequest**](AuthorizationCodeRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::AuthorizationCodeRequestBody.new(
15
+ authorization_code: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::AuthorizationCodeResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **code** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::AuthorizationCodeResponse.new(
15
+ code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::AuthorizationCodeResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **authorization_code** | [**Array&lt;AuthorizationCodeResponse&gt;**](AuthorizationCodeResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::AuthorizationCodeResponseBody.new(
15
+ authorization_code: null
16
+ )
17
+ ```
18
+
@@ -24,6 +24,7 @@ All URIs are relative to *https://api.mx.com*
24
24
  | [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
25
25
  | [**delete_transaction_rule**](MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule |
26
26
  | [**delete_user**](MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user |
27
+ | [**deprecated_request_payment_processor_authorization_code**](MxPlatformApi.md#deprecated_request_payment_processor_authorization_code) | **POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code. |
27
28
  | [**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf |
28
29
  | [**enhance_transactions**](MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions |
29
30
  | [**extend_history**](MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history |
@@ -79,6 +80,7 @@ All URIs are relative to *https://api.mx.com*
79
80
  | [**read_transaction**](MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction |
80
81
  | [**read_transaction_rule**](MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule |
81
82
  | [**read_user**](MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user |
83
+ | [**request_authorization_code**](MxPlatformApi.md#request_authorization_code) | **POST** /authorization_code | Request an authorization code. |
82
84
  | [**request_connect_widget_url**](MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url |
83
85
  | [**request_o_auth_window_uri**](MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri |
84
86
  | [**request_widget_url**](MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url |
@@ -1536,6 +1538,76 @@ nil (empty response body)
1536
1538
  - **Accept**: Not defined
1537
1539
 
1538
1540
 
1541
+ ## deprecated_request_payment_processor_authorization_code
1542
+
1543
+ > <PaymentProcessorAuthorizationCodeResponseBody> deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
1544
+
1545
+ (Deprecated) Request an authorization code.
1546
+
1547
+ (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
1548
+
1549
+ ### Examples
1550
+
1551
+ ```ruby
1552
+ require 'time'
1553
+ require 'mx-platform-ruby'
1554
+ # setup authorization
1555
+ MxPlatformRuby.configure do |config|
1556
+ # Configure HTTP basic authorization: basicAuth
1557
+ config.username = 'YOUR USERNAME'
1558
+ config.password = 'YOUR PASSWORD'
1559
+ end
1560
+
1561
+ api_instance = MxPlatformRuby::MxPlatformApi.new
1562
+ payment_processor_authorization_code_request_body = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new # PaymentProcessorAuthorizationCodeRequestBody | The scope for the authorization code.
1563
+
1564
+ begin
1565
+ # (Deprecated) Request an authorization code.
1566
+ result = api_instance.deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body)
1567
+ p result
1568
+ rescue MxPlatformRuby::ApiError => e
1569
+ puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code: #{e}"
1570
+ end
1571
+ ```
1572
+
1573
+ #### Using the deprecated_request_payment_processor_authorization_code_with_http_info variant
1574
+
1575
+ This returns an Array which contains the response data, status code and headers.
1576
+
1577
+ > <Array(<PaymentProcessorAuthorizationCodeResponseBody>, Integer, Hash)> deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
1578
+
1579
+ ```ruby
1580
+ begin
1581
+ # (Deprecated) Request an authorization code.
1582
+ data, status_code, headers = api_instance.deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body)
1583
+ p status_code # => 2xx
1584
+ p headers # => { ... }
1585
+ p data # => <PaymentProcessorAuthorizationCodeResponseBody>
1586
+ rescue MxPlatformRuby::ApiError => e
1587
+ puts "Error when calling MxPlatformApi->deprecated_request_payment_processor_authorization_code_with_http_info: #{e}"
1588
+ end
1589
+ ```
1590
+
1591
+ ### Parameters
1592
+
1593
+ | Name | Type | Description | Notes |
1594
+ | ---- | ---- | ----------- | ----- |
1595
+ | **payment_processor_authorization_code_request_body** | [**PaymentProcessorAuthorizationCodeRequestBody**](PaymentProcessorAuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
1596
+
1597
+ ### Return type
1598
+
1599
+ [**PaymentProcessorAuthorizationCodeResponseBody**](PaymentProcessorAuthorizationCodeResponseBody.md)
1600
+
1601
+ ### Authorization
1602
+
1603
+ [basicAuth](../README.md#basicAuth)
1604
+
1605
+ ### HTTP request headers
1606
+
1607
+ - **Content-Type**: application/json
1608
+ - **Accept**: application/vnd.mx.api.v1+json
1609
+
1610
+
1539
1611
  ## download_statement_pdf
1540
1612
 
1541
1613
  > File download_statement_pdf(member_guid, statement_guid, user_guid)
@@ -5686,6 +5758,76 @@ end
5686
5758
  - **Accept**: application/vnd.mx.api.v1+json
5687
5759
 
5688
5760
 
5761
+ ## request_authorization_code
5762
+
5763
+ > <AuthorizationCodeResponseBody> request_authorization_code(authorization_code_request_body)
5764
+
5765
+ Request an authorization code.
5766
+
5767
+ Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
5768
+
5769
+ ### Examples
5770
+
5771
+ ```ruby
5772
+ require 'time'
5773
+ require 'mx-platform-ruby'
5774
+ # setup authorization
5775
+ MxPlatformRuby.configure do |config|
5776
+ # Configure HTTP basic authorization: basicAuth
5777
+ config.username = 'YOUR USERNAME'
5778
+ config.password = 'YOUR PASSWORD'
5779
+ end
5780
+
5781
+ api_instance = MxPlatformRuby::MxPlatformApi.new
5782
+ authorization_code_request_body = MxPlatformRuby::AuthorizationCodeRequestBody.new # AuthorizationCodeRequestBody | The scope for the authorization code.
5783
+
5784
+ begin
5785
+ # Request an authorization code.
5786
+ result = api_instance.request_authorization_code(authorization_code_request_body)
5787
+ p result
5788
+ rescue MxPlatformRuby::ApiError => e
5789
+ puts "Error when calling MxPlatformApi->request_authorization_code: #{e}"
5790
+ end
5791
+ ```
5792
+
5793
+ #### Using the request_authorization_code_with_http_info variant
5794
+
5795
+ This returns an Array which contains the response data, status code and headers.
5796
+
5797
+ > <Array(<AuthorizationCodeResponseBody>, Integer, Hash)> request_authorization_code_with_http_info(authorization_code_request_body)
5798
+
5799
+ ```ruby
5800
+ begin
5801
+ # Request an authorization code.
5802
+ data, status_code, headers = api_instance.request_authorization_code_with_http_info(authorization_code_request_body)
5803
+ p status_code # => 2xx
5804
+ p headers # => { ... }
5805
+ p data # => <AuthorizationCodeResponseBody>
5806
+ rescue MxPlatformRuby::ApiError => e
5807
+ puts "Error when calling MxPlatformApi->request_authorization_code_with_http_info: #{e}"
5808
+ end
5809
+ ```
5810
+
5811
+ ### Parameters
5812
+
5813
+ | Name | Type | Description | Notes |
5814
+ | ---- | ---- | ----------- | ----- |
5815
+ | **authorization_code_request_body** | [**AuthorizationCodeRequestBody**](AuthorizationCodeRequestBody.md) | The scope for the authorization code. | |
5816
+
5817
+ ### Return type
5818
+
5819
+ [**AuthorizationCodeResponseBody**](AuthorizationCodeResponseBody.md)
5820
+
5821
+ ### Authorization
5822
+
5823
+ [basicAuth](../README.md#basicAuth)
5824
+
5825
+ ### HTTP request headers
5826
+
5827
+ - **Content-Type**: application/json
5828
+ - **Accept**: application/vnd.mx.api.v1+json
5829
+
5830
+
5689
5831
  ## request_connect_widget_url
5690
5832
 
5691
5833
  > <ConnectWidgetResponseBody> request_connect_widget_url(user_guid, connect_widget_request_body)
@@ -0,0 +1,22 @@
1
+ # MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_guid** | **String** | | [optional] |
8
+ | **member_guid** | **String** | | [optional] |
9
+ | **user_guid** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'mx-platform-ruby'
15
+
16
+ instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequest.new(
17
+ account_guid: ACT-4d4c0068-33bc-4d06-bbd6-cd270fd0135c,
18
+ member_guid: MBR-46637bc5-942d-4229-9370-ddd858bf805e,
19
+ user_guid: USR-f12b1f5a-7cbe-467c-aa30-0a10d0b2f549
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeRequest**](PaymentProcessorAuthorizationCodeRequest.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeRequestBody.new(
15
+ payment_processor_authorization_code: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **authorization_code** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponse.new(
15
+ authorization_code: 9nN-9D8_4Z3WYazx7-zXfmqsD3jwgL_2W927Sb3otI
16
+ )
17
+ ```
18
+
@@ -0,0 +1,18 @@
1
+ # MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **payment_processor_authorization_code** | [**PaymentProcessorAuthorizationCodeResponse**](PaymentProcessorAuthorizationCodeResponse.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'mx-platform-ruby'
13
+
14
+ instance = MxPlatformRuby::PaymentProcessorAuthorizationCodeResponseBody.new(
15
+ payment_processor_authorization_code: null
16
+ )
17
+ ```
18
+
@@ -9,6 +9,7 @@
9
9
  | **current_institution_code** | **String** | | [optional] |
10
10
  | **current_institution_guid** | **String** | | [optional] |
11
11
  | **current_member_guid** | **String** | | [optional] |
12
+ | **disable_background_agg** | **Boolean** | | [optional] |
12
13
  | **disable_institution_search** | **Boolean** | | [optional] |
13
14
  | **include_identity** | **Boolean** | | [optional] |
14
15
  | **include_transactions** | **Boolean** | | [optional] |
@@ -31,6 +32,7 @@ instance = MxPlatformRuby::WidgetRequest.new(
31
32
  current_institution_code: chase,
32
33
  current_institution_guid: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9,
33
34
  current_member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
35
+ disable_background_agg: false,
34
36
  disable_institution_search: false,
35
37
  include_identity: false,
36
38
  include_transactions: true,
@@ -1450,6 +1450,74 @@ module MxPlatformRuby
1450
1450
  return data, status_code, headers
1451
1451
  end
1452
1452
 
1453
+ # (Deprecated) Request an authorization code.
1454
+ # (This endpoint is deprecated. Clients should use `/authorization_code`.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
1455
+ # @param payment_processor_authorization_code_request_body [PaymentProcessorAuthorizationCodeRequestBody] The scope for the authorization code.
1456
+ # @param [Hash] opts the optional parameters
1457
+ # @return [PaymentProcessorAuthorizationCodeResponseBody]
1458
+ def deprecated_request_payment_processor_authorization_code(payment_processor_authorization_code_request_body, opts = {})
1459
+ data, _status_code, _headers = deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, opts)
1460
+ data
1461
+ end
1462
+
1463
+ # (Deprecated) Request an authorization code.
1464
+ # (This endpoint is deprecated. Clients should use &#x60;/authorization_code&#x60;.) Clients use this endpoint to request an authorization_code according to a user, member, and account specified in the request body. Clients then pass this code to processors. Processor access is scoped only to the user/member/account specified in this request. Before requesting an authorization_code, clients must have verified the specified member.
1465
+ # @param payment_processor_authorization_code_request_body [PaymentProcessorAuthorizationCodeRequestBody] The scope for the authorization code.
1466
+ # @param [Hash] opts the optional parameters
1467
+ # @return [Array<(PaymentProcessorAuthorizationCodeResponseBody, Integer, Hash)>] PaymentProcessorAuthorizationCodeResponseBody data, response status code and response headers
1468
+ def deprecated_request_payment_processor_authorization_code_with_http_info(payment_processor_authorization_code_request_body, opts = {})
1469
+ if @api_client.config.debugging
1470
+ @api_client.config.logger.debug 'Calling API: MxPlatformApi.deprecated_request_payment_processor_authorization_code ...'
1471
+ end
1472
+ # verify the required parameter 'payment_processor_authorization_code_request_body' is set
1473
+ if @api_client.config.client_side_validation && payment_processor_authorization_code_request_body.nil?
1474
+ fail ArgumentError, "Missing the required parameter 'payment_processor_authorization_code_request_body' when calling MxPlatformApi.deprecated_request_payment_processor_authorization_code"
1475
+ end
1476
+ # resource path
1477
+ local_var_path = '/payment_processor_authorization_code'
1478
+
1479
+ # query parameters
1480
+ query_params = opts[:query_params] || {}
1481
+
1482
+ # header parameters
1483
+ header_params = opts[:header_params] || {}
1484
+ # HTTP header 'Accept' (if needed)
1485
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
1486
+ # HTTP header 'Content-Type'
1487
+ content_type = @api_client.select_header_content_type(['application/json'])
1488
+ if !content_type.nil?
1489
+ header_params['Content-Type'] = content_type
1490
+ end
1491
+
1492
+ # form parameters
1493
+ form_params = opts[:form_params] || {}
1494
+
1495
+ # http body (model)
1496
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_processor_authorization_code_request_body)
1497
+
1498
+ # return_type
1499
+ return_type = opts[:debug_return_type] || 'PaymentProcessorAuthorizationCodeResponseBody'
1500
+
1501
+ # auth_names
1502
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
1503
+
1504
+ new_options = opts.merge(
1505
+ :operation => :"MxPlatformApi.deprecated_request_payment_processor_authorization_code",
1506
+ :header_params => header_params,
1507
+ :query_params => query_params,
1508
+ :form_params => form_params,
1509
+ :body => post_body,
1510
+ :auth_names => auth_names,
1511
+ :return_type => return_type
1512
+ )
1513
+
1514
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1515
+ if @api_client.config.debugging
1516
+ @api_client.config.logger.debug "API called: MxPlatformApi#deprecated_request_payment_processor_authorization_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1517
+ end
1518
+ return data, status_code, headers
1519
+ end
1520
+
1453
1521
  # Download statement pdf
1454
1522
  # Use this endpoint to download a specified statement PDF.
1455
1523
  # @param member_guid [String] The unique id for a &#x60;member&#x60;.
@@ -5376,6 +5444,74 @@ module MxPlatformRuby
5376
5444
  return data, status_code, headers
5377
5445
  end
5378
5446
 
5447
+ # Request an authorization code.
5448
+ # Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
5449
+ # @param authorization_code_request_body [AuthorizationCodeRequestBody] The scope for the authorization code.
5450
+ # @param [Hash] opts the optional parameters
5451
+ # @return [AuthorizationCodeResponseBody]
5452
+ def request_authorization_code(authorization_code_request_body, opts = {})
5453
+ data, _status_code, _headers = request_authorization_code_with_http_info(authorization_code_request_body, opts)
5454
+ data
5455
+ end
5456
+
5457
+ # Request an authorization code.
5458
+ # Clients use this endpoint to request an authorization code according to the parameters specified in the scope. Clients then pass this code to processors. Processor access is scoped only to the GUIDs and features specified in this request. Before requesting an authorization code which includes a member in the scope, clients must have verified that member.
5459
+ # @param authorization_code_request_body [AuthorizationCodeRequestBody] The scope for the authorization code.
5460
+ # @param [Hash] opts the optional parameters
5461
+ # @return [Array<(AuthorizationCodeResponseBody, Integer, Hash)>] AuthorizationCodeResponseBody data, response status code and response headers
5462
+ def request_authorization_code_with_http_info(authorization_code_request_body, opts = {})
5463
+ if @api_client.config.debugging
5464
+ @api_client.config.logger.debug 'Calling API: MxPlatformApi.request_authorization_code ...'
5465
+ end
5466
+ # verify the required parameter 'authorization_code_request_body' is set
5467
+ if @api_client.config.client_side_validation && authorization_code_request_body.nil?
5468
+ fail ArgumentError, "Missing the required parameter 'authorization_code_request_body' when calling MxPlatformApi.request_authorization_code"
5469
+ end
5470
+ # resource path
5471
+ local_var_path = '/authorization_code'
5472
+
5473
+ # query parameters
5474
+ query_params = opts[:query_params] || {}
5475
+
5476
+ # header parameters
5477
+ header_params = opts[:header_params] || {}
5478
+ # HTTP header 'Accept' (if needed)
5479
+ header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
5480
+ # HTTP header 'Content-Type'
5481
+ content_type = @api_client.select_header_content_type(['application/json'])
5482
+ if !content_type.nil?
5483
+ header_params['Content-Type'] = content_type
5484
+ end
5485
+
5486
+ # form parameters
5487
+ form_params = opts[:form_params] || {}
5488
+
5489
+ # http body (model)
5490
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(authorization_code_request_body)
5491
+
5492
+ # return_type
5493
+ return_type = opts[:debug_return_type] || 'AuthorizationCodeResponseBody'
5494
+
5495
+ # auth_names
5496
+ auth_names = opts[:debug_auth_names] || ['basicAuth']
5497
+
5498
+ new_options = opts.merge(
5499
+ :operation => :"MxPlatformApi.request_authorization_code",
5500
+ :header_params => header_params,
5501
+ :query_params => query_params,
5502
+ :form_params => form_params,
5503
+ :body => post_body,
5504
+ :auth_names => auth_names,
5505
+ :return_type => return_type
5506
+ )
5507
+
5508
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5509
+ if @api_client.config.debugging
5510
+ @api_client.config.logger.debug "API called: MxPlatformApi#request_authorization_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5511
+ end
5512
+ return data, status_code, headers
5513
+ end
5514
+
5379
5515
  # Request connect widget url
5380
5516
  # This endpoint will return a URL for an embeddable version of MX Connect.
5381
5517
  # @param user_guid [String] The unique id for a &#x60;user&#x60;.