clerk-http-client 1.0.0 → 2.0.0.beta2

data/docs/SAMLConnectionsApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## create_saml_connection
 
-> <SchemasSAMLConnection> create_saml_connection(create_saml_connection_request)
+> <SchemasSAMLConnection> create_saml_connection(opts)
 
 Create a SAML Connection
 
@@ -23,40 +23,41 @@ Create a new SAML Connection.
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::SAMLConnectionsApi.new
-create_saml_connection_request = ClerkHttpClient::CreateSAMLConnectionRequest.new({name: 'name_example', domain: 'domain_example', provider: 'saml_custom'}) # CreateSAMLConnectionRequest | 
+opts = {
+  create_saml_connection_request: ClerkHttpClient::CreateSAMLConnectionRequest.new({name: 'name_example', domain: 'domain_example', provider: 'saml_custom'}) # CreateSAMLConnectionRequest | 
+}
 
 begin
   # Create a SAML Connection
-  result = api_instance.create_saml_connection(create_saml_connection_request)
+  result = Clerk::SDK.saml_connections.create_saml_connection(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->create_saml_connection: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->create_saml_connection: #{e}"
 end
 ```
 
-#### Using the create_saml_connection_with_http_info variant
+#### Using the `create_saml_connection_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SchemasSAMLConnection>, Integer, Hash)> create_saml_connection_with_http_info(create_saml_connection_request)
+> <Array(<SchemasSAMLConnection>, Integer, Hash)> create_saml_connection_with_http_info(opts)
 
 ```ruby
 begin
   # Create a SAML Connection
-  data, status_code, headers = api_instance.create_saml_connection_with_http_info(create_saml_connection_request)
+  data, status_code, headers = Clerk::SDK.saml_connections.create_saml_connection_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SchemasSAMLConnection>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->create_saml_connection_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->create_saml_connection_with_http_info: #{e}"
 end
 ```
 
