apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/statements_api.rb

@@ -0,0 +1,165 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # StatementsApi
+  class StatementsApi < BaseApi
+    # Use this endpoint to fetch the statements associated with a particular
+    # 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 fetch_statements(accept_version,
+                         member_identifier,
+                         user_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/{member_identifier}/fetch_statements',
+                                     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 get an array of available statements.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_guid Required parameter: The unique id for a
+    # `member`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @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_statements_by_member(accept_version,
+                                  member_guid,
+                                  user_guid,
+                                  page: nil,
+                                  records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/members/{member_guid}/statements',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_guid, key: 'member_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(StatementsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to read a JSON representation of the statement.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_guid Required parameter: The unique id for a
+    # `member`.
+    # @param [String] statement_guid Required parameter: The unique id for a
+    # `statement`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_statement_by_member(accept_version,
+                                 member_guid,
+                                 statement_guid,
+                                 user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_guid, key: 'member_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(statement_guid, key: 'statement_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(StatementResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to download a specified statement PDF.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] member_guid Required parameter: The unique id for a
+    # `member`.
+    # @param [String] statement_guid Required parameter: The unique id for a
+    # `statement`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def download_statement_pdf(accept_version,
+                               member_guid,
+                               statement_guid,
+                               user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(member_guid, key: 'member_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(statement_guid, key: 'statement_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(:dynamic_deserializer))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/mx_platform_api/apis/taggings_api.rb

@@ -0,0 +1,184 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TaggingsApi
+  class TaggingsApi < BaseApi
+    # Use this endpoint to retrieve a list of all the taggings associated with a
+    # specific user.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @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_taggings(accept_version,
+                      user_guid,
+                      page: nil,
+                      records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/taggings',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TaggingsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to create a new association between a tag and a
+    # particular transaction, according to their unique GUIDs.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [TaggingCreateRequestBody] body Required parameter: Tagging object
+    # to be created with required parameters (tag_guid and transaction_guid)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_tagging(accept_version,
+                       user_guid,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_guid}/taggings',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TaggingResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to delete a tagging according to its unique GUID. If
+    # successful, the API will respond with an empty body and a status of 204 NO
+    # Content.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] tagging_guid Required parameter: The unique id for a
+    # `tagging`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_tagging(accept_version,
+                       tagging_guid,
+                       user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/users/{user_guid}/taggings/{tagging_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(tagging_guid, key: 'tagging_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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 `tagging` according to its
+    # unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] tagging_guid Required parameter: The unique id for a
+    # `tagging`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_tagging(accept_version,
+                     tagging_guid,
+                     user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/taggings/{tagging_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(tagging_guid, key: 'tagging_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TaggingResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to update a tagging.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] tagging_guid Required parameter: The unique id for a
+    # `tagging`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [TaggingUpdateRequestBody] body Required parameter: Tagging object
+    # to be updated with required parameter (tag_guid)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_tagging(accept_version,
+                       tagging_guid,
+                       user_guid,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_guid}/taggings/{tagging_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(tagging_guid, key: 'tagging_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TaggingResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/mx_platform_api/apis/tags_api.rb

@@ -0,0 +1,185 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TagsApi
+  class TagsApi < BaseApi
+    # Use this endpoint to list all tags associated with the specified `user`.
+    # Each user includes the `Business` tag by default.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @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_tags(accept_version,
+                  user_guid,
+                  page: nil,
+                  records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/tags',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TagsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to create a new custom tag.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [TagCreateRequestBody] body Required parameter: Tag object to be
+    # created with required parameters (tag_guid)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_tag(accept_version,
+                   user_guid,
+                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_guid}/tags',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TagResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to permanently delete a specific tag based on its unique
+    # GUID. If successful, the API will respond with status of `204 No Content`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] tag_guid Required parameter: The unique id for a `tag`.
+    # @param [String] accept Required parameter: Specifies the media type
+    # expected in the response.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def delete_tag(accept_version,
+                   tag_guid,
+                   accept,
+                   user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/users/{user_guid}/tags/{tag_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(tag_guid, key: 'tag_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(accept, key: 'Accept')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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 particular tag according to
+    # its unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] tag_guid Required parameter: The unique id for a `tag`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_tag(accept_version,
+                 tag_guid,
+                 user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/tags/{tag_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(tag_guid, key: 'tag_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TagResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to update the name of a specific tag according to its
+    # unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] tag_guid Required parameter: The unique id for a `tag`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [TagUpdateRequestBody] body Required parameter: Tag object to be
+    # updated with required parameter (tag_guid)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_tag(accept_version,
+                   tag_guid,
+                   user_guid,
+                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_guid}/tags/{tag_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(tag_guid, key: 'tag_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .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(TagResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end