mx-platform-ruby 0.3.0 → 0.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +29 -222
  4. data/docs/ChallengeResponse.md +2 -2
  5. data/docs/{ChallengeImageOptions.md → ImageOptionResponse.md} +2 -2
  6. data/docs/{ChallengeOptions.md → OptionResponse.md} +2 -2
  7. data/lib/mx-platform-ruby/models/challenge_response.rb +2 -2
  8. data/lib/mx-platform-ruby/models/{challenge_image_options.rb → image_option_response.rb} +3 -3
  9. data/lib/mx-platform-ruby/models/{challenge_options.rb → option_response.rb} +3 -3
  10. data/lib/mx-platform-ruby/version.rb +1 -1
  11. data/lib/mx-platform-ruby.rb +2 -2
  12. data/openapi/config.yml +1 -1
  13. data/openapi/templates/README.mustache +71 -0
  14. data/spec/models/{challenge_image_options_spec.rb → image_option_response_spec.rb} +6 -6
  15. data/spec/models/{challenge_options_spec.rb → option_response_spec.rb} +6 -6
  16. metadata +88 -190
  17. data/docs/Account.md +0 -96
  18. data/docs/AccountNumber.md +0 -32
  19. data/docs/AccountOwner.md +0 -40
  20. data/docs/Category.md +0 -32
  21. data/docs/Challenge.md +0 -30
  22. data/docs/ChallengeResponseImageOptions.md +0 -22
  23. data/docs/ChallengeResponseOptions.md +0 -20
  24. data/docs/ConnectWidget.md +0 -20
  25. data/docs/Credential.md +0 -26
  26. data/docs/EnhanceTransaction.md +0 -48
  27. data/docs/Holding.md +0 -52
  28. data/docs/InlineResponse200.md +0 -18
  29. data/docs/Institution.md +0 -36
  30. data/docs/Member.md +0 -40
  31. data/docs/MemberStatus.md +0 -34
  32. data/docs/Merchant.md +0 -28
  33. data/docs/OAuthWindow.md +0 -20
  34. data/docs/Pagination.md +0 -24
  35. data/docs/Statement.md +0 -32
  36. data/docs/Tag.md +0 -22
  37. data/docs/Tagging.md +0 -26
  38. data/docs/Transaction.md +0 -88
  39. data/docs/TransactionRule.md +0 -30
  40. data/docs/User.md +0 -26
  41. data/docs/Widget.md +0 -22
  42. data/lib/mx-platform-ruby/models/account.rb +0 -569
  43. data/lib/mx-platform-ruby/models/account_number.rb +0 -281
  44. data/lib/mx-platform-ruby/models/account_owner.rb +0 -317
  45. data/lib/mx-platform-ruby/models/category.rb +0 -281
  46. data/lib/mx-platform-ruby/models/challenge.rb +0 -276
  47. data/lib/mx-platform-ruby/models/challenge_response_image_options.rb +0 -236
  48. data/lib/mx-platform-ruby/models/challenge_response_options.rb +0 -227
  49. data/lib/mx-platform-ruby/models/connect_widget.rb +0 -227
  50. data/lib/mx-platform-ruby/models/credential.rb +0 -254
  51. data/lib/mx-platform-ruby/models/enhance_transaction.rb +0 -353
  52. data/lib/mx-platform-ruby/models/holding.rb +0 -371
  53. data/lib/mx-platform-ruby/models/inline_response200.rb +0 -218
  54. data/lib/mx-platform-ruby/models/institution.rb +0 -299
  55. data/lib/mx-platform-ruby/models/member.rb +0 -317
  56. data/lib/mx-platform-ruby/models/member_status.rb +0 -292
  57. data/lib/mx-platform-ruby/models/merchant.rb +0 -263
  58. data/lib/mx-platform-ruby/models/o_auth_window.rb +0 -227
  59. data/lib/mx-platform-ruby/models/pagination.rb +0 -245
  60. data/lib/mx-platform-ruby/models/statement.rb +0 -281
  61. data/lib/mx-platform-ruby/models/tag.rb +0 -236
  62. data/lib/mx-platform-ruby/models/tagging.rb +0 -254
  63. data/lib/mx-platform-ruby/models/transaction.rb +0 -533
  64. data/lib/mx-platform-ruby/models/transaction_rule.rb +0 -272
  65. data/lib/mx-platform-ruby/models/user.rb +0 -254
  66. data/lib/mx-platform-ruby/models/widget.rb +0 -236
  67. data/openapi/mx_platform_ruby.yml +0 -11
  68. data/pkg/mx-platform-ruby-0.2.0.gem +0 -0
  69. data/pkg/mx-platform-ruby-0.2.1.gem +0 -0
  70. data/spec/models/account_number_spec.rb +0 -76
  71. data/spec/models/account_owner_spec.rb +0 -100
  72. data/spec/models/account_spec.rb +0 -268
  73. data/spec/models/category_spec.rb +0 -76
  74. data/spec/models/challenge_response_image_options_spec.rb +0 -46
  75. data/spec/models/challenge_response_options_spec.rb +0 -40
  76. data/spec/models/challenge_spec.rb +0 -70
  77. data/spec/models/connect_widget_spec.rb +0 -40
  78. data/spec/models/credential_spec.rb +0 -58
  79. data/spec/models/enhance_transaction_spec.rb +0 -124
  80. data/spec/models/holding_spec.rb +0 -136
  81. data/spec/models/inline_response200_spec.rb +0 -34
  82. data/spec/models/institution_spec.rb +0 -88
  83. data/spec/models/member_spec.rb +0 -100
  84. data/spec/models/member_status_spec.rb +0 -82
  85. data/spec/models/merchant_spec.rb +0 -64
  86. data/spec/models/o_auth_window_spec.rb +0 -40
  87. data/spec/models/pagination_spec.rb +0 -52
  88. data/spec/models/statement_spec.rb +0 -76
  89. data/spec/models/tag_spec.rb +0 -46
  90. data/spec/models/tagging_spec.rb +0 -58
  91. data/spec/models/transaction_rule_spec.rb +0 -70
  92. data/spec/models/transaction_spec.rb +0 -244
  93. data/spec/models/user_spec.rb +0 -58
  94. data/spec/models/widget_spec.rb +0 -46
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 916429028ed15b063976159af249cfe2392c300789fc9ea38d806f9f59d799e3
4
- data.tar.gz: f91450807b2bdd02e2d308b5f3eca9b4256d97dcf9edea9e4602e61d345554b3
3
+ metadata.gz: 04bf08e0c3925530434130c1ab5d38b9df7e84fc59d7ac372d69257cf3174ab0
4
+ data.tar.gz: c8e6005d98acc2f7bd7bb7c6c39878faa0ccbdf03f3a9fd954b1dfef99975a97
5
5
  SHA512:
