svix 1.23.0 → 1.25.0

data/lib/svix/api/transformation_template_api.rb

@@ -19,6 +19,109 @@ module Svix
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Update Hubspot Oauth Config
+    # Create/update endpoint Hubsport OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
+    # @param app_id [String] The app's ID or UID
+    # @param endpoint_id [String] The ep's ID or UID
+    # @param hubspot_oauth_config_in [HubspotOauthConfigIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def v1_endpoint_update_hubspot_oauth_config(app_id, endpoint_id, hubspot_oauth_config_in, opts = {})
+      v1_endpoint_update_hubspot_oauth_config_with_http_info(app_id, endpoint_id, hubspot_oauth_config_in, opts)
+      nil
+    end
+
+    # Update Hubspot Oauth Config
+    # Create/update endpoint Hubsport OAuth configuration Specific private endpoint just for us, to avoid exposing the Hubspot secret to the client.
+    # @param app_id [String] The app's ID or UID
+    # @param endpoint_id [String] The ep's ID or UID
+    # @param hubspot_oauth_config_in [HubspotOauthConfigIn] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def v1_endpoint_update_hubspot_oauth_config_with_http_info(app_id, endpoint_id, hubspot_oauth_config_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config"
+      end
+      if @api_client.config.client_side_validation && app_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "app_id" when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && app_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "app_id" when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && app_id !~ pattern
+        fail ArgumentError, "invalid value for 'app_id' when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'endpoint_id' is set
+      if @api_client.config.client_side_validation && endpoint_id.nil?
+        fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config"
+      end
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length > 256
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && endpoint_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "endpoint_id" when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9\-_.]+$/)
+      if @api_client.config.client_side_validation && endpoint_id !~ pattern
+        fail ArgumentError, "invalid value for 'endpoint_id' when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'hubspot_oauth_config_in' is set
+      if @api_client.config.client_side_validation && hubspot_oauth_config_in.nil?
+        fail ArgumentError, "Missing the required parameter 'hubspot_oauth_config_in' when calling TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config"
+      end
+      # resource path
+      local_var_path = '/api/v1/app/{app_id}/endpoint/{endpoint_id}/transformation-template/oauth/hubspot'.sub('{' + 'app_id' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpoint_id' + '}', CGI.escape(endpoint_id.to_s))
+
+      # 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(hubspot_oauth_config_in)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"TransformationTemplateApi.v1_endpoint_update_hubspot_oauth_config",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TransformationTemplateApi#v1_endpoint_update_hubspot_oauth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create Transformation Template
     # Create a new transformation template
     # @param template_in [TemplateIn] 
@@ -357,28 +460,28 @@ module Svix
 
     # Authorize Discord
     # Get Discord Incoming webhook URL
-    # @param oauth_payload_in [OauthPayloadIn] 
+    # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [OauthPayloadOut]
-    def v1_transformation_template_oauth_discord(oauth_payload_in, opts = {})
-      data, _status_code, _headers = v1_transformation_template_oauth_discord_with_http_info(oauth_payload_in, opts)
+    # @return [IncomingWebhookPayloadOut]
+    def v1_transformation_template_oauth_discord(o_auth_payload_in, opts = {})
+      data, _status_code, _headers = v1_transformation_template_oauth_discord_with_http_info(o_auth_payload_in, opts)
       data
     end
 
     # Authorize Discord
     # Get Discord Incoming webhook URL
-    # @param oauth_payload_in [OauthPayloadIn] 
+    # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [Array<(OauthPayloadOut, Integer, Hash)>] OauthPayloadOut data, response status code and response headers
-    def v1_transformation_template_oauth_discord_with_http_info(oauth_payload_in, opts = {})
+    # @return [Array<(IncomingWebhookPayloadOut, Integer, Hash)>] IncomingWebhookPayloadOut data, response status code and response headers
+    def v1_transformation_template_oauth_discord_with_http_info(o_auth_payload_in, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransformationTemplateApi.v1_transformation_template_oauth_discord ...'
       end
-      # verify the required parameter 'oauth_payload_in' is set
-      if @api_client.config.client_side_validation && oauth_payload_in.nil?
-        fail ArgumentError, "Missing the required parameter 'oauth_payload_in' when calling TransformationTemplateApi.v1_transformation_template_oauth_discord"
+      # verify the required parameter 'o_auth_payload_in' is set
+      if @api_client.config.client_side_validation && o_auth_payload_in.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_payload_in' when calling TransformationTemplateApi.v1_transformation_template_oauth_discord"
       end
       # resource path
       local_var_path = '/api/v1/transformation-template/oauth/discord'
@@ -398,10 +501,10 @@ module Svix
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(oauth_payload_in)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_payload_in)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'OauthPayloadOut'
+      return_type = opts[:debug_return_type] || 'IncomingWebhookPayloadOut'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']
@@ -423,30 +526,98 @@ module Svix
       return data, status_code, headers
     end
 
