clerk-http-client 1.0.0 → 2.0.0.beta1

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 Contact: support@clerk.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.9.0
+Generator version: unset
 
 =end
 
@@ -21,29 +21,25 @@ module ClerkHttpClient
     end
     # Create a phone number
     # Create a new phone number
-    # @param create_phone_number_request [CreatePhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [CreatePhoneNumberRequest] :create_phone_number_request 
     # @return [PhoneNumber]
 
-    def create(create_phone_number_request, opts = {})
-      data, _status_code, _headers = create_with_http_info(create_phone_number_request, opts)
+    def create_phone_number(opts = {})
+      data, _status_code, _headers = create_phone_number_with_http_info(opts)
       data
     end
 
     # Create a phone number
     # Create a new phone number
-    # @param create_phone_number_request [CreatePhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [CreatePhoneNumberRequest] :create_phone_number_request 
     # @return [Array<(PhoneNumber, Integer, Hash)>] PhoneNumber data, response status code and response headers
     # POST 
-    def create_with_http_info(create_phone_number_request, opts = {})
+    def create_phone_number_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.create_phone_number ...'
       end
-      # verify the required parameter 'create_phone_number_request' is set
-      if @api_client.config.client_side_validation && create_phone_number_request.nil?
-        fail ArgumentError, "Missing the required parameter 'create_phone_number_request' when calling PhoneNumbersApi.create_phone_number"
-      end
       # resource path
       local_var_path = '/phone_numbers'
 
@@ -64,7 +60,7 @@ module ClerkHttpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_phone_number_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_phone_number_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'PhoneNumber'
@@ -95,8 +91,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [DeletedObject]
 
-    def delete(phone_number_id, opts = {})
-      data, _status_code, _headers = delete_with_http_info(phone_number_id, opts)
+    def delete_phone_number(phone_number_id, opts = {})
+      data, _status_code, _headers = delete_phone_number_with_http_info(phone_number_id, opts)
       data
     end
 
@@ -106,7 +102,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeletedObject, Integer, Hash)>] DeletedObject data, response status code and response headers
     # DELETE 
-    def delete_with_http_info(phone_number_id, opts = {})
+    def delete_phone_number_with_http_info(phone_number_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.delete_phone_number ...'
       end
@@ -160,8 +156,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [PhoneNumber]
 
-    def find(phone_number_id, opts = {})
-      data, _status_code, _headers = find_with_http_info(phone_number_id, opts)
+    def get_phone_number(phone_number_id, opts = {})
+      data, _status_code, _headers = get_phone_number_with_http_info(phone_number_id, opts)
       data
     end
 
@@ -171,7 +167,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(PhoneNumber, Integer, Hash)>] PhoneNumber data, response status code and response headers
     # GET 
