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.
Files changed (36) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +5 -0
  3. data/LICENSE +21 -0
  4. data/README.md +79 -0
  5. data/docs/README.md +30 -0
  6. data/docs/domains/api-keys.md +92 -0
  7. data/docs/domains/contact-properties.md +122 -0
  8. data/docs/domains/contacts.md +394 -0
  9. data/docs/domains/emails.md +150 -0
  10. data/docs/domains/metrics.md +131 -0
  11. data/docs/domains/projects.md +127 -0
  12. data/docs/domains/segments.md +116 -0
  13. data/docs/domains/sending-domains.md +160 -0
  14. data/docs/domains/suppressions.md +120 -0
  15. data/docs/domains/topics.md +141 -0
  16. data/docs/domains/webhooks.md +200 -0
  17. data/docs/types.md +1225 -0
  18. data/lib/apollo-deploy-signal-sdk.rb +3 -0
  19. data/lib/apollo_deploy_signal_sdk/client.rb +111 -0
  20. data/lib/apollo_deploy_signal_sdk/errors.rb +150 -0
  21. data/lib/apollo_deploy_signal_sdk/resources/api-keys.rb +86 -0
  22. data/lib/apollo_deploy_signal_sdk/resources/contact-properties.rb +108 -0
  23. data/lib/apollo_deploy_signal_sdk/resources/contacts.rb +356 -0
  24. data/lib/apollo_deploy_signal_sdk/resources/emails.rb +128 -0
  25. data/lib/apollo_deploy_signal_sdk/resources/metrics.rb +122 -0
  26. data/lib/apollo_deploy_signal_sdk/resources/projects.rb +114 -0
  27. data/lib/apollo_deploy_signal_sdk/resources/segments.rb +105 -0
  28. data/lib/apollo_deploy_signal_sdk/resources/sending-domains.rb +144 -0
  29. data/lib/apollo_deploy_signal_sdk/resources/suppressions.rb +104 -0
  30. data/lib/apollo_deploy_signal_sdk/resources/topics.rb +126 -0
  31. data/lib/apollo_deploy_signal_sdk/resources/webhooks.rb +184 -0
  32. data/lib/apollo_deploy_signal_sdk/transport.rb +618 -0
  33. data/lib/apollo_deploy_signal_sdk/types.rb +4917 -0
  34. data/lib/apollo_deploy_signal_sdk/version.rb +5 -0
  35. data/lib/apollo_deploy_signal_sdk.rb +47 -0
  36. metadata +135 -0
