apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/members_api.rb

@@ -0,0 +1,639 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MembersApi
+  class MembersApi < BaseApi
+    # This endpoint returns an array which contains information on every member
+    # associated with a specific user.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @param [String] use_case Optional parameter: The use case associated with
+    # the member. Valid values are `PFM` and `MONEY_MOVEMENT`. For example, you
+    # can append either `?use_case=PFM` or `?use_case=MONEY_MOVEMENT`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_members(accept_version,
+                     user_identifier,
+                     page: nil,
+                     records_per_page: nil,
+                     use_case: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .query_param(new_parameter(use_case, key: 'use_case'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MembersResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint allows you to create a new member using the required
+    # parameters `institution_code`, `credentials` (if creating a non-OAuth
+    # member), and `data_request.products`. When creating a non-OAuth member,
+    # include the correct type of credential required by the financial
+    # institution and provided by the user. You can find out which credential
+    # type is required with the `/institutions/{institution_code}/credentials`
+    # endpoint. Once you successfully create a member, MX will immediately
+    # validate the provided credentials and attempt to aggregate data. A status
+    # of 200 indicates the member was created successfully, and no aggregation
+    # was requested. A status of 201 indicates the member was created, but a
+    # product within `data_request` failed to aggregate. A status of 202
+    # indicates the member was successfully created, and standard aggregation
+    # (no `data_request`) was requested (does not indicate success or failure).
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [MemberCreateRequestBody] body Required parameter: Member object to
+    # be created
+    # @param [String] x_callback_payload Optional parameter: The base64 encoded
+    # string defined in this header will be returned in the
+    # [Member](/resources/webhooks/member/) and [Member Data
+    # Updated](/resources/webhooks/member/#member-data-updated) webhooks. This
+    # allows you to trace user interactions and workflows initiated externally
+    # and internally in the MX Platform. Max 1024 characters.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_member(accept_version,
+                      user_identifier,
+                      body,
+                      x_callback_payload: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(x_callback_payload, key: 'X-CALLBACK-PAYLOAD'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Accessing this endpoint will permanently delete a member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_member(accept_version,
+                      member_identifier,
+                      user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/users/{user_identifier}/members/{member_identifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to read the attributes of a specific member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_member(accept_version,
+                    member_identifier,
+                    user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to update a members attributes. Only the credentials,
+    # id, and metadata parameters can be updated. To get a list of the required
+    # credentials for the member, use the list member credentials endpoint.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [MemberUpdateRequestBody] body Required parameter: Member object to
+    # be updated (While no single parameter is required, the request body can't
+    # be empty)
+    # @param [String] x_callback_payload Optional parameter: The base64 encoded
+    # string defined in this header will be returned in the
+    # [Member](/resources/webhooks/member/) and [Member Data
+    # Updated](/resources/webhooks/member/#member-data-updated) webhooks. This
+    # allows you to trace user interactions and workflows initiated externally
+    # and internally in the MX Platform. Max 1024 characters.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_member(accept_version,
+                      member_identifier,
+                      user_identifier,
+                      body,
+                      x_callback_payload: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_identifier}/members/{member_identifier}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter(x_callback_payload, key: 'X-CALLBACK-PAYLOAD'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Calling this endpoint initiates an aggregation event for the member. This
+    # brings in the latest account and transaction data from the connected
+    # institution. If this data has recently been updated, MX may not initiate
+    # an aggregation event.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [String] x_callback_payload Optional parameter: The base64 encoded
+    # string defined in this header will be returned in the
+    # [Member](/resources/webhooks/member/) and [Member Data
+    # Updated](/resources/webhooks/member/#member-data-updated) webhooks. This
+    # allows you to trace user interactions and workflows initiated externally
+    # and internally in the MX Platform. Max 1024 characters.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def aggregate_member(accept_version,
+                         member_identifier,
+                         user_identifier,
+                         x_callback_payload: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/{member_identifier}/aggregate',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_callback_payload, key: 'X-CALLBACK-PAYLOAD'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint will kick off a new aggregation job for each member which
+    # belongs to the user. If you've set the `use_cases` field when creating the
+    # member, then the member's use case must be set to `PFM`, otherwise a 403
+    # will return. The response will include important information about the
+    # members' aggregations including the `is_being_aggregated` and
+    # `connection_status` fields. Aggregations can take some time to finish; you
+    # can use the the read member or list members endpoints to track the status
+    # and completion of each individual aggregation as it progresses.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def aggregate_all_members(accept_version,
+                              user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/aggregate_all',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MembersResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint for information on what multi-factor authentication
+    # challenges need to be answered in order to aggregate a member. If the
+    # aggregation is not challenged, i.e., the member does not have a connection
+    # status of `CHALLENGED`, then code `204 No Content` will be returned. If
+    # the aggregation has been challenged, i.e., the member does have a
+    # connection status of `CHALLENGED`, then code `200 OK` will be returned -
+    # along with the corresponding credentials.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_member_challenges(accept_version,
+                               member_identifier,
+                               user_identifier,
+                               page: nil,
+                               records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}/challenges',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ChallengesResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint operates much like the aggregate member endpoint except that
+    # it gathers only account balance information; it does not gather any
+    # transaction data.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def check_balances(accept_version,
+                       member_identifier,
+                       user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/{member_identifier}/check_balance',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns an array which contains information on every non-MFA
+    # credential associated with a specific member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `1000`. If the value exceeds `1000`, the default
+    # value of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_member_credentials(accept_version,
+                                member_identifier,
+                                user_identifier,
+                                page: nil,
+                                records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}/credentials',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CredentialsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The identify endpoint begins an identification process for an
+    # already-existing member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def identify_member(accept_version,
+                        member_identifier,
+                        user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/{member_identifier}/identify',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint answers the challenges needed when a member has been
+    # challenged by multi-factor authentication.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [MemberResumeRequestBody] body Required parameter: Member object
+    # with MFA challenge answers
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def resume_aggregation(accept_version,
+                           member_identifier,
+                           user_identifier,
+                           body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_identifier}/members/{member_identifier}/resume',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint provides the status of the members most recent aggregation
+    # event. The results returned by this endpoint should determine what you do
+    # next in order to successfully aggregate a member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_member_status(accept_version,
+                           member_identifier,
+                           user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_identifier}/members/{member_identifier}/status',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberStatusResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # The verify endpoint begins a verification process for a member.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_identifier Required parameter: Use either the
+    # member `id` you defined or the MX-defined member `guid`. See [MX-Defined
+    # GUIDs vs IDs Defined by
+    # You](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-de
+    # fined-by-you).
+    # @param [String] user_identifier Required parameter: Use either the user
+    # `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs
+    # IDs Defined by
+    # You​](/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-d
+    # efined-by-you).
+    # @param [String] x_callback_payload Optional parameter: The base64 encoded
+    # string defined in this header will be returned in the
+    # [Member](/resources/webhooks/member/) and [Member Data
+    # Updated](/resources/webhooks/member/#member-data-updated) webhooks. This
+    # allows you to trace user interactions and workflows initiated externally
+    # and internally in the MX Platform. Max 1024 characters.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def verify_member(accept_version,
+                      member_identifier,
+                      user_identifier,
+                      x_callback_payload: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/{member_identifier}/verify',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_identifier, key: 'member_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_identifier, key: 'user_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_callback_payload, key: 'X-CALLBACK-PAYLOAD'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MemberResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end