apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/contacts_api.rb

@@ -0,0 +1,478 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ContactsApi
+  class ContactsApi < 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/5995459280525-View-and
+    # -Edit-Contacts" target="_blank">Contacts</a> are people saved in
+    # Apollo.<br><br>Use the Create a Contact endpoint to add a new contact to
+    # your team's Apollo  account.<br><br>By default, Apollo doesn't apply
+    # deduplication processes when you create a new contact via API. If your
+    # entry has the same name, email address, or other details as an existing
+    # contact, Apollo creates a new contact instead of updating the existing
+    # contact. To enable deduplication and prevent duplicate contacts, set the
+    # <code>run_dedupe</code> parameter to <code>true</code>. <br><br>To update
+    # an existing contact, use the <a
+    # href="https://docs.apollo.io/reference/update-a-contact">Update a Contact
+    # endpoint</a> instead.
+    # @param [ContactsRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_a_contact(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts',
+                                     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(ContactsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 Contacts429ErrorException))
+        .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/5995459280525-View-and
+    # -Edit-Contacts" target="_blank">Contacts</a> are people saved in
+    # Apollo.<br><br>Use the Update a Contact endpoint to update existing
+    # contacts in your team's Apollo account.<br><br>To create a new contact,
+    # use the <a href="https://docs.apollo.io/reference/create-a-contact">Create
+    # a Contact endpoint</a> instead. To update the contact stage for multiple
+    # contacts, use the <a
+    # href="https://docs.apollo.io/reference/update-contact-stage">Update
+    # Contact Stage for Multiple Contacts</a> endpoint.
+    # @param [String] contact_id Required parameter: The Apollo ID for the
+    # contact that you want to update. <br><br>To find contact IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @param [ContactsRequest1] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_a_contact(contact_id,
+                         body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/contacts/{contact_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(contact_id, key: 'contact_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(ContactsResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 Contacts429ErrorException))
+        .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/5995459280525-View-and
+    # -Edit-Contacts" target="_blank">Contacts</a> are people saved in
+    # Apollo.<br><br>Use the View a Contact endpoint to retrieve details for an
+    # existing contact in your team's Apollo database.<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 [String] contact_id Required parameter: The Apollo ID for the
+    # contact that you want to view. <br><br>To find contact IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def view_a_contact(contact_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/contacts/{contact_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(contact_id, key: 'contact_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(ContactsResponse2.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Contacts422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Contacts429ErrorException))
+        .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/4415062467725-Deals-Ov
+    # erview" target="_blank">Deals</a> on Apollo help you track sales
+    # opportunities.<br><br>Use the View Associated Deals endpoint to retrieve
+    # the deals associated with a contact.<br><br>This endpoint doesn't require
+    # a request body. If you include one, Apollo doesn't read its fields. An
+    # empty JSON <code>{}</code> is sufficient.<br><br>Each result returns the
+    # same deal details as <a
+    # href="https://docs.apollo.io/reference/view-deal">View Deal</a> endpoint.
+    # If the contact has no associated deals or the contact ID isn't recognized,
+    # Apollo returns a <code>200</code> response with an empty array rather than
+    # a <code>404</code> error.
+    # @param [String] contact_id Required parameter: The ID for the contact
+    # whose associated deals you want to retrieve. <br><br>Example:
+    # <code>64a7ff0cc4dfae00013df1a5</code>
+    # @param [Object] body Optional parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def view_associated_deals(contact_id,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts/{contact_id}/opportunities',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(contact_id, key: 'contact_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ContactsOpportunitiesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 ContactsOpportunities429ErrorException))
+        .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/5995459280525-View-and
+    # -Edit-Contacts" target="_blank">Contacts</a> are people saved in
+    # Apollo.<br><br>Use the Search for Contacts endpoint to search for the
+    # contacts that have been added to your team's Apollo account.<br><br>This
+    # endpoint only returns contacts in the search results. To search for people
+    # in the Apollo database, call the <a
+    # href="https://docs.apollo.io/reference/people-api-search">People API
+    # Search endpoint</a>.<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 [ContactsSearchRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_for_contacts(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts/search',
+                                     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(ContactsSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 ContactsSearch403ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 ContactsSearch429ErrorException))
+        .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/4410623601165-Contact-
+    # and-Account-Stages-Overview" target="_blank">Contact stages</a> help you
+    # track progress on sales and marketing pipelines.<br><br>Use the Update
+    # Contact Stage for Multiple Contacts endpoint to update the contact stage
+    # for several contacts in your team's Apollo account.<br><br>To update more
+    # than the contact stage, such as job titles or contact details, use the <a
+    # href="https://docs.apollo.io/reference/update-a-contact">Update a Contact
+    # endpoint</a> instead.
+    # @param [Array[String]] contact_ids Required parameter: The Apollo IDs for
+    # the contacts that you want to update. <br><br>To find contact IDs, call
+    # the <a href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @param [String] contact_stage_id Required parameter: The Apollo ID for the
+    # contact stage to which you want to assign the contacts. Call the <a
+    # href="https://docs.apollo.io/reference/list-contact-stages"
+    # target="_blank">List Contact Stages endpoint</a> to retrieve a list of all
+    # the contact stage IDs available in your Apollo account. <br><br>Example:
+    # `6095a710bd01d100a506d4af`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_contact_stage(contact_ids,
+                             contact_stage_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts/update_stages',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(contact_ids, key: 'contact_ids[]')
+                                 .is_required(true))
+                   .query_param(new_parameter(contact_stage_id, key: 'contact_stage_id')
+                                 .is_required(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(ContactsUpdateStagesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 ContactsUpdateStages422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 ContactsUpdateStages429ErrorException))
+        .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/5631686093069-Edit-a-C
+    # ontact-or-Account-Owner" target="_blank">Contact owners</a> manage
+    # specific contacts in Apollo.<br><br>Use the Update Contact Owner for
+    # Multiple Contacts endpoint to assign multiple contacts to a different user
+    # in your team's Apollo account. <br><br>To update more than the contact's
+    # owner, such as job titles or contact details, use the <a
+    # href="https://docs.apollo.io/reference/update-a-contact">Update a Contact
+    # endpoint</a> instead.
+    # @param [Array[String]] contact_ids Required parameter: The Apollo IDs for
+    # the contacts that you want assign to an owner. <br><br>To find contact
+    # IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-contacts"
+    # target="_blank">Search for Contacts endpoint</a> and identify the `id`
+    # value for the contact. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @param [String] owner_id Required parameter: The ID for the contact owner
+    # within your team's Apollo account. This user will be assigned ownership of
+    # the contacts. <br><br>Use the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-users"
+    # target="_blank">Get a List of Users endpoint</a> endpoint to retrieve IDs
+    # for all of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_contact_ownership(contact_ids,
+                                 owner_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts/update_owners',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(contact_ids, key: 'contact_ids[]')
+                                 .is_required(true))
+                   .query_param(new_parameter(owner_id, key: 'owner_id')
+                                 .is_required(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(ContactsUpdateOwnersResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 ContactsUpdateOwners422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 ContactsUpdateOwners429ErrorException))
+        .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/5995459280525-View-and
+    # -Edit-Contacts" target="_blank">Contacts</a> are people saved in
+    # Apollo.<br><br>Use the Bulk Create Contacts endpoint to create up to 100
+    # contacts in a single API request. This endpoint supports intelligent
+    # deduplication and returns separated arrays for newly created and existing
+    # contacts. <br><br>Important: This endpoint creates new contacts but
+    # doesn't update existing ones (except for placeholder contacts from email
+    # imports). Existing contacts that match the criteria are returned in the
+    # <code>existing_contacts</code> array without modification.<br><br>To
+    # update existing contacts, use the <a
+    # href="https://docs.apollo.io/reference/bulk-update-contacts">Bulk Update
+    # Contacts endpoint</a>.
+    # @param [ContactsBulkCreateRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bulk_create_contacts(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts/bulk_create',
+                                     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(ContactsBulkCreateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401 - Unauthorized',
+                                 APIException)
+                    .local_error('422',
+                                 '422 - Unprocessable Entity',
+                                 ContactsBulkCreate422ErrorException)
+                    .local_error('429',
+                                 '429 - Too Many Requests',
+                                 ContactsBulkCreate429ErrorException)
+                    .local_error('500',
+                                 '500 - Internal Server Error',
+                                 ContactsBulkCreate500ErrorException))
+        .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/5995459280525-View-and
+    # -Edit-Contacts" target="_blank">Contacts</a> are people saved in
+    # Apollo.<br><br>Use the Bulk Update Contacts endpoint to update multiple
+    # contacts in your team's Apollo account simultaneously. <br><br>This
+    # endpoint allows you to update common fields across multiple contacts
+    # efficiently, such as contact stages, owners, custom fields, and other
+    # contact attributes. <br><br>You can update up to 1000 contacts per
+    # request; requests with more than 1000 contacts are rejected with a
+    # <code>422</code> error. Requests of 100 or fewer contacts are processed
+    # synchronously and return the updated contacts immediately. Requests of 101
+    # to 1000 contacts are processed asynchronously. You can also force
+    # asynchronous processing at any batch size by setting the
+    # <code>async</code> parameter to <code>true</code>.
+    # @param [ContactsBulkUpdateRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bulk_update_contacts(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/contacts/bulk_update',
+                                     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(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:BulkUpdateContactsResponse),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 ContactsBulkUpdate422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 ContactsBulkUpdate429ErrorException))
+        .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/4410623601165-Contact-
+    # and-Account-Stages-Overview" target="_blank">Contact stages</a> help you
+    # track progress on sales and marketing pipelines.<br><br>Use the List
+    # Contact Stages endpoint to retrieve the IDs for the available contact
+    # stages in your team's Apollo account. <br><br>Contact stage IDs can be
+    # used to <a href="https://docs.apollo.io/reference/update-a-contact">update
+    # individual contacts</a> and <a
+    # href="https://docs.apollo.io/reference/update-contact-stage">update the
+    # contact stages for multiple contacts</a> via Apollo API.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_contact_stages
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/contact_stages',
+                                     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',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 ContactStages429ErrorException))
+        .execute
+    end
+  end
+end

