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/webhooks.md ADDED
@@ -0,0 +1,200 @@
1
+ # WebhooksAPI
2
+
3
+ webhooks API operations.
4
+
5
+ [Documentation index](../README.md) · [SDK overview](../../README.md) · [Generated source](../../lib/apollo_deploy_signal_sdk/resources/webhooks.rb)
6
+
7
+ Client accessor: `client.webhooks`
8
+
9
+ ## Operations
10
+
11
+ | Method | HTTP | Path | Returns | Description |
12
+ |---|---|---|---|---|
13
+ | [`list_webhooks`](#list-webhooks) | `GET` | `/v1/projects/{projectId}/webhooks` | `WebhookPageResponse` | — |
14
+ | [`get_webhook`](#get-webhook) | `GET` | `/v1/projects/{projectId}/webhooks/{endpointId}` | `WebhookResponse` | — |
15
+ | [`list_webhook_deliveries`](#list-webhook-deliveries) | `GET` | `/v1/projects/{projectId}/webhooks/{endpointId}/deliveries` | `WebhookDeliveryPageResponse` | — |
16
+ | [`get_webhook_delivery`](#get-webhook-delivery) | `GET` | `/v1/projects/{projectId}/webhooks/{endpointId}/deliveries/{deliveryId}` | `WebhookDeliveryResponse` | — |
17
+ | [`create_webhook`](#create-webhook) | `POST` | `/v1/projects/{projectId}/webhooks` | `WebhookCreateResponse` | — |
18
+ | [`update_webhook`](#update-webhook) | `PATCH` | `/v1/projects/{projectId}/webhooks/{endpointId}` | `WebhookResponse` | — |
19
+ | [`delete_webhook`](#delete-webhook) | `DELETE` | `/v1/projects/{projectId}/webhooks/{endpointId}` | `nil` | — |
20
+ | [`test_webhook`](#test-webhook) | `POST` | `/v1/projects/{projectId}/webhooks/{endpointId}/test` | `WebhookDeliveryResponse` | — |
21
+ | [`replay_webhook_delivery`](#replay-webhook-delivery) | `POST` | `/v1/projects/{projectId}/webhooks/{endpointId}/replay/{deliveryId}` | `nil` | — |
22
+
23
+ ## list_webhooks
24
+
25
+ `GET /v1/projects/{projectId}/webhooks`
26
+
27
+ ### Parameters
28
+
29
+ | Name | Location | Type | Required | Description |
30
+ |---|---|---|:---:|---|
31
+ | `projectId` | Path | `String` | Yes | — |
32
+
33
+ ### Response
34
+
35
+ - Response schema selectors: `200`
36
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
37
+ - Type: `WebhookPageResponse`
38
+
39
+
40
+ ## get_webhook
41
+
42
+ `GET /v1/projects/{projectId}/webhooks/{endpointId}`
43
+
44
+ ### Parameters
45
+
46
+ | Name | Location | Type | Required | Description |
47
+ |---|---|---|:---:|---|
48
+ | `projectId` | Path | `String` | Yes | — |
49
+ | `endpointId` | Path | `String` | Yes | — |
50
+
51
+ ### Response
52
+
53
+ - Response schema selectors: `200`
54
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
55
+ - Type: `WebhookResponse`
56
+
57
+
58
+ ## list_webhook_deliveries
59
+
60
+ `GET /v1/projects/{projectId}/webhooks/{endpointId}/deliveries`
61
+
62
+ ### Parameters
63
+
64
+ | Name | Location | Type | Required | Description |
65
+ |---|---|---|:---:|---|
66
+ | `projectId` | Path | `String` | Yes | — |
67
+ | `endpointId` | Path | `String` | Yes | — |
68
+
69
+ ### Response
70
+
71
+ - Response schema selectors: `200`
72
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
73
+ - Type: `WebhookDeliveryPageResponse`
74
+
75
+
76
+ ## get_webhook_delivery
77
+
78
+ `GET /v1/projects/{projectId}/webhooks/{endpointId}/deliveries/{deliveryId}`
79
+
80
+ ### Parameters
81
+
82
+ | Name | Location | Type | Required | Description |
83
+ |---|---|---|:---:|---|
84
+ | `projectId` | Path | `String` | Yes | — |
85
+ | `endpointId` | Path | `String` | Yes | — |
86
+ | `deliveryId` | Path | `String` | Yes | — |
87
+
88
+ ### Response
89
+
90
+ - Response schema selectors: `200`
91
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
92
+ - Type: `WebhookDeliveryResponse`
93
+
94
+
95
+ ## create_webhook
96
+
97
+ `POST /v1/projects/{projectId}/webhooks`
98
+
99
+ ### Parameters
100
+
101
+ | Name | Location | Type | Required | Description |
102
+ |---|---|---|:---:|---|
103
+ | `projectId` | Path | `String` | Yes | — |
104
+
105
+ ### Request body
106
+
107
+ - Type: `CreateWebhookBody`
108
+ - Required: Yes
109
+ - Content type: `application/json`
110
+
111
+ ### Response
112
+
113
+ - Response schema selectors: `201`
114
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
115
+ - Type: `WebhookCreateResponse`
116
+
117
+
118
+ ## update_webhook
119
+
120
+ `PATCH /v1/projects/{projectId}/webhooks/{endpointId}`
121
+
122
+ ### Parameters
123
+
124
+ | Name | Location | Type | Required | Description |
125
+ |---|---|---|:---:|---|
126
+ | `projectId` | Path | `String` | Yes | — |
127
+ | `endpointId` | Path | `String` | Yes | — |
128
+
129
+ ### Request body
130
+
131
+ - Type: `UpdateWebhookBody`
132
+ - Required: Yes
133
+ - Content type: `application/json`
134
+
135
+ ### Response
136
+
137
+ - Response schema selectors: `200`
138
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
139
+ - Type: `WebhookResponse`
140
+
141
+
142
+ ## delete_webhook
143
+
144
+ `DELETE /v1/projects/{projectId}/webhooks/{endpointId}`
145
+
146
+ ### Parameters
147
+
148
+ | Name | Location | Type | Required | Description |
149
+ |---|---|---|:---:|---|
150
+ | `projectId` | Path | `String` | Yes | — |
151
+ | `endpointId` | Path | `String` | Yes | — |
152
+
153
+ ### Response
154
+
155
+ - Response schema selectors: `2XX`
156
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
157
+ - Type: `nil`
158
+
159
+
160
+ ## test_webhook
161
+
162
+ `POST /v1/projects/{projectId}/webhooks/{endpointId}/test`
163
+
164
+ ### Parameters
165
+
166
+ | Name | Location | Type | Required | Description |
167
+ |---|---|---|:---:|---|
168
+ | `projectId` | Path | `String` | Yes | — |
169
+ | `endpointId` | Path | `String` | Yes | — |
170
+
171
+ ### Response
172
+
173
+ - Response schema selectors: `202`
174
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
175
+ - Type: `WebhookDeliveryResponse`
176
+
177
+
178
+ ## replay_webhook_delivery
179
+
180
+ `POST /v1/projects/{projectId}/webhooks/{endpointId}/replay/{deliveryId}`
181
+
182
+ ### Parameters
183
+
184
+ | Name | Location | Type | Required | Description |
185
+ |---|---|---|:---:|---|
186
+ | `projectId` | Path | `String` | Yes | — |
187
+ | `endpointId` | Path | `String` | Yes | — |
188
+ | `deliveryId` | Path | `String` | Yes | — |
189
+
190
+ ### Response
191
+
192
+ - Response schema selectors: `2XX`
193
+ - HTTP success handling: every 2xx response is accepted; selectors identify the schema contract used for decoding.
194
+ - Type: `nil`
195
+
196
+
197
+ ---
198
+
199
+ Generated from the Apollo Signal API manifest by Tesseract.
200
+