clerk-http-client 1.0.0 → 2.0.0.beta2

data/docs/OrganizationMembership.md

@@ -9,8 +9,8 @@
 | **role** | **String** |  | [optional] |
 | **role_name** | **String** |  | [optional] |
 | **permissions** | **Array<String>** |  | [optional] |
-| **public_metadata** | **Object** | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the organization membership, accessible only from the Backend API | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization membership, accessible only from the Backend API | [optional] |
 | **organization** | [**Organization**](Organization.md) |  | [optional] |
 | **public_user_data** | [**OrganizationMembershipPublicUserData**](OrganizationMembershipPublicUserData.md) |  | [optional] |
 | **created_at** | **Integer** | Unix timestamp of creation. | [optional] |

data/docs/OrganizationMembershipsApi.md

@@ -24,27 +24,26 @@ Adds a user as a member to the given organization. Only users in the same instan
 
 ```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::OrganizationMembershipsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization where the new membership will be created
 create_organization_membership_request = ClerkHttpClient::CreateOrganizationMembershipRequest.new({user_id: 'user_id_example', role: 'role_example'}) # CreateOrganizationMembershipRequest | 
 
 begin
   # Create a new organization membership
-  result = api_instance.create_organization_membership(organization_id, create_organization_membership_request)
+  result = Clerk::SDK.organization_memberships.create_organization_membership(organization_id, create_organization_membership_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->create_organization_membership: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->create_organization_membership: #{e}"
 end
 ```
 