+    # Authorize Hubspot
+    # Get Hubspot access token using authorization code
+    # @param o_auth_payload_in [OAuthPayloadIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [OAuthPayloadOut]
+    def v1_transformation_template_oauth_hubspot(o_auth_payload_in, opts = {})
+      data, _status_code, _headers = v1_transformation_template_oauth_hubspot_with_http_info(o_auth_payload_in, opts)
+      data
+    end
+
+    # Authorize Hubspot
+    # Get Hubspot access token using authorization code
+    # @param o_auth_payload_in [OAuthPayloadIn] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key The request&#39;s idempotency key
+    # @return [Array<(OAuthPayloadOut, Integer, Hash)>] OAuthPayloadOut data, response status code and response headers
+    def v1_transformation_template_oauth_hubspot_with_http_info(o_auth_payload_in, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TransformationTemplateApi.v1_transformation_template_oauth_hubspot ...'
+      end
+      # verify the required parameter 'o_auth_payload_in' is set
+      if @api_client.config.client_side_validation && o_auth_payload_in.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_payload_in' when calling TransformationTemplateApi.v1_transformation_template_oauth_hubspot"
+      end
+      # resource path
+      local_var_path = '/api/v1/transformation-template/oauth/hubspot'
+
+      # 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'])
+      header_params[:'idempotency-key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_payload_in)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OAuthPayloadOut'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"TransformationTemplateApi.v1_transformation_template_oauth_hubspot",
+        :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: TransformationTemplateApi#v1_transformation_template_oauth_hubspot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Authorize Slack
     # Get Slack Incoming webhook URL
-    # @param oauth_payload_in [OauthPayloadIn] 
+    # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [OauthPayloadOut]
-    def v1_transformation_template_oauth_slack(oauth_payload_in, opts = {})
-      data, _status_code, _headers = v1_transformation_template_oauth_slack_with_http_info(oauth_payload_in, opts)
+    # @return [IncomingWebhookPayloadOut]
+    def v1_transformation_template_oauth_slack(o_auth_payload_in, opts = {})
+      data, _status_code, _headers = v1_transformation_template_oauth_slack_with_http_info(o_auth_payload_in, opts)
       data
     end
 
     # Authorize Slack
     # Get Slack Incoming webhook URL
-    # @param oauth_payload_in [OauthPayloadIn] 
+    # @param o_auth_payload_in [OAuthPayloadIn] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key The request&#39;s idempotency key
-    # @return [Array<(OauthPayloadOut, Integer, Hash)>] OauthPayloadOut data, response status code and response headers
-    def v1_transformation_template_oauth_slack_with_http_info(oauth_payload_in, opts = {})
+    # @return [Array<(IncomingWebhookPayloadOut, Integer, Hash)>] IncomingWebhookPayloadOut data, response status code and response headers
+    def v1_transformation_template_oauth_slack_with_http_info(o_auth_payload_in, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransformationTemplateApi.v1_transformation_template_oauth_slack ...'
       end
-      # verify the required parameter 'oauth_payload_in' is set
-      if @api_client.config.client_side_validation && oauth_payload_in.nil?
-        fail ArgumentError, "Missing the required parameter 'oauth_payload_in' when calling TransformationTemplateApi.v1_transformation_template_oauth_slack"
+      # verify the required parameter 'o_auth_payload_in' is set
+      if @api_client.config.client_side_validation && o_auth_payload_in.nil?
+        fail ArgumentError, "Missing the required parameter 'o_auth_payload_in' when calling TransformationTemplateApi.v1_transformation_template_oauth_slack"
       end
       # resource path
       local_var_path = '/api/v1/transformation-template/oauth/slack'
@@ -466,10 +637,10 @@ module Svix
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(oauth_payload_in)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_payload_in)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'OauthPayloadOut'
+      return_type = opts[:debug_return_type] || 'IncomingWebhookPayloadOut'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['HTTPBearer']

data/lib/svix/models/auth_token_out.rb

@@ -0,0 +1,272 @@
+=begin
+#Svix API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.1.1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Svix
+  class AuthTokenOut
+    attr_accessor :created_at
+
+    attr_accessor :expires_at
+
+    # The key's ID
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'created_at' => :'createdAt',
+        :'expires_at' => :'expiresAt',
+        :'id' => :'id',
+        :'name' => :'name',
+        :'token' => :'token'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'created_at' => :'Time',
+        :'expires_at' => :'Time',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'token' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expires_at',
+        :'name',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Svix::AuthTokenOut` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Svix::AuthTokenOut`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @token.nil?
+        invalid_properties.push('invalid value for "token", token cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @created_at.nil?
+      return false if @id.nil?
+      return false if @token.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          created_at == o.created_at &&
+          expires_at == o.expires_at &&
+          id == o.id &&
+          name == o.name &&
+          token == o.token
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [created_at, expires_at, id, name, token].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Svix.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/svix/models/client_secret_jwt_params_in.rb

@@ -15,12 +15,15 @@ require 'time'
 
 module Svix
   class ClientSecretJwtParamsIn
+    # The base64-encoded secret used for signing the JWT.
     attr_accessor :secret_base64
 
+    # Optional secret identifier. If supplied, this will be populated in the JWT header in the `kid` field.
     attr_accessor :secret_id
 
     attr_accessor :signing_algorithm
 
+    # Optional number of seconds after which the JWT should expire. Defaults to 300 seconds.
     attr_accessor :token_expiry_secs
 
     # Attribute mapping from ruby-style variable name to JSON key.