clerk-http-client 0.0.1

data/lib/clerk-http-client/api/instance_settings_api.rb

@@ -0,0 +1,232 @@
+=begin
+#Clerk Backend API
+
+#The Clerk REST Backend API, meant to be accessed by backend servers.  ### Versions  When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. `2021-02-05`. For more information, please see [Clerk API Versions](https://clerk.com/docs/backend-requests/versioning/overview).   Please see https://clerk.com/docs for more information.
+
+The version of the OpenAPI document: v1
+Contact: support@clerk.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ClerkHttpClient
+  class InstanceSettingsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Update instance settings
+    # Updates the settings of an instance
+    # @param update_instance_request [UpdateInstanceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+
+    def update(update_instance_request, opts = {})
+      update_with_http_info(update_instance_request, opts)
+      nil
+    end
+
+    # Update instance settings
+    # Updates the settings of an instance
+    # @param update_instance_request [UpdateInstanceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # PATCH 
+    def update_with_http_info(update_instance_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance ...'
+      end
+      # verify the required parameter 'update_instance_request' is set
+      if @api_client.config.client_side_validation && update_instance_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_instance_request' when calling InstanceSettingsApi.update_instance"
+      end
+      # resource path
+      local_var_path = '/instance'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_instance_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstanceSettingsApi.update_instance",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InstanceSettingsApi#update_instance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update instance organization settings
+    # Updates the organization settings of the instance
+    # @param update_instance_organization_settings_request [UpdateInstanceOrganizationSettingsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [OrganizationSettings]
+
+    def update_organization_settings(update_instance_organization_settings_request, opts = {})
+      data, _status_code, _headers = update_organization_settings_with_http_info(update_instance_organization_settings_request, opts)
+      data
+    end
+
+    # Update instance organization settings
+    # Updates the organization settings of the instance
+    # @param update_instance_organization_settings_request [UpdateInstanceOrganizationSettingsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrganizationSettings, Integer, Hash)>] OrganizationSettings data, response status code and response headers
+    # PATCH 
+    def update_organization_settings_with_http_info(update_instance_organization_settings_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance_organization_settings ...'
+      end
+      # verify the required parameter 'update_instance_organization_settings_request' is set
+      if @api_client.config.client_side_validation && update_instance_organization_settings_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_instance_organization_settings_request' when calling InstanceSettingsApi.update_instance_organization_settings"
+      end
+      # resource path
+      local_var_path = '/instance/organization_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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_instance_organization_settings_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrganizationSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstanceSettingsApi.update_instance_organization_settings",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InstanceSettingsApi#update_instance_organization_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update instance restrictions
+    # Updates the restriction settings of an instance
+    # @param update_instance_restrictions_request [UpdateInstanceRestrictionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [InstanceRestrictions]
+
+    def update_restrictions(update_instance_restrictions_request, opts = {})
+      data, _status_code, _headers = update_restrictions_with_http_info(update_instance_restrictions_request, opts)
+      data
+    end
+
+    # Update instance restrictions
+    # Updates the restriction settings of an instance
+    # @param update_instance_restrictions_request [UpdateInstanceRestrictionsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InstanceRestrictions, Integer, Hash)>] InstanceRestrictions data, response status code and response headers
+    # PATCH 
+    def update_restrictions_with_http_info(update_instance_restrictions_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance_restrictions ...'
+      end
+      # verify the required parameter 'update_instance_restrictions_request' is set
+      if @api_client.config.client_side_validation && update_instance_restrictions_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_instance_restrictions_request' when calling InstanceSettingsApi.update_instance_restrictions"
+      end
+      # resource path
+      local_var_path = '/instance/restrictions'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_instance_restrictions_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'InstanceRestrictions'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstanceSettingsApi.update_instance_restrictions",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InstanceSettingsApi#update_instance_restrictions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/clerk-http-client/api/invitations_api.rb

@@ -0,0 +1,241 @@
+=begin
+#Clerk Backend API
+
+#The Clerk REST Backend API, meant to be accessed by backend servers.  ### Versions  When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. `2021-02-05`. For more information, please see [Clerk API Versions](https://clerk.com/docs/backend-requests/versioning/overview).   Please see https://clerk.com/docs for more information.
+
+The version of the OpenAPI document: v1
+Contact: support@clerk.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ClerkHttpClient
+  class InvitationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an invitation
+    # Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.
+    # @param create_invitation_request [CreateInvitationRequest] Required parameters
+    # @param [Hash] opts the optional parameters
+    # @return [Invitation]
+
+    def create(create_invitation_request, opts = {})
+      data, _status_code, _headers = create_with_http_info(create_invitation_request, opts)
+      data
+    end
+
+    # Create an invitation
+    # Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.
+    # @param create_invitation_request [CreateInvitationRequest] Required parameters
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Invitation, Integer, Hash)>] Invitation data, response status code and response headers
+    # POST 
+    def create_with_http_info(create_invitation_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvitationsApi.create_invitation ...'
+      end
+      # verify the required parameter 'create_invitation_request' is set
+      if @api_client.config.client_side_validation && create_invitation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_invitation_request' when calling InvitationsApi.create_invitation"
+      end
+      # resource path
+      local_var_path = '/invitations'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_invitation_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Invitation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"InvitationsApi.create_invitation",
+        :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: InvitationsApi#create_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List all invitations
+    # Returns all non-revoked invitations for your application, sorted by creation date
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)
+    # @option opts [Float] :offset Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)
+    # @option opts [String] :status Filter invitations based on their status
+    # @return [Array<Invitation>]
+
+    def all(opts = {})
+      data, _status_code, _headers = all_with_http_info(opts)
+      data
+    end
+
+    # List all invitations
+    # Returns all non-revoked invitations for your application, sorted by creation date
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)
+    # @option opts [Float] :offset Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)
+    # @option opts [String] :status Filter invitations based on their status
+    # @return [Array<(Array<Invitation>, Integer, Hash)>] Array<Invitation> data, response status code and response headers
+    # GET array
+    def all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvitationsApi.list_invitations ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvitationsApi.list_invitations, must be smaller than or equal to 500.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvitationsApi.list_invitations, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InvitationsApi.list_invitations, must be greater than or equal to 0.'
+      end
+
+      allowable_values = ["pending", "accepted", "revoked", "expired"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/invitations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Invitation>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"InvitationsApi.list_invitations",
+        :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: InvitationsApi#list_invitations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revokes an invitation
+    # Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn't prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.
+    # @param invitation_id [String] The ID of the invitation to be revoked
+    # @param [Hash] opts the optional parameters
+    # @return [RevokeInvitation200Response]
+
+    def revoke(invitation_id, opts = {})
+      data, _status_code, _headers = revoke_with_http_info(invitation_id, opts)
+      data
+    end
+
+    # Revokes an invitation
+    # Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn&#39;t prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.
+    # @param invitation_id [String] The ID of the invitation to be revoked
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RevokeInvitation200Response, Integer, Hash)>] RevokeInvitation200Response data, response status code and response headers
+    # POST 
+    def revoke_with_http_info(invitation_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvitationsApi.revoke_invitation ...'
+      end
+      # verify the required parameter 'invitation_id' is set
+      if @api_client.config.client_side_validation && invitation_id.nil?
+        fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.revoke_invitation"
+      end
+      # resource path
+      local_var_path = '/invitations/{invitation_id}/revoke'.sub('{' + 'invitation_id' + '}', CGI.escape(invitation_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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'RevokeInvitation200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"InvitationsApi.revoke_invitation",
+        :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: InvitationsApi#revoke_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/clerk-http-client/api/jwks_api.rb

@@ -0,0 +1,81 @@
+=begin
+#Clerk Backend API
+
+#The Clerk REST Backend API, meant to be accessed by backend servers.  ### Versions  When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. `2021-02-05`. For more information, please see [Clerk API Versions](https://clerk.com/docs/backend-requests/versioning/overview).   Please see https://clerk.com/docs for more information.
+
+The version of the OpenAPI document: v1
+Contact: support@clerk.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ClerkHttpClient
+  class JWKSApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieve the JSON Web Key Set of the instance
+    # Retrieve the JSON Web Key Set of the instance
+    # @param [Hash] opts the optional parameters
+    # @return [WellKnownJWKS]
+
+    def get(opts = {})
+      data, _status_code, _headers = get_with_http_info(opts)
+      data
+    end
+
+    # Retrieve the JSON Web Key Set of the instance
+    # Retrieve the JSON Web Key Set of the instance
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WellKnownJWKS, Integer, Hash)>] WellKnownJWKS data, response status code and response headers
+    # GET 
+    def get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: JWKSApi.get_jwks ...'
+      end
+      # resource path
+      local_var_path = '/jwks'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WellKnownJWKS'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"JWKSApi.get_jwks",
+        :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: JWKSApi#get_jwks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end