apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/deals_api.rb

@@ -0,0 +1,253 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # DealsApi
+  class DealsApi < 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/4415062467725-Deals-Ov
+    # erview" target="_blank">Deals</a> on Apollo help you track sales
+    # opportunities.<br><br>Use the Create Deal endpoint to create new deals for
+    # an Apollo account.<br><br>To update existing deals in your Apollo account,
+    # use the <a href="https://docs.apollo.io/reference/update-deal">Update Deal
+    # endpoint</a> instead.<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 [OpportunitiesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_deal(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/opportunities',
+                                     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(OpportunitiesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 Opportunities429ErrorException))
+        .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 List All Deals endpoint to retrieve every
+    # deal that has 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] sort_by_field Optional parameter: Sort the tasks by 1 of
+    # the following options:    <ul> <li> `amount`: The largest deal values
+    # first. </li> <li> `is_closed`: Deals that have been closed first. </li>
+    # <li> `is_won`: Deals that have been won first. </li> </ul>
+    # @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 list_all_deals(sort_by_field: nil,
+                       page: nil,
+                       per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/opportunities/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(sort_by_field, key: 'sort_by_field'))
+                   .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(OpportunitiesSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 OpportunitiesSearch429ErrorException))
+        .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 Deal endpoint to retrieve complete
+    # details about a deal within your team's Apollo account.<br><br>Deal
+    # information can include the ID of the deal owner, the monetary value of
+    # the deal, the deal stage, and general details about the
+    # 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] opportunity_id Required parameter: The ID for the deal you
+    # want to view. <br><br>Each deal in the Apollo database is assigned a
+    # unique ID. To find deal IDs, call the <a
+    # href="https://docs.apollo.io/reference/list-all-deals"
+    # target="_blank">List All Deals endpoint</a> and identify the value for
+    # `id` for the desired deal. <br><br>Example: `66e09ea8e3cfcf01b2208ec7`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def view_deal(opportunity_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/opportunities/{opportunity_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(opportunity_id, key: 'opportunity_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(OpportunitiesResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('404',
+                                 '404',
+                                 Opportunities404ErrorException)
+                    .local_error('422',
+                                 '422',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 Opportunities429ErrorException))
+        .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 Update Deal endpoint to update the details
+    # of existing deals within your team's Apollo account.<br><br>To create new
+    # deals in your Apollo account, use the <a
+    # href="https://docs.apollo.io/reference/create-deal">Create Deal
+    # endpoint</a> instead.<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] opportunity_id Required parameter: The ID for the deal you
+    # want to update. <br><br>Each deal in the Apollo database is assigned a
+    # unique ID. To find deal IDs, call the <a
+    # href="https://docs.apollo.io/reference/list-all-deals"
+    # target="_blank">List All Deals endpoint</a> and identify the value for
+    # `id` for the desired deal. <br><br>Example: `66e09ea8e3cfcf01b2208ec7`
+    # @param [OpportunitiesRequest1] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_deal(opportunity_id,
+                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/opportunities/{opportunity_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(opportunity_id, key: 'opportunity_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(OpportunitiesResponse2.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Opportunities422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Opportunities429ErrorException))
+        .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 List Deal Stages endpoint to retrieve
+    # information about every deal stage that's available in your team's Apollo
+    # account.<br><br>The `id` value for each deal stage can be used to set the
+    # stage when <a href="https://docs.apollo.io/reference/create-deal">creating
+    # a deal</a> or <a
+    # href="https://docs.apollo.io/reference/update-deal">updating a deal</a>
+    # via the Apollo API.<br><br>This endpoint requires a master API key. If you
+    # call the endpoint without a master key, you receive a `403` response.
+    # Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an
+    # API Key</a> to learn how to create a master key.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_deal_stages
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/opportunity_stages',
+                                     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(OpportunityStagesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 OpportunityStages429ErrorException))
+        .execute
+    end
+  end
+end

data/lib/apollo_rest_api/apis/emailer_messages_api.rb

@@ -0,0 +1,160 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # EmailerMessagesApi
+  class EmailerMessagesApi < BaseApi
+    # Use the Create an Email Draft endpoint to create a single, unsent email
+    # message (an email draft) for a contact. The draft is created with a
+    # `drafted` status — this endpoint does not send the email. <br><br>To send
+    # the draft after creating it, call the <a
+    # href="https://docs.apollo.io/reference/send-email-now"
+    # target="_blank">Send Email Now endpoint</a> with the `id` returned in the
+    # response. <br><br>You must provide a `contact_id` so Apollo knows who the
+    # email is for. Alternatively, to draft a reply within an existing email
+    # thread, provide `in_response_to_emailer_message_id` instead and Apollo
+    # will infer the contact and recipients from the parent message. <br><br>The
+    # email is drafted from the user that owns the API key. That user must have
+    # permission to email the contact (i.e. they own the contact or its
+    # account), and the contact must not be blocked by your team's Do Not
+    # Contact (DNC) enforcement settings. <br><br>This endpoint returns the
+    # created `emailer_message` object. If the draft is linked to an outreach
+    # task, a `task` object is also returned.
+    # @param [EmailerMessagesRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_an_email_draft(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_messages',
+                                     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(EmailerMessagesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerMessages429ErrorException))
+        .execute
+    end
+
+    # Use the Send Email Now endpoint to immediately send an existing email
+    # message. This works for emails that are currently in a `drafted`,
+    # `scheduled`, or `failed` state — Apollo schedules the email to be sent
+    # right away and processes it asynchronously. <br><br>To first create an
+    # email draft, use the <a
+    # href="https://docs.apollo.io/reference/create-an-email-draft"
+    # target="_blank">Create an Email Draft endpoint</a> and then pass the
+    # returned `id` to this endpoint. <br><br>The email is sent from the user
+    # that owns the API key. That user must have a linked email account on the
+    # message, must have permission to send from that email account, and must
+    # have permission to email the contact. The contact must also not be blocked
+    # by your team's Do Not Contact (DNC) enforcement settings, and the user
+    # must not have exceeded their daily sending limit. <br><br>Because sending
+    # is processed asynchronously, a successful `200` response means the email
+    # has been queued for sending — not that it has been delivered. To check
+    # whether the email was delivered, poll the <a
+    # href="https://docs.apollo.io/reference/check-email-send-status"
+    # target="_blank">Check Email Send Status endpoint</a> using the message
+    # `id`. <br><br>This endpoint returns the `emailer_message` object. If the
+    # message is linked to an outreach task, a `task` object is also returned.
+    # @param [String] id Required parameter: The Apollo ID of the email message
+    # to send. This is the `id` returned when you create an email draft.
+    # <br><br>Example: `66e8cc45028aed019c25d724`
+    # @param [EmailerMessagesSendNowRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def send_email_now(id,
+                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_messages/{id}/send_now',
+                                     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(EmailerMessagesSendNowResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 NeedMasterApiKeyException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerMessagesSendNow429ErrorException))
+        .execute
+    end
+
+    # Use the Check Email Send Status endpoint to check the current delivery
+    # status of an email message. This is typically used after calling the <a
+    # href="https://docs.apollo.io/reference/send-email-now"
+    # target="_blank">Send Email Now endpoint</a>, since emails are sent
+    # asynchronously and a successful send response only means the email was
+    # queued. <br><br>You must provide the `id` of the email message. The
+    # message must belong to your team, otherwise a `404` is returned.
+    # <br><br>The response always includes the message `id`, its current
+    # `status`, and a human-readable `message`. The remaining fields depend on
+    # the status: <ul> <li> If the email was delivered (`completed`), a
+    # `completed_at` timestamp is included. </li> <li> If the email failed
+    # (`failed`), a `not_sent_reason`, `failure_reason`, and `failed_at`
+    # timestamp may be included. </li> <li> If the email is still being
+    # processed (e.g. `drafted` or `scheduled`), a `retry_after_seconds` value
+    # is included to indicate how long to wait before checking again. </li>
+    # </ul>
+    # @param [EmailerMessagesEmailSendStatusRequest] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def check_email_send_status(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/emailer_messages/email_send_status',
+                                     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(EmailerMessagesEmailSendStatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('404',
+                                 '404',
+                                 EmailerMessagesEmailSendStatus404ErrorException)
+                    .local_error('422',
+                                 '422',
+                                 EmailerMessagesEmailSendStatus422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 EmailerMessagesEmailSendStatus429ErrorException))
+        .execute
+    end
+  end
+end