data/docs/domains/projects.md ADDED
@@ -0,0 +1,127 @@
1
+ # ProjectsAPI
2
+
3
+ projects API operations.
4
+
5
+ [Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/projects.rb)
6
+
7
+ Client accessor: `client.projects`
8
+
9
+ ## Operations
10
+
11
+ | Method | HTTP | Path | Returns | Description |
12
+ |---|---|---|---|---|
13
+ | [`list_projects`](#list-projects) | `GET` | `/v1/projects` | `ProjectPageResponse` | — |
14
+ | [`get_project`](#get-project) | `GET` | `/v1/projects/{projectId}` | `ProjectResponse` | — |
15
+ | [`update_project`](#update-project) | `PATCH` | `/v1/projects/{projectId}` | `ProjectResponse` | — |
16
+ | [`list_emails`](#list-emails) | `GET` | `/v1/projects/{projectId}/emails` | `EmailPageResponse` | — |
17
+ | [`get_project_email`](#get-project-email) | `GET` | `/v1/projects/{projectId}/emails/{emailId}` | `EmailDetailResponse` | — |
18
+ | [`get_email_timeline`](#get-email-timeline) | `GET` | `/v1/projects/{projectId}/emails/{emailId}/events` | `EmailTimelineResponse` | — |
19
+
20
+ ## list_projects
21
+
22
+ `GET /v1/projects`
23
+
24
+ ### Response
25
+
26
+ - Response schema selectors: `200`
27
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
28
+ - Type: `ProjectPageResponse`
29
+
30
+
31
+ ## get_project
32
+
33
+ `GET /v1/projects/{projectId}`
34
+
35
+ ### Parameters
36
+
37
+ | Name | Location | Type | Required | Description |
38
+ |---|---|---|:---:|---|
39
+ | `projectId` | Path | `String` | Yes | — |
40
+
41
+ ### Response
42
+
43
+ - Response schema selectors: `200`
44
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
45
+ - Type: `ProjectResponse`
46
+
47
+
48
+ ## update_project
49
+
50
+ `PATCH /v1/projects/{projectId}`
51
+
52
+ ### Parameters
53
+
54
+ | Name | Location | Type | Required | Description |
55
+ |---|---|---|:---:|---|
56
+ | `projectId` | Path | `String` | Yes | — |
57
+
58
+ ### Request body
59
+
60
+ - Type: `UpdateProjectRequest`
61
+ - Required: Yes
62
+ - Content type: `application/json`
63
+
64
+ ### Response
65
+
66
+ - Response schema selectors: `200`
67
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
68
+ - Type: `ProjectResponse`
69
+
70
+
71
+ ## list_emails
72
+
73
+ `GET /v1/projects/{projectId}/emails`
74
+
75
+ ### Parameters
76
+
77
+ | Name | Location | Type | Required | Description |
78
+ |---|---|---|:---:|---|
79
+ | `projectId` | Path | `String` | Yes | — |
80
+
81
+ ### Response
82
+
83
+ - Response schema selectors: `200`
84
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
85
+ - Type: `EmailPageResponse`
86
+
87
+
88
+ ## get_project_email
89
+
90
+ `GET /v1/projects/{projectId}/emails/{emailId}`
91
+
92
+ ### Parameters
93
+
94
+ | Name | Location | Type | Required | Description |
95
+ |---|---|---|:---:|---|
96
+ | `projectId` | Path | `String` | Yes | — |
97
+ | `emailId` | Path | `String` | Yes | — |
98
+
99
+ ### Response
100
+
101
+ - Response schema selectors: `200`
102
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
103
+ - Type: `EmailDetailResponse`
104
+
105
+
106
+ ## get_email_timeline
107
+
108
+ `GET /v1/projects/{projectId}/emails/{emailId}/events`
109
+
110
+ ### Parameters
111
+
112
+ | Name | Location | Type | Required | Description |
113
+ |---|---|---|:---:|---|
114
+ | `projectId` | Path | `String` | Yes | — |
115
+ | `emailId` | Path | `String` | Yes | — |
116
+
117
+ ### Response
118
+
119
+ - Response schema selectors: `200`
120
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
121
+ - Type: `EmailTimelineResponse`
122
+
123
+
124
+ ---
125
+
126
+ Generated from the Apollo Signal API manifest by Tesseract.
127
+
data/docs/domains/segments.md ADDED
@@ -0,0 +1,116 @@
1
+ # SegmentsAPI
2
+
3
+ segments API operations.
4
+
5
+ [Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/segments.rb)
6
+
7
+ Client accessor: `client.segments`
8
+
9
+ ## Operations
10
+
11
+ | Method | HTTP | Path | Returns | Description |
12
+ |---|---|---|---|---|
13
+ | [`list_segments`](#list-segments) | `GET` | `/v1/projects/{projectId}/segments` | `SegmentPageResponse` | — |
14
+ | [`get_segment`](#get-segment) | `GET` | `/v1/projects/{projectId}/segments/{segmentId}` | `SegmentResponse` | — |
15
+ | [`list_contacts_in_segment`](#list-contacts-in-segment) | `GET` | `/v1/projects/{projectId}/segments/{segmentId}/contacts` | `CursorPage` | — |
16
+ | [`create_segment`](#create-segment) | `POST` | `/v1/projects/{projectId}/segments` | `SegmentResponse` | — |
17
+ | [`delete_segment`](#delete-segment) | `DELETE` | `/v1/projects/{projectId}/segments/{segmentId}` | `nil` | — |
18
+
19
+ ## list_segments
20
+
21
+ `GET /v1/projects/{projectId}/segments`
22
+
23
+ ### Parameters
24
+
25
+ | Name | Location | Type | Required | Description |
26
+ |---|---|---|:---:|---|
27
+ | `projectId` | Path | `String` | Yes | — |
28
+
29
+ ### Response
30
+
31
+ - Response schema selectors: `200`
32
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
33
+ - Type: `SegmentPageResponse`
34
+
35
+
36
+ ## get_segment
37
+
38
+ `GET /v1/projects/{projectId}/segments/{segmentId}`
39
+
40
+ ### Parameters
41
+
42
+ | Name | Location | Type | Required | Description |
43
+ |---|---|---|:---:|---|
44
+ | `projectId` | Path | `String` | Yes | — |
45
+ | `segmentId` | Path | `String` | Yes | — |
46
+
47
+ ### Response
48
+
49
+ - Response schema selectors: `200`
50
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
51
+ - Type: `SegmentResponse`
52
+
53
+
54
+ ## list_contacts_in_segment
55
+
56
+ `GET /v1/projects/{projectId}/segments/{segmentId}/contacts`
57
+
58
+ ### Parameters
59
+
60
+ | Name | Location | Type | Required | Description |
61
+ |---|---|---|:---:|---|
62
+ | `projectId` | Path | `String` | Yes | — |
63
+ | `segmentId` | Path | `String` | Yes | — |
64
+
65
+ ### Response
66
+
67
+ - Response schema selectors: `200`
68
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
69
+ - Type: `CursorPage`
70
+
71
+
72
+ ## create_segment
73
+
74
+ `POST /v1/projects/{projectId}/segments`
75
+
76
+ ### Parameters
77
+
78
+ | Name | Location | Type | Required | Description |
79
+ |---|---|---|:---:|---|
80
+ | `projectId` | Path | `String` | Yes | — |
81
+
82
+ ### Request body
83
+
84
+ - Type: `CreateSegmentBody`
85
+ - Required: Yes
86
+ - Content type: `application/json`
87
+
88
+ ### Response
89
+
90
+ - Response schema selectors: `201`
91
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
92
+ - Type: `SegmentResponse`
93
+
94
+
95
+ ## delete_segment
96
+
97
+ `DELETE /v1/projects/{projectId}/segments/{segmentId}`
98
+
99
+ ### Parameters
100
+
101
+ | Name | Location | Type | Required | Description |
102
+ |---|---|---|:---:|---|
103
+ | `projectId` | Path | `String` | Yes | — |
104
+ | `segmentId` | Path | `String` | Yes | — |
105
+
106
+ ### Response
107
+
108
+ - Response schema selectors: `2XX`
109
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
110
+ - Type: `nil`
111
+
112
+
113
+ ---
114
+
115
+ Generated from the Apollo Signal API manifest by Tesseract.
116
+
data/docs/domains/sending-domains.md ADDED
@@ -0,0 +1,160 @@
1
+ # SendingDomainsAPI
2
+
3
+ sendingDomains API operations.
4
+
5
+ [Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/sending-domains.rb)
6
+
7
+ Client accessor: `client.sending_domains`
8
+
9
+ ## Operations
10
+
11
+ | Method | HTTP | Path | Returns | Description |
12
+ |---|---|---|---|---|
13
+ | [`list_domains`](#list-domains) | `GET` | `/v1/projects/{projectId}/domains` | `DomainListPageResponse` | — |
14
+ | [`get_domain`](#get-domain) | `GET` | `/v1/projects/{projectId}/domains/{domainId}` | `DomainResponse` | — |
15
+ | [`register_domain`](#register-domain) | `POST` | `/v1/projects/{projectId}/domains` | `DomainResponse` | — |
16
+ | [`verify_domain`](#verify-domain) | `POST` | `/v1/projects/{projectId}/domains/{domainId}/verify` | `DomainResponse` | — |
17
+ | [`delete_domain`](#delete-domain) | `DELETE` | `/v1/projects/{projectId}/domains/{domainId}` | `nil` | — |
18
+ | [`verify_bimi`](#verify-bimi) | `POST` | `/v1/projects/{projectId}/domains/{domainId}/bimi/verify` | `DomainResponse` | — |
19
+ | [`update_bimi`](#update-bimi) | `PATCH` | `/v1/projects/{projectId}/domains/{domainId}/bimi` | `DomainResponse` | — |
20
+
21
+ ## list_domains
22
+
23
+ `GET /v1/projects/{projectId}/domains`
24
+
25
+ ### Parameters
26
+
27
+ | Name | Location | Type | Required | Description |
28
+ |---|---|---|:---:|---|
29
+ | `projectId` | Path | `String` | Yes | — |
30
+
31
+ ### Response
32
+
33
+ - Response schema selectors: `200`
34
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
35
+ - Type: `DomainListPageResponse`
36
+
37
+
38
+ ## get_domain
39
+
40
+ `GET /v1/projects/{projectId}/domains/{domainId}`
41
+
42
+ ### Parameters
43
+
44
+ | Name | Location | Type | Required | Description |
45
+ |---|---|---|:---:|---|
46
+ | `projectId` | Path | `String` | Yes | — |
47
+ | `domainId` | Path | `String` | Yes | — |
48
+
49
+ ### Response
50
+
51
+ - Response schema selectors: `200`
52
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
53
+ - Type: `DomainResponse`
54
+
55
+
56
+ ## register_domain
57
+
58
+ `POST /v1/projects/{projectId}/domains`
59
+
60
+ ### Parameters
61
+
62
+ | Name | Location | Type | Required | Description |
63
+ |---|---|---|:---:|---|
64
+ | `projectId` | Path | `String` | Yes | — |
65
+
66
+ ### Request body
67
+
68
+ - Type: `RegisterDomainRequest`
69
+ - Required: Yes
70
+ - Content type: `application/json`
71
+
72
+ ### Response
73
+
74
+ - Response schema selectors: `201`
75
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
76
+ - Type: `DomainResponse`
77
+
78
+
79
+ ## verify_domain
80
+
81
+ `POST /v1/projects/{projectId}/domains/{domainId}/verify`
82
+
83
+ ### Parameters
84
+
85
+ | Name | Location | Type | Required | Description |
86
+ |---|---|---|:---:|---|
87
+ | `projectId` | Path | `String` | Yes | — |
88
+ | `domainId` | Path | `String` | Yes | — |
89
+
90
+ ### Response
91
+
92
+ - Response schema selectors: `200`
93
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
94
+ - Type: `DomainResponse`
95
+
96
+
97
+ ## delete_domain
98
+
99
+ `DELETE /v1/projects/{projectId}/domains/{domainId}`
100
+
101
+ ### Parameters
102
+
103
+ | Name | Location | Type | Required | Description |
104
+ |---|---|---|:---:|---|
105
+ | `projectId` | Path | `String` | Yes | — |
106
+ | `domainId` | Path | `String` | Yes | — |
107
+
108
+ ### Response
109
+
110
+ - Response schema selectors: `2XX`
111
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
112
+ - Type: `nil`
113
+
114
+
115
+ ## verify_bimi
116
+
117
+ `POST /v1/projects/{projectId}/domains/{domainId}/bimi/verify`
118
+
119
+ ### Parameters
120
+
121
+ | Name | Location | Type | Required | Description |
122
+ |---|---|---|:---:|---|
123
+ | `projectId` | Path | `String` | Yes | — |
124
+ | `domainId` | Path | `String` | Yes | — |
125
+
126
+ ### Response
127
+
128
+ - Response schema selectors: `200`
129
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
130
+ - Type: `DomainResponse`
131
+
132
+
133
+ ## update_bimi
134
+
135
+ `PATCH /v1/projects/{projectId}/domains/{domainId}/bimi`
136
+
137
+ ### Parameters
138
+
139
+ | Name | Location | Type | Required | Description |
140
+ |---|---|---|:---:|---|
141
+ | `projectId` | Path | `String` | Yes | — |
142
+ | `domainId` | Path | `String` | Yes | — |
143
+
144
+ ### Request body
145
+
146
+ - Type: `UpdateBimiRequest`
147
+ - Required: Yes
148
+ - Content type: `application/json`
149
+
150
+ ### Response
151
+
152
+ - Response schema selectors: `200`
153
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
154
+ - Type: `DomainResponse`
155
+
156
+
157
+ ---
158
+
159
+ Generated from the Apollo Signal API manifest by Tesseract.
160
+
data/docs/domains/suppressions.md ADDED
@@ -0,0 +1,120 @@
1
+ # SuppressionsAPI
2
+
3
+ suppressions API operations.
4
+
5
+ [Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/suppressions.rb)
6
+
7
+ Client accessor: `client.suppressions`
8
+
9
+ ## Operations
10
+
11
+ | Method | HTTP | Path | Returns | Description |
12
+ |---|---|---|---|---|
13
+ | [`list_suppressions`](#list-suppressions) | `GET` | `/v1/projects/{projectId}/suppressions` | `SuppressionPageResponse` | — |
14
+ | [`export_suppressions`](#export-suppressions) | `GET` | `/v1/projects/{projectId}/suppressions/export` | `nil` | — |
15
+ | [`add_suppression`](#add-suppression) | `POST` | `/v1/projects/{projectId}/suppressions` | `SuppressionResponse` | — |
16
+ | [`remove_suppression`](#remove-suppression) | `DELETE` | `/v1/projects/{projectId}/suppressions/{email}` | `nil` | — |
17
+ | [`import_suppressions`](#import-suppressions) | `POST` | `/v1/projects/{projectId}/suppressions/import` | `SuppressionImportResponse` | — |
18
+
19
+ ## list_suppressions
20
+
21
+ `GET /v1/projects/{projectId}/suppressions`
22
+
23
+ ### Parameters
24
+
25
+ | Name | Location | Type | Required | Description |
26
+ |---|---|---|:---:|---|
27
+ | `projectId` | Path | `String` | Yes | — |
28
+
29
+ ### Response
30
+
31
+ - Response schema selectors: `200`
32
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
33
+ - Type: `SuppressionPageResponse`
34
+
35
+
36
+ ## export_suppressions
37
+
38
+ `GET /v1/projects/{projectId}/suppressions/export`
39
+
40
+ ### Parameters
41
+
42
+ | Name | Location | Type | Required | Description |
43
+ |---|---|---|:---:|---|
44
+ | `projectId` | Path | `String` | Yes | — |
45
+
46
+ ### Response
47
+
48
+ - Response schema selectors: `2XX`
49
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
50
+ - Type: `nil`
51
+
52
+
53
+ ## add_suppression
54
+
55
+ `POST /v1/projects/{projectId}/suppressions`
56
+
57
+ ### Parameters
58
+
59
+ | Name | Location | Type | Required | Description |
60
+ |---|---|---|:---:|---|
61
+ | `projectId` | Path | `String` | Yes | — |
62
+
63
+ ### Request body
64
+
65
+ - Type: `AddSuppressionBody`
66
+ - Required: Yes
67
+ - Content type: `application/json`
68
+
69
+ ### Response
70
+
71
+ - Response schema selectors: `201`
72
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
73
+ - Type: `SuppressionResponse`
74
+
75
+
76
+ ## remove_suppression
77
+
78
+ `DELETE /v1/projects/{projectId}/suppressions/{email}`
79
+
80
+ ### Parameters
81
+
82
+ | Name | Location | Type | Required | Description |
83
+ |---|---|---|:---:|---|
84
+ | `projectId` | Path | `String` | Yes | — |
85
+ | `email` | Path | `String` | Yes | — |
86
+
87
+ ### Response
88
+
89
+ - Response schema selectors: `2XX`
90
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
91
+ - Type: `nil`
92
+
93
+
94
+ ## import_suppressions
95
+
96
+ `POST /v1/projects/{projectId}/suppressions/import`
97
+
98
+ ### Parameters
99
+
100
+ | Name | Location | Type | Required | Description |
101
+ |---|---|---|:---:|---|
102
+ | `projectId` | Path | `String` | Yes | — |
103
+
104
+ ### Request body
105
+
106
+ - Type: `SuppressionImportBody`
107
+ - Required: Yes
108
+ - Content type: `application/json`
109
+
110
+ ### Response
111
+
112
+ - Response schema selectors: `200`
113
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
114
+ - Type: `SuppressionImportResponse`
115
+
116
+
117
+ ---
118
+
119
+ Generated from the Apollo Signal API manifest by Tesseract.
120
+
data/docs/domains/topics.md ADDED
@@ -0,0 +1,141 @@
1
+ # TopicsAPI
2
+
3
+ topics API operations.
4
+
5
+ [Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/topics.rb)
6
+
7
+ Client accessor: `client.topics`
8
+
9
+ ## Operations
10
+
11
+ | Method | HTTP | Path | Returns | Description |
12
+ |---|---|---|---|---|
13
+ | [`list_topics`](#list-topics) | `GET` | `/v1/projects/{projectId}/topics` | `TopicPageResponse` | — |
14
+ | [`get_topic`](#get-topic) | `GET` | `/v1/projects/{projectId}/topics/{topicId}` | `TopicResponse` | — |
15
+ | [`list_contacts_in_topic`](#list-contacts-in-topic) | `GET` | `/v1/projects/{projectId}/topics/{topicId}/contacts` | `CursorPage` | — |
16
+ | [`create_topic`](#create-topic) | `POST` | `/v1/projects/{projectId}/topics` | `TopicResponse` | — |
17
+ | [`update_topic`](#update-topic) | `PATCH` | `/v1/projects/{projectId}/topics/{topicId}` | `TopicResponse` | — |
18
+ | [`delete_topic`](#delete-topic) | `DELETE` | `/v1/projects/{projectId}/topics/{topicId}` | `nil` | — |
19
+
20
+ ## list_topics
21
+
22
+ `GET /v1/projects/{projectId}/topics`
23
+
24
+ ### Parameters
25
+
26
+ | Name | Location | Type | Required | Description |
27
+ |---|---|---|:---:|---|
28
+ | `projectId` | Path | `String` | Yes | — |
29
+
30
+ ### Response
31
+
32
+ - Response schema selectors: `200`
33
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
34
+ - Type: `TopicPageResponse`
35
+
36
+
37
+ ## get_topic
38
+
39
+ `GET /v1/projects/{projectId}/topics/{topicId}`
40
+
41
+ ### Parameters
42
+
43
+ | Name | Location | Type | Required | Description |
44
+ |---|---|---|:---:|---|
45
+ | `projectId` | Path | `String` | Yes | — |
46
+ | `topicId` | Path | `String` | Yes | — |
47
+
48
+ ### Response
49
+
50
+ - Response schema selectors: `200`
51
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
52
+ - Type: `TopicResponse`
53
+
54
+
55
+ ## list_contacts_in_topic
56
+
57
+ `GET /v1/projects/{projectId}/topics/{topicId}/contacts`
58
+
59
+ ### Parameters
60
+
61
+ | Name | Location | Type | Required | Description |
62
+ |---|---|---|:---:|---|
63
+ | `projectId` | Path | `String` | Yes | — |
64
+ | `topicId` | Path | `String` | Yes | — |
65
+
66
+ ### Response
67
+
68
+ - Response schema selectors: `200`
69
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
70
+ - Type: `CursorPage`
71
+
72
+
73
+ ## create_topic
74
+
75
+ `POST /v1/projects/{projectId}/topics`
76
+
77
+ ### Parameters
78
+
79
+ | Name | Location | Type | Required | Description |
80
+ |---|---|---|:---:|---|
81
+ | `projectId` | Path | `String` | Yes | — |
82
+
83
+ ### Request body
84
+
85
+ - Type: `CreateTopicBody`
86
+ - Required: Yes
87
+ - Content type: `application/json`
88
+
89
+ ### Response
90
+
91
+ - Response schema selectors: `201`
92
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
93
+ - Type: `TopicResponse`
94
+
95
+
96
+ ## update_topic
97
+
98
+ `PATCH /v1/projects/{projectId}/topics/{topicId}`
99
+
100
+ ### Parameters
101
+
102
+ | Name | Location | Type | Required | Description |
103
+ |---|---|---|:---:|---|
104
+ | `projectId` | Path | `String` | Yes | — |
105
+ | `topicId` | Path | `String` | Yes | — |
106
+
107
+ ### Request body
108
+
109
+ - Type: `UpdateTopicBody`
110
+ - Required: Yes
111
+ - Content type: `application/json`
112
+
113
+ ### Response
114
+
115
+ - Response schema selectors: `200`
116
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
117
+ - Type: `TopicResponse`
118
+
119
+
120
+ ## delete_topic
121
+
122
+ `DELETE /v1/projects/{projectId}/topics/{topicId}`
123
+
124
+ ### Parameters
125
+
126
+ | Name | Location | Type | Required | Description |
127
+ |---|---|---|:---:|---|
128
+ | `projectId` | Path | `String` | Yes | — |
129
+ | `topicId` | Path | `String` | Yes | — |
130
+
131
+ ### Response
132
+
133
+ - Response schema selectors: `2XX`
134
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
135
+ - Type: `nil`
136
+
137
+
138
+ ---
139
+
140
+ Generated from the Apollo Signal API manifest by Tesseract.
141
+