6
- metadata.gz: c370f487594cac10873a4a8d32d4215d73bbc9deff0a3eb60f4fecf16c10e790e69031f3bf641e40f961162053cf1634d723ea197b73a08a305e418f2d1770cc
7
- data.tar.gz: c4fd81a7428a52e990898a336b1b9127da1dd83193a41d4889d50473299000a1b83816cbe42bce33e6fa7b641fc94f0b926aaaad63cac0006aaadce3f09df26a
6
+ metadata.gz: 2cb712bcdf6ad88b67424d0a2981d9092f3a947188ac9720336cc2287fa716a360d1dc5d369654d2ee895f0e688c9bfbf7b053c1f56d90cd7a10914d4ab4c2cd
7
+ data.tar.gz: a83b433e53c4d4bc5a195ce406f7a4c3cc37e51c3922467587cfb24458b0b2a3f14f10f58c617b6b312634f4d75fc7af05dbb3036cf9407bbdb0a0a7d4c101c3
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- mx-platform-ruby (0.3.0)
4
+ mx-platform-ruby (0.4.1)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -71,7 +71,7 @@ GEM
71
71
  unicode-display_width (1.5.0)
72
72
 
73
73
  PLATFORMS
74
- x86_64-darwin-20
74
+ x86_64-linux
75
75
 
76
76
  DEPENDENCIES
77
77
  mx-platform-ruby!
@@ -81,4 +81,4 @@ DEPENDENCIES
81
81
  rubocop (~> 0.66.0)
82
82
 
83
83
  BUNDLED WITH
84
- 2.2.16
84
+ 2.2.26
data/README.md CHANGED
@@ -1,3 +1,5 @@
1
+ *This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform API Ruby Library.*
2
+
1
3
  # mx-platform-ruby
2
4
 
3
5
  MxPlatformRuby - the Ruby gem for the MX Platform API
@@ -6,257 +8,62 @@ The MX Platform API is a powerful, fully-featured API designed to make aggregati
6
8
 
7
9
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
10
 
9
- - API version: 0.1.0
10
- - Package version: 0.3.0
11
- - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
- For more information, please visit [https://www.mx.com/products/platform-api](https://www.mx.com/products/platform-api)
11
+ - Package version: 0.4.1
13
12
 
14
13
  ## Installation
15
14
 
16
- ### Build a gem
17
-
18
- To build the Ruby code into a gem:
15
+ Add this line to your application's Gemfile:
19
16
 
20
- ```shell
21
- gem build mx-platform-ruby.gemspec
17
+ ```ruby
18
+ gem 'mx-platform-ruby'
22
19
  ```
23
20
 
24
- Then either install the gem locally:
25
-
21
+ And then execute:
26
22
  ```shell
27
- gem install ./mx-platform-ruby-0.3.0.gem
23
+ $ bundle
28
24
  ```
29
25
 
30
- (for development, run `gem install --dev ./mx-platform-ruby-0.3.0.gem` to install the development dependencies)
31
-
32
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
-
34
- Finally add this to the Gemfile:
35
-
36
- gem 'mx-platform-ruby', '~> 0.3.0'
37
-
38
- ### Install from Git
39
-
40
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
41
-
42
- gem 'mx-platform-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
43
-
44
- ### Include the Ruby code directly
45
-
46
- Include the Ruby code directly using `-I` as follows:
47
-
26
+ Or install it yourself with:
48
27
  ```shell
49
- ruby -Ilib script.rb
28
+ $ gem install mx-platform-ruby
50
29
  ```
51
30
 
52
31
  ## Getting Started
53
32
 
33
+ In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
34
+
54
35
  Please follow the [installation](#installation) procedure and then run the following code:
55
36
 
56
37
  ```ruby
57
38
  # Load the gem
58
39
  require 'mx-platform-ruby'
59
40
 
60
- # Setup authorization
41
+ # setup authorization
61
42
  MxPlatformRuby.configure do |config|
62
- # Configure HTTP basic authorization: basicAuth
63
- config.username = 'YOUR_USERNAME'
64
- config.password = 'YOUR_PASSWORD'
43
+ # Configure HTTP basic authorization
44
+ config.username = 'Your Client ID from https://dashboard.mx.com'
45
+ config.password = 'Your API Key from https://dashboard.mx.com'
46
+
47
+ # Configure server. 0 for production, 1 for development
48
+ config.server_index = 1
65
49
  end
66
50
 
67
51
  api_instance = MxPlatformRuby::MxPlatformApi.new
68
- member_guid = 'MBR-7c6f361b-e582-15b6-60c0-358f12466b4b' # String | The unique id for a `member`.
69
- user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
52
+ user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
53
+ user: MxPlatformRuby::UserCreateRequest.new(
54
+ metadata: "Creating a user!"
55
+ )
56
+ )
70
57
 
