apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/miscellaneous_api.rb

@@ -0,0 +1,610 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # MiscellaneousApi
+  class MiscellaneousApi < BaseApi
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409130537101-Add-Mana
+    # ge-and-Deactivate-Users" target="_blank">Users</a> are the people who use
+    # your Apollo workspace.<br><br>Use the Get a List of Users endpoint to
+    # retrieve the IDs for all of the users in your Apollo account.<br><br>These
+    # IDs can be used for several other endpoints, including the <a
+    # href="https://docs.apollo.io/reference/create-deal">Create a Deal</a>, <a
+    # href="https://docs.apollo.io/reference/create-an-account">Create an
+    # Account</a>, and <a
+    # href="https://docs.apollo.io/reference/create-a-task">Create a Task</a>
+    # endpoints.<br><br>This endpoint requires a master API key. If you call the
+    # endpoint without a master key, you receive a `403` response. Check out <a
+    # href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
+    # learn how to create a master API key.
+    # @param [Integer] page Optional parameter: The page number of the Apollo
+    # data that you want to retrieve. <br><br>Use this parameter in combination
+    # with the `per_page` parameter to make search results for navigable and
+    # improve the performance of the endpoint. <br><br>Example: `4`
+    # @param [Integer] per_page Optional parameter: The number of search results
+    # that should be returned for each page. Limiting the number of results per
+    # page improves the endpoint's performance. <br><br>Use the `page` parameter
+    # to search the different pages of data. <br><br>Example: `10`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_list_of_users(page: nil,
+                            per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(per_page, key: 'per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UsersSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 UsersSearch429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # You can <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409127806093-Link-You
+    # r-Mailbox-to-Apollo" target="_blank">link mailboxes to Apollo</a>, and use
+    # them for prospect outreach.<br><br>Use the Get a List of Email Accounts
+    # endpoint to retrieve information about the linked email inboxes that your
+    # teammates use in your Apollo account.<br><br>In particular, this endpoint
+    # returns IDs for each of your team's linked email accounts, which can be
+    # used with the <a
+    # href="https://docs.apollo.io/reference/add-contacts-to-sequence">Add
+    # Contacts to a Sequence endpoint</a>.<br><br>This endpoint doesn't require
+    # any parameters.<br><br>This endpoint requires a master API key. If you
+    # call the endpoint without a master key, you receive a `403` response.
+    # Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an
+    # API Key</a> to learn how to create a master key.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_list_of_email_accounts
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/email_accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EmailAccountsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 EmailAccounts429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # Use the Get a List of All Lists endpoint to retrieve information about
+    # every <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409728608525-Create-a
+    # nd-Use-a-List" target="_blank">list</a> that has been created in your
+    # Apollo account. This endpoint can be used to check the available lists
+    # before you use the <a
+    # href="https://docs.apollo.io/reference/create-a-contact">Create a Contact
+    # endpoint</a>. <br><br>This endpoint doesn't require any
+    # parameters.<br><br>This endpoint requires a master API key. If you call
+    # the endpoint without a master key, you receive a `403` response. Check out
+    # <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a>
+    # to learn how to create a master key.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_list_of_all_lists
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/labels',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LabelsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 Labels429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # A <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409728608525-Create-a
+    # nd-Use-a-List" target="_blank">list</a> is a saved group of contacts or
+    # accounts in Apollo that you can organize, action, and track
+    # together.<br><br>Use the Create a List endpoint to create a new, empty
+    # contact or account list in your team's Apollo account. After you create a
+    # list, add records to it with the <a
+    # href="https://docs.apollo.io/reference/add-records-to-a-list">Add Records
+    # to a List endpoint</a>.<br><br>List names must be unique for each modality
+    # within your team. If you try to create a list with a name that already
+    # exists for the same modality, Apollo returns a `422` response.
+    # @param [LabelsRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_a_list(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/labels',
+                                     Server::DEFAULT)
+                   .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(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LabelsResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Labels422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Labels429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # A <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409728608525-Create-a
+    # nd-Use-a-List" target="_blank">list</a> is a saved group of contacts or
+    # accounts in Apollo that you can organize, action, and track
+    # together.<br><br>Use the Update a List endpoint to rename an existing list
+    # or to toggle its Book of Business status. You can't change a list's
+    # modality after it's created.<br><br>To find list IDs, call the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-all-lists">Get a List
+    # of All Lists endpoint</a> and identify the `id` value for the list you
+    # want to update.
+    # @param [String] id Required parameter: The Apollo ID for the list you want
+    # to update.<br><br>To find list IDs, call the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-all-lists">Get a List
+    # of All Lists endpoint</a> and identify the `id` value.<br><br>Example:
+    # `6612a4b7c8d9e0f123456789`
+    # @param [LabelsRequest1] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_a_list(id,
+                      body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/labels/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .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(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LabelsResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('404',
+                                 '404',
+                                 Labels404ErrorException)
+                    .local_error('422',
+                                 '422',
+                                 Labels422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Labels429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # A <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409728608525-Create-a
+    # nd-Use-a-List" target="_blank">list</a> is a saved group of contacts or
+    # accounts in Apollo that you can organize, action, and track
+    # together.<br><br>Use the Add Records to a List endpoint to add existing
+    # contacts or accounts to one or more lists, referencing the lists by name.
+    # If a list name you provide doesn't exist yet for the given modality,
+    # Apollo creates it automatically.<br><br>Provide the record IDs in
+    # `entity_ids` and the target list names in `label_names`. To find record
+    # IDs, use the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts">Search for
+    # Contacts</a> or <a
+    # href="https://docs.apollo.io/reference/search-for-accounts">Search for
+    # Accounts</a> endpoints.<br><br>If you provide no valid `entity_ids` or no
+    # `label_names`, the endpoint makes no changes and returns a `200` response
+    # with a confirmation message.
+    # @param [LabelsAddEntityIdsToLabelNamesRequest] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_records_to_a_list(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/labels/add_entity_ids_to_label_names',
+                                     Server::DEFAULT)
+                   .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(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LabelsAddEntityIdsToLabelNamesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 LabelsAddEntityIdsToLabelNames422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 LabelsAddEntityIdsToLabelNames429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # A <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409728608525-Create-a
+    # nd-Use-a-List" target="_blank">list</a> is a saved group of contacts or
+    # accounts in Apollo that you can organize, action, and track
+    # together.<br><br>Use the Remove Records from a List endpoint to remove
+    # contacts or accounts from one or more lists, referencing the lists by
+    # name. Removing records from a list doesn't delete the records themselves —
+    # it only removes them from the specified lists.<br><br>Provide the record
+    # IDs in `entity_ids` and the list names in `label_names`. To find record
+    # IDs, use the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts">Search for
+    # Contacts</a> or <a
+    # href="https://docs.apollo.io/reference/search-for-accounts">Search for
+    # Accounts</a> endpoints.<br><br>If you provide no valid `entity_ids` or no
+    # `label_names`, the endpoint makes no changes and returns a `200` response
+    # with a confirmation message.
+    # @param [LabelsRemoveEntityIdsFromLabelNamesRequest] body Required
+    # parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def remove_records_from_a_list(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/labels/remove_entity_ids_from_label_names',
+                                     Server::DEFAULT)
+                   .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(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LabelsRemoveEntityIdsFromLabelNamesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 LabelsRemoveEntityIdsFromLabelNames422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 LabelsRemoveEntityIdsFromLabelNames429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # Use the Get a List of Fields endpoint to retrieve information about all of
+    # the fields that exist in your Apollo account.<br><br>This endpoint
+    # requires a master API key. If you call the endpoint without a master key,
+    # you receive a `403` response. Check out <a
+    # href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
+    # learn how to create a master key.
+    # @param [Source] source Optional parameter: Example:
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_list_of_fields(source: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/fields',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(source, key: 'source'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FieldsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 Fields429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # The Create a Custom Field endpoint lets you add custom fields to your
+    # Apollo account, helping your team capture unique details with <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4412498825869-Create-C
+    # ustom-Contact-Fields" target="_blank">custom contact</a>, <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4412498754445-Create-C
+    # ustom-Account-Fields" target="_blank">custom account</a>, or <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4415062486669-Create-a
+    # -Deal" target="_blank">custom deal fields</a>.<br><br>Use these fields to
+    # enhance your sequences and deliver more personalized, relevant outreach.
+    # @param [FieldsRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_a_custom_field(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/fields',
+                                     Server::DEFAULT)
+                   .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(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FieldsResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # This endpoint is deprecated. To achieve the same result, use the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-fields">Fields
+    # endpoint</a> (use `source: custom` to get custom fields only).<br><br> Use
+    # the Get a List of Custom Fields endpoint to retrieve information about all
+    # of the custom fields that have been created in your Apollo
+    # account.<br><br>This endpoint doesn't require any parameters. <br><br>This
+    # endpoint requires a master API key. If you call the endpoint without a
+    # master key, you receive a `403` response. Check out <a
+    # href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
+    # learn how to create a master key.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_list_of_all_custom_fields
+      warn 'Endpoint get_a_list_of_all_custom_fields in MiscellaneousApi is de'\
+           'precated'
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/typed_custom_fields',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TypedCustomFieldsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 TypedCustomFields429ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # Use the Poll Webhook Result endpoint to retrieve webhook results from
+    # Apollo. This endpoint enables you to poll for the webhook payload if you
+    # didn't receive the original webhook callback.  <br><br>To use this
+    # endpoint, you need the <code>request_id</code> from the <a
+    # href="https://docs.apollo.io/reference/people-enrichment">People
+    # Enrichment</a> or <a
+    # href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People
+    # Enrichment</a> endpoint. Pass this value as <code>request_id</code> in
+    # this endpoint.<br><br>This endpoint returns webhook results for your team
+    # from up to thirty days after the webhook was triggered.
+    # @param [Integer] request_id Required parameter: The
+    # <code>request_id</code> returned when the original enrichment request was
+    # submitted. This value is an integer and can be positive or negative.
+    # <br><br>Example: <code>1039995589705121900</code>
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def poll_webhook_result(request_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/webhook_result/{request_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(request_id, key: 'request_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WebhookResultResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('404',
+                                 '404',
+                                 WebhookResult404ErrorException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # Use the View API Usage Stats endpoint to view your team's usage of Apollo
+    # API and your rate limit for API endpoints.<br><br>Each endpoint has a rate
+    # limit per minute, hour, and day. Your <a
+    # href="https://docs.apollo.io/docs/api-pricing">Apollo plan</a> does impact
+    # the rate limits for API endpoints.<br><br>This endpoint requires a master
+    # API key. If you call the endpoint without a master key, you receive a
+    # `403` response. Check out <a
+    # href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
+    # learn how to create a master key.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_apiusage
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/usage_stats/api_usage_stats',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 APIException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/28746467476365-Notes-O
+    # verview" target="_blank">Notes</a> on Apollo let you keep track of info
+    # directly on prospect profiles.<br><br>The Get a List of Notes endpoint
+    # retrieves notes associated with a specific contact, account, opportunity,
+    # calendar event, or conversation in your Apollo account. You must provide
+    # at least one relation parameter (<code>account_id</code>,
+    # <code>contact_id</code>, <code>contact_ids</code>,
+    # <code>opportunity_id</code>, <code>calendar_event_id</code>,
+    # <code>conversation_id</code>, or <code>conversation_ids</code>). Use this
+    # endpoint to fetch notes with sorting and pagination support.
+    # @param [String] contact_id Optional parameter: The ID of the contact whose
+    # notes you want to retrieve. <br><br>Example: `60a5c0b8e4b0c7001c4f1234`
+    # @param [String] account_id Optional parameter: The ID of the account whose
+    # notes you want to retrieve. <br><br>Example: `60a5c0b8e4b0c7001c4f5678`
+    # @param [String] opportunity_id Optional parameter: The ID of the
+    # opportunity whose notes you want to retrieve. <br><br>Example:
+    # `60a5c0b8e4b0c7001c4f9012`
+    # @param [String] calendar_event_id Optional parameter: The ID of the
+    # calendar event whose notes you want to retrieve. <br><br>Example:
+    # `60a5c0b8e4b0c7001c4f3456`
+    # @param [String] conversation_id Optional parameter: The ID of the
+    # conversation whose notes you want to retrieve. <br><br>Example:
+    # `60a5c0b8e4b0c7001c4f7890`
+    # @param [Array[String]] conversation_ids Optional parameter: An array of
+    # conversation IDs to filter notes by multiple conversations.
+    # @param [Array[String]] contact_ids Optional parameter: An array of contact
+    # IDs to filter notes by multiple contacts.
+    # @param [String] start_date Optional parameter: Filter notes created on or
+    # after this date. Must be a valid date string. <br><br>Example:
+    # `2024-01-01`
+    # @param [SortByField1] sort_by_field Optional parameter: The field to sort
+    # results by. Defaults to `created_at`.
+    # @param [SortDirection] sort_direction Optional parameter: The direction to
+    # sort results. Defaults to `desc`.
+    # @param [Integer] skip Optional parameter: The number of notes to skip for
+    # pagination. Must be a non-negative integer. Defaults to `0`.
+    # @param [Integer] limit Optional parameter: The maximum number of notes to
+    # return per request. Defaults to `25`. Maximum value is `100`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_list_of_notes(contact_id: nil,
+                            account_id: nil,
+                            opportunity_id: nil,
+                            calendar_event_id: nil,
+                            conversation_id: nil,
+                            conversation_ids: nil,
+                            contact_ids: nil,
+                            start_date: nil,
+                            sort_by_field: SortByField1::CREATED_AT,
+                            sort_direction: SortDirection::DESC,
+                            skip: 0,
+                            limit: 25)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/notes',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(contact_id, key: 'contact_id'))
+                   .query_param(new_parameter(account_id, key: 'account_id'))
+                   .query_param(new_parameter(opportunity_id, key: 'opportunity_id'))
+                   .query_param(new_parameter(calendar_event_id, key: 'calendar_event_id'))
+                   .query_param(new_parameter(conversation_id, key: 'conversation_id'))
+                   .query_param(new_parameter(conversation_ids, key: 'conversation_ids'))
+                   .query_param(new_parameter(contact_ids, key: 'contact_ids'))
+                   .query_param(new_parameter(start_date, key: 'start_date'))
+                   .query_param(new_parameter(sort_by_field, key: 'sort_by_field'))
+                   .query_param(new_parameter(sort_direction, key: 'sort_direction'))
+                   .query_param(new_parameter(skip, key: 'skip'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(NotesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 '400',
+                                 Notes400ErrorException)
+                    .local_error('401',
+                                 '401',
+                                 APIException))
+        .execute
+    end
+  end
+end