svix 0.44.0 → 0.50.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +62 -8
- data/lib/svix/api/application_api.rb +15 -0
- data/lib/svix/api/authentication_api.rb +6 -0
- data/lib/svix/api/endpoint_api.rb +39 -0
- data/lib/svix/api/environment_api.rb +6 -0
- data/lib/svix/api/environment_settings_api.rb +3 -0
- data/lib/svix/api/event_type_api.rb +18 -0
- data/lib/svix/api/health_api.rb +5 -0
- data/lib/svix/api/integration_api.rb +21 -0
- data/lib/svix/api/message_api.rb +26 -2
- data/lib/svix/api/message_attempt_api.rb +363 -4
- data/lib/svix/api/organization_api.rb +29 -29
- data/lib/svix/api/organization_settings_api.rb +6 -6
- data/lib/svix/api/statistics_api.rb +6 -0
- data/lib/svix/message_attempt_api.rb +11 -1
- data/lib/svix/models/export_organization_out.rb +3 -3
- data/lib/svix/models/import_organization_in.rb +3 -3
- data/lib/svix/models/list_response_endpoint_message_out.rb +13 -4
- data/lib/svix/models/list_response_message_attempt_endpoint_out.rb +13 -4
- data/lib/svix/models/list_response_message_attempt_out.rb +13 -4
- data/lib/svix/models/list_response_message_out.rb +13 -4
- data/lib/svix/models/message_attempt_endpoint_out.rb +15 -1
- data/lib/svix/models/message_attempt_exhausted_event_data.rb +1 -1
- data/lib/svix/models/message_attempt_failed_data.rb +251 -0
- data/lib/svix/models/message_attempt_failing_event.rb +269 -0
- data/lib/svix/models/message_attempt_failing_event_data.rb +310 -0
- data/lib/svix/models/status_code_class.rb +41 -0
- data/lib/svix/models/webhook_types.rb +15 -1
- data/lib/svix/version.rb +1 -1
- data/lib/svix.rb +1 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f1fcb4204e40625fedfada1b7fe1403a8bf7523627d728ee5d619396b8a08a8e
|
4
|
+
data.tar.gz: 9f88f4f4d53250af40a5f626c16af03c00d2e5a56df3f7d715da0e471dda1612
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 880788a0c2c0c9485eb3198c3812d07064ebeb1367f99549422eb75a534d113d40ab7b147f78b21f1e11d975c461ade7c786f25d830114d4776e7c38aee1403a
|
7
|
+
data.tar.gz: d288fc316da27807c1cef13fb363605c186f2a886c6b50485082e1d0f216ee0ed89b5da478d0fcccbfc8dfd580b061e581f9c42a494abecaa37480ca7998cbae
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,6 +1,46 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
1
|
+
<h1 align="center">
|
2
|
+
<a style="text-decoration: none" href="https://www.svix.com">
|
3
|
+
<img width="120" src="https://avatars.githubusercontent.com/u/80175132?s=200&v=4" />
|
4
|
+
<p align="center">Svix - Webhooks as a service</p>
|
5
|
+
</a>
|
6
|
+
</h1>
|
7
|
+
<h2 align="center">
|
8
|
+
<a href="https://svix.com">Website</a> | <a href="https://docs.svix.com">Documentation</a> | <a href="https://svix.com/slack">Community Slack</a>
|
9
|
+
<h2>
|
10
|
+
|
11
|
+
Ruby library for interacting with the Svix API and verifying webhook signatures
|
12
|
+
|
13
|
+
![GitHub tag](https://img.shields.io/github/tag/svix/svix-webhooks.svg)
|
14
|
+
[![Gem](https://img.shields.io/gem/v/svix)](https://rubygems.org/gems/svix)
|
15
|
+
|
16
|
+
|
17
|
+
[![Join our slack](https://img.shields.io/badge/Slack-join%20the%20community-blue?logo=slack&style=social)](https://www.svix.com/slack/)
|
18
|
+
|
19
|
+
# Usage Documentation
|
20
|
+
|
21
|
+
You can find general usage documentation at <https://docs.svix.com>. For complete API documentation with code examples for each endpoint in all of our official client libraries head over to our API documentation site at <https://api.svix.com>.
|
22
|
+
|
23
|
+
# Language Support
|
24
|
+
|
25
|
+
<table style="table-layout:fixed; white-space: nowrap;">
|
26
|
+
<th colspan="2">⚡️ Features ⚡️</th>
|
27
|
+
<tr>
|
28
|
+
<th>Officially Supported</th>
|
29
|
+
<th>✅</th>
|
30
|
+
</tr>
|
31
|
+
<tr>
|
32
|
+
<th>API Support</th>
|
33
|
+
<th>✅</th>
|
34
|
+
</tr>
|
35
|
+
<tr>
|
36
|
+
<th>Signature Verification</th>
|
37
|
+
<th>✅</th>
|
38
|
+
</tr>
|
39
|
+
<tr>
|
40
|
+
<th>Caveats</th>
|
41
|
+
<th>🚀 None!</th>
|
42
|
+
</tr>
|
43
|
+
</table>
|
4
44
|
|
5
45
|
## Installation
|
6
46
|
|
@@ -22,19 +62,33 @@ Or install it yourself as:
|
|
22
62
|
gem install svix
|
23
63
|
```
|
24
64
|
|
25
|
-
|
65
|
+
# Development
|
66
|
+
|
67
|
+
First checkout the [core README](../README.md#development) for details on how to generate our API bindings, then follow the steps below.
|
26
68
|
|
27
|
-
|
69
|
+
## Building
|
28
70
|
|
29
|
-
|
71
|
+
```sh
|
72
|
+
bundler exec rake build
|
73
|
+
```
|
30
74
|
|
75
|
+
## Contributing
|
31
76
|
|
32
|
-
|
77
|
+
Before opening a PR be sure to format your code!
|
33
78
|
|
79
|
+
```sh
|
34
80
|
bundle exec rspec spec
|
81
|
+
```
|
35
82
|
|
83
|
+
## Running Tests
|
84
|
+
|
85
|
+
Simply run:
|
86
|
+
|
87
|
+
```sh
|
88
|
+
bundle exec rspec spec
|
89
|
+
```
|
36
90
|
|
37
|
-
|
91
|
+
## Publishing
|
38
92
|
|
39
93
|
```sh
|
40
94
|
gem build svix.gemspec
|
@@ -24,6 +24,7 @@ module Svix
|
|
24
24
|
# @param application_in [ApplicationIn]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [Boolean] :get_if_exists (default to false)
|
27
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
27
28
|
# @return [ApplicationOut]
|
28
29
|
def create_application_api_v1_app_post(application_in, opts = {})
|
29
30
|
data, _status_code, _headers = create_application_api_v1_app_post_with_http_info(application_in, opts)
|
@@ -35,6 +36,7 @@ module Svix
|
|
35
36
|
# @param application_in [ApplicationIn]
|
36
37
|
# @param [Hash] opts the optional parameters
|
37
38
|
# @option opts [Boolean] :get_if_exists
|
39
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
38
40
|
# @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
|
39
41
|
def create_application_api_v1_app_post_with_http_info(application_in, opts = {})
|
40
42
|
if @api_client.config.debugging
|
@@ -57,6 +59,7 @@ module Svix
|
|
57
59
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
58
60
|
# HTTP header 'Content-Type'
|
59
61
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
62
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
60
63
|
|
61
64
|
# form parameters
|
62
65
|
form_params = opts[:form_params] || {}
|
@@ -91,6 +94,7 @@ module Svix
|
|
91
94
|
# Delete an application.
|
92
95
|
# @param app_id [String]
|
93
96
|
# @param [Hash] opts the optional parameters
|
97
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
94
98
|
# @return [nil]
|
95
99
|
def delete_application_api_v1_app_app_id_delete(app_id, opts = {})
|
96
100
|
delete_application_api_v1_app_app_id_delete_with_http_info(app_id, opts)
|
@@ -101,6 +105,7 @@ module Svix
|
|
101
105
|
# Delete an application.
|
102
106
|
# @param app_id [String]
|
103
107
|
# @param [Hash] opts the optional parameters
|
108
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
104
109
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
105
110
|
def delete_application_api_v1_app_app_id_delete_with_http_info(app_id, opts = {})
|
106
111
|
if @api_client.config.debugging
|
@@ -133,6 +138,7 @@ module Svix
|
|
133
138
|
header_params = opts[:header_params] || {}
|
134
139
|
# HTTP header 'Accept' (if needed)
|
135
140
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
141
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
136
142
|
|
137
143
|
# form parameters
|
138
144
|
form_params = opts[:form_params] || {}
|
@@ -167,6 +173,7 @@ module Svix
|
|
167
173
|
# Get an application.
|
168
174
|
# @param app_id [String]
|
169
175
|
# @param [Hash] opts the optional parameters
|
176
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
170
177
|
# @return [ApplicationOut]
|
171
178
|
def get_application_api_v1_app_app_id_get(app_id, opts = {})
|
172
179
|
data, _status_code, _headers = get_application_api_v1_app_app_id_get_with_http_info(app_id, opts)
|
@@ -177,6 +184,7 @@ module Svix
|
|
177
184
|
# Get an application.
|
178
185
|
# @param app_id [String]
|
179
186
|
# @param [Hash] opts the optional parameters
|
187
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
180
188
|
# @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
|
181
189
|
def get_application_api_v1_app_app_id_get_with_http_info(app_id, opts = {})
|
182
190
|
if @api_client.config.debugging
|
@@ -209,6 +217,7 @@ module Svix
|
|
209
217
|
header_params = opts[:header_params] || {}
|
210
218
|
# HTTP header 'Accept' (if needed)
|
211
219
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
220
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
212
221
|
|
213
222
|
# form parameters
|
214
223
|
form_params = opts[:form_params] || {}
|
@@ -244,6 +253,7 @@ module Svix
|
|
244
253
|
# @param [Hash] opts the optional parameters
|
245
254
|
# @option opts [String] :iterator
|
246
255
|
# @option opts [Integer] :limit (default to 50)
|
256
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
247
257
|
# @return [ListResponseApplicationOut]
|
248
258
|
def list_applications_api_v1_app_get(opts = {})
|
249
259
|
data, _status_code, _headers = list_applications_api_v1_app_get_with_http_info(opts)
|
@@ -255,6 +265,7 @@ module Svix
|
|
255
265
|
# @param [Hash] opts the optional parameters
|
256
266
|
# @option opts [String] :iterator
|
257
267
|
# @option opts [Integer] :limit
|
268
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
258
269
|
# @return [Array<(ListResponseApplicationOut, Integer, Hash)>] ListResponseApplicationOut data, response status code and response headers
|
259
270
|
def list_applications_api_v1_app_get_with_http_info(opts = {})
|
260
271
|
if @api_client.config.debugging
|
@@ -276,6 +287,7 @@ module Svix
|
|
276
287
|
header_params = opts[:header_params] || {}
|
277
288
|
# HTTP header 'Accept' (if needed)
|
278
289
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
290
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
279
291
|
|
280
292
|
# form parameters
|
281
293
|
form_params = opts[:form_params] || {}
|
@@ -311,6 +323,7 @@ module Svix
|
|
311
323
|
# @param app_id [String]
|
312
324
|
# @param application_in [ApplicationIn]
|
313
325
|
# @param [Hash] opts the optional parameters
|
326
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
314
327
|
# @return [ApplicationOut]
|
315
328
|
def update_application_api_v1_app_app_id_put(app_id, application_in, opts = {})
|
316
329
|
data, _status_code, _headers = update_application_api_v1_app_app_id_put_with_http_info(app_id, application_in, opts)
|
@@ -322,6 +335,7 @@ module Svix
|
|
322
335
|
# @param app_id [String]
|
323
336
|
# @param application_in [ApplicationIn]
|
324
337
|
# @param [Hash] opts the optional parameters
|
338
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
325
339
|
# @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
|
326
340
|
def update_application_api_v1_app_app_id_put_with_http_info(app_id, application_in, opts = {})
|
327
341
|
if @api_client.config.debugging
|
@@ -360,6 +374,7 @@ module Svix
|
|
360
374
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
361
375
|
# HTTP header 'Content-Type'
|
362
376
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
377
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
363
378
|
|
364
379
|
# form parameters
|
365
380
|
form_params = opts[:form_params] || {}
|
@@ -23,6 +23,7 @@ module Svix
|
|
23
23
|
# Use this function to get magic links (and authentication codes) for connecting your users to the management UIs.
|
24
24
|
# @param app_id [String]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
26
27
|
# @return [DashboardAccessOut]
|
27
28
|
def get_dashboard_access_api_v1_auth_dashboard_access_app_id_post(app_id, opts = {})
|
28
29
|
data, _status_code, _headers = get_dashboard_access_api_v1_auth_dashboard_access_app_id_post_with_http_info(app_id, opts)
|
@@ -33,6 +34,7 @@ module Svix
|
|
33
34
|
# Use this function to get magic links (and authentication codes) for connecting your users to the management UIs.
|
34
35
|
# @param app_id [String]
|
35
36
|
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
36
38
|
# @return [Array<(DashboardAccessOut, Integer, Hash)>] DashboardAccessOut data, response status code and response headers
|
37
39
|
def get_dashboard_access_api_v1_auth_dashboard_access_app_id_post_with_http_info(app_id, opts = {})
|
38
40
|
if @api_client.config.debugging
|
@@ -65,6 +67,7 @@ module Svix
|
|
65
67
|
header_params = opts[:header_params] || {}
|
66
68
|
# HTTP header 'Accept' (if needed)
|
67
69
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
70
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
68
71
|
|
69
72
|
# form parameters
|
70
73
|
form_params = opts[:form_params] || {}
|
@@ -98,6 +101,7 @@ module Svix
|
|
98
101
|
# Logout
|
99
102
|
# Logout an app token. Trying to log out other tokens will fail.
|
100
103
|
# @param [Hash] opts the optional parameters
|
104
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
101
105
|
# @return [nil]
|
102
106
|
def logout_api_v1_auth_logout_post(opts = {})
|
103
107
|
logout_api_v1_auth_logout_post_with_http_info(opts)
|
@@ -107,6 +111,7 @@ module Svix
|
|
107
111
|
# Logout
|
108
112
|
# Logout an app token. Trying to log out other tokens will fail.
|
109
113
|
# @param [Hash] opts the optional parameters
|
114
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
110
115
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
111
116
|
def logout_api_v1_auth_logout_post_with_http_info(opts = {})
|
112
117
|
if @api_client.config.debugging
|
@@ -122,6 +127,7 @@ module Svix
|
|
122
127
|
header_params = opts[:header_params] || {}
|
123
128
|
# HTTP header 'Accept' (if needed)
|
124
129
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
130
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
125
131
|
|
126
132
|
# form parameters
|
127
133
|
form_params = opts[:form_params] || {}
|
@@ -24,6 +24,7 @@ module Svix
|
|
24
24
|
# @param app_id [String]
|
25
25
|
# @param endpoint_in [EndpointIn]
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
27
28
|
# @return [EndpointOut]
|
28
29
|
def create_endpoint_api_v1_app_app_id_endpoint_post(app_id, endpoint_in, opts = {})
|
29
30
|
data, _status_code, _headers = create_endpoint_api_v1_app_app_id_endpoint_post_with_http_info(app_id, endpoint_in, opts)
|
@@ -35,6 +36,7 @@ module Svix
|
|
35
36
|
# @param app_id [String]
|
36
37
|
# @param endpoint_in [EndpointIn]
|
37
38
|
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
38
40
|
# @return [Array<(EndpointOut, Integer, Hash)>] EndpointOut data, response status code and response headers
|
39
41
|
def create_endpoint_api_v1_app_app_id_endpoint_post_with_http_info(app_id, endpoint_in, opts = {})
|
40
42
|
if @api_client.config.debugging
|
@@ -73,6 +75,7 @@ module Svix
|
|
73
75
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
74
76
|
# HTTP header 'Content-Type'
|
75
77
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
78
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
76
79
|
|
77
80
|
# form parameters
|
78
81
|
form_params = opts[:form_params] || {}
|
@@ -108,6 +111,7 @@ module Svix
|
|
108
111
|
# @param endpoint_id [String]
|
109
112
|
# @param app_id [String]
|
110
113
|
# @param [Hash] opts the optional parameters
|
114
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
111
115
|
# @return [nil]
|
112
116
|
def delete_endpoint_api_v1_app_app_id_endpoint_endpoint_id_delete(endpoint_id, app_id, opts = {})
|
113
117
|
delete_endpoint_api_v1_app_app_id_endpoint_endpoint_id_delete_with_http_info(endpoint_id, app_id, opts)
|
@@ -119,6 +123,7 @@ module Svix
|
|
119
123
|
# @param endpoint_id [String]
|
120
124
|
# @param app_id [String]
|
121
125
|
# @param [Hash] opts the optional parameters
|
126
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
122
127
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
123
128
|
def delete_endpoint_api_v1_app_app_id_endpoint_endpoint_id_delete_with_http_info(endpoint_id, app_id, opts = {})
|
124
129
|
if @api_client.config.debugging
|
@@ -168,6 +173,7 @@ module Svix
|
|
168
173
|
header_params = opts[:header_params] || {}
|
169
174
|
# HTTP header 'Accept' (if needed)
|
170
175
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
176
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
171
177
|
|
172
178
|
# form parameters
|
173
179
|
form_params = opts[:form_params] || {}
|
@@ -203,6 +209,7 @@ module Svix
|
|
203
209
|
# @param endpoint_id [String]
|
204
210
|
# @param app_id [String]
|
205
211
|
# @param [Hash] opts the optional parameters
|
212
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
206
213
|
# @return [EndpointOut]
|
207
214
|
def get_endpoint_api_v1_app_app_id_endpoint_endpoint_id_get(endpoint_id, app_id, opts = {})
|
208
215
|
data, _status_code, _headers = get_endpoint_api_v1_app_app_id_endpoint_endpoint_id_get_with_http_info(endpoint_id, app_id, opts)
|
@@ -214,6 +221,7 @@ module Svix
|
|
214
221
|
# @param endpoint_id [String]
|
215
222
|
# @param app_id [String]
|
216
223
|
# @param [Hash] opts the optional parameters
|
224
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
217
225
|
# @return [Array<(EndpointOut, Integer, Hash)>] EndpointOut data, response status code and response headers
|
218
226
|
def get_endpoint_api_v1_app_app_id_endpoint_endpoint_id_get_with_http_info(endpoint_id, app_id, opts = {})
|
219
227
|
if @api_client.config.debugging
|
@@ -263,6 +271,7 @@ module Svix
|
|
263
271
|
header_params = opts[:header_params] || {}
|
264
272
|
# HTTP header 'Accept' (if needed)
|
265
273
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
274
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
266
275
|
|
267
276
|
# form parameters
|
268
277
|
form_params = opts[:form_params] || {}
|
@@ -298,6 +307,7 @@ module Svix
|
|
298
307
|
# @param endpoint_id [String]
|
299
308
|
# @param app_id [String]
|
300
309
|
# @param [Hash] opts the optional parameters
|
310
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
301
311
|
# @return [EndpointHeadersOut]
|
302
312
|
def get_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_get(endpoint_id, app_id, opts = {})
|
303
313
|
data, _status_code, _headers = get_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_get_with_http_info(endpoint_id, app_id, opts)
|
@@ -309,6 +319,7 @@ module Svix
|
|
309
319
|
# @param endpoint_id [String]
|
310
320
|
# @param app_id [String]
|
311
321
|
# @param [Hash] opts the optional parameters
|
322
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
312
323
|
# @return [Array<(EndpointHeadersOut, Integer, Hash)>] EndpointHeadersOut data, response status code and response headers
|
313
324
|
def get_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_get_with_http_info(endpoint_id, app_id, opts = {})
|
314
325
|
if @api_client.config.debugging
|
@@ -358,6 +369,7 @@ module Svix
|
|
358
369
|
header_params = opts[:header_params] || {}
|
359
370
|
# HTTP header 'Accept' (if needed)
|
360
371
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
372
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
361
373
|
|
362
374
|
# form parameters
|
363
375
|
form_params = opts[:form_params] || {}
|
@@ -393,6 +405,7 @@ module Svix
|
|
393
405
|
# @param endpoint_id [String]
|
394
406
|
# @param app_id [String]
|
395
407
|
# @param [Hash] opts the optional parameters
|
408
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
396
409
|
# @return [EndpointSecretOut]
|
397
410
|
def get_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_get(endpoint_id, app_id, opts = {})
|
398
411
|
data, _status_code, _headers = get_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_get_with_http_info(endpoint_id, app_id, opts)
|
@@ -404,6 +417,7 @@ module Svix
|
|
404
417
|
# @param endpoint_id [String]
|
405
418
|
# @param app_id [String]
|
406
419
|
# @param [Hash] opts the optional parameters
|
420
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
407
421
|
# @return [Array<(EndpointSecretOut, Integer, Hash)>] EndpointSecretOut data, response status code and response headers
|
408
422
|
def get_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_get_with_http_info(endpoint_id, app_id, opts = {})
|
409
423
|
if @api_client.config.debugging
|
@@ -453,6 +467,7 @@ module Svix
|
|
453
467
|
header_params = opts[:header_params] || {}
|
454
468
|
# HTTP header 'Accept' (if needed)
|
455
469
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
470
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
456
471
|
|
457
472
|
# form parameters
|
458
473
|
form_params = opts[:form_params] || {}
|
@@ -488,6 +503,7 @@ module Svix
|
|
488
503
|
# @param endpoint_id [String]
|
489
504
|
# @param app_id [String]
|
490
505
|
# @param [Hash] opts the optional parameters
|
506
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
491
507
|
# @return [EndpointStats]
|
492
508
|
def get_endpoint_stats_api_v1_app_app_id_endpoint_endpoint_id_stats_get(endpoint_id, app_id, opts = {})
|
493
509
|
data, _status_code, _headers = get_endpoint_stats_api_v1_app_app_id_endpoint_endpoint_id_stats_get_with_http_info(endpoint_id, app_id, opts)
|
@@ -499,6 +515,7 @@ module Svix
|
|
499
515
|
# @param endpoint_id [String]
|
500
516
|
# @param app_id [String]
|
501
517
|
# @param [Hash] opts the optional parameters
|
518
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
502
519
|
# @return [Array<(EndpointStats, Integer, Hash)>] EndpointStats data, response status code and response headers
|
503
520
|
def get_endpoint_stats_api_v1_app_app_id_endpoint_endpoint_id_stats_get_with_http_info(endpoint_id, app_id, opts = {})
|
504
521
|
if @api_client.config.debugging
|
@@ -548,6 +565,7 @@ module Svix
|
|
548
565
|
header_params = opts[:header_params] || {}
|
549
566
|
# HTTP header 'Accept' (if needed)
|
550
567
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
568
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
551
569
|
|
552
570
|
# form parameters
|
553
571
|
form_params = opts[:form_params] || {}
|
@@ -584,6 +602,7 @@ module Svix
|
|
584
602
|
# @param [Hash] opts the optional parameters
|
585
603
|
# @option opts [String] :iterator
|
586
604
|
# @option opts [Integer] :limit (default to 50)
|
605
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
587
606
|
# @return [ListResponseEndpointOut]
|
588
607
|
def list_endpoints_api_v1_app_app_id_endpoint_get(app_id, opts = {})
|
589
608
|
data, _status_code, _headers = list_endpoints_api_v1_app_app_id_endpoint_get_with_http_info(app_id, opts)
|
@@ -596,6 +615,7 @@ module Svix
|
|
596
615
|
# @param [Hash] opts the optional parameters
|
597
616
|
# @option opts [String] :iterator
|
598
617
|
# @option opts [Integer] :limit
|
618
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
599
619
|
# @return [Array<(ListResponseEndpointOut, Integer, Hash)>] ListResponseEndpointOut data, response status code and response headers
|
600
620
|
def list_endpoints_api_v1_app_app_id_endpoint_get_with_http_info(app_id, opts = {})
|
601
621
|
if @api_client.config.debugging
|
@@ -634,6 +654,7 @@ module Svix
|
|
634
654
|
header_params = opts[:header_params] || {}
|
635
655
|
# HTTP header 'Accept' (if needed)
|
636
656
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
657
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
637
658
|
|
638
659
|
# form parameters
|
639
660
|
form_params = opts[:form_params] || {}
|
@@ -670,6 +691,7 @@ module Svix
|
|
670
691
|
# @param endpoint_id [String]
|
671
692
|
# @param endpoint_headers_in [EndpointHeadersIn]
|
672
693
|
# @param [Hash] opts the optional parameters
|
694
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
673
695
|
# @return [nil]
|
674
696
|
def patch_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_patch(app_id, endpoint_id, endpoint_headers_in, opts = {})
|
675
697
|
patch_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_patch_with_http_info(app_id, endpoint_id, endpoint_headers_in, opts)
|
@@ -682,6 +704,7 @@ module Svix
|
|
682
704
|
# @param endpoint_id [String]
|
683
705
|
# @param endpoint_headers_in [EndpointHeadersIn]
|
684
706
|
# @param [Hash] opts the optional parameters
|
707
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
685
708
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
686
709
|
def patch_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_patch_with_http_info(app_id, endpoint_id, endpoint_headers_in, opts = {})
|
687
710
|
if @api_client.config.debugging
|
@@ -737,6 +760,7 @@ module Svix
|
|
737
760
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
738
761
|
# HTTP header 'Content-Type'
|
739
762
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
763
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
740
764
|
|
741
765
|
# form parameters
|
742
766
|
form_params = opts[:form_params] || {}
|
@@ -773,6 +797,7 @@ module Svix
|
|
773
797
|
# @param endpoint_id [String]
|
774
798
|
# @param recover_in [RecoverIn]
|
775
799
|
# @param [Hash] opts the optional parameters
|
800
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
776
801
|
# @return [Object]
|
777
802
|
def recover_failed_webhooks_api_v1_app_app_id_endpoint_endpoint_id_recover_post(app_id, endpoint_id, recover_in, opts = {})
|
778
803
|
data, _status_code, _headers = recover_failed_webhooks_api_v1_app_app_id_endpoint_endpoint_id_recover_post_with_http_info(app_id, endpoint_id, recover_in, opts)
|
@@ -785,6 +810,7 @@ module Svix
|
|
785
810
|
# @param endpoint_id [String]
|
786
811
|
# @param recover_in [RecoverIn]
|
787
812
|
# @param [Hash] opts the optional parameters
|
813
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
788
814
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
789
815
|
def recover_failed_webhooks_api_v1_app_app_id_endpoint_endpoint_id_recover_post_with_http_info(app_id, endpoint_id, recover_in, opts = {})
|
790
816
|
if @api_client.config.debugging
|
@@ -840,6 +866,7 @@ module Svix
|
|
840
866
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
841
867
|
# HTTP header 'Content-Type'
|
842
868
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
869
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
843
870
|
|
844
871
|
# form parameters
|
845
872
|
form_params = opts[:form_params] || {}
|
@@ -876,6 +903,7 @@ module Svix
|
|
876
903
|
# @param app_id [String]
|
877
904
|
# @param endpoint_secret_rotate_in [EndpointSecretRotateIn]
|
878
905
|
# @param [Hash] opts the optional parameters
|
906
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
879
907
|
# @return [nil]
|
880
908
|
def rotate_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_rotate_post(endpoint_id, app_id, endpoint_secret_rotate_in, opts = {})
|
881
909
|
rotate_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_rotate_post_with_http_info(endpoint_id, app_id, endpoint_secret_rotate_in, opts)
|
@@ -888,6 +916,7 @@ module Svix
|
|
888
916
|
# @param app_id [String]
|
889
917
|
# @param endpoint_secret_rotate_in [EndpointSecretRotateIn]
|
890
918
|
# @param [Hash] opts the optional parameters
|
919
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
891
920
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
892
921
|
def rotate_endpoint_secret_api_v1_app_app_id_endpoint_endpoint_id_secret_rotate_post_with_http_info(endpoint_id, app_id, endpoint_secret_rotate_in, opts = {})
|
893
922
|
if @api_client.config.debugging
|
@@ -943,6 +972,7 @@ module Svix
|
|
943
972
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
944
973
|
# HTTP header 'Content-Type'
|
945
974
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
975
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
946
976
|
|
947
977
|
# form parameters
|
948
978
|
form_params = opts[:form_params] || {}
|
@@ -979,6 +1009,7 @@ module Svix
|
|
979
1009
|
# @param endpoint_id [String]
|
980
1010
|
# @param event_example_in [EventExampleIn]
|
981
1011
|
# @param [Hash] opts the optional parameters
|
1012
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
982
1013
|
# @return [MessageOut]
|
983
1014
|
def send_event_type_example_message_api_v1_app_app_id_endpoint_endpoint_id_send_example_post(app_id, endpoint_id, event_example_in, opts = {})
|
984
1015
|
data, _status_code, _headers = send_event_type_example_message_api_v1_app_app_id_endpoint_endpoint_id_send_example_post_with_http_info(app_id, endpoint_id, event_example_in, opts)
|
@@ -991,6 +1022,7 @@ module Svix
|
|
991
1022
|
# @param endpoint_id [String]
|
992
1023
|
# @param event_example_in [EventExampleIn]
|
993
1024
|
# @param [Hash] opts the optional parameters
|
1025
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
994
1026
|
# @return [Array<(MessageOut, Integer, Hash)>] MessageOut data, response status code and response headers
|
995
1027
|
def send_event_type_example_message_api_v1_app_app_id_endpoint_endpoint_id_send_example_post_with_http_info(app_id, endpoint_id, event_example_in, opts = {})
|
996
1028
|
if @api_client.config.debugging
|
@@ -1046,6 +1078,7 @@ module Svix
|
|
1046
1078
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1047
1079
|
# HTTP header 'Content-Type'
|
1048
1080
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1081
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
1049
1082
|
|
1050
1083
|
# form parameters
|
1051
1084
|
form_params = opts[:form_params] || {}
|
@@ -1082,6 +1115,7 @@ module Svix
|
|
1082
1115
|
# @param app_id [String]
|
1083
1116
|
# @param endpoint_update [EndpointUpdate]
|
1084
1117
|
# @param [Hash] opts the optional parameters
|
1118
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
1085
1119
|
# @return [EndpointOut]
|
1086
1120
|
def update_endpoint_api_v1_app_app_id_endpoint_endpoint_id_put(endpoint_id, app_id, endpoint_update, opts = {})
|
1087
1121
|
data, _status_code, _headers = update_endpoint_api_v1_app_app_id_endpoint_endpoint_id_put_with_http_info(endpoint_id, app_id, endpoint_update, opts)
|
@@ -1094,6 +1128,7 @@ module Svix
|
|
1094
1128
|
# @param app_id [String]
|
1095
1129
|
# @param endpoint_update [EndpointUpdate]
|
1096
1130
|
# @param [Hash] opts the optional parameters
|
1131
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
1097
1132
|
# @return [Array<(EndpointOut, Integer, Hash)>] EndpointOut data, response status code and response headers
|
1098
1133
|
def update_endpoint_api_v1_app_app_id_endpoint_endpoint_id_put_with_http_info(endpoint_id, app_id, endpoint_update, opts = {})
|
1099
1134
|
if @api_client.config.debugging
|
@@ -1149,6 +1184,7 @@ module Svix
|
|
1149
1184
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1150
1185
|
# HTTP header 'Content-Type'
|
1151
1186
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1187
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
1152
1188
|
|
1153
1189
|
# form parameters
|
1154
1190
|
form_params = opts[:form_params] || {}
|
@@ -1185,6 +1221,7 @@ module Svix
|
|
1185
1221
|
# @param endpoint_id [String]
|
1186
1222
|
# @param endpoint_headers_in [EndpointHeadersIn]
|
1187
1223
|
# @param [Hash] opts the optional parameters
|
1224
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
1188
1225
|
# @return [nil]
|
1189
1226
|
def update_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_put(app_id, endpoint_id, endpoint_headers_in, opts = {})
|
1190
1227
|
update_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_put_with_http_info(app_id, endpoint_id, endpoint_headers_in, opts)
|
@@ -1197,6 +1234,7 @@ module Svix
|
|
1197
1234
|
# @param endpoint_id [String]
|
1198
1235
|
# @param endpoint_headers_in [EndpointHeadersIn]
|
1199
1236
|
# @param [Hash] opts the optional parameters
|
1237
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
1200
1238
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
1201
1239
|
def update_endpoint_headers_api_v1_app_app_id_endpoint_endpoint_id_headers_put_with_http_info(app_id, endpoint_id, endpoint_headers_in, opts = {})
|
1202
1240
|
if @api_client.config.debugging
|
@@ -1252,6 +1290,7 @@ module Svix
|
|
1252
1290
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1253
1291
|
# HTTP header 'Content-Type'
|
1254
1292
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1293
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
1255
1294
|
|
1256
1295
|
# form parameters
|
1257
1296
|
form_params = opts[:form_params] || {}
|
@@ -23,6 +23,7 @@ module Svix
|
|
23
23
|
# Download a JSON file containing all org-settings and event types
|
24
24
|
# @param body [Object]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
26
27
|
# @return [EnvironmentOut]
|
27
28
|
def export_environment_configuration_api_v1_environment_export_post(body, opts = {})
|
28
29
|
data, _status_code, _headers = export_environment_configuration_api_v1_environment_export_post_with_http_info(body, opts)
|
@@ -33,6 +34,7 @@ module Svix
|
|
33
34
|
# Download a JSON file containing all org-settings and event types
|
34
35
|
# @param body [Object]
|
35
36
|
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
36
38
|
# @return [Array<(EnvironmentOut, Integer, Hash)>] EnvironmentOut data, response status code and response headers
|
37
39
|
def export_environment_configuration_api_v1_environment_export_post_with_http_info(body, opts = {})
|
38
40
|
if @api_client.config.debugging
|
@@ -54,6 +56,7 @@ module Svix
|
|
54
56
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
57
|
# HTTP header 'Content-Type'
|
56
58
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
59
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
57
60
|
|
58
61
|
# form parameters
|
59
62
|
form_params = opts[:form_params] || {}
|
@@ -88,6 +91,7 @@ module Svix
|
|
88
91
|
# Import a configuration into the active organization. It doesn't delete anything, only adds/updates what was passed to it.
|
89
92
|
# @param environment_in [EnvironmentIn]
|
90
93
|
# @param [Hash] opts the optional parameters
|
94
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
91
95
|
# @return [nil]
|
92
96
|
def import_environment_configuration_api_v1_environment_import_post(environment_in, opts = {})
|
93
97
|
import_environment_configuration_api_v1_environment_import_post_with_http_info(environment_in, opts)
|
@@ -98,6 +102,7 @@ module Svix
|
|
98
102
|
# Import a configuration into the active organization. It doesn't delete anything, only adds/updates what was passed to it.
|
99
103
|
# @param environment_in [EnvironmentIn]
|
100
104
|
# @param [Hash] opts the optional parameters
|
105
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
101
106
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
102
107
|
def import_environment_configuration_api_v1_environment_import_post_with_http_info(environment_in, opts = {})
|
103
108
|
if @api_client.config.debugging
|
@@ -119,6 +124,7 @@ module Svix
|
|
119
124
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
120
125
|
# HTTP header 'Content-Type'
|
121
126
|
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
127
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
122
128
|
|
123
129
|
# form parameters
|
124
130
|
form_params = opts[:form_params] || {}
|
@@ -22,6 +22,7 @@ module Svix
|
|
22
22
|
# Get Org Settings
|
23
23
|
# Get the environment's settings
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
25
26
|
# @return [EnvironmentSettingsOut]
|
26
27
|
def get_org_settings_api_v1_environment_settings_get(opts = {})
|
27
28
|
data, _status_code, _headers = get_org_settings_api_v1_environment_settings_get_with_http_info(opts)
|
@@ -31,6 +32,7 @@ module Svix
|
|
31
32
|
# Get Org Settings
|
32
33
|
# Get the environment's settings
|
33
34
|
# @param [Hash] opts the optional parameters
|
35
|
+
# @option opts [String] :idempotency_key The request's idempotency key
|
34
36
|
# @return [Array<(EnvironmentSettingsOut, Integer, Hash)>] EnvironmentSettingsOut data, response status code and response headers
|
35
37
|
def get_org_settings_api_v1_environment_settings_get_with_http_info(opts = {})
|
36
38
|
if @api_client.config.debugging
|
@@ -46,6 +48,7 @@ module Svix
|
|
46
48
|
header_params = opts[:header_params] || {}
|
47
49
|
# HTTP header 'Accept' (if needed)
|
48
50
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
51
|
+
header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
49
52
|
|
50
53
|
# form parameters
|
51
54
|
form_params = opts[:form_params] || {}
|