71
58
  begin
72
- #Aggregate member
73
- result = api_instance.aggregate_member(member_guid, user_guid)
59
+ # Create user
60
+ result = api_instance.create_user(user_create_request_body)
74
61
  p result
75
62
  rescue MxPlatformRuby::ApiError => e
76
- puts "Exception when calling MxPlatformApi->aggregate_member: #{e}"
63
+ puts "Error when calling MxPlatformApi->create_user: #{e}"
77
64
  end
78
-
79
65
  ```
80
66
 
81
- ## Documentation for API Endpoints
82
-
83
- All URIs are relative to *https://api.mx.com*
84
-
85
- Class | Method | HTTP request | Description
86
- ------------ | ------------- | ------------- | -------------
87
- *MxPlatformRuby::MxPlatformApi* | [**aggregate_member**](docs/MxPlatformApi.md#aggregate_member) | **POST** /users/{user_guid}/members/{member_guid}/aggregate | Aggregate member
88
- *MxPlatformRuby::MxPlatformApi* | [**check_balances**](docs/MxPlatformApi.md#check_balances) | **POST** /users/{user_guid}/members/{member_guid}/check_balance | Check balances
89
- *MxPlatformRuby::MxPlatformApi* | [**create_category**](docs/MxPlatformApi.md#create_category) | **POST** /users/{user_guid}/categories | Create category
90
- *MxPlatformRuby::MxPlatformApi* | [**create_member**](docs/MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member
91
- *MxPlatformRuby::MxPlatformApi* | [**create_tag**](docs/MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag
92
- *MxPlatformRuby::MxPlatformApi* | [**create_tagging**](docs/MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging
93
- *MxPlatformRuby::MxPlatformApi* | [**create_transaction_rule**](docs/MxPlatformApi.md#create_transaction_rule) | **POST** /users/{user_guid}/transaction_rules | Create transaction rule
94
- *MxPlatformRuby::MxPlatformApi* | [**create_user**](docs/MxPlatformApi.md#create_user) | **POST** /users | Create user
95
- *MxPlatformRuby::MxPlatformApi* | [**delete_category**](docs/MxPlatformApi.md#delete_category) | **DELETE** /users/{user_guid}/categories/{category_guid} | Delete category
96
- *MxPlatformRuby::MxPlatformApi* | [**delete_member**](docs/MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member
97
- *MxPlatformRuby::MxPlatformApi* | [**delete_tag**](docs/MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag
98
- *MxPlatformRuby::MxPlatformApi* | [**delete_tagging**](docs/MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging
99
- *MxPlatformRuby::MxPlatformApi* | [**delete_transaction_rule**](docs/MxPlatformApi.md#delete_transaction_rule) | **DELETE** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Delete transaction rule
100
- *MxPlatformRuby::MxPlatformApi* | [**delete_user**](docs/MxPlatformApi.md#delete_user) | **DELETE** /users/{user_guid} | Delete user
101
- *MxPlatformRuby::MxPlatformApi* | [**download_statement_pdf**](docs/MxPlatformApi.md#download_statement_pdf) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf
102
- *MxPlatformRuby::MxPlatformApi* | [**enhance_transactions**](docs/MxPlatformApi.md#enhance_transactions) | **POST** /transactions/enhance | Enhance transactions
103
- *MxPlatformRuby::MxPlatformApi* | [**extend_history**](docs/MxPlatformApi.md#extend_history) | **POST** /users/{user_guid}/members/{member_guid}/extend_history | Extend history
104
- *MxPlatformRuby::MxPlatformApi* | [**fetch_statements**](docs/MxPlatformApi.md#fetch_statements) | **POST** /users/{user_guid}/members/{member_guid}/fetch_statements | Fetch statements
105
- *MxPlatformRuby::MxPlatformApi* | [**identify_member**](docs/MxPlatformApi.md#identify_member) | **POST** /users/{user_guid}/members/{member_guid}/identify | Identify member
106
- *MxPlatformRuby::MxPlatformApi* | [**list_account_numbers_by_account**](docs/MxPlatformApi.md#list_account_numbers_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account
107
- *MxPlatformRuby::MxPlatformApi* | [**list_account_numbers_by_member**](docs/MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member
108
- *MxPlatformRuby::MxPlatformApi* | [**list_account_owners_by_member**](docs/MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member
109
- *MxPlatformRuby::MxPlatformApi* | [**list_categories**](docs/MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories
110
- *MxPlatformRuby::MxPlatformApi* | [**list_default_categories**](docs/MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories
111
- *MxPlatformRuby::MxPlatformApi* | [**list_favorite_institutions**](docs/MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions
112
- *MxPlatformRuby::MxPlatformApi* | [**list_holdings**](docs/MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings
113
- *MxPlatformRuby::MxPlatformApi* | [**list_holdings_by_member**](docs/MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member
114
- *MxPlatformRuby::MxPlatformApi* | [**list_institution_credentials**](docs/MxPlatformApi.md#list_institution_credentials) | **GET** /institutions/{institution_code}/credentials | List institution credentials
115
- *MxPlatformRuby::MxPlatformApi* | [**list_institutions**](docs/MxPlatformApi.md#list_institutions) | **GET** /institutions | List institutions
116
- *MxPlatformRuby::MxPlatformApi* | [**list_member_challenges**](docs/MxPlatformApi.md#list_member_challenges) | **GET** /users/{user_guid}/members/{member_guid}/challenges | List member challenges
117
- *MxPlatformRuby::MxPlatformApi* | [**list_member_credentials**](docs/MxPlatformApi.md#list_member_credentials) | **GET** /users/{user_guid}/members/{member_guid}/credentials | List member credentials
118
- *MxPlatformRuby::MxPlatformApi* | [**list_members**](docs/MxPlatformApi.md#list_members) | **GET** /users/{user_guid}/members | List members
119
- *MxPlatformRuby::MxPlatformApi* | [**list_merchants**](docs/MxPlatformApi.md#list_merchants) | **GET** /merchants | List merchants
120
- *MxPlatformRuby::MxPlatformApi* | [**list_statements_by_member**](docs/MxPlatformApi.md#list_statements_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member
121
- *MxPlatformRuby::MxPlatformApi* | [**list_taggings**](docs/MxPlatformApi.md#list_taggings) | **GET** /users/{user_guid}/taggings | List taggings
122
- *MxPlatformRuby::MxPlatformApi* | [**list_tags**](docs/MxPlatformApi.md#list_tags) | **GET** /users/{user_guid}/tags | List tags
123
- *MxPlatformRuby::MxPlatformApi* | [**list_transaction_rules**](docs/MxPlatformApi.md#list_transaction_rules) | **GET** /users/{user_guid}/transaction_rules | List transaction rules
124
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions**](docs/MxPlatformApi.md#list_transactions) | **GET** /users/{user_guid}/transactions | List transactions
125
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions_by_account**](docs/MxPlatformApi.md#list_transactions_by_account) | **GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account
126
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions_by_member**](docs/MxPlatformApi.md#list_transactions_by_member) | **GET** /users/{user_guid}/members/{member_guid}/transactions | List transactions by member
127
- *MxPlatformRuby::MxPlatformApi* | [**list_transactions_by_tag**](docs/MxPlatformApi.md#list_transactions_by_tag) | **GET** /users/{user_guid}/tags/{tag_guid}/transactions | List transactions by tag
128
- *MxPlatformRuby::MxPlatformApi* | [**list_user_accounts**](docs/MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts
129
- *MxPlatformRuby::MxPlatformApi* | [**list_users**](docs/MxPlatformApi.md#list_users) | **GET** /users | List users
130
- *MxPlatformRuby::MxPlatformApi* | [**read_account**](docs/MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account
131
- *MxPlatformRuby::MxPlatformApi* | [**read_category**](docs/MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category
132
- *MxPlatformRuby::MxPlatformApi* | [**read_holding**](docs/MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding
133
- *MxPlatformRuby::MxPlatformApi* | [**read_institution**](docs/MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution
134
- *MxPlatformRuby::MxPlatformApi* | [**read_member**](docs/MxPlatformApi.md#read_member) | **GET** /users/{user_guid}/members/{member_guid} | Read member
135
- *MxPlatformRuby::MxPlatformApi* | [**read_member_status**](docs/MxPlatformApi.md#read_member_status) | **GET** /users/{user_guid}/members/{member_guid}/status | Read member status
136
- *MxPlatformRuby::MxPlatformApi* | [**read_merchant**](docs/MxPlatformApi.md#read_merchant) | **GET** /merchants/{merchant_guid} | Read merchant
137
- *MxPlatformRuby::MxPlatformApi* | [**read_statement_by_member**](docs/MxPlatformApi.md#read_statement_by_member) | **GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member
138
- *MxPlatformRuby::MxPlatformApi* | [**read_tag**](docs/MxPlatformApi.md#read_tag) | **GET** /users/{user_guid}/tags/{tag_guid} | Read tag
139
- *MxPlatformRuby::MxPlatformApi* | [**read_tagging**](docs/MxPlatformApi.md#read_tagging) | **GET** /users/{user_guid}/taggings/{tagging_guid} | Read tagging
140
- *MxPlatformRuby::MxPlatformApi* | [**read_transaction**](docs/MxPlatformApi.md#read_transaction) | **GET** /users/{user_guid}/transactions/{transaction_guid} | Read transaction
141
- *MxPlatformRuby::MxPlatformApi* | [**read_transaction_rule**](docs/MxPlatformApi.md#read_transaction_rule) | **GET** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Read transaction rule
142
- *MxPlatformRuby::MxPlatformApi* | [**read_user**](docs/MxPlatformApi.md#read_user) | **GET** /users/{user_guid} | Read user
143
- *MxPlatformRuby::MxPlatformApi* | [**request_connect_widget_url**](docs/MxPlatformApi.md#request_connect_widget_url) | **POST** /users/{user_guid}/connect_widget_url | Request connect widget url
144
- *MxPlatformRuby::MxPlatformApi* | [**request_o_auth_window_uri**](docs/MxPlatformApi.md#request_o_auth_window_uri) | **GET** /users/{user_guid}/members/{member_guid}/oauth_window_uri | Request oauth window uri
145
- *MxPlatformRuby::MxPlatformApi* | [**request_widget_url**](docs/MxPlatformApi.md#request_widget_url) | **POST** /users/{user_guid}/widget_urls | Request widget url
146
- *MxPlatformRuby::MxPlatformApi* | [**resume_aggregation**](docs/MxPlatformApi.md#resume_aggregation) | **PUT** /users/{user_guid}/members/{member_guid}/resume | Resume aggregation
147
- *MxPlatformRuby::MxPlatformApi* | [**update_account_by_member**](docs/MxPlatformApi.md#update_account_by_member) | **PUT** /users/{user_guid}/members/{member_guid}/accounts/{account_guid} | Update account by member
148
- *MxPlatformRuby::MxPlatformApi* | [**update_category**](docs/MxPlatformApi.md#update_category) | **PUT** /users/{user_guid}/categories/{category_guid} | Update category
149
- *MxPlatformRuby::MxPlatformApi* | [**update_member**](docs/MxPlatformApi.md#update_member) | **PUT** /users/{user_guid}/members/{member_guid} | Update member
150
- *MxPlatformRuby::MxPlatformApi* | [**update_tag**](docs/MxPlatformApi.md#update_tag) | **PUT** /users/{user_guid}/tags/{tag_guid} | Update tag
151
- *MxPlatformRuby::MxPlatformApi* | [**update_tagging**](docs/MxPlatformApi.md#update_tagging) | **PUT** /users/{user_guid}/taggings/{tagging_guid} | Update tagging
152
- *MxPlatformRuby::MxPlatformApi* | [**update_transaction**](docs/MxPlatformApi.md#update_transaction) | **PUT** /users/{user_guid}/transactions/{transaction_guid} | Update transaction
153
- *MxPlatformRuby::MxPlatformApi* | [**update_transaction_rule**](docs/MxPlatformApi.md#update_transaction_rule) | **PUT** /users/{user_guid}/transaction_rules/{transaction_rule_guid} | Update transaction_rule
154
- *MxPlatformRuby::MxPlatformApi* | [**update_user**](docs/MxPlatformApi.md#update_user) | **PUT** /users/{user_guid} | Update user
155
- *MxPlatformRuby::MxPlatformApi* | [**verify_member**](docs/MxPlatformApi.md#verify_member) | **POST** /users/{user_guid}/members/{member_guid}/verify | Verify member
156
-
157
-
158
- ## Documentation for Models
159
-
160
- - [MxPlatformRuby::AccountNumberResponse](docs/AccountNumberResponse.md)
161
- - [MxPlatformRuby::AccountNumbersResponseBody](docs/AccountNumbersResponseBody.md)
162
- - [MxPlatformRuby::AccountOwnerResponse](docs/AccountOwnerResponse.md)
163
- - [MxPlatformRuby::AccountOwnersResponseBody](docs/AccountOwnersResponseBody.md)
164
- - [MxPlatformRuby::AccountResponse](docs/AccountResponse.md)
165
- - [MxPlatformRuby::AccountResponseBody](docs/AccountResponseBody.md)
166
- - [MxPlatformRuby::AccountUpdateRequest](docs/AccountUpdateRequest.md)
167
- - [MxPlatformRuby::AccountUpdateRequestBody](docs/AccountUpdateRequestBody.md)
168
- - [MxPlatformRuby::AccountsResponseBody](docs/AccountsResponseBody.md)
169
- - [MxPlatformRuby::CategoriesResponseBody](docs/CategoriesResponseBody.md)
170
- - [MxPlatformRuby::CategoryCreateRequest](docs/CategoryCreateRequest.md)
171
- - [MxPlatformRuby::CategoryCreateRequestBody](docs/CategoryCreateRequestBody.md)
172
- - [MxPlatformRuby::CategoryResponse](docs/CategoryResponse.md)
173
- - [MxPlatformRuby::CategoryResponseBody](docs/CategoryResponseBody.md)
174
- - [MxPlatformRuby::CategoryUpdateRequest](docs/CategoryUpdateRequest.md)
175
- - [MxPlatformRuby::CategoryUpdateRequestBody](docs/CategoryUpdateRequestBody.md)
176
- - [MxPlatformRuby::ChallengeResponse](docs/ChallengeResponse.md)
177
- - [MxPlatformRuby::ChallengeResponseImageOptions](docs/ChallengeResponseImageOptions.md)
178
- - [MxPlatformRuby::ChallengeResponseOptions](docs/ChallengeResponseOptions.md)
179
- - [MxPlatformRuby::ChallengesResponseBody](docs/ChallengesResponseBody.md)
180
- - [MxPlatformRuby::ConnectWidgetRequest](docs/ConnectWidgetRequest.md)
181
- - [MxPlatformRuby::ConnectWidgetRequestBody](docs/ConnectWidgetRequestBody.md)
182
- - [MxPlatformRuby::ConnectWidgetResponse](docs/ConnectWidgetResponse.md)
183
- - [MxPlatformRuby::ConnectWidgetResponseBody](docs/ConnectWidgetResponseBody.md)
184
- - [MxPlatformRuby::CredentialRequest](docs/CredentialRequest.md)
185
- - [MxPlatformRuby::CredentialResponse](docs/CredentialResponse.md)
186
- - [MxPlatformRuby::CredentialsResponseBody](docs/CredentialsResponseBody.md)
187
- - [MxPlatformRuby::EnhanceTransactionResponse](docs/EnhanceTransactionResponse.md)
188
- - [MxPlatformRuby::EnhanceTransactionsRequest](docs/EnhanceTransactionsRequest.md)
189
- - [MxPlatformRuby::EnhanceTransactionsRequestBody](docs/EnhanceTransactionsRequestBody.md)
190
- - [MxPlatformRuby::EnhanceTransactionsResponseBody](docs/EnhanceTransactionsResponseBody.md)
191
- - [MxPlatformRuby::HoldingResponse](docs/HoldingResponse.md)
192
- - [MxPlatformRuby::HoldingResponseBody](docs/HoldingResponseBody.md)
193
- - [MxPlatformRuby::HoldingsResponseBody](docs/HoldingsResponseBody.md)
194
- - [MxPlatformRuby::InstitutionResponse](docs/InstitutionResponse.md)
195
- - [MxPlatformRuby::InstitutionResponseBody](docs/InstitutionResponseBody.md)
196
- - [MxPlatformRuby::InstitutionsResponseBody](docs/InstitutionsResponseBody.md)
197
- - [MxPlatformRuby::MemberCreateRequest](docs/MemberCreateRequest.md)
198
- - [MxPlatformRuby::MemberCreateRequestBody](docs/MemberCreateRequestBody.md)
199
- - [MxPlatformRuby::MemberResponse](docs/MemberResponse.md)
200
- - [MxPlatformRuby::MemberResponseBody](docs/MemberResponseBody.md)
201
- - [MxPlatformRuby::MemberResumeRequest](docs/MemberResumeRequest.md)
202
- - [MxPlatformRuby::MemberResumeRequestBody](docs/MemberResumeRequestBody.md)
203
- - [MxPlatformRuby::MemberStatusResponse](docs/MemberStatusResponse.md)
204
- - [MxPlatformRuby::MemberStatusResponseBody](docs/MemberStatusResponseBody.md)
205
- - [MxPlatformRuby::MemberUpdateRequest](docs/MemberUpdateRequest.md)
206
- - [MxPlatformRuby::MemberUpdateRequestBody](docs/MemberUpdateRequestBody.md)
207
- - [MxPlatformRuby::MembersResponseBody](docs/MembersResponseBody.md)
208
- - [MxPlatformRuby::MerchantResponse](docs/MerchantResponse.md)
209
- - [MxPlatformRuby::MerchantResponseBody](docs/MerchantResponseBody.md)
210
- - [MxPlatformRuby::MerchantsResponseBody](docs/MerchantsResponseBody.md)
211
- - [MxPlatformRuby::OAuthWindowResponse](docs/OAuthWindowResponse.md)
212
- - [MxPlatformRuby::OAuthWindowResponseBody](docs/OAuthWindowResponseBody.md)
213
- - [MxPlatformRuby::PaginationResponse](docs/PaginationResponse.md)
214
- - [MxPlatformRuby::StatementResponse](docs/StatementResponse.md)
215
- - [MxPlatformRuby::StatementResponseBody](docs/StatementResponseBody.md)
216
- - [MxPlatformRuby::StatementsResponseBody](docs/StatementsResponseBody.md)
217
- - [MxPlatformRuby::TagCreateRequest](docs/TagCreateRequest.md)
218
- - [MxPlatformRuby::TagCreateRequestBody](docs/TagCreateRequestBody.md)
219
- - [MxPlatformRuby::TagResponse](docs/TagResponse.md)
220
- - [MxPlatformRuby::TagResponseBody](docs/TagResponseBody.md)
221
- - [MxPlatformRuby::TagUpdateRequest](docs/TagUpdateRequest.md)
222
- - [MxPlatformRuby::TagUpdateRequestBody](docs/TagUpdateRequestBody.md)
223
- - [MxPlatformRuby::TaggingCreateRequest](docs/TaggingCreateRequest.md)
224
- - [MxPlatformRuby::TaggingCreateRequestBody](docs/TaggingCreateRequestBody.md)
225
- - [MxPlatformRuby::TaggingResponse](docs/TaggingResponse.md)
226
- - [MxPlatformRuby::TaggingResponseBody](docs/TaggingResponseBody.md)
227
- - [MxPlatformRuby::TaggingUpdateRequest](docs/TaggingUpdateRequest.md)
228
- - [MxPlatformRuby::TaggingUpdateRequestBody](docs/TaggingUpdateRequestBody.md)
229
- - [MxPlatformRuby::TaggingsResponseBody](docs/TaggingsResponseBody.md)
230
- - [MxPlatformRuby::TagsResponseBody](docs/TagsResponseBody.md)
231
- - [MxPlatformRuby::TransactionResponse](docs/TransactionResponse.md)
232
- - [MxPlatformRuby::TransactionResponseBody](docs/TransactionResponseBody.md)
233
- - [MxPlatformRuby::TransactionRuleCreateRequest](docs/TransactionRuleCreateRequest.md)
234
- - [MxPlatformRuby::TransactionRuleCreateRequestBody](docs/TransactionRuleCreateRequestBody.md)
235
- - [MxPlatformRuby::TransactionRuleResponse](docs/TransactionRuleResponse.md)
236
- - [MxPlatformRuby::TransactionRuleResponseBody](docs/TransactionRuleResponseBody.md)
237
- - [MxPlatformRuby::TransactionRuleUpdateRequest](docs/TransactionRuleUpdateRequest.md)
238
- - [MxPlatformRuby::TransactionRuleUpdateRequestBody](docs/TransactionRuleUpdateRequestBody.md)
239
- - [MxPlatformRuby::TransactionRulesResponseBody](docs/TransactionRulesResponseBody.md)
240
- - [MxPlatformRuby::TransactionUpdateRequest](docs/TransactionUpdateRequest.md)
241
- - [MxPlatformRuby::TransactionUpdateRequestBody](docs/TransactionUpdateRequestBody.md)
242
- - [MxPlatformRuby::TransactionsResponseBody](docs/TransactionsResponseBody.md)
243
- - [MxPlatformRuby::UserCreateRequest](docs/UserCreateRequest.md)
244
- - [MxPlatformRuby::UserCreateRequestBody](docs/UserCreateRequestBody.md)
245
- - [MxPlatformRuby::UserResponse](docs/UserResponse.md)
246
- - [MxPlatformRuby::UserResponseBody](docs/UserResponseBody.md)
247
- - [MxPlatformRuby::UserUpdateRequest](docs/UserUpdateRequest.md)
248
- - [MxPlatformRuby::UserUpdateRequestBody](docs/UserUpdateRequestBody.md)
249
- - [MxPlatformRuby::UsersResponseBody](docs/UsersResponseBody.md)
250
- - [MxPlatformRuby::WidgetRequest](docs/WidgetRequest.md)
251
- - [MxPlatformRuby::WidgetRequestBody](docs/WidgetRequestBody.md)
252
- - [MxPlatformRuby::WidgetResponse](docs/WidgetResponse.md)
253
- - [MxPlatformRuby::WidgetResponseBody](docs/WidgetResponseBody.md)
254
-
255
-
256
- ## Documentation for Authorization
257
-
258
-
259
- ### basicAuth
260
-
261
- - **Type**: HTTP basic authentication
67
+ ## Documentation
262
68
 
69
+ Additional examples for the API endpoints can be found [here](docs/MxPlatformApi.md).
data/docs/ChallengeResponse.md CHANGED
@@ -7,9 +7,9 @@
7
7
  | **field_name** | **String** | | [optional] |
8
8
  | **guid** | **String** | | [optional] |
9
9
  | **image_data** | **String** | | [optional] |
10
- | **image_options** | [**Array<ChallengeResponseImageOptions>**](ChallengeResponseImageOptions.md) | | [optional] |
10
+ | **image_options** | [**Array<ImageOptionResponse>**](ImageOptionResponse.md) | | [optional] |
11
11
  | **label** | **String** | | [optional] |
12
- | **options** | [**Array<ChallengeResponseOptions>**](ChallengeResponseOptions.md) | | [optional] |
12
+ | **options** | [**Array<OptionResponse>**](OptionResponse.md) | | [optional] |
13
13
  | **type** | **String** | | [optional] |
14
14
 
15
15
  ## Example
data/docs/{ChallengeImageOptions.md → ImageOptionResponse.md} RENAMED
@@ -1,4 +1,4 @@
1
- # MxPlatformRuby::ChallengeImageOptions
1
+ # MxPlatformRuby::ImageOptionResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -13,7 +13,7 @@
13
13
  ```ruby