-    def find_with_http_info(phone_number_id, opts = {})
+    def get_phone_number_with_http_info(phone_number_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.get_phone_number ...'
       end
@@ -222,23 +218,23 @@ module ClerkHttpClient
     # Update a phone number
     # Updates a phone number
     # @param phone_number_id [String] The ID of the phone number to update
-    # @param update_phone_number_request [UpdatePhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [UpdatePhoneNumberRequest] :update_phone_number_request 
     # @return [PhoneNumber]
 
-    def update(phone_number_id, update_phone_number_request, opts = {})
-      data, _status_code, _headers = update_with_http_info(phone_number_id, update_phone_number_request, opts)
+    def update_phone_number(phone_number_id, opts = {})
+      data, _status_code, _headers = update_phone_number_with_http_info(phone_number_id, opts)
       data
     end
 
     # Update a phone number
     # Updates a phone number
     # @param phone_number_id [String] The ID of the phone number to update
-    # @param update_phone_number_request [UpdatePhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [UpdatePhoneNumberRequest] :update_phone_number_request 
     # @return [Array<(PhoneNumber, Integer, Hash)>] PhoneNumber data, response status code and response headers
     # PATCH 
-    def update_with_http_info(phone_number_id, update_phone_number_request, opts = {})
+    def update_phone_number_with_http_info(phone_number_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PhoneNumbersApi.update_phone_number ...'
       end
@@ -246,10 +242,6 @@ module ClerkHttpClient
       if @api_client.config.client_side_validation && phone_number_id.nil?
         fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneNumbersApi.update_phone_number"
       end
-      # verify the required parameter 'update_phone_number_request' is set
-      if @api_client.config.client_side_validation && update_phone_number_request.nil?
-        fail ArgumentError, "Missing the required parameter 'update_phone_number_request' when calling PhoneNumbersApi.update_phone_number"
-      end
       # resource path
       local_var_path = '/phone_numbers/{phone_number_id}'.sub('{' + 'phone_number_id' + '}', CGI.escape(phone_number_id.to_s))
 
@@ -270,7 +262,7 @@ module ClerkHttpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_phone_number_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_phone_number_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'PhoneNumber'

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 Contact: support@clerk.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.9.0
+Generator version: unset
 
 =end
 
@@ -21,29 +21,25 @@ module ClerkHttpClient
     end
     # Verify the proxy configuration for your domain
     # This endpoint can be used to validate that a proxy-enabled domain is operational. It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API.  You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based configuration will not lead to downtime for your instance.  The `proxy_url` parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.
-    # @param verify_domain_proxy_request [VerifyDomainProxyRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [VerifyDomainProxyRequest] :verify_domain_proxy_request 
     # @return [ProxyCheck]
 
-    def verify(verify_domain_proxy_request, opts = {})
-      data, _status_code, _headers = verify_with_http_info(verify_domain_proxy_request, opts)
+    def verify_domain_proxy(opts = {})
+      data, _status_code, _headers = verify_domain_proxy_with_http_info(opts)
       data
     end
 
     # Verify the proxy configuration for your domain
     # This endpoint can be used to validate that a proxy-enabled domain is operational. It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API.  You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based configuration will not lead to downtime for your instance.  The `proxy_url` parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.
-    # @param verify_domain_proxy_request [VerifyDomainProxyRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [VerifyDomainProxyRequest] :verify_domain_proxy_request 
     # @return [Array<(ProxyCheck, Integer, Hash)>] ProxyCheck data, response status code and response headers
     # POST 
-    def verify_with_http_info(verify_domain_proxy_request, opts = {})
+    def verify_domain_proxy_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProxyChecksApi.verify_domain_proxy ...'
       end
-      # verify the required parameter 'verify_domain_proxy_request' is set
-      if @api_client.config.client_side_validation && verify_domain_proxy_request.nil?
-        fail ArgumentError, "Missing the required parameter 'verify_domain_proxy_request' when calling ProxyChecksApi.verify_domain_proxy"
-      end
       # resource path
       local_var_path = '/proxy_checks'
 
@@ -64,7 +60,7 @@ module ClerkHttpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(verify_domain_proxy_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'verify_domain_proxy_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'ProxyCheck'

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 Contact: support@clerk.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.9.0
+Generator version: unset
 
 =end
 
@@ -21,29 +21,25 @@ module ClerkHttpClient
     end
     # Create a redirect URL
     # Create a redirect URL
-    # @param create_redirect_url_request [CreateRedirectURLRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [CreateRedirectURLRequest] :create_redirect_url_request 
     # @return [RedirectURL]
 
-    def create(create_redirect_url_request, opts = {})
-      data, _status_code, _headers = create_with_http_info(create_redirect_url_request, opts)
+    def create_redirect_url(opts = {})
+      data, _status_code, _headers = create_redirect_url_with_http_info(opts)
       data
     end
 
     # Create a redirect URL
     # Create a redirect URL
-    # @param create_redirect_url_request [CreateRedirectURLRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [CreateRedirectURLRequest] :create_redirect_url_request 
     # @return [Array<(RedirectURL, Integer, Hash)>] RedirectURL data, response status code and response headers
     # POST 
-    def create_with_http_info(create_redirect_url_request, opts = {})
+    def create_redirect_url_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RedirectURLsApi.create_redirect_url ...'
       end
-      # verify the required parameter 'create_redirect_url_request' is set
-      if @api_client.config.client_side_validation && create_redirect_url_request.nil?
-        fail ArgumentError, "Missing the required parameter 'create_redirect_url_request' when calling RedirectURLsApi.create_redirect_url"
-      end
       # resource path
       local_var_path = '/redirect_urls'
 
@@ -64,7 +60,7 @@ module ClerkHttpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_redirect_url_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_redirect_url_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'RedirectURL'
@@ -95,8 +91,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [DeletedObject]
 
-    def delete(id, opts = {})
-      data, _status_code, _headers = delete_with_http_info(id, opts)
+    def delete_redirect_url(id, opts = {})
+      data, _status_code, _headers = delete_redirect_url_with_http_info(id, opts)
       data
     end
 
@@ -106,7 +102,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeletedObject, Integer, Hash)>] DeletedObject data, response status code and response headers
     # DELETE 
-    def delete_with_http_info(id, opts = {})
+    def delete_redirect_url_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RedirectURLsApi.delete_redirect_url ...'
       end
@@ -160,8 +156,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [RedirectURL]
 
-    def find(id, opts = {})
-      data, _status_code, _headers = find_with_http_info(id, opts)
+    def get_redirect_url(id, opts = {})
+      data, _status_code, _headers = get_redirect_url_with_http_info(id, opts)
       data
     end
 
@@ -171,7 +167,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(RedirectURL, Integer, Hash)>] RedirectURL data, response status code and response headers
     # GET 
