apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/search_api.rb

@@ -0,0 +1,675 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SearchApi
+  class SearchApi < 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/4412658716941-Search-f
+    # or-People" target="_blank">People</a> are net-new prospects you haven't
+    # yet saved as contacts on Apollo.<br><br>Use the People API Search endpoint
+    # to find new prospects. Several filters are available to help narrow your
+    # search. This endpoint doesn't return email addresses or phone numbers. Use
+    # 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> endpoints to enrich data.<br><br>This endpoint requires a
+    # master API key. Check out <a
+    # href="https://docs.apollo.io/docs/create-api-key" target="_blank">Create
+    # an API Key</a> to learn how to create a master key.<br><br>To protect
+    # Apollo's performance for all users, this endpoint has a display limit of
+    # 50,000 records (100 records per page, up to 500 pages). Add more filters
+    # to narrow your search results as much as possible.
+    # @param [Array[String]] person_titles Optional parameter: Job titles held
+    # by the people you want to find. For a person to be included in search
+    # results, they only need to match 1 of the job titles you add. Adding more
+    # job titles expands your search results. <br><br>Results also include job
+    # titles with the same terms, even if they are not exact matches. For
+    # example, searching for `marketing manager` might return people with the
+    # job title `content marketing manager`. <br><br>Use this parameter in
+    # combination with the `person_seniorities[]` parameter to find people based
+    # on specific job functions and seniority levels. <br><br>Examples: `sales
+    # development representative`; `marketing manager`; `research analyst`
+    # @param [TrueClass | FalseClass] include_similar_titles Optional parameter:
+    # This parameter determines whether people with job titles similar to the
+    # titles you define in the `person_titles[]` parameter are returned in the
+    # response. <br><br>Set this parameter to `false` when using
+    # `person_titles[]` to return only strict matches for job titles.
+    # @param [String] q_keywords Optional parameter: A string of words over
+    # which we want to filter the results.
+    # @param [Array[String]] person_locations Optional parameter: The location
+    # where people live. You can search across cities, US states, and countries.
+    # <br><br>To find people based on the headquarters locations of their
+    # current employer, use the `organization_locations` parameter.
+    # <br><br>Examples: `california`; `ireland`; `chicago`
+    # @param [Array[String]] person_seniorities Optional parameter: The job
+    # seniority that people hold within their current employer. This enables you
+    # to find people that currently hold positions at certain reporting levels,
+    # such as Director level or senior IC level. <br><br>For a person to be
+    # included in search results, they only need to match 1 of the seniorities
+    # you add. Adding more seniorities expands your search results. <br><br>
+    # Searches only return results based on their current job title, so
+    # searching for Director-level employees only returns people that currently
+    # hold a Director-level title. If someone was previously a Director, but is
+    # currently a VP, they would not be included in your search results.
+    # <br><br>Use this parameter in combination with the `person_titles[]`
+    # parameter to find people based on specific job functions and seniority
+    # levels. <br><br>The following options can be used for this parameter:
+    # <br><ul><li><code>owner</code></li><li><code>founder</code></li><li><code>
+    # c_suite</code></li><li><code>partner</code></li><li><code>vp</code></li><l
+    # i><code>head</code></li><li><code>director</code></li><li><code>manager</c
+    # ode></li><li><code>senior</code></li><li><code>entry</code></li><li><code>
+    # intern</code></li></ul>
+    # @param [Array[String]] organization_locations Optional parameter: The
+    # location of the company headquarters for a person's current employer. You
+    # can search across cities, US states, and countries. <br><br>If a company
+    # has several office locations, results are still based on the headquarters
+    # location. For example, if you search `chicago` but a company's HQ location
+    # is in `boston`, people that work for the Boston-based company will not
+    # appear in your results, even if they match other \parameters. <br><br>To
+    # find people based on their personal location, use the `person_locations`
+    # parameter. <br><br>Examples: `texas`; `tokyo`; `spain`
+    # @param [Array[String]] q_organization_domains_list Optional parameter: The
+    # domain name for the person's employer. This can be the current employer or
+    # a previous employer. Do not include `www.`, the `@` symbol, or similar.
+    # <br><br>This parameter accepts up to 1,000 domains in a single request.
+    # <br><br>Examples: `apollo.io`; `microsoft.com`
+    # @param [Array[String]] contact_email_status Optional parameter: The email
+    # statuses for the people you want to find. You can add multiple statuses to
+    # expand your search. <br><br>The statuses you can search include:  <ul>
+    # <li> <code>verified</code> </li> <li> <code>unverified</code> </li> <li>
+    # <code>likely to engage</code> </li> <li> <code>unavailable</code> </li>
+    # </ul>
+    # @param [Array[String]] organization_ids Optional parameter: The Apollo IDs
+    # for the companies (employers) you want to include in your search results.
+    # Each company in the Apollo database is assigned a unique ID. <br><br>To
+    # find IDs, call the <a
+    # href="https://docs.apollo.io/reference/organization-search"
+    # target="_blank">Organization Search endpoint</a> and identify the values
+    # for `organization_id`.  <br><br>Example: `5e66b6381e05b4008c8331b8`
+    # @param [Array[String]] organization_num_employees_ranges Optional
+    # parameter: The number range of employees working for the person's current
+    # company. This enables you to find people based on the headcount of their
+    # employer. You can add multiple ranges to expand your search results.
+    # <br><br>Each range you add needs to be a string, with the upper and lower
+    # numbers of the range separated only by a comma. <br><br>Examples: `1,10`;
+    # `250,500`; `10000,20000`
+    # @param [Integer] revenue_range_min Optional parameter: The minimum revenue
+    # the person's current employer generates. Use this parameter in combination
+    # with `revenue_range[max]` to set a revenue range. <br><br>Do not enter
+    # currency symbols, commas, or decimal points in the figure.
+    # <br><br>Examples: `500000`; `1500000`
+    # @param [Integer] revenue_range_max Optional parameter: The maximum revenue
+    # the person's current employer generates. Use this parameter in combination
+    # with `revenue_range[min]` to set a revenue range. <br><br>Do not enter
+    # currency symbols, commas, or decimal points in the figure.
+    # <br><br>Examples: `500000`; `1500000`
+    # @param [Array[String]] currently_using_all_of_technology_uids Optional
+    # parameter: Find people based on all of the technologies their current
+    # employer uses. Apollo supports filtering by 1,500+ technologies.
+    # <br><br>Apollo calculates technologies data from multiple sources. This
+    # data is updated regularly. Check out the full list of supported
+    # technologies by <a
+    # href="https://api.apollo.io/v1/auth/supported_technologies_csv"
+    # target="_blank">downloading this CSV file</a>. <br><br>Use underscores
+    # (`_`) to replace spaces and periods for the technologies listed in the CSV
+    # file. <br><br>Examples: `salesforce`; `google_analytics`;
+    # `wordpress_org`
+    # @param [Array[String]] currently_using_any_of_technology_uids Optional
+    # parameter: Find people based on any of the technologies their current
+    # employer uses. Apollo supports filtering by 1,500+ technologies.
+    # <br><br>Apollo calculates technologies data from multiple sources. This
+    # data is updated regularly. Check out the full list of supported
+    # technologies by <a
+    # href="https://api.apollo.io/v1/auth/supported_technologies_csv"
+    # target="_blank">downloading this CSV file</a>. <br><br>Use underscores
+    # (`_`) to replace spaces and periods for the technologies listed in the CSV
+    # file. <br><br>Examples: `salesforce`; `google_analytics`;
+    # `wordpress_org`
+    # @param [Array[String]] currently_not_using_any_of_technology_uids Optional
+    # parameter: Exclude people from your search based on any of the
+    # technologies their current employer uses. Apollo supports filtering by
+    # 1,500+ technologies. <br><br>Apollo calculates technologies data from
+    # multiple sources. This data is updated regularly. Check out the full list
+    # of supported technologies by <a
+    # href="https://api.apollo.io/v1/auth/supported_technologies_csv"
+    # target="_blank">downloading this CSV file</a>. <br><br>Use underscores
+    # (`_`) to replace spaces and periods for the technologies listed in the CSV
+    # file. <br><br>Examples: `salesforce`; `google_analytics`;
+    # `wordpress_org`
+    # @param [Array[String]] q_organization_job_titles Optional parameter: The
+    # job titles that are listed in active job postings at the person's current
+    # employer. <br><br>Examples: `sales manager`; `research analyst`
+    # @param [Array[String]] organization_job_locations Optional parameter: The
+    # locations of the jobs being actively recruited by the person's employer.
+    # <br><br>Examples: `atlanta`; `japan`
+    # @param [Integer] organization_num_jobs_range_min Optional parameter: The
+    # minimum number of job postings active at the person's current empployer.
+    # Use this parameter in combination with `organization_num_jobs_range[max]`
+    # to set a job postings range. <br><br>Examples: `50`; `500`
+    # @param [Integer] organization_num_jobs_range_max Optional parameter: The
+    # maximum number of job postings active at the person's current empployer.
+    # Use this parameter in combination with `organization_num_jobs_range[min]`
+    # to set a job postings range. <br><br>Examples: `50`; `500`
+    # @param [Date] organization_job_posted_at_range_min Optional parameter: The
+    # earliest date when jobs were posted by the person's current employer. Use
+    # this parameter in combination with `organization_job_posted_at_range[max]`
+    # to set a date range for when jobs posted. <br><br>Example: `2025-07-25`
+    # @param [Date] organization_job_posted_at_range_max Optional parameter: The
+    # latest date when jobs were posted by the person's current employer. Use
+    # this parameter in combination with `organization_job_posted_at_range[min]`
+    # to set a date range for when jobs posted. <br><br>Example: `2025-09-25`
+    # @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 people_api_search(person_titles: nil,
+                          include_similar_titles: nil,
+                          q_keywords: nil,
+                          person_locations: nil,
+                          person_seniorities: nil,
+                          organization_locations: nil,
+                          q_organization_domains_list: nil,
+                          contact_email_status: nil,
+                          organization_ids: nil,
+                          organization_num_employees_ranges: nil,
+                          revenue_range_min: nil,
+                          revenue_range_max: nil,
+                          currently_using_all_of_technology_uids: nil,
+                          currently_using_any_of_technology_uids: nil,
+                          currently_not_using_any_of_technology_uids: nil,
+                          q_organization_job_titles: nil,
+                          organization_job_locations: nil,
+                          organization_num_jobs_range_min: nil,
+                          organization_num_jobs_range_max: nil,
+                          organization_job_posted_at_range_min: nil,
+                          organization_job_posted_at_range_max: nil,
+                          page: nil,
+                          per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/mixed_people/api_search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(person_titles, key: 'person_titles[]'))
+                   .query_param(new_parameter(include_similar_titles, key: 'include_similar_titles'))
+                   .query_param(new_parameter(q_keywords, key: 'q_keywords'))
+                   .query_param(new_parameter(person_locations, key: 'person_locations[]'))
+                   .query_param(new_parameter(person_seniorities, key: 'person_seniorities[]'))
+                   .query_param(new_parameter(organization_locations, key: 'organization_locations[]'))
+                   .query_param(new_parameter(q_organization_domains_list, key: 'q_organization_domains_list[]'))
+                   .query_param(new_parameter(contact_email_status, key: 'contact_email_status[]'))
+                   .query_param(new_parameter(organization_ids, key: 'organization_ids[]'))
+                   .query_param(new_parameter(organization_num_employees_ranges, key: 'organization_num_employees_ranges[]'))
+                   .query_param(new_parameter(revenue_range_min, key: 'revenue_range[min]'))
+                   .query_param(new_parameter(revenue_range_max, key: 'revenue_range[max]'))
+                   .query_param(new_parameter(currently_using_all_of_technology_uids, key: 'currently_using_all_of_technology_uids[]'))
+                   .query_param(new_parameter(currently_using_any_of_technology_uids, key: 'currently_using_any_of_technology_uids[]'))
+                   .query_param(new_parameter(currently_not_using_any_of_technology_uids, key: 'currently_not_using_any_of_technology_uids[]'))
+                   .query_param(new_parameter(q_organization_job_titles, key: 'q_organization_job_titles[]'))
+                   .query_param(new_parameter(organization_job_locations, key: 'organization_job_locations[]'))
+                   .query_param(new_parameter(organization_num_jobs_range_min, key: 'organization_num_jobs_range[min]'))
+                   .query_param(new_parameter(organization_num_jobs_range_max, key: 'organization_num_jobs_range[max]'))
+                   .query_param(new_parameter(organization_job_posted_at_range_min, key: 'organization_job_posted_at_range[min]'))
+                   .query_param(new_parameter(organization_job_posted_at_range_max, key: 'organization_job_posted_at_range[max]'))
+                   .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(MixedPeopleApiSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 MixedPeopleApiSearch422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 MixedPeopleApiSearch429ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per page** when results are
+    # returned. Each page can include up to 100 results. If Apollo doesn't
+    # return results, the request consumes **0 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/4412658766477-Search-f
+    # or-Companies" target="_blank">Organizations</a> are companies you haven't
+    # yet saved as accounts on Apollo.<br><br>Use the Organization Search
+    # endpoint to find companies in the Apollo database. Several filters are
+    # available to help narrow your search.<br><br>To protect Apollo's
+    # performance for all users, this endpoint has a display limit of 50,000
+    # records (100 records per page, up to 500 pages). Add more filters to
+    # narrow your search results as much as possible.
+    # @param [Array[String]] q_organization_domains_list Optional parameter: The
+    # domain name for the person's employer. This can be the current employer or
+    # a previous employer. Do not include `www.`, the `@` symbol, or similar.
+    # <br><br>This parameter accepts up to 1,000 domains in a single request.
+    # <br><br>Examples: `apollo.io`; `microsoft.com`
+    # @param [Array[String]] organization_num_employees_ranges Optional
+    # parameter: The number range of employees working for the company. This
+    # enables you to find companies based on headcount. You can add multiple
+    # ranges to expand your search results. <br><br>Each range you add needs to
+    # be a string, with the upper and lower numbers of the range separated only
+    # by a comma. <br><br>Examples: `1,10`; `250,500`; `10000,20000`
+    # @param [Array[String]] organization_locations Optional parameter: The
+    # location of the company headquarters. You can search across cities, US
+    # states, and countries. <br><br>If a company has several office locations,
+    # results are still based on the headquarters location. For example, if you
+    # search `chicago` but a company's HQ location is in `boston`, any
+    # Boston-based companies will not appearch in your search results, even if
+    # they match other parameters.. <br><br>To exclude companies based on
+    # location, use the `organization_not_locations` parameter.
+    # <br><br>Examples: `texas`; `tokyo`; `spain`
+    # @param [Array[String]] organization_not_locations Optional parameter:
+    # Exclude companies from search results based on the location of the company
+    # headquarters. You can use cities, US states, and countries as locations to
+    # exclude. <br><br>This parameter is useful for ensuring you do not prospect
+    # in an undesirable territory. For example, if you use `ireland` as a value,
+    # no Ireland-based companies will appear in your search results.
+    # <br><br>Examples: `minnesota`; `ireland`; `seoul`
+    # @param [Integer] revenue_range_min Optional parameter: Search for
+    # organizations based on their revenue. <br><br>Use this parameter to set
+    # the lower range of organization revenue. Use the `revenue_range[max]`
+    # parameter to set the upper range of revenue. <br><br>Do not enter currency
+    # symbols, commas, or decimal points in the figure. <br><br>Example:
+    # `300000`
+    # @param [Integer] revenue_range_max Optional parameter: Search for
+    # organizations based on their revenue. <br><br>Use this parameter to set
+    # the upper range of organization revenue. Use the `revenue_range[min]`
+    # parameter to set the lower range of revenue. <br><br>Do not enter currency
+    # symbols, commas, or decimal points in the figure. <br><br>Example:
+    # `50000000`
+    # @param [Array[String]] currently_using_any_of_technology_uids Optional
+    # parameter: Find organizations based on the technologies they currently
+    # use. Apollo supports filtering by 1,500+ technologies. <br><br>Apollo
+    # calculates technologies data from multiple sources. This data is updated
+    # regularly. Check out the full list of supported technologies by <a
+    # href="https://api.apollo.io/v1/auth/supported_technologies_csv"
+    # target="_blank">downloading this CSV file</a>. <br><br>Use underscores
+    # (`_`) to replace spaces and periods for the technologies listed in the CSV
+    # file. <br><br>Examples: `salesforce`; `google_analytics`;
+    # `wordpress_org`
+    # @param [Array[String]] q_organization_keyword_tags Optional parameter:
+    # Filter search results based on keywords associated with companies. For
+    # example, you can enter `mining` as a value to return only companies that
+    # have an association with the mining industry. <br><br>Examples: `mining`;
+    # `sales strategy`; `consulting`
+    # @param [String] q_organization_name Optional parameter: Filter search
+    # results to include a specific company name. <br><br>If the value you enter
+    # for this parameter does not match with a company's name, the company will
+    # not appear in search results, even if it matches other parameters. Partial
+    # matches are accepted. For example, if you filter by the value `marketing`,
+    # a company called `NY Marketing Unlimited` would still be eligible as a
+    # search result, but `NY Market Analysis` would not be eligible.
+    # <br><br>Example: `apollo` or `mining`
+    # @param [Array[String]] organization_ids Optional parameter: The Apollo IDs
+    # for the companies you want to include in your search results. Each company
+    # in the Apollo database is assigned a unique ID. <br><br>To find IDs,
+    # identify the values for `organization_id` when you call this endpoint.
+    # <br><br>Example: `5e66b6381e05b4008c8331b8`
+    # @param [Integer] latest_funding_amount_range_min Optional parameter: The
+    # minimum amount the company received with its most recent funding round.
+    # Use this parameter in combination with `latest_funding_amount_range[max]`
+    # to set a monetary range for the company's most recent funding round.
+    # <br><br>Do not enter currency symbols, commas, or decimal points in the
+    # figure. <br><br>Examples: `5000000`; `15000000`
+    # @param [Integer] latest_funding_amount_range_max Optional parameter: The
+    # maximium amount the company received with its most recent funding round.
+    # Use this parameter in combination with `latest_funding_amount_range[min]`
+    # to set a monetary range for the company's most recent funding round.
+    # <br><br>Do not enter currency symbols, commas, or decimal points in the
+    # figure. <br><br>Examples: `5000000`; `15000000`
+    # @param [Integer] total_funding_range_min Optional parameter: The minimum
+    # amount the company received during all of its funding rounds combined. Use
+    # this parameter in combination with `total_funding_range[max]` to set a
+    # monetary range for all of the company's funding rounds. <br><br>Do not
+    # enter currency symbols, commas, or decimal points in the figure.
+    # <br><br>Examples: `50000000`; `350000000`
+    # @param [Integer] total_funding_range_max Optional parameter: The maximum
+    # amount the company received during all of its funding rounds combined. Use
+    # this parameter in combination with `total_funding_range[min]` to set a
+    # monetary range for all of the company's funding rounds. <br><br>Do not
+    # enter currency symbols, commas, or decimal points in the figure.
+    # <br><br>Examples: `50000000`; `350000000`
+    # @param [Date] latest_funding_date_range_min Optional parameter: The
+    # earliest date when the company received its most recent funding round. Use
+    # this parameter in combination with `latest_funding_date_range[max]` to set
+    # a date range for when the company received its most recent funding round.
+    # <br><br>Example: `2025-07-25`
+    # @param [Date] latest_funding_date_range_max Optional parameter: The latest
+    # date when the company received its most recent funding round. Use this
+    # parameter in combination with `latest_funding_date_range[min]` to set a
+    # date range for when the company received its most recent funding round.
+    # <br><br>Example: `2025-09-25`
+    # @param [Array[String]] q_organization_job_titles Optional parameter: The
+    # job titles that are listed in active job postings at the company.
+    # <br><br>Examples: `sales manager`; `research analyst`
+    # @param [Array[String]] organization_job_locations Optional parameter: The
+    # locations of the jobs being actively recruited by the company.
+    # <br><br>Examples: `atlanta`; `japan`
+    # @param [Integer] organization_num_jobs_range_min Optional parameter: The
+    # minimum number of job postings active at the company. Use this parameter
+    # in combination with `organization_num_jobs_range[max]` to set a job
+    # postings range. <br><br>Examples: `50`; `500`
+    # @param [Integer] organization_num_jobs_range_max Optional parameter: The
+    # maximum number of job postings active at the company. Use this parameter
+    # in combination with `organization_num_jobs_range[min]` to set a job
+    # postings range. <br><br>Examples: `50`; `500`
+    # @param [Date] organization_job_posted_at_range_min Optional parameter: The
+    # earliest date when jobs were posted by the company. Use this parameter in
+    # combination with `organization_job_posted_at_range[max]` to set a date
+    # range for when jobs posted. <br><br>Example: `2025-07-25`
+    # @param [Date] organization_job_posted_at_range_max Optional parameter: The
+    # latest date when jobs were posted by the company. Use this parameter in
+    # combination with `organization_job_posted_at_range[min]` to set a date
+    # range for when jobs posted. <br><br>Example: `2025-09-25`
+    # @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 organization_search(q_organization_domains_list: nil,
+                            organization_num_employees_ranges: nil,
+                            organization_locations: nil,
+                            organization_not_locations: nil,
+                            revenue_range_min: nil,
+                            revenue_range_max: nil,
+                            currently_using_any_of_technology_uids: nil,
+                            q_organization_keyword_tags: nil,
+                            q_organization_name: nil,
+                            organization_ids: nil,
+                            latest_funding_amount_range_min: nil,
+                            latest_funding_amount_range_max: nil,
+                            total_funding_range_min: nil,
+                            total_funding_range_max: nil,
+                            latest_funding_date_range_min: nil,
+                            latest_funding_date_range_max: nil,
+                            q_organization_job_titles: nil,
+                            organization_job_locations: nil,
+                            organization_num_jobs_range_min: nil,
+                            organization_num_jobs_range_max: nil,
+                            organization_job_posted_at_range_min: nil,
+                            organization_job_posted_at_range_max: nil,
+                            page: nil,
+                            per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/mixed_companies/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(q_organization_domains_list, key: 'q_organization_domains_list[]'))
+                   .query_param(new_parameter(organization_num_employees_ranges, key: 'organization_num_employees_ranges[]'))
+                   .query_param(new_parameter(organization_locations, key: 'organization_locations[]'))
+                   .query_param(new_parameter(organization_not_locations, key: 'organization_not_locations[]'))
+                   .query_param(new_parameter(revenue_range_min, key: 'revenue_range[min]'))
+                   .query_param(new_parameter(revenue_range_max, key: 'revenue_range[max]'))
+                   .query_param(new_parameter(currently_using_any_of_technology_uids, key: 'currently_using_any_of_technology_uids[]'))
+                   .query_param(new_parameter(q_organization_keyword_tags, key: 'q_organization_keyword_tags[]'))
+                   .query_param(new_parameter(q_organization_name, key: 'q_organization_name'))
+                   .query_param(new_parameter(organization_ids, key: 'organization_ids[]'))
+                   .query_param(new_parameter(latest_funding_amount_range_min, key: 'latest_funding_amount_range[min]'))
+                   .query_param(new_parameter(latest_funding_amount_range_max, key: 'latest_funding_amount_range[max]'))
+                   .query_param(new_parameter(total_funding_range_min, key: 'total_funding_range[min]'))
+                   .query_param(new_parameter(total_funding_range_max, key: 'total_funding_range[max]'))
+                   .query_param(new_parameter(latest_funding_date_range_min, key: 'latest_funding_date_range[min]'))
+                   .query_param(new_parameter(latest_funding_date_range_max, key: 'latest_funding_date_range[max]'))
+                   .query_param(new_parameter(q_organization_job_titles, key: 'q_organization_job_titles[]'))
+                   .query_param(new_parameter(organization_job_locations, key: 'organization_job_locations[]'))
+                   .query_param(new_parameter(organization_num_jobs_range_min, key: 'organization_num_jobs_range[min]'))
+                   .query_param(new_parameter(organization_num_jobs_range_max, key: 'organization_num_jobs_range[max]'))
+                   .query_param(new_parameter(organization_job_posted_at_range_min, key: 'organization_job_posted_at_range[min]'))
+                   .query_param(new_parameter(organization_job_posted_at_range_max, key: 'organization_job_posted_at_range[max]'))
+                   .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(MixedCompaniesSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 MixedCompaniesSearch403ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 MixedCompaniesSearch429ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per page** when results are
+    # returned. Each page can include up to 10,000 results. If Apollo doesn't
+    # return results, the request consumes **0 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/4412658766477-Search-f
+    # or-Companies" target="_blank">Organizations</a> are companies you haven't
+    # yet saved as accounts on Apollo.<br><br>Use the Organization Job Postings
+    # endpoint to retrieve the current job postings for companies. This can help
+    # you identify companies that are growing headcount in areas that are
+    # strategically important for you.<br><br>To protect Apollo's performance
+    # for all users, this endpoint has a display limit of 10,000 records.
+    # @param [String] organization_id Required parameter: The organization ID of
+    # the company for which you want to find job postings.<br><br>Each company
+    # in the Apollo database is assigned a unique ID. To find IDs, call the <a
+    # href="https://docs.apollo.io/reference/organization-search"
+    # target="_blank">Organization Search endpoint</a> and identify the values
+    # for `organization_id`. <br><br>Example: `5e66b6381e05b4008c8331b8`
+    # @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 organization_jobs_postings(organization_id,
+                                   page: nil,
+                                   per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organizations/{organization_id}/job_postings',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(organization_id, key: 'organization_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .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(OrganizationsJobPostingsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 OrganizationsJobPostings422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 OrganizationsJobPostings429ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per company** when a company
+    # record is matched. If Apollo doesn't find a matching company, the request
+    # consumes **0 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/4412658766477-Search-f
+    # or-Companies" target="_blank">Organizations</a> are companies you haven't
+    # yet saved as accounts on Apollo.<br><br>Use the Get Complete Organization
+    # Info endpoint to retrieve complete details about an organization in
+    # Apollo.<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" target="_blank">Create
+    # an API Key</a> to learn how to create a master key.
+    # @param [String] id Required parameter: The Apollo ID for the organization
+    # that you want to research. <br><br>To find organization IDs, call the <a
+    # href="https://docs.apollo.io/reference/organization-search#/"
+    # target="_blank">Organization Search endpoint</a> and identify the
+    # `organizaton_id` value for the organization. <br><br>Example:
+    # `5e66b6381e05b4008c8331b8`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_organizations_id(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organizations/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: '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(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 APIException)
+                    .local_error('422',
+                                 'Unprocessable Entity',
+                                 APIException))
+        .execute
+    end
+
+    # This endpoint consumes Apollo credits per record when data is returned.
+    # Learn more about [API pricing and
+    # credits](https://docs.apollo.io/docs/api-pricing).
+    # Use the Get Complete Person Info endpoint to retrieve complete details
+    # about a person in the Apollo database, including employment history,
+    # location, and the full details of the person's current
+    # organization.<br><br>This endpoint requires a master API key. If you call
+    # this 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 [String] id Required parameter: The Apollo ID for the person that
+    # you want to research. <br><br>To find person IDs, call the <a
+    # href="https://docs.apollo.io/reference/people-api-search"
+    # target="_blank">People Search endpoint</a> and identify the `id` value for
+    # the person. <br><br>Example: `65f0a1b2c3d4e5f600012345`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_people_id(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/people/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: '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(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 APIException)
+                    .local_error('422',
+                                 'Unprocessable Entity',
+                                 APIException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per page** when results are
+    # returned. Each page can include up to 25 results. If Apollo doesn't return
+    # results, the request consumes **0 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/4412665755661-Search-F
+    # ilters-Overview#news" target="_blank">News</a> includes articles related
+    # to companies in Apollo.<br><br>Use the News Articles Search endpoint to
+    # find news articles related to specific companies. Several filters are
+    # available to help narrow your search.
+    # @param [Array[String]] organization_ids Required parameter: The Apollo IDs
+    # for the companies you want to include in your search results. Each company
+    # in the Apollo database is assigned a unique ID. <br><br>To find IDs, call
+    # the <a href="https://docs.apollo.io/reference/organization-search"
+    # target="_blank">Organization Search endpoint</a> and identify the values
+    # for `organization_id`.  <br><br>Example: `5e66b6381e05b4008c8331b8`
+    # @param [Array[String]] categories Optional parameter: Filter your search
+    # to include only certain categories or sub-categories of news. Use the
+    # <b>News</b> search filter for companies within Apollo to uncover all
+    # possible categories and sub-categories. <br><br>Examples: `hires`;
+    # `investment`; `contract`
+    # @param [Date] published_at_min Optional parameter: Set the lower bound of
+    # the date range you want to search. <br><br>Use this parameter in
+    # combination with the `published_at[max]` parameter. This date should fall
+    # before the `published_at[max]` date. <br><br>The date should be formatted
+    # as `YYYY-MM-DD`. <br><br>Example: `2025-02-15`
+    # @param [Date] published_at_max Optional parameter: Set the upper bound of
+    # the date range you want to search. <br><br>Use this parameter in
+    # combination with the `published_at[min]` parameter. This date should fall
+    # after the `published_at[min]` date. <br><br>The date should be formatted
+    # as `YYYY-MM-DD`. <br><br>Example: `2025-05-15`
+    # @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 news_articles_search(organization_ids,
+                             categories: nil,
+                             published_at_min: nil,
+                             published_at_max: nil,
+                             page: nil,
+                             per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/news_articles/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(organization_ids, key: 'organization_ids[]')
+                                 .is_required(true))
+                   .query_param(new_parameter(categories, key: 'categories[]'))
+                   .query_param(new_parameter(published_at_min, key: 'published_at[min]'))
+                   .query_param(new_parameter(published_at_max, key: 'published_at[max]'))
+                   .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(:dynamic_deserializer))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('422',
+                                 'Unprocessable Entity',
+                                 APIException))
+        .execute
+    end
+  end
+end