svix 0.43.2 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4d5477a7c45e7ce760b3ecbaf129104fd87ab3499cefd3b0734b503c6bfce50
-  data.tar.gz: f76c1ae5de0348c89abb51bbe27ea28cd57eb0955ee00f523c386591e75becee
+  metadata.gz: ad220418b20ebcf88529ae1a4036018679ee31b08c3715242b7240a7a69aed04
+  data.tar.gz: 1ebd10e65a0780d47f9727a519b74b5d13a2565fcfe09f15a8f382e19dfd4177
 SHA512:
-  metadata.gz: 1cebae06fcaa4d2100c43676cf5be855e8885182eb2182be4dc91dd33022ae3b4a569cd395879c29963123310ec5ee4940fdfa1c9d460ba9100ca19b797ecd78
-  data.tar.gz: 2155b0f51d24baaecf980f040262800b0e58ccb9e79dab40176d787ca2f54ba4c5273cfe5ceda3bc1d7a79f51f9841d8cb2123dadcfebf41cffa74a9692ac07f
+  metadata.gz: 34361fb676b9e62e795f601a93fd557dddd68339fe8b19a68199ce935f9901752c1192b88e9ec6e07eeb0a9978fedf156fd82b71fb440ff843631fadd08ceb7b
+  data.tar.gz: 3a1aaa10ba50db71e7cdf7e154c7fabe9cc8e83c1605ec59a580660876f218cddd3ef9046c56b5930c0351641b44284a9d94221cc3045092bf7aa55fb89a474f

data/Gemfile.lock

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

data/lib/svix/api/application_api.rb

@@ -23,6 +23,7 @@ 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)
     # @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 +34,7 @@ module Svix
     # Create a new application.
     # @param application_in [ApplicationIn] 
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :get_if_exists 
     # @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 +49,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] || {}

data/lib/svix/api/environment_api.rb

@@ -0,0 +1,152 @@
+=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/).   ## 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
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'cgi'
+
+module Svix
+  class EnvironmentApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Export Environment Configuration
+    # Download a JSON file containing all org-settings and event types
+    # @param body [Object] 
+    # @param [Hash] opts the optional parameters
+    # @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)
+      data
+    end
+
+    # Export Environment Configuration
+    # Download a JSON file containing all org-settings and event types
+    # @param body [Object] 
+    # @param [Hash] opts the optional parameters
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentApi.export_environment_configuration_api_v1_environment_export_post ...'
+      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"
+      end
+      # resource path
+      local_var_path = '/api/v1/environment/export/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EnvironmentOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentApi.export_environment_configuration_api_v1_environment_export_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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}"
+      end
+      return data, status_code, headers
+    end
+
+    # Import Environment Configuration
+    # Import a configuration into the active organization. It doesn't delete anything, only adds/updates what was passed to it.
+    # @param environment_in [EnvironmentIn] 
+    # @param [Hash] opts the optional parameters
+    # @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)
+      nil
+    end
+
+    # Import Environment Configuration
+    # Import a configuration into the active organization. It doesn&#39;t delete anything, only adds/updates what was passed to it.
+    # @param environment_in [EnvironmentIn] 
+    # @param [Hash] opts the optional parameters
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentApi.import_environment_configuration_api_v1_environment_import_post ...'
+      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"
+      end
+      # resource path
+      local_var_path = '/api/v1/environment/import/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(environment_in)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentApi.import_environment_configuration_api_v1_environment_import_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/svix/api/environment_settings_api.rb

@@ -0,0 +1,79 @@
+=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/).   ## 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
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'cgi'
+
+module Svix
+  class EnvironmentSettingsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Org Settings
+    # Get the environment's settings
+    # @param [Hash] opts the optional parameters
+    # @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)
+      data
+    end
+
+    # Get Org Settings
+    # Get the environment&#39;s settings
+    # @param [Hash] opts the optional parameters
+    # @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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EnvironmentSettingsApi.get_org_settings_api_v1_environment_settings_get ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/environment/settings/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EnvironmentSettingsOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"EnvironmentSettingsApi.get_org_settings_api_v1_environment_settings_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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}"
+      end
+      return data, status_code, headers
+    end
+  end
+end