You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/MxPlatformApi.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -810,7 +810,7 @@ Name | Type | Description | Notes
810
810
811
811
Create user
812
812
813
-
Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
813
+
Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
814
814
815
815
### Example
816
816
```java
@@ -6544,7 +6544,7 @@ Name | Type | Description | Notes
6544
6544
6545
6545
Update user
6546
6546
6547
-
Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
6547
+
Use this endpoint to update the attributes of the specified user.
* Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
1613
+
* Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
1614
1614
* @param userCreateRequestBody User object to be created. (None of these parameters are required, but the user object cannot be empty) (required)
1615
1615
* @return UserResponseBody
1616
1616
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1627,7 +1627,7 @@ public UserResponseBody createUser(UserCreateRequestBody userCreateRequestBody)
1627
1627
1628
1628
/**
1629
1629
* Create user
1630
-
* Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
1630
+
* Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
1631
1631
* @param userCreateRequestBody User object to be created. (None of these parameters are required, but the user object cannot be empty) (required)
1632
1632
* @return ApiResponse<UserResponseBody>
1633
1633
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
@@ -1645,7 +1645,7 @@ public ApiResponse<UserResponseBody> createUserWithHttpInfo(UserCreateRequestBod
1645
1645
1646
1646
/**
1647
1647
* Create user (asynchronously)
1648
-
* Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
1648
+
* Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
1649
1649
* @param userCreateRequestBody User object to be created. (None of these parameters are required, but the user object cannot be empty) (required)
1650
1650
* @param _callback The callback to be executed when the API call finishes
* Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
13168
+
* Use this endpoint to update the attributes of the specified user.
13169
13169
* @param userGuid The unique id for a `user`. (required)
13170
13170
* @param userUpdateRequestBody User object to be updated (None of these parameters are required, but the user object cannot be empty.) (required)
13171
13171
* @return UserResponseBody
@@ -13183,7 +13183,7 @@ public UserResponseBody updateUser(String userGuid, UserUpdateRequestBody userUp
13183
13183
13184
13184
/**
13185
13185
* Update user
13186
-
* Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
13186
+
* Use this endpoint to update the attributes of the specified user.
13187
13187
* @param userGuid The unique id for a `user`. (required)
13188
13188
* @param userUpdateRequestBody User object to be updated (None of these parameters are required, but the user object cannot be empty.) (required)
13189
13189
* @return ApiResponse<UserResponseBody>
@@ -13202,7 +13202,7 @@ public ApiResponse<UserResponseBody> updateUserWithHttpInfo(String userGuid, Use
13202
13202
13203
13203
/**
13204
13204
* Update user (asynchronously)
13205
-
* Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
13205
+
* Use this endpoint to update the attributes of the specified user.
13206
13206
* @param userGuid The unique id for a `user`. (required)
13207
13207
* @param userUpdateRequestBody User object to be updated (None of these parameters are required, but the user object cannot be empty.) (required)
13208
13208
* @param _callback The callback to be executed when the API call finishes
Copy file name to clipboardExpand all lines: src/test/java/com/mx/client/mx_platform_api/MxPlatformApiTest.java
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -260,7 +260,7 @@ public void createTransactionRuleTest() throws ApiException {
260
260
/**
261
261
* Create user
262
262
*
263
-
* Call this endpoint to create a new user. The MX Platform API will respond with the newly-created user object if successful. This endpoint accepts several parameters - id, metadata, and is_disabled. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill.
263
+
* Use this endpoint to create a new user. The API will respond with the newly-created user object if successful. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled.
264
264
*
265
265
* @throws ApiException
266
266
* if the Api call fails
@@ -1613,7 +1613,7 @@ public void updateTransactionRuleTest() throws ApiException {
1613
1613
/**
1614
1614
* Update user
1615
1615
*
1616
-
* Use this endpoint to update the attributes of a specific user. The MX Platform API will respond with the updated user object. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that users data until they are no longer disabled. Users who are disabled for the entirety of an MX Platform API billing period will not be factored into that months bill. To disable a user, update it and set the is_disabled parameter to true. Set it to false to re-enable the user.
1616
+
* Use this endpoint to update the attributes of the specified user.
0 commit comments