apollo-deploy-signal-sdk 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +5 -0
- data/LICENSE +21 -0
- data/README.md +79 -0
- data/docs/README.md +30 -0
- data/docs/domains/api-keys.md +92 -0
- data/docs/domains/contact-properties.md +122 -0
- data/docs/domains/contacts.md +394 -0
- data/docs/domains/emails.md +150 -0
- data/docs/domains/metrics.md +131 -0
- data/docs/domains/projects.md +127 -0
- data/docs/domains/segments.md +116 -0
- data/docs/domains/sending-domains.md +160 -0
- data/docs/domains/suppressions.md +120 -0
- data/docs/domains/topics.md +141 -0
- data/docs/domains/webhooks.md +200 -0
- data/docs/types.md +1225 -0
- data/lib/apollo-deploy-signal-sdk.rb +3 -0
- data/lib/apollo_deploy_signal_sdk/client.rb +111 -0
- data/lib/apollo_deploy_signal_sdk/errors.rb +150 -0
- data/lib/apollo_deploy_signal_sdk/resources/api-keys.rb +86 -0
- data/lib/apollo_deploy_signal_sdk/resources/contact-properties.rb +108 -0
- data/lib/apollo_deploy_signal_sdk/resources/contacts.rb +356 -0
- data/lib/apollo_deploy_signal_sdk/resources/emails.rb +128 -0
- data/lib/apollo_deploy_signal_sdk/resources/metrics.rb +122 -0
- data/lib/apollo_deploy_signal_sdk/resources/projects.rb +114 -0
- data/lib/apollo_deploy_signal_sdk/resources/segments.rb +105 -0
- data/lib/apollo_deploy_signal_sdk/resources/sending-domains.rb +144 -0
- data/lib/apollo_deploy_signal_sdk/resources/suppressions.rb +104 -0
- data/lib/apollo_deploy_signal_sdk/resources/topics.rb +126 -0
- data/lib/apollo_deploy_signal_sdk/resources/webhooks.rb +184 -0
- data/lib/apollo_deploy_signal_sdk/transport.rb +618 -0
- data/lib/apollo_deploy_signal_sdk/types.rb +4917 -0
- data/lib/apollo_deploy_signal_sdk/version.rb +5 -0
- data/lib/apollo_deploy_signal_sdk.rb +47 -0
- metadata +135 -0
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "apollo_deploy_signal_sdk/version"
|
|
4
|
+
require_relative "apollo_deploy_signal_sdk/errors"
|
|
5
|
+
require_relative "apollo_deploy_signal_sdk/transport"
|
|
6
|
+
require_relative "apollo_deploy_signal_sdk/types"
|
|
7
|
+
require_relative "apollo_deploy_signal_sdk/client"
|
|
8
|
+
require_relative "apollo_deploy_signal_sdk/resources/emails"
|
|
9
|
+
require_relative "apollo_deploy_signal_sdk/resources/metrics"
|
|
10
|
+
require_relative "apollo_deploy_signal_sdk/resources/suppressions"
|
|
11
|
+
require_relative "apollo_deploy_signal_sdk/resources/segments"
|
|
12
|
+
require_relative "apollo_deploy_signal_sdk/resources/topics"
|
|
13
|
+
require_relative "apollo_deploy_signal_sdk/resources/contact-properties"
|
|
14
|
+
require_relative "apollo_deploy_signal_sdk/resources/contacts"
|
|
15
|
+
require_relative "apollo_deploy_signal_sdk/resources/webhooks"
|
|
16
|
+
require_relative "apollo_deploy_signal_sdk/resources/api-keys"
|
|
17
|
+
require_relative "apollo_deploy_signal_sdk/resources/projects"
|
|
18
|
+
require_relative "apollo_deploy_signal_sdk/resources/sending-domains"
|
|
19
|
+
|
|
20
|
+
module ApolloDeploySignalSdk
|
|
21
|
+
# Factory method to create a new client instance.
|
|
22
|
+
#
|
|
23
|
+
# @param base_url [String] the base URL for the API
|
|
24
|
+
# @param timeout [Integer] request timeout in seconds (default: 15)
|
|
25
|
+
# @param retries [Hash] retry configuration
|
|
26
|
+
# @option retries [Integer] :attempts (3)
|
|
27
|
+
# @option retries [Float] :backoff (0.4)
|
|
28
|
+
# @option retries [Boolean] :jitter (true)
|
|
29
|
+
# @option retries [Float] :max_backoff (30.0)
|
|
30
|
+
# @param sse_client [Object, nil] optional SSE client implementation
|
|
31
|
+
# @return [ApolloDeploySignalSdk::Client]
|
|
32
|
+
def self.create_client(
|
|
33
|
+
base_url: "https://signal.apollodeploy.com",
|
|
34
|
+
timeout: 15,
|
|
35
|
+
retries: { attempts: 3, backoff: 0.4, jitter: true, max_backoff: 30.0 },
|
|
36
|
+
sse_client: nil,
|
|
37
|
+
**extra
|
|
38
|
+
)
|
|
39
|
+
ApolloDeploySignalSdk::Client.new(
|
|
40
|
+
base_url: base_url,
|
|
41
|
+
timeout: timeout,
|
|
42
|
+
retries: retries,
|
|
43
|
+
sse_client: sse_client,
|
|
44
|
+
**extra
|
|
45
|
+
)
|
|
46
|
+
end
|
|
47
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: apollo-deploy-signal-sdk
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 1.0.5
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Apollo Deploy
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2026-08-30 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: faraday
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '2.0'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '2.0'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: rake
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '13.0'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '13.0'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: rspec
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '3.0'
|
|
48
|
+
type: :development
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '3.0'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: webmock
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '3.0'
|
|
62
|
+
type: :development
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '3.0'
|
|
69
|
+
description: A Ruby client library for the Apollo Signal API.
|
|
70
|
+
email:
|
|
71
|
+
executables: []
|
|
72
|
+
extensions: []
|
|
73
|
+
extra_rdoc_files: []
|
|
74
|
+
files:
|
|
75
|
+
- Gemfile
|
|
76
|
+
- LICENSE
|
|
77
|
+
- README.md
|
|
78
|
+
- docs/README.md
|
|
79
|
+
- docs/domains/api-keys.md
|
|
80
|
+
- docs/domains/contact-properties.md
|
|
81
|
+
- docs/domains/contacts.md
|
|
82
|
+
- docs/domains/emails.md
|
|
83
|
+
- docs/domains/metrics.md
|
|
84
|
+
- docs/domains/projects.md
|
|
85
|
+
- docs/domains/segments.md
|
|
86
|
+
- docs/domains/sending-domains.md
|
|
87
|
+
- docs/domains/suppressions.md
|
|
88
|
+
- docs/domains/topics.md
|
|
89
|
+
- docs/domains/webhooks.md
|
|
90
|
+
- docs/types.md
|
|
91
|
+
- lib/apollo-deploy-signal-sdk.rb
|
|
92
|
+
- lib/apollo_deploy_signal_sdk.rb
|
|
93
|
+
- lib/apollo_deploy_signal_sdk/client.rb
|
|
94
|
+
- lib/apollo_deploy_signal_sdk/errors.rb
|
|
95
|
+
- lib/apollo_deploy_signal_sdk/resources/api-keys.rb
|
|
96
|
+
- lib/apollo_deploy_signal_sdk/resources/contact-properties.rb
|
|
97
|
+
- lib/apollo_deploy_signal_sdk/resources/contacts.rb
|
|
98
|
+
- lib/apollo_deploy_signal_sdk/resources/emails.rb
|
|
99
|
+
- lib/apollo_deploy_signal_sdk/resources/metrics.rb
|
|
100
|
+
- lib/apollo_deploy_signal_sdk/resources/projects.rb
|
|
101
|
+
- lib/apollo_deploy_signal_sdk/resources/segments.rb
|
|
102
|
+
- lib/apollo_deploy_signal_sdk/resources/sending-domains.rb
|
|
103
|
+
- lib/apollo_deploy_signal_sdk/resources/suppressions.rb
|
|
104
|
+
- lib/apollo_deploy_signal_sdk/resources/topics.rb
|
|
105
|
+
- lib/apollo_deploy_signal_sdk/resources/webhooks.rb
|
|
106
|
+
- lib/apollo_deploy_signal_sdk/transport.rb
|
|
107
|
+
- lib/apollo_deploy_signal_sdk/types.rb
|
|
108
|
+
- lib/apollo_deploy_signal_sdk/version.rb
|
|
109
|
+
homepage: https://github.com/Apollo-Deploy/signal-sdks
|
|
110
|
+
licenses:
|
|
111
|
+
- MIT
|
|
112
|
+
metadata:
|
|
113
|
+
homepage_uri: https://github.com/Apollo-Deploy/signal-sdks
|
|
114
|
+
source_code_uri: https://github.com/Apollo-Deploy/signal-sdks
|
|
115
|
+
bug_tracker_uri: https://github.com/Apollo-Deploy/signal-sdks/issues
|
|
116
|
+
post_install_message:
|
|
117
|
+
rdoc_options: []
|
|
118
|
+
require_paths:
|
|
119
|
+
- lib
|
|
120
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
121
|
+
requirements:
|
|
122
|
+
- - ">="
|
|
123
|
+
- !ruby/object:Gem::Version
|
|
124
|
+
version: 2.7.0
|
|
125
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
126
|
+
requirements:
|
|
127
|
+
- - ">="
|
|
128
|
+
- !ruby/object:Gem::Version
|
|
129
|
+
version: '0'
|
|
130
|
+
requirements: []
|
|
131
|
+
rubygems_version: 3.5.22
|
|
132
|
+
signing_key:
|
|
133
|
+
specification_version: 4
|
|
134
|
+
summary: Ruby SDK for Apollo Signal API
|
|
135
|
+
test_files: []
|