svix 0.83.1 → 0.84.1

data/lib/svix/api/environment_api.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -25,8 +25,8 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [EnvironmentOut]
-    def export_environment_configuration_api_v1_environment_export_post(body, opts = {})
-      data, _status_code, _headers = export_environment_configuration_api_v1_environment_export_post_with_http_info(body, opts)
+    def v1_environment_export(body, opts = {})
+      data, _status_code, _headers = v1_environment_export_with_http_info(body, opts)
       data
     end
 
@@ -36,13 +36,13 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(EnvironmentOut, Integer, Hash)>] EnvironmentOut data, response status code and response headers
-    def export_environment_configuration_api_v1_environment_export_post_with_http_info(body, opts = {})
+    def v1_environment_export_with_http_info(body, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: EnvironmentApi.export_environment_configuration_api_v1_environment_export_post ...'
+        @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_export ...'
       end
       # verify the required parameter 'body' is set
       if @api_client.config.client_side_validation && body.nil?
-        fail ArgumentError, "Missing the required parameter 'body' when calling EnvironmentApi.export_environment_configuration_api_v1_environment_export_post"
+        fail ArgumentError, "Missing the required parameter 'body' when calling EnvironmentApi.v1_environment_export"
       end
       # resource path
       local_var_path = '/api/v1/environment/export/'
@@ -71,7 +71,7 @@ module Svix
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
-        :operation => :"EnvironmentApi.export_environment_configuration_api_v1_environment_export_post",
+        :operation => :"EnvironmentApi.v1_environment_export",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -82,7 +82,7 @@ module Svix
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EnvironmentApi#export_environment_configuration_api_v1_environment_export_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EnvironmentApi#v1_environment_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -93,8 +93,8 @@ module Svix
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [nil]
-    def import_environment_configuration_api_v1_environment_import_post(environment_in, opts = {})
-      import_environment_configuration_api_v1_environment_import_post_with_http_info(environment_in, opts)
+    def v1_environment_import(environment_in, opts = {})
+      v1_environment_import_with_http_info(environment_in, opts)
       nil
     end
 
@@ -104,13 +104,13 @@ module Svix
     # @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 import_environment_configuration_api_v1_environment_import_post_with_http_info(environment_in, opts = {})
+    def v1_environment_import_with_http_info(environment_in, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: EnvironmentApi.import_environment_configuration_api_v1_environment_import_post ...'
+        @api_client.config.logger.debug 'Calling API: EnvironmentApi.v1_environment_import ...'
       end
       # verify the required parameter 'environment_in' is set
       if @api_client.config.client_side_validation && environment_in.nil?
-        fail ArgumentError, "Missing the required parameter 'environment_in' when calling EnvironmentApi.import_environment_configuration_api_v1_environment_import_post"
+        fail ArgumentError, "Missing the required parameter 'environment_in' when calling EnvironmentApi.v1_environment_import"
       end
       # resource path
       local_var_path = '/api/v1/environment/import/'
@@ -139,7 +139,7 @@ module Svix
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
-        :operation => :"EnvironmentApi.import_environment_configuration_api_v1_environment_import_post",
+        :operation => :"EnvironmentApi.v1_environment_import",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -150,7 +150,7 @@ module Svix
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EnvironmentApi#import_environment_configuration_api_v1_environment_import_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EnvironmentApi#v1_environment_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/svix/api/environment_settings_api.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 1.4.1
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 5.2.0
@@ -22,21 +22,19 @@ module Svix
     # Get Org Settings
     # Get the environment's settings
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [EnvironmentSettingsOut]
-    def get_org_settings_api_v1_environment_settings_get(opts = {})
-      data, _status_code, _headers = get_org_settings_api_v1_environment_settings_get_with_http_info(opts)
+    def v1_environment_get_settings(opts = {})
+      data, _status_code, _headers = v1_environment_get_settings_with_http_info(opts)
       data
     end
 
     # Get Org Settings
     # Get the environment&#39;s settings
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :idempotency_key The request&#39;s idempotency key
     # @return [Array<(EnvironmentSettingsOut, Integer, Hash)>] EnvironmentSettingsOut data, response status code and response headers
-    def get_org_settings_api_v1_environment_settings_get_with_http_info(opts = {})
+    def v1_environment_get_settings_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: EnvironmentSettingsApi.get_org_settings_api_v1_environment_settings_get ...'
+        @api_client.config.logger.debug 'Calling API: EnvironmentSettingsApi.v1_environment_get_settings ...'
       end
       # resource path
       local_var_path = '/api/v1/environment/settings/'
@@ -48,7 +46,6 @@ 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] || {}
@@ -63,7 +60,7 @@ module Svix
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']
 
       new_options = opts.merge(
-        :operation => :"EnvironmentSettingsApi.get_org_settings_api_v1_environment_settings_get",
+        :operation => :"EnvironmentSettingsApi.v1_environment_get_settings",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -74,7 +71,7 @@ module Svix
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: EnvironmentSettingsApi#get_org_settings_api_v1_environment_settings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: EnvironmentSettingsApi#v1_environment_get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end