apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/sequences_api.rb

@@ -0,0 +1,774 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # SequencesApi
+  class SequencesApi < 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/4409477927309-Configur
+    # e-a-Sequence-Sending-Schedule" target="_blank">Sending schedules</a>
+    # control the days and times that Apollo sends emails for your
+    # sequences.<br><br>Use the List Email Schedules endpoint to retrieve every
+    # sending schedule that has been created for your team's Apollo account,
+    # including each schedule's ID, time zone, and weekly sending
+    # windows.<br><br>Use a schedule's `id` as the `emailer_schedule_id` when
+    # you <a href="https://docs.apollo.io/reference/create-sequence">create a
+    # sequence</a> or <a
+    # href="https://docs.apollo.io/reference/update-sequence">update a
+    # sequence</a> to control when that sequence's emails are sent.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_email_schedules
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/emailer_schedules',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Or.new('bearerAuth', 'apiKey')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EmailerSchedulesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerSchedules429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Search for Sequences endpoint to search for the
+    # sequences that have been created for your team's Apollo
+    # account.<br><br>This endpoint requires a master API key. If you call the
+    # endpoint without a master key, you receive a `403` response. Check out <a
+    # href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to
+    # learn how to create a master key.
+    # @param [String] q_name Optional parameter: Add keywords to narrow the
+    # search of the sequences in your team's Apollo account. <br><br>Keywords
+    # should directly match at least part of a sequence's name. For example,
+    # searching the keyword `marketing` might return the result `NY Marketing
+    # Sequence`, but not `NY Marketer Conference 2025 attendees`. <br><br>This
+    # parameter only searches sequence names, not other sequence fields.
+    # <br><br>Example: `marketing conference attendees`
+    # @param [String] 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 [String] 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 search_for_sequences(q_name: nil,
+                             page: nil,
+                             per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_campaigns/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(q_name, key: 'q_name'))
+                   .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(EmailerCampaignsSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerCampaignsSearch429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Add Contacts to a Sequence endpoint to add contacts
+    # to the existing sequences in your team's Apollo account.<br><br>A contact
+    # is a person that your team has explicitly added to your database. Only
+    # contacts can be added to sequences. To enrich a person's data, call the <a
+    # href="https://docs.apollo.io/reference/people-enrichment">People
+    # Enrichment endpoint</a>. Then, to add the person as a contact in your
+    # database, call the <a
+    # href="https://docs.apollo.io/reference/create-a-contact">Create a Contact
+    # endpoint</a>.<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] sequence_id Required parameter: The Apollo ID for the
+    # sequence to which you want to add contacts. <br><br>To find sequence IDs,
+    # call the <a href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the `id`
+    # value for the sequence. <br><br>Example: `66e9e215ece19801b219997f`
+    # @param [String] emailer_campaign_id Required parameter: The same ID as the
+    # `sequence_id`. <br><br>Example: `66e9e215ece19801b219997f`
+    # @param [String | Array[String]] send_email_from_email_account_id Required
+    # parameter: The Apollo ID(s) for the email account(s) used to send to
+    # contacts you add to the sequence. Accepts either one id as a string, or
+    # multiple ids as an array of strings (multi-mailbox / rotation). To find
+    # email account IDs, call the <a
+    # href="https://docs.apollo.io/reference/get-a-list-of-email-accounts"
+    # target="_blank">Get a List of Email Accounts endpoint</a> and identify the
+    # `id` value for each email account. <br><br>Examples:
+    # `6633baaece5fbd01c791d7ca` (string) or `["6633baaece5fbd01c791d7ca",
+    # "6633baaece5fbd01c791d7cb"]` (array).
+    # @param [Array[String]] contact_ids Optional parameter: The Apollo IDs for
+    # the contacts that you want to add to the sequence. <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`<br><br>Note: Either `contact_ids[]` or
+    # `label_names[]` must be provided.
+    # @param [Array[String]] label_names Optional parameter: Alternative to
+    # `contact_ids[]`. Array of label names to identify contacts to add to the
+    # sequence. Contacts with these labels will be added to the sequence.
+    # <br><br>Note: Either `contact_ids[]` or `label_names[]` must be
+    # provided.
+    # @param [String] send_email_from_email_address Optional parameter: Optional
+    # specific email address to send from within the email account.
+    # @param [TrueClass | FalseClass] sequence_no_email Optional parameter: Set
+    # to `true` if you want to add contacts to the sequence even if they do not
+    # have an email address.
+    # @param [TrueClass | FalseClass] sequence_unverified_email Optional
+    # parameter: Set to `true` if you want to add contacts to the sequence if
+    # they have an unverified email address.
+    # @param [TrueClass | FalseClass] sequence_job_change Optional parameter:
+    # Set to `true` if you want to add contacts to the sequence even if they
+    # have recently changed jobs.
+    # @param [TrueClass | FalseClass] sequence_active_in_other_campaigns
+    # Optional parameter: Set to `true` if you want to add contacts to the
+    # sequence even if they have been added to other sequences. This parameter
+    # does not differentiate between active and paused sequences.
+    # @param [TrueClass | FalseClass] sequence_finished_in_other_campaigns
+    # Optional parameter: Set to `true` if you want to add contacts to the
+    # sequence if they have been marked as `finished` in another sequence.
+    # @param [TrueClass | FalseClass] sequence_same_company_in_same_campaign
+    # Optional parameter: Set to `true` if you want to add contacts to the
+    # sequence even if other contacts from the same company are already in the
+    # sequence.
+    # @param [TrueClass | FalseClass] contacts_without_ownership_permission
+    # Optional parameter: Set to `true` if you want to add contacts even if you
+    # don't have ownership permission for them.
+    # @param [TrueClass | FalseClass] add_if_in_queue Optional parameter: Set to
+    # `true` if you want to add contacts even if they are currently in the queue
+    # for processing.
+    # @param [TrueClass | FalseClass] contact_verification_skipped Optional
+    # parameter: Set to `true` if you want to skip contact verification during
+    # the addition process.
+    # @param [String] user_id Optional parameter: The ID for the user in your
+    # team's Apollo account. <br><br>This is the user taking the action to add
+    # contacts to a sequence. When the sequence is updated, the activity log
+    # shows the user that added 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> to retrieve IDs for all
+    # of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @param [Status2] status Optional parameter: Initial status for added
+    # contacts. When set to `paused` along with `auto_unpause_at`, enables
+    # scheduled addition of contacts.
+    # @param [DateTime] auto_unpause_at Optional parameter: DateTime when paused
+    # contacts should be automatically unpaused. Must be used with
+    # `status=paused`. Format: ISO 8601 datetime string.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_contacts_to_sequence(sequence_id,
+                                 emailer_campaign_id,
+                                 send_email_from_email_account_id,
+                                 contact_ids: nil,
+                                 label_names: nil,
+                                 send_email_from_email_address: nil,
+                                 sequence_no_email: false,
+                                 sequence_unverified_email: false,
+                                 sequence_job_change: false,
+                                 sequence_active_in_other_campaigns: false,
+                                 sequence_finished_in_other_campaigns: false,
+                                 sequence_same_company_in_same_campaign: false,
+                                 contacts_without_ownership_permission: false,
+                                 add_if_in_queue: false,
+                                 contact_verification_skipped: false,
+                                 user_id: nil,
+                                 status: nil,
+                                 auto_unpause_at: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_campaigns/{sequence_id}/add_contact_ids',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(sequence_id, key: 'sequence_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(emailer_campaign_id, key: 'emailer_campaign_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(send_email_from_email_account_id, key: 'send_email_from_email_account_id')
+                                 .is_required(true)
+                                 .validator(proc do |value|
+                                   UnionTypeLookUp.get(:AddContactsToSequenceSendEmailFromEmailAccountId)
+                                                  .validate(value)
+                                 end))
+                   .query_param(new_parameter(contact_ids, key: 'contact_ids[]'))
+                   .query_param(new_parameter(label_names, key: 'label_names[]'))
+                   .query_param(new_parameter(send_email_from_email_address, key: 'send_email_from_email_address'))
+                   .query_param(new_parameter(sequence_no_email, key: 'sequence_no_email'))
+                   .query_param(new_parameter(sequence_unverified_email, key: 'sequence_unverified_email'))
+                   .query_param(new_parameter(sequence_job_change, key: 'sequence_job_change'))
+                   .query_param(new_parameter(sequence_active_in_other_campaigns, key: 'sequence_active_in_other_campaigns'))
+                   .query_param(new_parameter(sequence_finished_in_other_campaigns, key: 'sequence_finished_in_other_campaigns'))
+                   .query_param(new_parameter(sequence_same_company_in_same_campaign, key: 'sequence_same_company_in_same_campaign'))
+                   .query_param(new_parameter(contacts_without_ownership_permission, key: 'contacts_without_ownership_permission'))
+                   .query_param(new_parameter(add_if_in_queue, key: 'add_if_in_queue'))
+                   .query_param(new_parameter(contact_verification_skipped, key: 'contact_verification_skipped'))
+                   .query_param(new_parameter(user_id, key: 'user_id'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(auto_unpause_at, key: 'auto_unpause_at'))
+                   .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(EmailerCampaignsAddContactIdsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized - Invalid API key',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden - Master API key required',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 'Unprocessable Entity - Validation errors',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests - Rate limit exceeded',
+                                 EmailerCampaignsAddContactIds429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Update Contact Status in a Sequence endpoint to
+    # either mark contacts as having `finished` a sequence, or to remove them
+    # from a sequence entirely.<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 [Array[String]] emailer_campaign_ids Required parameter: The Apollo
+    # IDs for the sequences that you want to update. If you add multiple
+    # sequences, you will update the status of the contacts across the chosen
+    # sequences. <br><br>To find sequence IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the `id`
+    # value for the sequence. <br><br>Example: `66e9e215ece19801b219997f`
+    # @param [Array[String]] contact_ids Required parameter: The Apollo IDs for
+    # the contacts in the sequences. These are the contacts whose sequence
+    # status 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] mode Required parameter: Choose 1 of the following options
+    # to update the sequence status of the contacts:   <ul> <li>
+    # `mark_as_finished`: Mark the contacts as having finished the sequence.
+    # </li> <li> `remove`: Remove the contacts from the sequence. </li> <li>
+    # `stop`: Indicate that the contacts progress in the sequence has halted.
+    # </li> </ul>
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_contact_status_sequence(emailer_campaign_ids,
+                                       contact_ids,
+                                       mode)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_campaigns/remove_or_stop_contact_ids',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(emailer_campaign_ids, key: 'emailer_campaign_ids[]')
+                                 .is_required(true))
+                   .query_param(new_parameter(contact_ids, key: 'contact_ids[]')
+                                 .is_required(true))
+                   .query_param(new_parameter(mode, key: 'mode')
+                                 .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(EmailerCampaignsRemoveOrStopContactIdsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerCampaignsRemoveOrStopContactIds429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Create a Sequence endpoint to create a new sequence
+    # in your team's Apollo account, including its steps and email
+    # templates.<br><br>To create a sequence with steps, add the `emailer_steps`
+    # array to the request body. Each email step (`auto_email`, `manual_email`)
+    # can include one or more `emailer_touches` (email variants); adding more
+    # than one touch to a step creates an A/B test, which requires a plan with
+    # A/B testing access.<br><br>To activate the sequence immediately after
+    # creation, set `active` to `true`. Email touches only send if their
+    # `status` is `approved`, and a touch can only be approved if its template
+    # has a non-empty body.<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 [SequencesRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_sequence(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/sequences',
+                                     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(SequencesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Sequences422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 APIException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Update a Sequence endpoint to update an existing
+    # sequence (emailer campaign) in your team's Apollo account.<br><br>You can
+    # update sequence-level settings, such as the name, active state, schedule,
+    # and sending limits, as well as the sequence's steps and the email touches
+    # within each step. <br><br>To turn a sequence on or off, set the `active`
+    # field. Passing `emailer_steps` will create, update, reorder, or remove
+    # steps and their touches based on the IDs you provide.<br><br>To create a
+    # new sequence instead, use the <a
+    # href="https://docs.apollo.io/reference/create-sequence">Create a Sequence
+    # endpoint</a>.<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] id Required parameter: The Apollo ID for the sequence that
+    # you want to update. <br><br>To find sequence IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the `id`
+    # value for the sequence. <br><br>Example: `66e34b81740c50074e3d1bd4`
+    # @param [SequencesRequest1] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_sequence(id,
+                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/sequences/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .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(SequencesResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('404',
+                                 '404',
+                                 Sequences404ErrorException)
+                    .local_error('422',
+                                 '422',
+                                 Sequences422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Sequences429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Check Email Stats endpoint to review the complete
+    # details for an email sent as part of an Apollo sequence. This includes the
+    # contents of the emails, stats related to the email such as opens and
+    # clicks, and details about the contact that received the email.<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] id Required parameter: The ID for the email you want to
+    # view. <br><br>Each outreach email in Apollo is assigned a unique ID. To
+    # find email IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-for-outreach-emails"
+    # target="_blank">Search for Outreach Emails endpoint</a> and identify the
+    # `id` value for the email. <br><br>Example: `684b2203a2ce950021cbf730`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_emailstats(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/emailer_messages/{id}/activities',
+                                     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',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 APIException)
+                    .local_error('422',
+                                 'Unprocessable Entity',
+                                 APIException))
+        .execute
+    end
+
+    # This endpoint doesn't consume Apollo credits. Learn more about [API
+    # pricing and credits](https://docs.apollo.io/docs/api-pricing).
+    # <a
+    # href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Search for Outreach Emails endpoint to find emails
+    # that your team has created and sent as part of Apollo sequences.<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]] emailer_message_stats Optional parameter: Find
+    # emails based on their current status, such as whether they were delivered
+    # or opened. You can add multiple statuses. <br><br>Possible values include:
+    # <ul> <li> `delivered` </li> <li> `scheduled` </li> <li> `drafted` </li>
+    # <li> `not_opened` </li> <li> `opened` </li> <li> `clicked` </li> <li>
+    # `unsubscribed` </li> <li> `demoed` </li> <li> `bounced` </li> <li>
+    # `spam_blocked` </li> <li> `failed_other` </li> </ul>
+    # @param [Array[String]] emailer_message_reply_classes Optional parameter:
+    # Find emails based on the response sentiment of the recipient. This can
+    # include the recipient expressing interest in meeting or having a follow-up
+    # question. You can add multiple values.<br><br>Possible values include:
+    # <ul> <li> `willing_to_meet` </li> <li> `follow_up_question` </li> <li>
+    # `person_referral` </li> <li> `out_of_office` </li> <li>
+    # `already_left_company_or_not_right_person` </li> <li> `not_interested`
+    # </li> <li> `unsubscribe` </li> <li> `none_of_the_above` </li> </ul>
+    # @param [Array[String]] user_ids Optional parameter: Find emails sent by
+    # specific users in your team's Apollo account. You can add multiple users.
+    # <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> to retrieve IDs for all
+    # of the users within your Apollo account. <br><br>Example:
+    # `66302798d03b9601c7934ebf`
+    # @param [String] email_account_id_and_aliases Optional parameter:
+    # Example:
+    # @param [Array[String]] emailer_campaign_ids Optional parameter: Search for
+    # emails that are included in specific sequences in your Apollo account. You
+    # can search multiple sequences. Any sequence not included in this parameter
+    # will be exclude from search results.<br><br>To find sequence IDs, call the
+    # <a href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the `id`
+    # value for the sequence. <br><br>Example: `66e9e215ece19801b219997f`
+    # @param [Array[String]] not_emailer_campaign_ids Optional parameter:
+    # Exclude emails from specific sequences in your Apollo account. You can
+    # exclude multiple sequences. Any sequence not excluded using this parameter
+    # will be included in search results.<br><br>To find sequence IDs, call the
+    # <a href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the `id`
+    # value for the sequence. <br><br>Example: `66e9e215ece19801b219997f`
+    # @param [String] emailer_message_date_range_mode Optional parameter: Use
+    # this parameter in combination with the `emailer_message_date_range[max]`
+    # and `emailer_message_date_range[min]` parameters. Find emails based on 1
+    # of the following options: <ul> <li> `due_at`: When emails are scheduled to
+    # be delivered. </li> <li> `completed_at`: When emails were delivered. </li>
+    # </ul>
+    # @param [Date] emailer_message_date_range_max Optional parameter: Set the
+    # upper bound of the date range you want to search. <br><br>Use this
+    # parameter in combination with the `emailer_message_date_range[min]` and
+    # `emailer_message_date_range_mode` parameters. This date should fall after
+    # the `emailer_message_date_range[min]` date. <br><br>The date should be
+    # formatted as `YYYY-MM-DD`. <br><br>Example: `2025-10-30`
+    # @param [Date] emailer_message_date_range_min Optional parameter: Set the
+    # lower bound of the date range you want to search. <br><br>Use this
+    # parameter in combination with the `emailer_message_date_range[max]` and
+    # `emailer_message_date_range_mode` parameters. This date should fall before
+    # the `emailer_message_date_range[max]` date. <br><br>The date should be
+    # formatted as `YYYY-MM-DD`. <br><br>Example: `2025-10-30`
+    # @param [Array[String]] not_sent_reason_cds Optional parameter: Find emails
+    # based on the reason they were not sent. You can add multiple
+    # values.<br><br>Possible values include: <ul> <li>
+    # `contact_stage_safeguard` </li> <li> `same_account_reply` </li> <li>
+    # `account_stage_safeguard` </li> <li> `email_unverified` </li> <li>
+    # `snippets_missing` </li> <li> `personalized_opener_missing` </li> <li>
+    # `thread_reply_original_email_missing` </li> <li> `no_active_email_account`
+    # </li> <li> `email_format_invalid` </li> <li> `ownership_permission` </li>
+    # <li> `email_service_provider_delivery_failure` </li> <li>
+    # `sendgrid_dropped_email` </li> <li> `mailgun_dropped_email` </li> <li>
+    # `gdpr_compliance` </li> <li> `not_valid_hard_bounce_detected` <li>
+    # `other_safeguard` </li> <li> `new_job_change_detected` </li> <li>
+    # `email_on_global_bounce_list` </li> </ul>
+    # @param [String] q_keywords Optional parameter: Add keywords to narrow the
+    # search of the emails in your team's Apollo account. <br><br>Keywords
+    # should directly match at least part of an email's content. For example,
+    # searching the keyword `James` might return emails that were sent by `James
+    # Smith`. <br><br>Example: `Jane`
+    # @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 emailer_messages_search(emailer_message_stats: nil,
+                                emailer_message_reply_classes: nil,
+                                user_ids: nil,
+                                email_account_id_and_aliases: nil,
+                                emailer_campaign_ids: nil,
+                                not_emailer_campaign_ids: nil,
+                                emailer_message_date_range_mode: nil,
+                                emailer_message_date_range_max: nil,
+                                emailer_message_date_range_min: nil,
+                                not_sent_reason_cds: nil,
+                                q_keywords: nil,
+                                page: nil,
+                                per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/emailer_messages/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(emailer_message_stats, key: 'emailer_message_stats[]'))
+                   .query_param(new_parameter(emailer_message_reply_classes, key: 'emailer_message_reply_classes[]'))
+                   .query_param(new_parameter(user_ids, key: 'user_ids[]'))
+                   .query_param(new_parameter(email_account_id_and_aliases, key: 'email_account_id_and_aliases'))
+                   .query_param(new_parameter(emailer_campaign_ids, key: 'emailer_campaign_ids[]'))
+                   .query_param(new_parameter(not_emailer_campaign_ids, key: 'not_emailer_campaign_ids[]'))
+                   .query_param(new_parameter(emailer_message_date_range_mode, key: 'emailer_message_date_range_mode'))
+                   .query_param(new_parameter(emailer_message_date_range_max, key: 'emailer_message_date_range[max]'))
+                   .query_param(new_parameter(emailer_message_date_range_min, key: 'emailer_message_date_range[min]'))
+                   .query_param(new_parameter(not_sent_reason_cds, key: 'not_sent_reason_cds[]'))
+                   .query_param(new_parameter(q_keywords, key: 'q_keywords'))
+                   .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',
+                                 '422',
+                                 EmailerMessagesSearch422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerMessagesSearch429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Activate a Sequence endpoint to start an inactive
+    # sequence. Once activated, the sequence begins sending emails to its
+    # contacts on the configured schedule. The sequence must have at least one
+    # step configured before it can be activated.<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] sequence_id Required parameter: The Apollo ID for the
+    # sequence that you want to activate. <br><br>To find sequence IDs, call the
+    # <a href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the
+    # <code>id</code> value for the sequence. <br><br>Example:
+    # <code>66e9e215ece19801b219997f</code>
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def approve_sequence(sequence_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_campaigns/{sequence_id}/approve',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(sequence_id, key: 'sequence_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(EmailerCampaignsApproveResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 EmailerCampaignsApprove422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerCampaignsApprove429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Deactivate a Sequence endpoint to stop an active
+    # sequence. Once deactivated, the sequence pauses all contacts and stops
+    # sending emails.<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] sequence_id Required parameter: The Apollo ID for the
+    # sequence that you want to deactivate. <br><br>To find sequence IDs, call
+    # the <a href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the
+    # <code>id</code> value for the sequence. <br><br>Example:
+    # <code>66e9e215ece19801b219997f</code>
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def abort_sequence(sequence_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_campaigns/{sequence_id}/abort',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(sequence_id, key: 'sequence_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(EmailerCampaignsAbortResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 EmailerCampaignsAbort422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerCampaignsAbort429ErrorException))
+        .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/4409237165837-Sequence
+    # s-Overview" target="_blank">Sequences</a> are outreach campaigns that
+    # sales teams use to reach out to contacts over a planned period of
+    # time.<br><br>Use the Archive a Sequence endpoint to archive a sequence.
+    # Archiving a sequence marks it as inactive and finishes all contacts
+    # currently in the sequence. You must be the owner of the sequence or have
+    # full access sharing permissions to archive it.<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] sequence_id Required parameter: The Apollo ID for the
+    # sequence that you want to archive. <br><br>To find sequence IDs, call the
+    # <a href="https://docs.apollo.io/reference/search-for-sequences"
+    # target="_blank">Search for Sequences endpoint</a> and identify the
+    # <code>id</code> value for the sequence. <br><br>Example:
+    # <code>66e9e215ece19801b219997f</code>
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def archive_sequence(sequence_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_campaigns/{sequence_id}/archive',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(sequence_id, key: 'sequence_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(EmailerCampaignsArchiveResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerCampaignsArchive429ErrorException))
+        .execute
+    end
+  end
+end