apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/enrichment_api.rb

@@ -0,0 +1,447 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EnrichmentApi
+  class EnrichmentApi < BaseApi
+    # This endpoint consumes **1-9 Apollo credits per person** when
+    # credit-consuming data is found: **1 credit** for demographics/email, plus
+    # **8 credits** if a mobile phone is returned. If Apollo doesn't return
+    # credit-consuming data, the request consumes **0 credits**.
+    # If you use waterfall enrichment for phone or email, credit usage depends
+    # on the returned data and the vendors included in your [waterfall
+    # enrichment
+    # configuration](https://knowledge.apollo.io/hc/en-us/articles/3407112166478
+    # 1-Use-Waterfall-Enrichment). Learn more about [API pricing and
+    # credits](https://docs.apollo.io/docs/api-pricing).
+    # <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichm
+    # ent-Overview" target="_blank">Enrichment</a> is when you refresh existing
+    # records so your prospecting data is up-to-date.<br><br>Use the People
+    # Enrichment endpoint to enrich data for one person. To enrich data for up
+    # to ten people with a single API call, use the <a
+    # href="https://docs.apollo.io/reference/bulk-people-enrichment">Bulk People
+    # Enrichment endpoint</a> instead.<br><br>Apollo relies on the information
+    # you pass via the endpoint's parameters to identify the correct person to
+    # enrich. If you provide more information about a person, Apollo is more
+    # likely to find a match within its database. If you only provide general
+    # information, such as a name without a domain or email address, you might
+    # receive a `200` response, but the response indicates that no records have
+    # been enriched.<br><br>By default, this endpoint doesn't return personal
+    # emails or phone numbers. Use the `reveal_personal_emails` and
+    # `reveal_phone_number` parameters to retrieve emails and phone
+    # numbers.<br><br>When you use `reveal_phone_number`, a valid `webhook_url`
+    # is required so Apollo can deliver the completed phone enrichment results.
+    # Apollo returns the main enrichment response synchronously, then sends the
+    # requested phone numbers to the webhook asynchronously. [See webhook
+    # details](#webhook-details).<br><br>You can also use the
+    # `run_waterfall_email` and `run_waterfall_phone` parameters to run
+    # waterfall enrichment via this endpoint. [Waterfall
+    # enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-W
+    # aterfall-Enrichment-Overview) gives you broader data coverage by checking
+    # connected third-party data sources for contact emails and phone
+    # numbers.<br><br>When you call this endpoint and include at least one
+    # waterfall parameter, a valid `webhook_url` is required so Apollo can
+    # deliver the completed waterfall enrichment results. Apollo returns an
+    # immediate synchronous response with demographic and firmographic data,
+    # along with a waterfall enrichment request status. Apollo then delivers
+    # enriched emails or phone numbers asynchronously to the configured webhook.
+    # ### Webhook Details
+    # - When using Apollo enrichment for phone number reveal, the webhook
+    # response follows: [Native webhook response
+    # details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-d
+    # etails).
+    # - When using waterfall enrichment, the webhook response follows:
+    # [Waterfall webhook response
+    # details](doc:enrich-phone-and-email-using-data-waterfall#response-details)
+    # .
+    # - You can poll webhook results with the [poll webhook
+    # result](doc:poll-webhook-result) endpoint by passing
+    # <code>request_id</code>.
+    # ### Webhook Requirements
+    # - **HTTPS Required:** Your endpoint must be publicly accessible over
+    # HTTPS.
+    # - **Rate Limiting:** Ensure your webhook endpoint can handle the volume of
+    # webhook traffic sent by Apollo.
+    # - **Idempotency:** Apollo may retry webhook calls; your endpoint should be
+    # idempotent to handle duplicate payloads safely.
+    # @param [String] first_name Optional parameter: The first name of the
+    # person. This is typically used in combination with the `last_name`
+    # parameter. <br><br>Example: `tim`
+    # @param [String] last_name Optional parameter: The last name of the person.
+    # This is typically used in combination with the `first_name` parameter.
+    # <br><br>Example: `zheng`
+    # @param [String] name Optional parameter: The full name of the person. This
+    # will typically be a first name and last name separated by a space.  If you
+    # use this parameter, you do not need to use the `first_name` and
+    # `last_name` parameters. <br><br>Example: `tim zheng`
+    # @param [String] email Optional parameter: The email address of the person.
+    # <br><br>Example: `example@email.com`
+    # @param [String] hashed_email Optional parameter: The hashed email of the
+    # person. The email should adhere to either the MD5 or SHA-256 hash format.
+    # <br><br>Example: `8d935115b9ff4489f2d1f9249503cadf` (MD5) or
+    # `97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152`
+    # (SHA-256)
+    # @param [String] organization_name Optional parameter: The name of the
+    # person's employer. This can be the current employer or a previous
+    # employer. <br><br>Example: `apollo`
+    # @param [String] domain 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>Example: `apollo.io` or `microsoft.com`
+    # @param [String] id Optional parameter: The Apollo ID for the person. Each
+    # person in the Apollo database is assigned a unique ID. <br><br>To find
+    # IDs, call the <a href="https://docs.apollo.io/reference/people-api-search"
+    # target="_blank">People API Search endpoint</a> and identify the values for
+    # `person_id`. <br><br>Example: `587cf802f65125cad923a266`
+    # @param [String] linkedin_url Optional parameter: The URL for the person's
+    # LinkedIn profile. <br><br>Example:
+    # `http://www.linkedin.com/in/tim-zheng-677ba010`
+    # @param [TrueClass | FalseClass] run_waterfall_email Optional parameter:
+    # Set to true to enable email waterfall enrichment
+    # @param [TrueClass | FalseClass] run_waterfall_phone Optional parameter:
+    # Set to true to enable phone waterfall enrichment
+    # @param [TrueClass | FalseClass] reveal_personal_emails Optional parameter:
+    # Set to `true` if you want to enrich the person's data with personal
+    # emails. This potentially consumes credits as part of your <a
+    # href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo
+    # pricing plan</a>. The default value is `false`. <br><br>If a person
+    # resides in a <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409141087757"
+    # target="_blank">GDPR</a>-compliant region, Apollo will not reveal their
+    # personal email.
+    # @param [TrueClass | FalseClass] reveal_phone_number Optional parameter:
+    # Set to `true` if you want to enrich the person's data with all available
+    # phone numbers, including mobile phone numbers. This potentially consumes
+    # credits as part of your <a href="https://docs.apollo.io/docs/api-pricing"
+    # target="_blank">Apollo pricing plan</a>. The default value is `false`.
+    # <br><br>If this parameter is set to `true`, you must enter a webhook URL
+    # for the `webhook_url` parameter. Apollo will asynchronously verify phone
+    # numbers for you, then send a JSON response that includes only details
+    # about the person's phone numbers to the webhook URL you provide. It can
+    # take several minutes for the phone numbers to be delivered.
+    # @param [String] webhook_url Optional parameter: If you set the
+    # `reveal_phone_number` parameter to `true`, this parameter becomes
+    # mandatory. Otherwise, do not use this parameter. <br><br>Enter the webhook
+    # URL that specifies where Apollo should send a JSON response that includes
+    # the phone number you requested. Apollo suggests testing this flow to
+    # ensure you receive the separate response with the phone number. <br><br>If
+    # phone numbers are not revealed delivered to the webhook URL, try applying
+    # UTF-8 encoding to the webhook URL. <br><br>Example:
+    # `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`;
+    # `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def people_enrichment(first_name: nil,
+                          last_name: nil,
+                          name: nil,
+                          email: nil,
+                          hashed_email: nil,
+                          organization_name: nil,
+                          domain: nil,
+                          id: nil,
+                          linkedin_url: nil,
+                          run_waterfall_email: false,
+                          run_waterfall_phone: false,
+                          reveal_personal_emails: false,
+                          reveal_phone_number: false,
+                          webhook_url: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/people/match',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(first_name, key: 'first_name'))
+                   .query_param(new_parameter(last_name, key: 'last_name'))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(email, key: 'email'))
+                   .query_param(new_parameter(hashed_email, key: 'hashed_email'))
+                   .query_param(new_parameter(organization_name, key: 'organization_name'))
+                   .query_param(new_parameter(domain, key: 'domain'))
+                   .query_param(new_parameter(id, key: 'id'))
+                   .query_param(new_parameter(linkedin_url, key: 'linkedin_url'))
+                   .query_param(new_parameter(run_waterfall_email, key: 'run_waterfall_email'))
+                   .query_param(new_parameter(run_waterfall_phone, key: 'run_waterfall_phone'))
+                   .query_param(new_parameter(reveal_personal_emails, key: 'reveal_personal_emails'))
+                   .query_param(new_parameter(reveal_phone_number, key: 'reveal_phone_number'))
+                   .query_param(new_parameter(webhook_url, key: 'webhook_url'))
+                   .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(PeopleMatchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 PeopleMatch429ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1-9 Apollo credits per person** when
+    # credit-consuming data is found: **1 credit** for demographics/email, plus
+    # **8 credits** if a mobile phone is returned. You can enrich up to 10
+    # people per request. If Apollo doesn't return credit-consuming data for a
+    # person, that person consumes **0 credits**.
+    # If you use waterfall enrichment for phone or email, credit usage depends
+    # on the returned data and the vendors included in your [waterfall
+    # enrichment
+    # configuration](https://knowledge.apollo.io/hc/en-us/articles/3407112166478
+    # 1-Use-Waterfall-Enrichment). Learn more about [API pricing and
+    # credits](https://docs.apollo.io/docs/api-pricing).
+    # <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/33699917233293-Enrichm
+    # ent-Overview" target="_blank">Enrichment</a> is when you refresh existing
+    # records so your prospecting data is up-to-date.<br><br>Use the Bulk People
+    # Enrichment endpoint to enrich data for up to ten people with a single API
+    # call. To enrich data for a single person, use the <a
+    # href="https://docs.apollo.io/reference/people-enrichment">People
+    # Enrichment endpoint</a> instead.<br><br>Apollo relies on the information
+    # you pass via the endpoint's parameters to identify the correct people to
+    # enrich. When you provide more information, Apollo is more likely to find
+    # matches within its database. If you only provide general information, such
+    # as a name without a domain or email address, you may receive a `200`
+    # response, but the response indicates that no records have been enriched.
+    # The details for each person should be passed as an object in the
+    # `details[]` array.<br><br>By default, this endpoint doesn't return
+    # personal emails or phone numbers. Use the `reveal_personal_emails`
+    # parameter to retrieve personal emails and `reveal_phone_number` to
+    # retrieve phone numbers. If you set either of these parameters to `true`,
+    # Apollo attempts to provide emails or phone numbers for all
+    # matches.<br><br>When you use `reveal_phone_number`, a valid `webhook_url`
+    # is required so Apollo can deliver the completed phone enrichment results.
+    # Apollo returns the main enrichment response synchronously, then sends the
+    # requested phone numbers to the webhook asynchronously. [See webhook
+    # details](#webhook-details).<br><br>You can also use the
+    # `run_waterfall_email` and `run_waterfall_phone` parameters to run
+    # waterfall enrichment via this endpoint. [Waterfall
+    # enrichment](https://knowledge.apollo.io/hc/en-us/articles/34071089002509-W
+    # aterfall-Enrichment-Overview) gives you broader data coverage by checking
+    # connected third-party data sources for contact emails and phone
+    # numbers.<br><br>When you call this endpoint and include at least one
+    # waterfall parameter, a valid `webhook_url` is required so Apollo can
+    # deliver the completed waterfall enrichment results. Apollo returns an
+    # immediate synchronous response with demographic and firmographic data,
+    # along with a waterfall enrichment request status. Apollo then delivers
+    # enriched emails or phone numbers asynchronously to the configured
+    # webhook.<br><br>
+    # ### Webhook Details
+    # * When using native phone enrichment, the webhook response follows:
+    # [Native webhook response
+    # details](doc:retrieve-mobile-phone-numbers-for-contacts#webhook-response-d
+    # etails).
+    # * When using waterfall enrichment, the webhook response follows:
+    # [Waterfall webhook response
+    # details](doc:enrich-phone-and-email-using-data-waterfall#response-details)
+    # .
+    # * You can poll webhook results with the [Poll Webhook
+    # Result](doc:poll-webhook-result) endpoint by passing
+    # <code>request_id</code>.
+    # ### Webhook Requirements
+    # * **HTTPS Required:** Your endpoint must be publicly accessible over
+    # HTTPS.
+    # * **Rate Limiting:** Ensure your webhook endpoint can handle the volume of
+    # webhook traffic sent by Apollo.
+    # * **Idempotency:** Apollo may retry webhook calls. Your endpoint should be
+    # idempotent to handle duplicate payloads safely.
+    # @param [TrueClass | FalseClass] run_waterfall_email Optional parameter:
+    # Set to true to enable email waterfall enrichment
+    # @param [TrueClass | FalseClass] run_waterfall_phone Optional parameter:
+    # Set to true to enable phone waterfall enrichment
+    # @param [TrueClass | FalseClass] reveal_personal_emails Optional parameter:
+    # Set to `true` if you want to enrich all matched people with personal
+    # emails. This potentially consumes credits as part of your <a
+    # href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo
+    # pricing plan</a>. The default value is `false`. <br><br>If a person
+    # resides in a <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409141087757"
+    # target="_blank">GDPR</a>-compliant region, Apollo will not reveal their
+    # personal email.
+    # @param [TrueClass | FalseClass] reveal_phone_number Optional parameter:
+    # Set to `true` if you want to enrich the data of all matched people with
+    # all available phone numbers, including mobile phone numbers. This
+    # potentially consumes credits as part of your <a
+    # href="https://docs.apollo.io/docs/api-pricing" target="_blank">Apollo
+    # pricing plan</a>. The default value is `false`. <br><br>If this parameter
+    # is set to `true`, you must enter a webhook URL for the `webhook_url`
+    # parameter. Apollo will asynchronously verify phone numbers for you, then
+    # send a JSON response that includes only details about the phone numbers to
+    # the webhook URL you provide. It can take several minutes for the phone
+    # numbers to be delivered.
+    # @param [String] webhook_url Optional parameter: If you set the
+    # `reveal_phone_number` parameter to `true`, this parameter becomes
+    # mandatory. Otherwise, do not use this parameter. <br><br>Enter the webhook
+    # URL that specifies where Apollo should send a JSON response that includes
+    # the phone number you requested. Apollo suggests testing this flow to
+    # ensure you receive the separate response with the phone number. <br><br>If
+    # phone numbers are not revealed delivered to the webhook URL, try applying
+    # UTF-8 encoding to the webhook URL. <br><br>Example:
+    # `https://webhook.site/11f2643a-b1b4-c6be-8e6a-6c7da2c12610`;
+    # `https%3A%2F%2Fwebhook.site%2F11f2643a-b1b4-c6be-8e6a-6c7da2c12610`
+    # @param [PeopleBulkMatchRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bulk_people_enrichment(run_waterfall_email: false,
+                               run_waterfall_phone: false,
+                               reveal_personal_emails: false,
+                               reveal_phone_number: false,
+                               webhook_url: nil,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/people/bulk_match',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .query_param(new_parameter(run_waterfall_email, key: 'run_waterfall_email'))
+                   .query_param(new_parameter(run_waterfall_phone, key: 'run_waterfall_phone'))
+                   .query_param(new_parameter(reveal_personal_emails, key: 'reveal_personal_emails'))
+                   .query_param(new_parameter(reveal_phone_number, key: 'reveal_phone_number'))
+                   .query_param(new_parameter(webhook_url, key: 'webhook_url'))
+                   .body_param(new_parameter(body))
+                   .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(PeopleBulkMatchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 '400',
+                                 APIException)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 PeopleBulkMatch429ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per organization** when an
+    # organization/company is matched or found. If Apollo doesn't find a
+    # matching organization, 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/33699917233293-Enrichm
+    # ent-Overview" target="_blank">Enrichment</a> is when you refresh existing
+    # records so your prospecting data is up-to-date.<br><br>Use the
+    # Organization Enrichment endpoint to enrich data for one company. To enrich
+    # data for up to ten companies with a single API call, use the <a
+    # href="https://docs.apollo.io/reference/bulk-organization-enrichment">Bulk
+    # Organization Enrichment endpoint</a> instead.<br><br>You can match the
+    # company to enrich by domain, LinkedIn URL, name, and/or website. At least
+    # one of these is required, and providing more than one improves match
+    # accuracy.<br><br>Enriched data potentially includes industry information,
+    # revenue, employee counts, funding round details, corporate phone numbers,
+    # and locations.
+    # @param [String] domain Optional parameter: The domain of the company that
+    # you want to enrich. Do not include `www.`, the `@` symbol, or similar.
+    # <br><br>At least one of `domain`, `linkedin_url`, `name`, or `website` is
+    # required. <br><br>Example: `apollo.io` or `microsoft.com`
+    # @param [String] linkedin_url Optional parameter: The URL for the company's
+    # LinkedIn profile. <br><br>At least one of `domain`, `linkedin_url`,
+    # `name`, or `website` is required. <br><br>Example:
+    # `http://www.linkedin.com/company/apolloio`
+    # @param [String] name Optional parameter: The name of the company that you
+    # want to enrich. <br><br>At least one of `domain`, `linkedin_url`, `name`,
+    # or `website` is required. <br><br>Example: `apollo`
+    # @param [String] website Optional parameter: The full website URL of the
+    # company that you want to enrich. <br><br>At least one of `domain`,
+    # `linkedin_url`, `name`, or `website` is required. <br><br>Example:
+    # `http://www.apollo.io`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def organization_enrichment(domain: nil,
+                                linkedin_url: nil,
+                                name: nil,
+                                website: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/organizations/enrich',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(domain, key: 'domain'))
+                   .query_param(new_parameter(linkedin_url, key: 'linkedin_url'))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(website, key: 'website'))
+                   .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(OrganizationsEnrichResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 OrganizationsEnrich422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 OrganizationsEnrich429ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per organization** when an
+    # organization/company is matched or found. If Apollo doesn't find a
+    # matching organization, that organization 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/33699917233293-Enrichm
+    # ent-Overview" target="_blank">Enrichment</a> is when you refresh existing
+    # records so your prospecting data is up-to-date.<br><br>Use the Bulk
+    # Organization Enrichment endpoint to enrich data for up to ten companies
+    # with a single API call. To enrich data for a single company, use the <a
+    # href="https://docs.apollo.io/reference/organization-enrichment">Organizati
+    # on Enrichment endpoint</a> instead.<br><br>You can identify the companies
+    # to enrich by providing a list of domains via the  <code>domains[]</code>
+    # query parameter, or by providing a <code>details</code> array in the
+    # request body where each company can be matched by any combination of
+    # domain, LinkedIn URL, name, and website.<br><br>Enriched data potentially
+    # includes industry information, revenue, employee counts, funding round
+    # details, and corporate phone numbers and locations.<br><br>This endpoint's
+    # <a href="https://docs.apollo.io/reference/rate-limits">rate limit</a> is
+    # 20/min, 100/hour, 600/day.
+    # @param [Array[String]] domains Optional parameter: The domain of each
+    # company that you want to enrich. Do not include `www.`, the `@` symbol, or
+    # similar. <br><br>Use this parameter to match companies by domain only. To
+    # match by LinkedIn URL, name, or website in addition to domain, use the
+    # `details` array in the request body instead. <br><br>This parameter is
+    # required unless you provide a `details` payload in the request body.
+    # <br><br>Example: `apollo.io` and `microsoft.com`
+    # @param [OrganizationsBulkEnrichRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bulk_organization_enrichment(domains: nil,
+                                     body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/organizations/bulk_enrich',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .query_param(new_parameter(domains, key: 'domains[]'))
+                   .body_param(new_parameter(body))
+                   .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(OrganizationsBulkEnrichResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 '400',
+                                 OrganizationsBulkEnrich400ErrorException)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 OrganizationsBulkEnrich429ErrorException))
+        .execute
+    end
+  end
+end