-    def find_with_http_info(id, opts = {})
+    def get_redirect_url_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RedirectURLsApi.get_redirect_url ...'
       end
@@ -224,8 +220,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<RedirectURL>]
 
-    def all(opts = {})
-      data, _status_code, _headers = all_with_http_info(opts)
+    def list_redirect_urls(opts = {})
+      data, _status_code, _headers = list_redirect_urls_with_http_info(opts)
       data
     end
 
@@ -234,7 +230,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<RedirectURL>, Integer, Hash)>] Array<RedirectURL> data, response status code and response headers
     # GET array
-    def all_with_http_info(opts = {})
+    def list_redirect_urls_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RedirectURLsApi.list_redirect_urls ...'
       end

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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 Contact: support@clerk.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.9.0
+Generator version: unset
 
 =end
 
@@ -21,29 +21,25 @@ module ClerkHttpClient
     end
     # Create a SAML Connection
     # Create a new SAML Connection.
-    # @param create_saml_connection_request [CreateSAMLConnectionRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [CreateSAMLConnectionRequest] :create_saml_connection_request 
     # @return [SchemasSAMLConnection]
 
-    def create(create_saml_connection_request, opts = {})
-      data, _status_code, _headers = create_with_http_info(create_saml_connection_request, opts)
+    def create_saml_connection(opts = {})
+      data, _status_code, _headers = create_saml_connection_with_http_info(opts)
       data
     end
 
     # Create a SAML Connection
     # Create a new SAML Connection.
-    # @param create_saml_connection_request [CreateSAMLConnectionRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [CreateSAMLConnectionRequest] :create_saml_connection_request 
     # @return [Array<(SchemasSAMLConnection, Integer, Hash)>] SchemasSAMLConnection data, response status code and response headers
     # POST 
-    def create_with_http_info(create_saml_connection_request, opts = {})
+    def create_saml_connection_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SAMLConnectionsApi.create_saml_connection ...'
       end
-      # verify the required parameter 'create_saml_connection_request' is set
-      if @api_client.config.client_side_validation && create_saml_connection_request.nil?
-        fail ArgumentError, "Missing the required parameter 'create_saml_connection_request' when calling SAMLConnectionsApi.create_saml_connection"
-      end
       # resource path
       local_var_path = '/saml_connections'
 
