apimatic-apollo-sdk 0.0.1

data/lib/apollo_rest_api/apis/tasks_api.rb

@@ -0,0 +1,397 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  # TasksApi
+  class TasksApi < 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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Create a Task endpoint to create a single task in Apollo for you and your
+    # team. Tasks help track the upcoming actions you need to take, such as
+    # emailing or calling a contact.<br><br>This endpoint returns the created
+    # task object.<br><br>Apollo does not apply deduplication  processes when
+    # you create a new task via the API. If your entry has the same task owner,
+    # contact, and other details as an existing task, Apollo will create a new
+    # task instead of updating the existing task.<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 [TasksRequest] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_a_task(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tasks',
+                                     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(TasksResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Tasks422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Tasks429ErrorException))
+        .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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Bulk Create Tasks endpoint to create multiple tasks in a single API
+    # request. A separate task will be created for each contact provided.
+    # <br><br>This endpoint returns a `success` boolean and a `tasks` array
+    # containing the created tasks. <br><br>Apollo doesn't apply deduplication
+    # processes when you create a new task via the API. If your entry has the
+    # same task owner, contact, and other details as an existing task, Apollo
+    # creates a new task instead of updating the existing task. <br><br>For
+    # creating a single task, use the <a
+    # href="https://docs.apollo.io/reference/create-a-task">Create a Task
+    # 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 [TasksBulkCreateRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def bulk_create_tasks(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tasks/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(TasksBulkCreateResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 TasksBulkCreate422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 TasksBulkCreate429ErrorException))
+        .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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Get a Task endpoint to retrieve the full details for a single task that
+    # belongs to your team's Apollo account.<br><br>The response includes the
+    # task's associated <a
+    # href="https://docs.apollo.io/reference/view-an-account">account</a> and <a
+    # href="https://docs.apollo.io/reference/view-a-contact">contact</a> when
+    # the task has one attached. Depending on the task type, the response can
+    # also include other fields, such as `phone_call` for call tasks,
+    # `emailer_message` for email tasks, or a LinkedIn message template for
+    # LinkedIn-step tasks.<br><br>To find task IDs, use the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task you want to view.
+    # @param [String] id Required parameter: The Apollo ID for the task.
+    # <br><br>To find task IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task. <br><br>Example:
+    # `67a1b2c3d4e5f60001234567`
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_a_task(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/tasks/{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(TasksResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Tasks422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Tasks429ErrorException))
+        .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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Update a Task endpoint to change the details of an existing task that
+    # belongs to your team's Apollo account.<br><br>The fields you can update
+    # depend on the task's current `status`. For a task with a `scheduled`
+    # status, you can update any of the parameters listed below. For a task
+    # that's already `completed` or `skipped`, you can only update `note`,
+    # `priority`, `priority_cd`, and `contact_id`.<br><br>To find task IDs, use
+    # the <a href="https://docs.apollo.io/reference/search-tasks">Search for
+    # Tasks endpoint</a> and identify the `id` value for the task you want to
+    # update.
+    # @param [String] id Required parameter: The Apollo ID for the task.
+    # <br><br>To find task IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task. <br><br>Example:
+    # `67a1b2c3d4e5f60001234567`
+    # @param [TasksRequest1] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_a_task(id,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/tasks/{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(TasksResponse1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 Tasks401ErrorException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 Tasks422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 Tasks429ErrorException))
+        .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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Complete a Task endpoint to mark an existing task as
+    # `completed`.<br><br>To find task IDs, use the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task you want to
+    # complete.<br><br>If the task no longer exists (for example, because the
+    # sequence it belonged to was paused and the task was removed), Apollo
+    # returns a `200` response with `deleted: true` on the task instead of an
+    # error.<br><br>To skip a task instead of completing it, use the <a
+    # href="https://docs.apollo.io/reference/skip-a-task">Skip a Task
+    # endpoint</a>.
+    # @param [String] id Required parameter: The Apollo ID for the task.
+    # <br><br>To find task IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task. <br><br>Example:
+    # `67a1b2c3d4e5f60001234567`
+    # @param [TasksCompleteRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def complete_a_task(id,
+                        body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tasks/{id}/complete',
+                                     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(TasksCompleteResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 TasksComplete422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 TasksComplete429ErrorException))
+        .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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Skip a Task endpoint to mark an existing task as `skipped` without
+    # completing it.<br><br>To find task IDs, use the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task you want to
+    # skip.<br><br>If the task no longer exists (for example, because the
+    # sequence it belonged to was paused and the task was removed), Apollo
+    # returns a `200` response with `deleted: true` on the task instead of an
+    # error.<br><br>To mark a task as done instead of skipping it, use the <a
+    # href="https://docs.apollo.io/reference/complete-a-task">Complete a Task
+    # endpoint</a>.
+    # @param [String] id Required parameter: The Apollo ID for the task.
+    # <br><br>To find task IDs, call the <a
+    # href="https://docs.apollo.io/reference/search-tasks">Search for Tasks
+    # endpoint</a> and identify the `id` value for the task. <br><br>Example:
+    # `67a1b2c3d4e5f60001234567`
+    # @param [TasksSkipRequest] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def skip_a_task(id,
+                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tasks/{id}/skip',
+                                     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(TasksSkipResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 NeedMasterApiKeyException)
+                    .local_error('422',
+                                 '422',
+                                 TasksSkip422ErrorException)
+                    .local_error('429',
+                                 '429',
+                                 TasksSkip429ErrorException))
+        .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/28705458602125-Tasks-O
+    # verview" target="_blank">Tasks</a> let you track, prioritize, and help you
+    # complete actions required for your outbound sales motion.<br><br>Use the
+    # Search for Tasks endpoint to find tasks that your team has created in
+    # Apollo.<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.<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> `task_due_at`: The most future-dated
+    # first. </li> <li> `task_priority`: The highest priority first. </li>
+    # </ul>
+    # @param [Array[String]] open_factor_names Optional parameter: Enter
+    # `task_types` for this parameter to return a count of tasks by task type.
+    # <br><br>When used, the response includes a `"task_types": []` array with a
+    # `"count"` value for each task type.
+    # @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 search_tasks(sort_by_field: nil,
+                     open_factor_names: nil,
+                     page: nil,
+                     per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tasks/search',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(sort_by_field, key: 'sort_by_field'))
+                   .query_param(new_parameter(open_factor_names, key: 'open_factor_names[]'))
+                   .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(TasksSearchResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 '401',
+                                 APIException)
+                    .local_error('403',
+                                 '403',
+                                 APIException)
+                    .local_error('422',
+                                 '422',
+                                 APIException)
+                    .local_error('429',
+                                 '429',
+                                 TasksSearch429ErrorException))
+        .execute
+    end
+  end
+end

