apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/transaction_rules_api.rb

@@ -0,0 +1,163 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TransactionRulesApi
+  class TransactionRulesApi < BaseApi
+    # Use this endpoint to read the attributes of all existing transaction rules
+    # belonging to the 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_transaction_rules(accept_version,
+                               user_guid,
+                               page: nil,
+                               records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/transaction_rules',
+                                     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(TransactionRulesResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to create a new transaction rule. The newly-created
+    # `transaction_rule` object will be returned if successful.
+    # For more information about transaction rules, see the [Transaction Rules
+    # Guide](/products/experience/pfm/integration-guides/personalization/transac
+    # tion-rules).
+    # @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 [TransactionRuleCreateRequestBody] body Required parameter:
+    # TransactionRule object to be created with optional parameters
+    # (description) and required parameters (category_guid and
+    # match_description)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_transaction_rule(accept_version,
+                                user_guid,
+                                body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/users/{user_guid}/transaction_rules',
+                                     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(TransactionRuleResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to read the attributes of an existing transaction rule
+    # based on the rule’s unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] transaction_rule_guid Required parameter: The unique id
+    # for a `transaction_rule`.
+    # @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_transaction_rule(accept_version,
+                              transaction_rule_guid,
+                              user_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/transaction_rules/{transaction_rule_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(transaction_rule_guid, key: 'transaction_rule_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(TransactionRuleResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to update the attributes of a specific transaction rule
+    # based on its unique GUID. The API will respond with the updated
+    # transaction_rule object. Any attributes not provided will be left
+    # unchanged.
+    # For more information about transaction rules, see the [Transaction Rules
+    # Guide](/products/experience/pfm/integration-guides/personalization/transac
+    # tion-rules).
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] transaction_rule_guid Required parameter: The unique id
+    # for a `transaction_rule`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [TransactionRuleUpdateRequestBody] body Required parameter:
+    # TransactionRule object to be updated
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_transaction_rule(accept_version,
+                                transaction_rule_guid,
+                                user_guid,
+                                body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_guid}/transaction_rules/{transaction_rule_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(transaction_rule_guid, key: 'transaction_rule_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(TransactionRuleResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end