@@ -64,7 +60,7 @@ module ClerkHttpClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_saml_connection_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'create_saml_connection_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'SchemasSAMLConnection'
@@ -95,8 +91,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [DeletedObject]
 
-    def delete(saml_connection_id, opts = {})
-      data, _status_code, _headers = delete_with_http_info(saml_connection_id, opts)
+    def delete_saml_connection(saml_connection_id, opts = {})
+      data, _status_code, _headers = delete_saml_connection_with_http_info(saml_connection_id, opts)
       data
     end
 
@@ -106,7 +102,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeletedObject, Integer, Hash)>] DeletedObject data, response status code and response headers
     # DELETE 
-    def delete_with_http_info(saml_connection_id, opts = {})
+    def delete_saml_connection_with_http_info(saml_connection_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SAMLConnectionsApi.delete_saml_connection ...'
       end
@@ -160,8 +156,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [SchemasSAMLConnection]
 
-    def find(saml_connection_id, opts = {})
-      data, _status_code, _headers = find_with_http_info(saml_connection_id, opts)
+    def get_saml_connection(saml_connection_id, opts = {})
+      data, _status_code, _headers = get_saml_connection_with_http_info(saml_connection_id, opts)
       data
     end
 
@@ -171,7 +167,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(SchemasSAMLConnection, Integer, Hash)>] SchemasSAMLConnection data, response status code and response headers
     # GET 
-    def find_with_http_info(saml_connection_id, opts = {})
+    def get_saml_connection_with_http_info(saml_connection_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SAMLConnectionsApi.get_saml_connection ...'
       end
@@ -224,10 +220,11 @@ module ClerkHttpClient
     # @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 [Array<String>] :organization_id Returns SAML connections that have an associated organization ID to the given organizations. For each organization id, the &#x60;+&#x60; and &#x60;-&#x60; can be prepended to the id, which denote whether the respective organization should be included or excluded from the result set. Accepts up to 100 organization ids.
     # @return [SAMLConnections]
 
-    def all(opts = {})
-      data, _status_code, _headers = all_with_http_info(opts)
+    def list_saml_connections(opts = {})
+      data, _status_code, _headers = list_saml_connections_with_http_info(opts)
       data
     end
 
@@ -236,9 +233,10 @@ module ClerkHttpClient
     # @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 [Array<String>] :organization_id Returns SAML connections that have an associated organization ID to the given organizations. For each organization id, the &#x60;+&#x60; and &#x60;-&#x60; can be prepended to the id, which denote whether the respective organization should be included or excluded from the result set. Accepts up to 100 organization ids.
     # @return [Array<(SAMLConnections, Integer, Hash)>] SAMLConnections data, response status code and response headers
     # GET 
-    def all_with_http_info(opts = {})
+    def list_saml_connections_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SAMLConnectionsApi.list_saml_connections ...'
       end
@@ -261,6 +259,7 @@ module ClerkHttpClient
       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[:'organization_id'] = @api_client.build_collection_param(opts[:'organization_id'], :multi) if !opts[:'organization_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -303,8 +302,8 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [SchemasSAMLConnection]
 
-    def update(saml_connection_id, update_saml_connection_request, opts = {})
-      data, _status_code, _headers = update_with_http_info(saml_connection_id, update_saml_connection_request, opts)
+    def update_saml_connection(saml_connection_id, update_saml_connection_request, opts = {})
+      data, _status_code, _headers = update_saml_connection_with_http_info(saml_connection_id, update_saml_connection_request, opts)
       data
     end
 
@@ -315,7 +314,7 @@ module ClerkHttpClient
     # @param [Hash] opts the optional parameters
     # @return [Array<(SchemasSAMLConnection, Integer, Hash)>] SchemasSAMLConnection data, response status code and response headers
     # PATCH 
-    def update_with_http_info(saml_connection_id, update_saml_connection_request, opts = {})
+    def update_saml_connection_with_http_info(saml_connection_id, update_saml_connection_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: SAMLConnectionsApi.update_saml_connection ...'
       end