apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/rewards_api.rb

@@ -0,0 +1,149 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # RewardsApi
+  class RewardsApi < BaseApi
+    # Calling this endpoint initiates an aggregation-type event which will
+    # gather the member's rewards information, as well as account and
+    # transaction information. Rewards data is also gathered with daily
+    # background aggregations. Member and Rewards guids are defined by MX.
+    # @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 [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).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_rewards(accept_version,
+                      user_identifier,
+                      member_identifier)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_identifier}/members/{member_identifier}/fetch_rewards',
+                                     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))
+                   .template_param(new_parameter(member_identifier, key: 'member_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 list all the `rewards` associated with a specified
+    # `member`. Member guids are defined by MX.
+    # @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 [String] member_guid Required parameter: The unique id for a
+    # `member`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_rewards(accept_version,
+                     user_guid,
+                     member_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/members/{member_guid}/rewards',
+                                     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))
+                   .template_param(new_parameter(member_guid, key: 'member_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(RewardsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to read a specific `reward` based on its unique GUID.
+    # Member and Rewards guids are defined by MX.
+    # @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 [String] member_guid Required parameter: The unique id for a
+    # `member`.
+    # @param [String] reward_guid Required parameter: The unique identifier for
+    # the rewards. Defined by MX.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_rewards(accept_version,
+                     user_guid,
+                     member_guid,
+                     reward_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/members/{member_guid}/rewards/{reward_guid}',
+                                     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))
+                   .template_param(new_parameter(member_guid, key: 'member_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(reward_guid, key: 'reward_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(RewardResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns the specified `credit_card_product` according to the
+    # unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] credit_card_product_guid Required parameter: The required
+    # `credit_card_product_guid` can be found on the `account` object.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def credit_card(accept_version,
+                    credit_card_product_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/credit_card_products/{credit_card_product_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(credit_card_product_guid, key: 'credit_card_product_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(CreditCardProductResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end