data/lib/apollo_rest_api/client.rb

@@ -0,0 +1,147 @@
+# apollo_rest_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApolloRestApi
+  #  apollo_rest_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to enrichment controller.
+    # @return [EnrichmentApi] Returns the controller instance.
+    def enrichment
+      @enrichment ||= EnrichmentApi.new @global_configuration
+    end
+
+    # Access to search controller.
+    # @return [SearchApi] Returns the controller instance.
+    def search
+      @search ||= SearchApi.new @global_configuration
+    end
+
+    # Access to accounts controller.
+    # @return [AccountsApi] Returns the controller instance.
+    def accounts
+      @accounts ||= AccountsApi.new @global_configuration
+    end
+
+    # Access to contacts controller.
+    # @return [ContactsApi] Returns the controller instance.
+    def contacts
+      @contacts ||= ContactsApi.new @global_configuration
+    end
+
+    # Access to deals controller.
+    # @return [DealsApi] Returns the controller instance.
+    def deals
+      @deals ||= DealsApi.new @global_configuration
+    end
+
+    # Access to sequences controller.
+    # @return [SequencesApi] Returns the controller instance.
+    def sequences
+      @sequences ||= SequencesApi.new @global_configuration
+    end
+
+    # Access to tasks controller.
+    # @return [TasksApi] Returns the controller instance.
+    def tasks
+      @tasks ||= TasksApi.new @global_configuration
+    end
+
+    # Access to calls controller.
+    # @return [CallsApi] Returns the controller instance.
+    def calls
+      @calls ||= CallsApi.new @global_configuration
+    end
+
+    # Access to conversations controller.
+    # @return [ConversationsApi] Returns the controller instance.
+    def conversations
+      @conversations ||= ConversationsApi.new @global_configuration
+    end
+
+    # Access to analytics controller.
+    # @return [AnalyticsApi] Returns the controller instance.
+    def analytics
+      @analytics ||= AnalyticsApi.new @global_configuration
+    end
+
+    # Access to miscellaneous controller.
+    # @return [MiscellaneousApi] Returns the controller instance.
+    def miscellaneous
+      @miscellaneous ||= MiscellaneousApi.new @global_configuration
+    end
+
+    # Access to emailer_messages controller.
+    # @return [EmailerMessagesApi] Returns the controller instance.
+    def emailer_messages
+      @emailer_messages ||= EmailerMessagesApi.new @global_configuration
+    end
+
+    # Access to client controller.
+    # @return [Api] Returns the controller instance.
+    def client
+      @client ||= Api.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      api_key_credentials: nil, bearer_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    api_key_credentials: api_key_credentials,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[apiKey bearerAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['apiKey'] = ApiKey.new(http_client_config.api_key_credentials)
+      @auth_managers['bearerAuth'] = BearerAuth.new(http_client_config.bearer_auth_credentials)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end