apollo-deploy-signal-sdk 1.0.5

data/lib/apollo_deploy_signal_sdk/resources/contacts.rb

@@ -0,0 +1,356 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # contacts API domain
+  class Contacts
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ContactPageResponse]
+    def list_contacts(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ContactResponse]
+    def get_contact(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts/${contactId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ListContactSegmentsResponse]
+    def list_contact_segments(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/segments",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [GetContactTopicsResponse]
+    def get_contact_topics(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/topics",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [CreateContactBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ContactResponse]
+    def create_contact(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/contacts",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @param body [UpdateContactBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ContactResponse]
+    def update_contact(project_id:, contact_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :patch,
+        path: "/v1/projects/${projectId}/contacts/${contactId}",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def delete_contact(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/contacts/${contactId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ContactResponse]
+    def upload_contact_image(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/image",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @param body [SetImageUrlBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ContactResponse]
+    def set_contact_image_url(project_id:, contact_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :put,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/image",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def delete_contact_image(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/image",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @param body [AddToSegmentBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def add_contact_to_segment(project_id:, contact_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/segments",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @param segment_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def remove_contact_from_segment(project_id:, contact_id:, segment_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+        "segmentId" => segment_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/segments/${segmentId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @param body [UpdateTopicsBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def update_contact_topics(project_id:, contact_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :patch,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/topics",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [GetContactActivityResponse]
+    def get_contact_activity(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/activity",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EngagementScoreResponse]
+    def get_contact_engagement_score(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/engagement",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailValidationStatusResponse]
+    def get_contact_email_validation_status(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/email-validation",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EngagementScoreResponse]
+    def refresh_contact_engagement_score(project_id:, contact_id:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/engagement/refresh",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param contact_id [String]
+    # @param body [RecordValidationBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def record_contact_email_validation(project_id:, contact_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "contactId" => contact_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/contacts/${contactId}/email-validation",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/emails.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # emails API domain
+  class Emails
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param body [SendEmailRequest] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SendEmailResponse]
+    def send_email(body:)
+
+      transport.request(
+        method: :post,
+        path: "/v1/emails",
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param email_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailDetailResponse]
+    def get_email(email_id:)
+      path_params = {
+        "emailId" => email_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/emails/${emailId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param body [BatchSendRequest] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [BatchSendResponse]
+    def batch_send_emails(body:)
+
+      transport.request(
+        method: :post,
+        path: "/v1/emails/batch",
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param email_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [CancelResponse]
+    def cancel_email(email_id:)
+      path_params = {
+        "emailId" => email_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/emails/${emailId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [BulkCancelResponse]
+    def bulk_cancel_emails()
+
+      transport.request(
+        method: :delete,
+        path: "/v1/emails",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [StreamTokenResponse]
+    def issue_stream_token(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/emails/${projectId}/stream/token",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [Enumerator<SSEEvent>]
+    def stream_email_events()
+
+      transport.stream(
+        method: :get,
+        path: "/v1/emails/stream",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param body [ValidateLinksRequest] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ValidateLinksResponse]
+    def validate_links(body:)
+
+      transport.request(
+        method: :post,
+        path: "/v1/emails/validate",
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/metrics.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # metrics API domain
+  class Metrics
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param id [String]
+    # @param query [Hash, nil] query parameters
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [TopicPerformanceResponse]
+    def get_topic_performance(id:, query: nil)
+      path_params = {
+        "id" => id,
+      }
+      query_params = {}
+      query_params["window"] = query[:window] if query && query.key?(:window)
+      query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
+      query_params = nil if query_params.empty?
+
+      transport.request(
+        method: :get,
+        path: "/v1/metrics/topics/${id}",
+        path_params: path_params,
+        query: query_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailPerformanceResponse]
+    def get_email_performance(id:)
+      path_params = {
+        "id" => id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/metrics/emails/${id}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailReadScrollAnalyticsResponse]
+    def get_email_engagement(id:)
+      path_params = {
+        "id" => id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/metrics/emails/${id}/engagement",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param query [Hash, nil] query parameters
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ProjectMetricsSummaryResponse]
+    def get_project_metrics_summary(query: nil)
+      query_params = {}
+      query_params["window"] = query[:window] if query && query.key?(:window)
+      query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
+      query_params = nil if query_params.empty?
+
+      transport.request(
+        method: :get,
+        path: "/v1/metrics/summary",
+        query: query_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param query [Hash, nil] query parameters
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ProjectMetricsTimelineResponse]
+    def get_project_metrics_timeline(query: nil)
+      query_params = {}
+      query_params["window"] = query[:window] if query && query.key?(:window)
+      query_params["granularity"] = query[:granularity] if query && query.key?(:granularity)
+      query_params["format"] = query[:format] if query && query.key?(:format)
+      query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
+      query_params = nil if query_params.empty?
+
+      transport.request(
+        method: :get,
+        path: "/v1/metrics/timeline",
+        query: query_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param query [Hash, nil] query parameters
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [AdvisorReportResponse]
+    def get_metrics_advisor(query: nil)
+      query_params = {}
+      query_params["projectId"] = query[:project_id] if query && query.key?(:project_id)
+      query_params = nil if query_params.empty?
+
+      transport.request(
+        method: :get,
+        path: "/v1/metrics/advisor",
+        query: query_params,
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/projects.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # projects API domain
+  class Projects
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ProjectPageResponse]
+    def list_projects()
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ProjectResponse]
+    def get_project(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [UpdateProjectRequest] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [ProjectResponse]
+    def update_project(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :patch,
+        path: "/v1/projects/${projectId}",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailPageResponse]
+    def list_emails(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/emails",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param email_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailDetailResponse]
+    def get_project_email(project_id:, email_id:)
+      path_params = {
+        "projectId" => project_id,
+        "emailId" => email_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/emails/${emailId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param email_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [EmailTimelineResponse]
+    def get_email_timeline(project_id:, email_id:)
+      path_params = {
+        "projectId" => project_id,
+        "emailId" => email_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/emails/${emailId}/events",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end