-#### Using the create_organization_membership_with_http_info variant
+#### Using the `create_organization_membership_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -53,12 +52,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Create a new organization membership
-  data, status_code, headers = api_instance.create_organization_membership_with_http_info(organization_id, create_organization_membership_request)
+  data, status_code, headers = Clerk::SDK.organization_memberships.create_organization_membership_with_http_info(organization_id, create_organization_membership_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationMembership>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->create_organization_membership_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->create_organization_membership_with_http_info: #{e}"
 end
 ```
 
@@ -95,27 +94,26 @@ Removes the given membership from the organization
 
 ```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::OrganizationMembershipsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization the membership belongs to
 user_id = 'user_id_example' # String | The ID of the user that this membership belongs to
 
 begin
   # Remove a member from an organization
-  result = api_instance.delete_organization_membership(organization_id, user_id)
+  result = Clerk::SDK.organization_memberships.delete_organization_membership(organization_id, user_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->delete_organization_membership: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->delete_organization_membership: #{e}"
 end
 ```
 
-#### Using the delete_organization_membership_with_http_info variant
+#### Using the `delete_organization_membership_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -124,12 +122,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Remove a member from an organization
-  data, status_code, headers = api_instance.delete_organization_membership_with_http_info(organization_id, user_id)
+  data, status_code, headers = Clerk::SDK.organization_memberships.delete_organization_membership_with_http_info(organization_id, user_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationMembership>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->delete_organization_membership_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->delete_organization_membership_with_http_info: #{e}"
 end
 ```
 
@@ -166,14 +164,13 @@ Retrieves all organization user memberships for the given instance.
 
 ```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::OrganizationMembershipsApi.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`.
@@ -182,14 +179,14 @@ opts = {
 
 begin
   # Get a list of all organization memberships within an instance.
-  result = api_instance.instance_get_organization_memberships(opts)
+  result = Clerk::SDK.organization_memberships.instance_get_organization_memberships(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->instance_get_organization_memberships: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->instance_get_organization_memberships: #{e}"
 end
 ```
 
-#### Using the instance_get_organization_memberships_with_http_info variant
+#### Using the `instance_get_organization_memberships_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -198,12 +195,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Get a list of all organization memberships within an instance.
-  data, status_code, headers = api_instance.instance_get_organization_memberships_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.organization_memberships.instance_get_organization_memberships_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationMemberships>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->instance_get_organization_memberships_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->instance_get_organization_memberships_with_http_info: #{e}"
 end
 ```
 
@@ -241,14 +238,13 @@ Retrieves all user memberships for the given organization
 
 ```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::OrganizationMembershipsApi.new
 organization_id = 'organization_id_example' # String | The organization ID.
 opts = {
   limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
@@ -258,14 +254,14 @@ opts = {
 
 begin
   # Get a list of all members of an organization
-  result = api_instance.list_organization_memberships(organization_id, opts)
+  result = Clerk::SDK.organization_memberships.list_organization_memberships(organization_id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->list_organization_memberships: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->list_organization_memberships: #{e}"
 end
 ```
 
-#### Using the list_organization_memberships_with_http_info variant
+#### Using the `list_organization_memberships_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -274,12 +270,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Get a list of all members of an organization
-  data, status_code, headers = api_instance.list_organization_memberships_with_http_info(organization_id, opts)
+  data, status_code, headers = Clerk::SDK.organization_memberships.list_organization_memberships_with_http_info(organization_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationMemberships>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->list_organization_memberships_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->list_organization_memberships_with_http_info: #{e}"
 end
 ```
 
@@ -318,28 +314,27 @@ Updates the properties of an existing organization membership
 
 ```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::OrganizationMembershipsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization the membership belongs to
 user_id = 'user_id_example' # String | The ID of the user that this membership belongs to
 update_organization_membership_request = ClerkHttpClient::UpdateOrganizationMembershipRequest.new({role: 'role_example'}) # UpdateOrganizationMembershipRequest | 
 
 begin
   # Update an organization membership
-  result = api_instance.update_organization_membership(organization_id, user_id, update_organization_membership_request)
+  result = Clerk::SDK.organization_memberships.update_organization_membership(organization_id, user_id, update_organization_membership_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->update_organization_membership: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->update_organization_membership: #{e}"
 end
 ```
 
-#### Using the update_organization_membership_with_http_info variant
+#### Using the `update_organization_membership_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -348,12 +343,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Update an organization membership
-  data, status_code, headers = api_instance.update_organization_membership_with_http_info(organization_id, user_id, update_organization_membership_request)
+  data, status_code, headers = Clerk::SDK.organization_memberships.update_organization_membership_with_http_info(organization_id, user_id, update_organization_membership_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationMembership>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->update_organization_membership_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->update_organization_membership_with_http_info: #{e}"
 end
 ```
 
@@ -381,7 +376,7 @@ end
 
 ## update_organization_membership_metadata
 
-> <OrganizationMembership> update_organization_membership_metadata(organization_id, user_id, update_organization_membership_metadata_request)
+> <OrganizationMembership> update_organization_membership_metadata(organization_id, user_id, opts)
 
 Merge and update organization membership metadata
 
@@ -391,42 +386,43 @@ Update an organization membership's metadata attributes by merging existing valu
 
 ```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::OrganizationMembershipsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization the membership belongs to
 user_id = 'user_id_example' # String | The ID of the user that this membership belongs to
-update_organization_membership_metadata_request = ClerkHttpClient::UpdateOrganizationMembershipMetadataRequest.new # UpdateOrganizationMembershipMetadataRequest | 
+opts = {
+  update_organization_membership_metadata_request: ClerkHttpClient::UpdateOrganizationMembershipMetadataRequest.new # UpdateOrganizationMembershipMetadataRequest | 
+}
 
 begin
   # Merge and update organization membership metadata
-  result = api_instance.update_organization_membership_metadata(organization_id, user_id, update_organization_membership_metadata_request)
+  result = Clerk::SDK.organization_memberships.update_organization_membership_metadata(organization_id, user_id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->update_organization_membership_metadata: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->update_organization_membership_metadata: #{e}"
 end
 ```
 
-#### Using the update_organization_membership_metadata_with_http_info variant
+#### Using the `update_organization_membership_metadata_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OrganizationMembership>, Integer, Hash)> update_organization_membership_metadata_with_http_info(organization_id, user_id, update_organization_membership_metadata_request)
+> <Array(<OrganizationMembership>, Integer, Hash)> update_organization_membership_metadata_with_http_info(organization_id, user_id, opts)
 
 ```ruby
 begin
   # Merge and update organization membership metadata
-  data, status_code, headers = api_instance.update_organization_membership_metadata_with_http_info(organization_id, user_id, update_organization_membership_metadata_request)
+  data, status_code, headers = Clerk::SDK.organization_memberships.update_organization_membership_metadata_with_http_info(organization_id, user_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationMembership>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationMembershipsApi->update_organization_membership_metadata_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organization_memberships->update_organization_membership_metadata_with_http_info: #{e}"
 end
 ```
 
@@ -436,7 +432,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **organization_id** | **String** | The ID of the organization the membership belongs to |  |
 | **user_id** | **String** | The ID of the user that this membership belongs to |  |
-| **update_organization_membership_metadata_request** | [**UpdateOrganizationMembershipMetadataRequest**](UpdateOrganizationMembershipMetadataRequest.md) |  |  |
+| **update_organization_membership_metadata_request** | [**UpdateOrganizationMembershipMetadataRequest**](UpdateOrganizationMembershipMetadataRequest.md) |  | [optional] |
 
 ### Return type
 

data/docs/OrganizationWithLogo.md

@@ -11,8 +11,8 @@
 | **members_count** | **Integer** |  | [optional] |
 | **max_allowed_memberships** | **Integer** |  |  |
 | **admin_delete_enabled** | **Boolean** |  | [optional] |
-| **public_metadata** | **Object** |  |  |
-| **private_metadata** | **Object** |  |  |
+| **public_metadata** | **Hash<String, Object>** |  |  |
+| **private_metadata** | **Hash<String, Object>** |  |  |
 | **created_by** | **String** |  | [optional] |
 | **created_at** | **Integer** | Unix timestamp of creation.  |  |
 | **updated_at** | **Integer** | Unix timestamp of last update.  |  |