@@ -64,7 +65,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_saml_connection_request** | [**CreateSAMLConnectionRequest**](CreateSAMLConnectionRequest.md) |  |  |
+| **create_saml_connection_request** | [**CreateSAMLConnectionRequest**](CreateSAMLConnectionRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -92,26 +93,25 @@ Deletes the SAML Connection whose ID matches the provided `id` in the path.
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::SAMLConnectionsApi.new
 saml_connection_id = 'saml_connection_id_example' # String | The ID of the SAML Connection to delete
 
 begin
   # Delete a SAML Connection
-  result = api_instance.delete_saml_connection(saml_connection_id)
+  result = Clerk::SDK.saml_connections.delete_saml_connection(saml_connection_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->delete_saml_connection: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->delete_saml_connection: #{e}"
 end
 ```
 
-#### Using the delete_saml_connection_with_http_info variant
+#### Using the `delete_saml_connection_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -120,12 +120,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Delete a SAML Connection
-  data, status_code, headers = api_instance.delete_saml_connection_with_http_info(saml_connection_id)
+  data, status_code, headers = Clerk::SDK.saml_connections.delete_saml_connection_with_http_info(saml_connection_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DeletedObject>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->delete_saml_connection_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->delete_saml_connection_with_http_info: #{e}"
 end
 ```
 
@@ -161,26 +161,25 @@ Fetches the SAML Connection whose ID matches the provided `saml_connection_id` i
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::SAMLConnectionsApi.new
 saml_connection_id = 'saml_connection_id_example' # String | The ID of the SAML Connection
 
 begin
   # Retrieve a SAML Connection by ID
-  result = api_instance.get_saml_connection(saml_connection_id)
+  result = Clerk::SDK.saml_connections.get_saml_connection(saml_connection_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->get_saml_connection: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->get_saml_connection: #{e}"
 end
 ```
 
-#### Using the get_saml_connection_with_http_info variant
+#### Using the `get_saml_connection_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -189,12 +188,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve a SAML Connection by ID
-  data, status_code, headers = api_instance.get_saml_connection_with_http_info(saml_connection_id)
+  data, status_code, headers = Clerk::SDK.saml_connections.get_saml_connection_with_http_info(saml_connection_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SchemasSAMLConnection>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->get_saml_connection_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->get_saml_connection_with_http_info: #{e}"
 end
 ```
 
@@ -230,29 +229,29 @@ Returns the list of SAML Connections for an instance. Results can be paginated u
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::SAMLConnectionsApi.new
 opts = {
   limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
-  offset: 8.14 # Float | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
+  offset: 8.14, # Float | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
+  organization_id: ['inner_example'] # Array<String> | Returns SAML connections that have an associated organization ID to the given organizations. For each organization id, the `+` and `-` 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.
 }
 
 begin
   # Get a list of SAML Connections for an instance
-  result = api_instance.list_saml_connections(opts)
+  result = Clerk::SDK.saml_connections.list_saml_connections(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->list_saml_connections: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->list_saml_connections: #{e}"
 end
 ```
 
-#### Using the list_saml_connections_with_http_info variant
+#### Using the `list_saml_connections_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -261,12 +260,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Get a list of SAML Connections for an instance
-  data, status_code, headers = api_instance.list_saml_connections_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.saml_connections.list_saml_connections_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SAMLConnections>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->list_saml_connections_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->list_saml_connections_with_http_info: #{e}"
 end
 ```
 
@@ -276,6 +275,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **limit** | **Float** | Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. | [optional][default to 10] |
 | **offset** | **Float** | 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;. | [optional][default to 0] |
+| **organization_id** | [**Array&lt;String&gt;**](String.md) | 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. | [optional] |
 
 ### Return type
 
@@ -303,27 +303,26 @@ Updates the SAML Connection whose ID matches the provided `id` in the path.
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::SAMLConnectionsApi.new
 saml_connection_id = 'saml_connection_id_example' # String | The ID of the SAML Connection to update
 update_saml_connection_request = ClerkHttpClient::UpdateSAMLConnectionRequest.new # UpdateSAMLConnectionRequest | 
 
 begin
   # Update a SAML Connection
-  result = api_instance.update_saml_connection(saml_connection_id, update_saml_connection_request)
+  result = Clerk::SDK.saml_connections.update_saml_connection(saml_connection_id, update_saml_connection_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->update_saml_connection: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->update_saml_connection: #{e}"
 end
 ```
 
-#### Using the update_saml_connection_with_http_info variant
+#### Using the `update_saml_connection_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -332,12 +331,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Update a SAML Connection
-  data, status_code, headers = api_instance.update_saml_connection_with_http_info(saml_connection_id, update_saml_connection_request)
+  data, status_code, headers = Clerk::SDK.saml_connections.update_saml_connection_with_http_info(saml_connection_id, update_saml_connection_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SchemasSAMLConnection>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SAMLConnectionsApi->update_saml_connection_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.saml_connections->update_saml_connection_with_http_info: #{e}"
 end
 ```
 

data/docs/SchemasSAMLConnection.md

@@ -16,6 +16,7 @@
 | **acs_url** | **String** |  |  |
 | **sp_entity_id** | **String** |  |  |
 | **sp_metadata_url** | **String** |  |  |
+| **organization_id** | **String** |  | [optional] |
 | **attribute_mapping** | [**SchemasSAMLConnectionAttributeMapping**](SchemasSAMLConnectionAttributeMapping.md) |  | [optional] |
 | **active** | **Boolean** |  |  |
 | **provider** | **String** |  |  |
@@ -45,6 +46,7 @@ instance = ClerkHttpClient::SchemasSAMLConnection.new(
   acs_url: null,
   sp_entity_id: null,
   sp_metadata_url: null,
+  organization_id: null,
   attribute_mapping: null,
   active: null,
   provider: null,