apollo-deploy-signal-sdk 1.0.5

data/lib/apollo_deploy_signal_sdk/resources/segments.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # segments API domain
+  class Segments
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SegmentPageResponse]
+    def list_segments(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/segments",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param segment_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SegmentResponse]
+    def get_segment(project_id:, segment_id:)
+      path_params = {
+        "projectId" => project_id,
+        "segmentId" => segment_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/segments/${segmentId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param segment_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [CursorPage]
+    def list_contacts_in_segment(project_id:, segment_id:)
+      path_params = {
+        "projectId" => project_id,
+        "segmentId" => segment_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/segments/${segmentId}/contacts",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [CreateSegmentBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SegmentResponse]
+    def create_segment(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/segments",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param segment_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def delete_segment(project_id:, segment_id:)
+      path_params = {
+        "projectId" => project_id,
+        "segmentId" => segment_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/segments/${segmentId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/sending-domains.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # sendingDomains API domain
+  class SendingDomains
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [DomainListPageResponse]
+    def list_domains(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/domains",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param domain_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [DomainResponse]
+    def get_domain(project_id:, domain_id:)
+      path_params = {
+        "projectId" => project_id,
+        "domainId" => domain_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/domains/${domainId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [RegisterDomainRequest] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [DomainResponse]
+    def register_domain(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/domains",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param domain_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [DomainResponse]
+    def verify_domain(project_id:, domain_id:)
+      path_params = {
+        "projectId" => project_id,
+        "domainId" => domain_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/domains/${domainId}/verify",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param domain_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def delete_domain(project_id:, domain_id:)
+      path_params = {
+        "projectId" => project_id,
+        "domainId" => domain_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/domains/${domainId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param domain_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [DomainResponse]
+    def verify_bimi(project_id:, domain_id:)
+      path_params = {
+        "projectId" => project_id,
+        "domainId" => domain_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/domains/${domainId}/bimi/verify",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param domain_id [String]
+    # @param body [UpdateBimiRequest] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [DomainResponse]
+    def update_bimi(project_id:, domain_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "domainId" => domain_id,
+      }
+
+      transport.request(
+        method: :patch,
+        path: "/v1/projects/${projectId}/domains/${domainId}/bimi",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/suppressions.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # suppressions API domain
+  class Suppressions
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SuppressionPageResponse]
+    def list_suppressions(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/suppressions",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def export_suppressions(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/suppressions/export",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [AddSuppressionBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SuppressionResponse]
+    def add_suppression(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/suppressions",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param email [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def remove_suppression(project_id:, email:)
+      path_params = {
+        "projectId" => project_id,
+        "email" => email,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/suppressions/${email}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [SuppressionImportBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [SuppressionImportResponse]
+    def import_suppressions(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/suppressions/import",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/topics.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # topics API domain
+  class Topics
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [TopicPageResponse]
+    def list_topics(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/topics",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param topic_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [TopicResponse]
+    def get_topic(project_id:, topic_id:)
+      path_params = {
+        "projectId" => project_id,
+        "topicId" => topic_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/topics/${topicId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param topic_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [CursorPage]
+    def list_contacts_in_topic(project_id:, topic_id:)
+      path_params = {
+        "projectId" => project_id,
+        "topicId" => topic_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/topics/${topicId}/contacts",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [CreateTopicBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [TopicResponse]
+    def create_topic(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/topics",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param topic_id [String]
+    # @param body [UpdateTopicBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [TopicResponse]
+    def update_topic(project_id:, topic_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "topicId" => topic_id,
+      }
+
+      transport.request(
+        method: :patch,
+        path: "/v1/projects/${projectId}/topics/${topicId}",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param topic_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def delete_topic(project_id:, topic_id:)
+      path_params = {
+        "projectId" => project_id,
+        "topicId" => topic_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/topics/${topicId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end

data/lib/apollo_deploy_signal_sdk/resources/webhooks.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative "../transport"
+require_relative "../errors"
+
+module ApolloDeploySignalSdk
+  # webhooks API domain
+  class Webhooks
+    attr_reader :transport
+
+    def initialize(transport)
+      @transport = transport
+    end
+
+    # @param project_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookPageResponse]
+    def list_webhooks(project_id:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/webhooks",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookResponse]
+    def get_webhook(project_id:, endpoint_id:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookDeliveryPageResponse]
+    def list_webhook_deliveries(project_id:, endpoint_id:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}/deliveries",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @param delivery_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookDeliveryResponse]
+    def get_webhook_delivery(project_id:, endpoint_id:, delivery_id:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+        "deliveryId" => delivery_id,
+      }
+
+      transport.request(
+        method: :get,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}/deliveries/${deliveryId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param body [CreateWebhookBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookCreateResponse]
+    def create_webhook(project_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/webhooks",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @param body [UpdateWebhookBody] request body
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookResponse]
+    def update_webhook(project_id:, endpoint_id:, body:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+      }
+
+      transport.request(
+        method: :patch,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}",
+        path_params: path_params,
+        body: body,
+        content_type: "application/json",
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def delete_webhook(project_id:, endpoint_id:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+      }
+
+      transport.request(
+        method: :delete,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [WebhookDeliveryResponse]
+    def test_webhook(project_id:, endpoint_id:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}/test",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+    # @param project_id [String]
+    # @param endpoint_id [String]
+    # @param delivery_id [String]
+    # @raise [ApolloDeploySignalSdk::SDKError]
+    # @return [nil]
+    def replay_webhook_delivery(project_id:, endpoint_id:, delivery_id:)
+      path_params = {
+        "projectId" => project_id,
+        "endpointId" => endpoint_id,
+        "deliveryId" => delivery_id,
+      }
+
+      transport.request(
+        method: :post,
+        path: "/v1/projects/${projectId}/webhooks/${endpointId}/replay/${deliveryId}",
+        path_params: path_params,
+        timeout_ms: nil,
+      )
+    end
+
+  end
+end