data/lib/apollo_rest_api/apis/conversations_api.rb

@@ -0,0 +1,157 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # ConversationsApi
+  class ConversationsApi < 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/45998035787533-Use-Con
+    # versations">Conversations</a> are prospect video meetings stored in
+    # Apollo.<br><br>Use the Search Conversations endpoint to find a list of
+    # conversations. Several filters are available to help narrow your search,
+    # including by type, account, contact, date range, and more. Each result
+    # includes a summary of the conversation.<br><br>This endpoint doesn't
+    # include transcripts or recording URLs. Use the conversation ID retrieved
+    # from your search to request full details using <a
+    # href="https://docs.apollo.io/docs/get-conversations-info">Get
+    # Conversations Info</a>.
+    # @param [ConversationsSearchRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_conversations(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/conversations/search',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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(ConversationsSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('403',
+                                 '403',
+                                 ConversationsSearch403ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per conversation** if the
+    # conversation has AI insights. If the conversation doesn't have AI
+    # insights, 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/45998035787533-Use-Con
+    # versations">Conversations</a> are prospect video meetings stored in
+    # Apollo.<br><br>Use the Get Conversation Info endpoint to retrieve the full
+    # details of a single conversation by its ID.<br><br>To get a conversation's
+    # ID, refer to <a
+    # href="https://docs.apollo.io/docs/search-conversations">Search
+    # Conversations</a>.
+    # @param [String] id Required parameter: The conversation ID. Supports an
+    # optional share ID in the format <code>id_shareid</code>
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_conversations_info(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/conversations/{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(:custom_type_deserializer))
+                    .deserialize_into(ConversationsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 '404',
+                                 Conversations404ErrorException)
+                    .local_error('422',
+                                 '422',
+                                 Conversations422ErrorException))
+        .execute
+    end
+
+    # This endpoint consumes **1 Apollo credit per conversation** if the
+    # exported conversation has AI insights. Conversations without AI insights
+    # consume **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/45998035787533-Use-Con
+    # versations">Conversations</a> are prospect video meetings stored in
+    # Apollo.<br><br>Use the Export Conversations endpoint to export
+    # conversations within a time range. Exports are processed asynchronously
+    # and delivered as a gzipped JSON file. A notification email is sent to the
+    # specified team member when the export is ready.<br><br>To get the download
+    # URL once the export is ready, refer to <a
+    # href="https://docs.apollo.io/docs/get-conversations-export">Get
+    # Export</a>.
+    # @param [ConversationsExportRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def export_conversations(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/conversations/export',
+                                     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(ConversationsExportResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 '404',
+                                 ConversationsExport404ErrorException)
+                    .local_error('422',
+                                 '422',
+                                 ConversationsExport422ErrorException))
+        .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/45998035787533-Use-Con
+    # versations">Conversations</a> are prospect video meetings stored in
+    # Apollo.<br><br>Use the Get Conversations Export endpoint to retrieve a
+    # download URL for your exported conversations.<br><br>This endpoint is used
+    # as a follow-up to the <a
+    # href="https://docs.apollo.io/docs/export-conversations">Export
+    # Conversations</a> endpoint.
+    # @param [String] id Required parameter: The export ID returned by the
+    # Export Conversations endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_conversations_export(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/conversations/export/{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(:custom_type_deserializer))
+                    .deserialize_into(ConversationsExportResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('404',
+                                 '404',
+                                 ConversationsExport404ErrorException))
+        .execute
+    end
+  end
+end