14
14
  require 'mx-platform-ruby'
15
15
 
16
- instance = MxPlatformRuby::ChallengeImageOptions.new(
16
+ instance = MxPlatformRuby::ImageOptionResponse.new(
17
17
  data_uri: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image data ...,
18
18
  label: IMAGE_1,
19
19
  value: image_data
data/docs/{ChallengeOptions.md → OptionResponse.md} RENAMED
@@ -1,4 +1,4 @@
1
- # MxPlatformRuby::ChallengeOptions
1
+ # MxPlatformRuby::OptionResponse
2
2
 
3
3
  ## Properties
4
4
 
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'mx-platform-ruby'
14
14
 
15
- instance = MxPlatformRuby::ChallengeOptions.new(
15
+ instance = MxPlatformRuby::OptionResponse.new(
16
16
  label: IMAGE_1,
17
17
  value: image_data
18
18
  )
data/lib/mx-platform-ruby/models/challenge_response.rb CHANGED
@@ -53,9 +53,9 @@ module MxPlatformRuby
53
53
  :'field_name' => :'String',
54
54
  :'guid' => :'String',
55
55
  :'image_data' => :'String',
56
- :'image_options' => :'Array<ChallengeResponseImageOptions>',
56
+ :'image_options' => :'Array<ImageOptionResponse>',
57
57
  :'label' => :'String',
58
- :'options' => :'Array<ChallengeResponseOptions>',
58
+ :'options' => :'Array<OptionResponse>',
59
59
  :'type' => :'String'
60
60
  }
61
61
  end
data/lib/mx-platform-ruby/models/{challenge_image_options.rb → image_option_response.rb} RENAMED
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module MxPlatformRuby
17
- class ChallengeImageOptions
17
+ class ImageOptionResponse
18
18
  attr_accessor :data_uri
19
19
 
20
20
  attr_accessor :label
@@ -54,13 +54,13 @@ module MxPlatformRuby
54
54
  # @param [Hash] attributes Model attributes in the form of hash
55
55
  def initialize(attributes = {})
56
56
  if (!attributes.is_a?(Hash))
57
- fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::ChallengeImageOptions` initialize method"
57
+ fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::ImageOptionResponse` initialize method"
58
58
  end
59
59
 
60
60
  # check to see if the attribute exists and convert string to symbol for hash key
61
61
  attributes = attributes.each_with_object({}) { |(k, v), h|
62
62
  if (!self.class.attribute_map.key?(k.to_sym))
63
- fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::ChallengeImageOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
63
+ fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::ImageOptionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
64
64
  end
65
65
  h[k.to_sym] = v
66
66
  }
data/lib/mx-platform-ruby/models/{challenge_options.rb → option_response.rb} RENAMED
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module MxPlatformRuby
17
- class ChallengeOptions
17
+ class OptionResponse
18
18
  attr_accessor :label
19
19
 
20
20
  attr_accessor :value
@@ -50,13 +50,13 @@ module MxPlatformRuby
50
50
  # @param [Hash] attributes Model attributes in the form of hash
51
51
  def initialize(attributes = {})
52
52
  if (!attributes.is_a?(Hash))
53
- fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::ChallengeOptions` initialize method"
53
+ fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::OptionResponse` initialize method"
54
54
  end
55
55
 
56
56
  # check to see if the attribute exists and convert string to symbol for hash key
57
57
  attributes = attributes.each_with_object({}) { |(k, v), h|
58
58
  if (!self.class.attribute_map.key?(k.to_sym))
59
- fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::ChallengeOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
59
+ fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::OptionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
60
  end
61
61
  h[k.to_sym] = v
62
62
  }
data/lib/mx-platform-ruby/version.rb CHANGED
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.0
11
11
  =end
12
12
 
13
13
  module MxPlatformRuby
14
- VERSION = '0.3.0'
14
+ VERSION = '0.4.1'
15
15
  end
data/lib/mx-platform-ruby.rb CHANGED
@@ -34,8 +34,6 @@ require 'mx-platform-ruby/models/category_response_body'
34
34
  require 'mx-platform-ruby/models/category_update_request'
35
35
  require 'mx-platform-ruby/models/category_update_request_body'
36
36
  require 'mx-platform-ruby/models/challenge_response'
37
- require 'mx-platform-ruby/models/challenge_response_image_options'
38
- require 'mx-platform-ruby/models/challenge_response_options'
39
37
  require 'mx-platform-ruby/models/challenges_response_body'
40
38
  require 'mx-platform-ruby/models/connect_widget_request'
41
39
  require 'mx-platform-ruby/models/connect_widget_request_body'
@@ -51,6 +49,7 @@ require 'mx-platform-ruby/models/enhance_transactions_response_body'
51
49
  require 'mx-platform-ruby/models/holding_response'
52
50
  require 'mx-platform-ruby/models/holding_response_body'
53
51
  require 'mx-platform-ruby/models/holdings_response_body'
52
+ require 'mx-platform-ruby/models/image_option_response'
54
53
  require 'mx-platform-ruby/models/institution_response'
55
54
  require 'mx-platform-ruby/models/institution_response_body'
56
55
  require 'mx-platform-ruby/models/institutions_response_body'
@@ -70,6 +69,7 @@ require 'mx-platform-ruby/models/merchant_response_body'
70
69
  require 'mx-platform-ruby/models/merchants_response_body'
71
70
  require 'mx-platform-ruby/models/o_auth_window_response'
72
71
  require 'mx-platform-ruby/models/o_auth_window_response_body'
72
+ require 'mx-platform-ruby/models/option_response'
73
73
  require 'mx-platform-ruby/models/pagination_response'
74
74
  require 'mx-platform-ruby/models/statement_response'
75
75
  require 'mx-platform-ruby/models/statement_response_body'