Module: ApolloDeploySignalSdkRails

Defined in:
lib/apollo_deploy_signal_sdk_rails.rb,
lib/apollo_deploy_signal_sdk_rails/types.rb,
lib/apollo_deploy_signal_sdk_rails/client.rb,
lib/apollo_deploy_signal_sdk_rails/errors.rb,
lib/apollo_deploy_signal_sdk_rails/railtie.rb,
lib/apollo_deploy_signal_sdk_rails/version.rb,
lib/apollo_deploy_signal_sdk_rails/transport.rb,
lib/apollo_deploy_signal_sdk_rails/configuration.rb,
lib/apollo_deploy_signal_sdk_rails/resources/emails.rb,
lib/apollo_deploy_signal_sdk_rails/resources/topics.rb,
lib/apollo_deploy_signal_sdk_rails/resources/metrics.rb,
lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb,
lib/apollo_deploy_signal_sdk_rails/resources/contacts.rb,
lib/apollo_deploy_signal_sdk_rails/resources/projects.rb,
lib/apollo_deploy_signal_sdk_rails/resources/segments.rb,
lib/apollo_deploy_signal_sdk_rails/resources/webhooks.rb,
lib/apollo_deploy_signal_sdk_rails/resources/suppressions.rb,
lib/apollo_deploy_signal_sdk_rails/resources/sending-domains.rb,
lib/apollo_deploy_signal_sdk_rails/resources/contact-properties.rb

Defined Under Namespace

Modules: EmailValidationStatusInput Classes: ActivityMetadataResponse, ActivityResponse, AddSuppressionBody, AddToSegmentBody, AdvisorRecommendationDataResponse, AdvisorRecommendationResponse, AdvisorReportResponse, ApiKey, ApiKeyUsageRecord, ApiKeyUsageResponse, ApiKeys, AttachmentRequest, BatchSendItemResponse, BatchSendRequest, BatchSendResponse, BulkCancelResponse, CancelResponse, Client, Config, ContactPageResponse, ContactProperties, ContactPropertyPageResponse, ContactPropertyResponse, ContactResponse, Contacts, CreateContactBody, CreateContactPropertyBody, CreateSegmentBody, CreateTopicBody, CreateWebhookBody, CursorInfo, CursorPage, DeliveryWindowRequest, DkimRecordResponse, DnsRecordResponse, DomainListItemResponse, DomainListPageResponse, DomainResponse, EmailDetailResponse, EmailPageResponse, EmailPerformanceResponse, EmailReadScrollAnalyticsResponse, EmailTimelineItem, EmailTimelineResponse, EmailValidationStatusResponse, Emails, EngagementScoreResponse, GetMetricsAdvisorQuery, GetProjectMetricsSummaryQuery, GetProjectMetricsTimelineQuery, GetTopicPerformanceQuery, LinkResultItem, ListApiKeysResponse, Metrics, MetricsWindowResponse, PageInfo, ProjectLimitsModel, ProjectMetricsSummaryResponse, ProjectMetricsTimelineResponse, ProjectPageResponse, ProjectResponse, ProjectTimelineBucketResponse, ProjectTrackingSettingsModel, Projects, Railtie, RecordValidationBody, RegisterDomainRequest, SDKError, SSEEvent, SegmentContactResponse, SegmentPageResponse, SegmentRef, SegmentResponse, Segments, SendEmailRequest, SendEmailResponse, SendingDomains, SetImageUrlBody, StreamEventResponse, StreamTokenResponse, SuppressionImportBody, SuppressionImportResponse, SuppressionImportRowSerializable, SuppressionPageResponse, SuppressionResponse, Suppressions, TopicPageResponse, TopicPerformanceResponse, TopicResponse, TopicSubscriptionBody, TopicSubscriptionResponse, Topics, TrackingSettingsRequest, Transport, UpdateBimiRequest, UpdateContactBody, UpdateContactPropertyBody, UpdateProjectRequest, UpdateTopicBody, UpdateTopicsBody, UpdateWebhookBody, UsagePage, ValidateLinksRequest, ValidateLinksResponse, VerificationRecordsResponse, WebhookCreateResponse, WebhookDeliveryPageResponse, WebhookDeliveryResponse, WebhookFilterSerializable, WebhookPageResponse, WebhookResponse, WebhookTransformationSerializable, Webhooks

Constant Summary collapse

ListContactSegmentsResponse =

ListContactSegmentsResponse — type alias for Array

Array
GetContactTopicsResponse =

GetContactTopicsResponse — type alias for Array

Array
GetContactActivityResponse =

GetContactActivityResponse — type alias for Array

Array
VERSION = 
"4.0.1"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object

Mutable application-level defaults. Rails applications may configure these values in environment configuration or an initializer.



7
8
9
 
# File 'lib/apollo_deploy_signal_sdk_rails/configuration.rb', line 7

def configuration
  @configuration ||= Config.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



11
12
13
 
# File 'lib/apollo_deploy_signal_sdk_rails/configuration.rb', line 11

def configure
  yield(configuration)
end

.create_client(base_url: "https://api.signal.apollodeploy.com", timeout: 15, retries: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 }, sse_client: nil, **extra) ⇒ ApolloDeploySignalSdkRails::Client

Factory method to create a new client instance.

Parameters:

  • base_url (String) (defaults to: "https://api.signal.apollodeploy.com") —

    the base URL for the API

  • timeout (Integer) (defaults to: 15) —

    request timeout in seconds (default: 15)

  • retries (Hash) (defaults to: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 }) —

    retry configuration

  • sse_client (Object, nil) (defaults to: nil) —

    optional SSE client implementation

Options Hash (retries:):

  • :attempts (Integer) — default: 3
  • :backoff (Float) — default: 0.4
  • :jitter (Boolean) — default: true
  • :max_backoff (Float) — default: 30.0

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/apollo_deploy_signal_sdk_rails.rb', line 34

def self.create_client(
  base_url: "https://api.signal.apollodeploy.com",
  timeout: 15,
  retries: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 },
  sse_client: nil,
  **extra
)
  ApolloDeploySignalSdkRails::Client.new(
    base_url: base_url,
    timeout: timeout,
    retries: retries,
    sse_client: sse_client,
    **extra
  )
end

.rails_client ⇒ Object

Resolve a fresh client so long-lived processes observe current settings.



16
17
18
 
# File 'lib/apollo_deploy_signal_sdk_rails/configuration.rb', line 16

def rails_client
  Client.new(configuration)
end