fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/controllers/transactions_ebt_card_controller.rb

@@ -0,0 +1,77 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # TransactionsEBTCardController
+  class TransactionsEBTCardController < BaseController
+    # Create a new keyed EBT voucher clear refund transaction
+    # @param [V1TransactionsEbtVoucherClearRefundKeyedRequest] body Required
+    # parameter: TODO: type description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def ebt_voucher_clear_refund(body,
+                                 expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/transactions/ebt/voucher-clear-refund/keyed',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+
+    # Create a new keyed EBT voucher clear sale transaction
+    # @param [V1TransactionsEbtVoucherClearSaleKeyedRequest] body Required
+    # parameter: TODO: type description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def ebt_voucher_clear_sale(body,
+                               expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/transactions/ebt/voucher-clear-sale/keyed',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+  end
+end

data/lib/fortis_api/controllers/transactions_read_controller.rb

@@ -0,0 +1,136 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # TransactionsReadController
+  class TransactionsReadController < BaseController
+    # Get BIN info record associated with a transaction
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @return [ResponseTransactionBinInfo] Response from the API call.
+    def get_bin_info(transaction_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/transactions/{transaction_id}/bin-info',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransactionBinInfo.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException))
+        .execute
+    end
+
+    # Get single transaction record
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @param [Array[Field57Enum]] fields Optional parameter: You can use any
+    # `field_name` from this endpoint results to filter the list of fields
+    # returned on the response.
+    # @return [ResponseTransaction] Response from the API call.
+    def get_transaction(transaction_id,
+                        expand: nil,
+                        fields: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/transactions/{transaction_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .query_param(new_parameter(fields, key: 'fields'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException))
+        .execute
+    end
+
+    # List transactions
+    # @param [Page] page Optional parameter: Use this field to specify paginate
+    # your results, by using page size and number. You can use one of the
+    # following methods: >/endpoint?page={ "number": 1, "size": 50 } >
+    # >/endpoint?page[number]=1&page[size]=50 >
+    # @param [Array[Order21]] order Optional parameter: Criteria used in query
+    # string parameters to order results.  Most fields from the endpoint results
+    # can be used as a `key`.  Unsupported fields or operators will return a
+    # `412`.  Must be encoded, or use syntax that does not require encoding.
+    # >/endpoint?order[0][key]=created_ts&order[0][operator]=asc >
+    # >/endpoint?order=[{ "key": "created_ts", "operator": "asc"}] >
+    # >/endpoint?order=[{ "key": "balance", "operator": "desc"},{ "key":
+    # "created_ts", "operator": "asc"}] >
+    # @param [Array[FilterBy]] filter_by Optional parameter: Filter criteria
+    # that can be used in query string parameters.  Most fields from the
+    # endpoint results can be used as a `key`.  Unsupported fields or operators
+    # will return a `412`. Must be encoded, or use syntax that does not require
+    # encoding.
+    # >?filter_by[0][key]=first_name&filter_by[0][operator]==&filter_by[0][value
+    # ]=Steve > >/endpoint?filter_by=[{ "key": "first_name", "operator": "=",
+    # "value": "Fred" }] > >/endpoint?filter_by=[{ "key": "account_type",
+    # "operator": "=", "value": "VISA" }] > >/endpoint?filter_by=[{ "key":
+    # "created_ts", "operator": ">=", "value": "946702799" }, { "key":
+    # "created_ts", "operator": "<=", value: "1695061891" }] >
+    # >/endpoint?filter_by=[{ "key": "last_name", "operator": "IN", "value":
+    # "Williams,Brown,Allman" }] >
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @param [Format1Enum] format Optional parameter: Reporting format, valid
+    # values: csv, tsv
+    # @param [String] typeahead Optional parameter: You can use any `field_name`
+    # from this endpoint results to order the list using the value provided as
+    # filter for the same `field_name`. It will be ordered using the following
+    # rules: 1) Exact match, 2) Starts with, 3) Contains. >/endpoint?filter={
+    # "field_name": "Value" }&_typeahead=field_name >
+    # @param [Array[Field57Enum]] fields Optional parameter: You can use any
+    # `field_name` from this endpoint results to filter the list of fields
+    # returned on the response.
+    # @return [ResponseTransactionsCollection] Response from the API call.
+    def list_transactions(page: nil,
+                          order: nil,
+                          filter_by: nil,
+                          expand: nil,
+                          format: nil,
+                          typeahead: nil,
+                          fields: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/transactions',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(order, key: 'order'))
+                   .query_param(new_parameter(filter_by, key: 'filter_by'))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .query_param(new_parameter(format, key: '_format'))
+                   .query_param(new_parameter(typeahead, key: '_typeahead'))
+                   .query_param(new_parameter(fields, key: 'fields'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransactionsCollection.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException))
+        .execute
+    end
+  end
+end

data/lib/fortis_api/controllers/transactions_updates_controller.rb

@@ -0,0 +1,266 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # TransactionsUpdatesController
+  class TransactionsUpdatesController < BaseController
+    # Void a transaction
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def void(transaction_id,
+             expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/v1/transactions/{transaction_id}/void',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException))
+        .execute
+    end
+
+    # Void a transaction
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [V1TransactionsVoidRequest] body Required parameter: TODO: type
+    # description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def void1(transaction_id,
+              body,
+              expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/transactions/{transaction_id}/void',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+
+    # Perform an auth complete transaction
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [V1TransactionsAuthCompleteRequest] body Required parameter: TODO:
+    # type description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def auth_complete(transaction_id,
+                      body,
+                      expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/transactions/{transaction_id}/auth-complete',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+
+    # Perform an auth increment transaction
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [V1TransactionsAuthIncrementRequest] body Required parameter: TODO:
+    # type description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def auth_increment(transaction_id,
+                       body,
+                       expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/transactions/{transaction_id}/auth-increment',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+
+    # Perform a partial reversal
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [V1TransactionsPartialReversalRequest] body Required parameter:
+    # TODO: type description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def partial_reversal(transaction_id,
+                         body,
+                         expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/transactions/{transaction_id}/partial-reversal',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+
+    # Perform a refund transaction
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [V1TransactionsRefundRequest] body Required parameter: TODO: type
+    # description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def refund_transaction(transaction_id,
+                           body,
+                           expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/transactions/{transaction_id}/refund',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+
+    # Increment the authorized transaction amount to include a tip
+    # @param [String] transaction_id Required parameter: Transaction ID
+    # @param [V1TransactionsTipAdjustRequest] body Required parameter: TODO:
+    # type description here
+    # @param [Array[Expand60Enum]] expand Optional parameter: Most endpoints in
+    # the API have a way to retrieve extra data related to the current record
+    # being retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @return [ResponseTransaction] Response from the API call.
+    def tip_adjustment(transaction_id,
+                       body,
+                       expand: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/v1/transactions/{transaction_id}/tip-adjust',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(transaction_id, key: 'transaction_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseTransaction.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException)
+                    .local_error('412',
+                                 'Precondition Failed',
+                                 Response412Exception))
+        .execute
+    end
+  end
+end

data/lib/fortis_api/controllers/user_verifications_controller.rb

@@ -0,0 +1,103 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # UserVerificationsController
+  class UserVerificationsController < BaseController
+    # Get user verification
+    # @param [String] user_verification_id Required parameter: TODO: type
+    # description here
+    # @return [ResponseUserVerification] Response from the API call.
+    def get_user_verification(user_verification_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/user-verifications/{user_verification_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(user_verification_id, key: 'user_verification_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseUserVerification.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException))
+        .execute
+    end
+
+    # List user verifications
+    # @param [Page] page Optional parameter: Use this field to specify paginate
+    # your results, by using page size and number. You can use one of the
+    # following methods: >/endpoint?page={ "number": 1, "size": 50 } >
+    # >/endpoint?page[number]=1&page[size]=50 >
+    # @param [Array[Order21]] order Optional parameter: Criteria used in query
+    # string parameters to order results.  Most fields from the endpoint results
+    # can be used as a `key`.  Unsupported fields or operators will return a
+    # `412`.  Must be encoded, or use syntax that does not require encoding.
+    # >/endpoint?order[0][key]=created_ts&order[0][operator]=asc >
+    # >/endpoint?order=[{ "key": "created_ts", "operator": "asc"}] >
+    # >/endpoint?order=[{ "key": "balance", "operator": "desc"},{ "key":
+    # "created_ts", "operator": "asc"}] >
+    # @param [Array[FilterBy]] filter_by Optional parameter: Filter criteria
+    # that can be used in query string parameters.  Most fields from the
+    # endpoint results can be used as a `key`.  Unsupported fields or operators
+    # will return a `412`. Must be encoded, or use syntax that does not require
+    # encoding.
+    # >?filter_by[0][key]=first_name&filter_by[0][operator]==&filter_by[0][value
+    # ]=Steve > >/endpoint?filter_by=[{ "key": "first_name", "operator": "=",
+    # "value": "Fred" }] > >/endpoint?filter_by=[{ "key": "account_type",
+    # "operator": "=", "value": "VISA" }] > >/endpoint?filter_by=[{ "key":
+    # "created_ts", "operator": ">=", "value": "946702799" }, { "key":
+    # "created_ts", "operator": "<=", value: "1695061891" }] >
+    # >/endpoint?filter_by=[{ "key": "last_name", "operator": "IN", "value":
+    # "Williams,Brown,Allman" }] >
+    # @param [Array[String]] expand Optional parameter: Most endpoints in the
+    # API have a way to retrieve extra data related to the current record being
+    # retrieved. For example, if the API request is for the accountvaults
+    # endpoint, and the end user also needs to know which contact the token
+    # belongs to, this data can be returned in the accountvaults endpoint
+    # request.
+    # @param [Format1Enum] format Optional parameter: Reporting format, valid
+    # values: csv, tsv
+    # @param [String] typeahead Optional parameter: You can use any `field_name`
+    # from this endpoint results to order the list using the value provided as
+    # filter for the same `field_name`. It will be ordered using the following
+    # rules: 1) Exact match, 2) Starts with, 3) Contains. >/endpoint?filter={
+    # "field_name": "Value" }&_typeahead=field_name >
+    # @param [Array[Field59Enum]] fields Optional parameter: You can use any
+    # `field_name` from this endpoint results to filter the list of fields
+    # returned on the response.
+    # @return [ResponseUserVerificationsCollection] Response from the API call.
+    def list_user_verifications(page: nil,
+                                order: nil,
+                                filter_by: nil,
+                                expand: nil,
+                                format: nil,
+                                typeahead: nil,
+                                fields: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/user-verifications',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(order, key: 'order'))
+                   .query_param(new_parameter(filter_by, key: 'filter_by'))
+                   .query_param(new_parameter(expand, key: 'expand'))
+                   .query_param(new_parameter(format, key: '_format'))
+                   .query_param(new_parameter(typeahead, key: '_typeahead'))
+                   .query_param(new_parameter(fields, key: 'fields'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(And.new('user-id', 'user-api-key', 'developer-id')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseUserVerificationsCollection.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 Response401tokenException))
+        .execute
+    end
+  end
+end