Class: ApolloDeploySignalSdk::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk/client.rb

Overview

Main client for the Apollo Signal API API.

Provides access to all API domains as instance methods.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil) ⇒ Client

Create a new API client.

Parameters:

  • config (ApolloDeploySignalSdk::Config, Hash, nil) (defaults to: nil) —

    Either a Config instance or keyword arguments matching Config#initialize.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 87

def initialize(config = nil)
  @config = if config.is_a?(Config)
              config
            elsif config.is_a?(Hash)
              Config.new(**config)
            else
              Config.new
            end

  @transport = Transport.new(@config)

  @emails = ApolloDeploySignalSdk::Emails.new(@transport)
  @metrics = ApolloDeploySignalSdk::Metrics.new(@transport)
  @suppressions = ApolloDeploySignalSdk::Suppressions.new(@transport)
  @segments = ApolloDeploySignalSdk::Segments.new(@transport)
  @topics = ApolloDeploySignalSdk::Topics.new(@transport)
  @contactProperties = ApolloDeploySignalSdk::ContactProperties.new(@transport)
  @contacts = ApolloDeploySignalSdk::Contacts.new(@transport)
  @webhooks = ApolloDeploySignalSdk::Webhooks.new(@transport)
  @apiKeys = ApolloDeploySignalSdk::ApiKeys.new(@transport)
  @projects = ApolloDeploySignalSdk::Projects.new(@transport)
  @sendingDomains = ApolloDeploySignalSdk::SendingDomains.new(@transport)
end

Instance Attribute Details

#apiKeys ⇒ ApolloDeploySignalSdk::ApiKeys (readonly)

Returns:



71
72
73
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 71

def apiKeys
  @apiKeys
end

#config ⇒ ApolloDeploySignalSdk::Config (readonly)

Returns the client configuration.

Returns:



78
79
80
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 78

def config
  @config
end

#contactProperties ⇒ ApolloDeploySignalSdk::ContactProperties (readonly)

Returns:



65
66
67
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 65

def contactProperties
  @contactProperties
end

#contacts ⇒ ApolloDeploySignalSdk::Contacts (readonly)

Returns:



67
68
69
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 67

def contacts
  @contacts
end

#emails ⇒ ApolloDeploySignalSdk::Emails (readonly)

Returns:



55
56
57
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 55

def emails
  @emails
end

#metrics ⇒ ApolloDeploySignalSdk::Metrics (readonly)

Returns:



57
58
59
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 57

def metrics
  @metrics
end

#projects ⇒ ApolloDeploySignalSdk::Projects (readonly)

Returns:



73
74
75
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 73

def projects
  @projects
end

#segments ⇒ ApolloDeploySignalSdk::Segments (readonly)

Returns:



61
62
63
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 61

def segments
  @segments
end

#sendingDomains ⇒ ApolloDeploySignalSdk::SendingDomains (readonly)

Returns:



75
76
77
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 75

def sendingDomains
  @sendingDomains
end

#suppressions ⇒ ApolloDeploySignalSdk::Suppressions (readonly)

Returns:



59
60
61
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 59

def suppressions
  @suppressions
end

#topics ⇒ ApolloDeploySignalSdk::Topics (readonly)

Returns:



63
64
65
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 63

def topics
  @topics
end

#transport ⇒ ApolloDeploySignalSdk::Transport (readonly)

Returns the underlying HTTP transport.

Returns:



81
82
83
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 81

def transport
  @transport
end

#webhooks ⇒ ApolloDeploySignalSdk::Webhooks (readonly)

Returns:



69
70
71
 
# File 'lib/apollo_deploy_signal_sdk/client.rb', line 69

def webhooks
  @webhooks
end