svix 0.41.0 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eb8ab3af1e0634005724f6b5c759319008f9a3cc130be62b917989139ad899a
-  data.tar.gz: ed7a0a14128124670d25f6a4f7b3703ebdc3365842054273e03ea22887e5a728
+  metadata.gz: e1742c65f260a8cbf205d478341f72aff69b0e6ef1019ddccb309355b266f583
+  data.tar.gz: 62150765756ff23b82ddd3f3906d60923f14053d3895c94317bde67d0b39d51a
 SHA512:
-  metadata.gz: 77fa1947cea80de4a1d57aca24f8e9ccad811dded54b81d27567cd8a125d7cb96e364bfc8cb655c2d25a6467c2f15198a53bcf8083ff9130c34f631426f3d6ba
-  data.tar.gz: 3dbde77e7dd662432ddf3d44bce754534a47fc7b06692c0c47effc30b27668a84f1774d71c113ff274bd0fbe6236ba9aa629ff475f66e1509ff11d223b37eb40
+  metadata.gz: cac5c60620c751a953300a734bf1910a11f30401752d81e1eb3b5d19eac33e57f2e87f8da7614f1e715e5ab71b31542a4cfefafbc7d0cd14f5072a41b9ccf01f
+  data.tar.gz: 79428d402103ce0068cd8e52a48bdb208c90c96be1169ceb8c17bd845f91ad831803fa4b1e92427da43911f74fa875abfb552d4068e7154403490978eb318d41

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    svix (0.41.0)
+    svix (0.48.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -1,6 +1,46 @@
-# Svix Ruby
-
-Please refer to [the documentation](https://docs.svix.com) for usage instructions.
+<h1 align="center">
+    <a style="text-decoration: none" href="https://www.svix.com">
+      <img width="120" src="https://avatars.githubusercontent.com/u/80175132?s=200&v=4" />
+      <p align="center">Svix - Webhooks as a service</p>
+    </a>
+</h1>
+<h2 align="center">
+  <a href="https://svix.com">Website</a> | <a href="https://docs.svix.com">Documentation</a> | <a href="https://svix.com/slack">Community Slack</a>
+<h2>
+
+Ruby library for interacting with the Svix API and verifying webhook signatures
+
+![GitHub tag](https://img.shields.io/github/tag/svix/svix-webhooks.svg)
+[![Gem](https://img.shields.io/gem/v/svix)](https://rubygems.org/gems/svix)
+
+
+[![Join our slack](https://img.shields.io/badge/Slack-join%20the%20community-blue?logo=slack&style=social)](https://www.svix.com/slack/)
+
+# Usage Documentation
+
+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>.
+
+# Language Support
+
+<table style="table-layout:fixed; white-space: nowrap;">
+  <th colspan="2">⚡️ Features ⚡️</th>
+  <tr>
+    <th>Officially Supported</th>
+    <th>✅</th>
+  </tr>
+  <tr>
+    <th>API Support</th>
+    <th>✅</th>
+  </tr>
+  <tr>
+    <th>Signature Verification</th>
+    <th>✅</th>
+  </tr>
+  <tr>
+    <th>Caveats</th>
+    <th>🚀 None!</th>
+  </tr>
+</table>
 
 ## Installation
 
@@ -22,19 +62,33 @@ Or install it yourself as:
 gem install svix
 ```
 
-## Development
+# Development
+
+First checkout the [core README](../README.md#development) for details on how to generate our API bindings, then follow the steps below.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Building
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```sh
+bundler exec rake build
+```
 
+## Contributing
 
-### Run Tests
+Before opening a PR be sure to format your code!
 
+```sh
 bundle exec rspec spec
+```
 
+## Running Tests
+
+Simply run:
+
+```sh
+bundle exec rspec spec
+```
 
-### Build & Upload
+## Publishing
 
 ```sh
 gem build svix.gemspec

data/lib/svix/api/application_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Svix API
 
-#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
+#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
 The version of the OpenAPI document: 1.4
 
@@ -23,6 +23,8 @@ module Svix
     # Create a new application.
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :get_if_exists  (default to false)
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [ApplicationOut]
     def create_application_api_v1_app_post(application_in, opts = {})
       data, _status_code, _headers = create_application_api_v1_app_post_with_http_info(application_in, opts)
@@ -33,6 +35,8 @@ module Svix
     # Create a new application.
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :get_if_exists 
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
     def create_application_api_v1_app_post_with_http_info(application_in, opts = {})
       if @api_client.config.debugging
@@ -47,6 +51,7 @@ module Svix
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'get_if_exists'] = opts[:'get_if_exists'] if !opts[:'get_if_exists'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -54,6 +59,7 @@ module Svix
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -88,6 +94,7 @@ module Svix
     # Delete an application.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [nil]
     def delete_application_api_v1_app_app_id_delete(app_id, opts = {})
       delete_application_api_v1_app_app_id_delete_with_http_info(app_id, opts)
@@ -98,6 +105,7 @@ module Svix
     # Delete an application.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_application_api_v1_app_app_id_delete_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
@@ -130,6 +138,7 @@ module Svix
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -164,6 +173,7 @@ module Svix
     # Get an application.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [ApplicationOut]
     def get_application_api_v1_app_app_id_get(app_id, opts = {})
       data, _status_code, _headers = get_application_api_v1_app_app_id_get_with_http_info(app_id, opts)
@@ -174,6 +184,7 @@ module Svix
     # Get an application.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
     def get_application_api_v1_app_app_id_get_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
@@ -206,6 +217,7 @@ module Svix
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -241,6 +253,7 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :iterator 
     # @option opts [Integer] :limit  (default to 50)
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [ListResponseApplicationOut]
     def list_applications_api_v1_app_get(opts = {})
       data, _status_code, _headers = list_applications_api_v1_app_get_with_http_info(opts)
@@ -252,11 +265,16 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :iterator 
     # @option opts [Integer] :limit 
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(ListResponseApplicationOut, Integer, Hash)>] ListResponseApplicationOut data, response status code and response headers
     def list_applications_api_v1_app_get_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ApplicationApi.list_applications_api_v1_app_get ...'
       end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 250
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ApplicationApi.list_applications_api_v1_app_get, must be smaller than or equal to 250.'
+      end
+
       # resource path
       local_var_path = '/api/v1/app/'
 
@@ -269,6 +287,7 @@ module Svix
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -304,6 +323,7 @@ module Svix
     # @param app_id [String] 
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [ApplicationOut]
     def update_application_api_v1_app_app_id_put(app_id, application_in, opts = {})
       data, _status_code, _headers = update_application_api_v1_app_app_id_put_with_http_info(app_id, application_in, opts)
@@ -315,6 +335,7 @@ module Svix
     # @param app_id [String] 
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(ApplicationOut, Integer, Hash)>] ApplicationOut data, response status code and response headers
     def update_application_api_v1_app_app_id_put_with_http_info(app_id, application_in, opts = {})
       if @api_client.config.debugging
@@ -353,6 +374,7 @@ module Svix
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
       header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}

data/lib/svix/api/authentication_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Svix API
 
-#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
+#Welcome to the Svix API documentation!  Useful links: [Homepage](https://www.svix.com) | [Support email](mailto:support+docs@svix.com) | [Blog](https://www.svix.com/blog/) | [Slack Community](https://www.svix.com/slack/)  # Introduction  This is the reference documentation and schemas for the [Svix webhook service](https://www.svix.com) API. For tutorials and other documentation please refer to [the documentation](https://docs.svix.com).  ## Main concepts  In Svix you have four important entities you will be interacting with:  - `messages`: these are the webhooks being sent. They can have contents and a few other properties. - `application`: this is where `messages` are sent to. Usually you want to create one application for each user on your platform. - `endpoint`: endpoints are the URLs messages will be sent to. Each application can have multiple `endpoints` and each message sent to that application will be sent to all of them (unless they are not subscribed to the sent event type). - `event-type`: event types are identifiers denoting the type of the message being sent. Event types are primarily used to decide which events are sent to which endpoint.   ## Authentication  Get your authentication token (`AUTH_TOKEN`) from the [Svix dashboard](https://dashboard.svix.com) and use it as part of the `Authorization` header as such: `Authorization: Bearer ${AUTH_TOKEN}`.  <SecurityDefinitions />   ## Code samples  The code samples assume you already have the respective libraries installed and you know how to use them. For the latest information on how to do that, please refer to [the documentation](https://docs.svix.com/).   ## Idempotency  Svix supports [idempotency](https://en.wikipedia.org/wiki/Idempotence) for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response.  To perform an idempotent request, pass the idempotency key in the `Idempotency-Key` header to the request. The idempotency key should be a unique value generated by the client. You can create the key in however way you like, though we suggest using UUID v4, or any other string with enough entropy to avoid collisions.  Svix's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key for any successful request. Subsequent requests with the same key return the same result.  Please note that idempotency is only supported for `POST` requests.   ## Cross-Origin Resource Sharing  This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). And that allows cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. 
 
 The version of the OpenAPI document: 1.4
 
@@ -23,6 +23,7 @@ module Svix
     # Use this function to get magic links (and authentication codes) for connecting your users to the management UIs.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [DashboardAccessOut]
     def get_dashboard_access_api_v1_auth_dashboard_access_app_id_post(app_id, opts = {})
       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
     # Use this function to get magic links (and authentication codes) for connecting your users to the management UIs.
     # @param app_id [String] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(DashboardAccessOut, Integer, Hash)>] DashboardAccessOut data, response status code and response headers
     def get_dashboard_access_api_v1_auth_dashboard_access_app_id_post_with_http_info(app_id, opts = {})
       if @api_client.config.debugging
@@ -65,6 +67,7 @@ module Svix
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -98,6 +101,7 @@ module Svix
     # Logout
     # Logout an app token.  Trying to log out other tokens will fail.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [nil]
     def logout_api_v1_auth_logout_post(opts = {})
       logout_api_v1_auth_logout_post_with_http_info(opts)
@@ -107,6 +111,7 @@ module Svix
     # Logout
     # Logout an app token.  Trying to log out other tokens will fail.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def logout_api_v1_auth_logout_post_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -122,6 +127,7 @@ module Svix
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}