clerk-http-client 1.0.0 → 2.0.0.beta2

data/docs/OrganizationsApi.md

@@ -16,50 +16,51 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## create_organization
 
-> <Organization> create_organization(create_organization_request)
+> <Organization> create_organization(opts)
 
 Create an organization
 
-Creates a new organization with the given name for an instance. In order to successfully create an organization you need to provide the ID of the User who will become the organization administrator. You can specify an optional slug for the new organization. If provided, the organization slug can contain only lowercase alphanumeric characters (letters and digits) and the dash \"-\". Organization slugs must be unique for the instance. You can provide additional metadata for the organization and set any custom attribute you want. Organizations support private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. The `created_by` user will see this as their [active organization] (https://clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don't explicitly set a different organization as active before then.
+Creates a new organization with the given name for an instance. You can specify an optional slug for the new organization. If provided, the organization slug can contain only lowercase alphanumeric characters (letters and digits) and the dash \"-\". Organization slugs must be unique for the instance. You can provide additional metadata for the organization and set any custom attribute you want. Organizations support private and public metadata. Private metadata can only be accessed from the Backend API. Public metadata can be accessed from the Backend API, and are read-only from the Frontend API. The `created_by` user will see this as their [active organization] (https://clerk.com/docs/organizations/overview#active-organization) the next time they create a session, presuming they don't explicitly set a different organization as active before then.
 
 ### Examples
 
 ```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::OrganizationsApi.new
-create_organization_request = ClerkHttpClient::CreateOrganizationRequest.new({name: 'name_example', created_by: 'created_by_example'}) # CreateOrganizationRequest | 
+opts = {
+  create_organization_request: ClerkHttpClient::CreateOrganizationRequest.new({name: 'name_example'}) # CreateOrganizationRequest | 
+}
 
 begin
   # Create an organization
-  result = api_instance.create_organization(create_organization_request)
+  result = Clerk::SDK.organizations.create_organization(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->create_organization: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->create_organization: #{e}"
 end
 ```
 
-#### Using the create_organization_with_http_info variant
+#### Using the `create_organization_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Organization>, Integer, Hash)> create_organization_with_http_info(create_organization_request)
+> <Array(<Organization>, Integer, Hash)> create_organization_with_http_info(opts)
 
 ```ruby
 begin
   # Create an organization
-  data, status_code, headers = api_instance.create_organization_with_http_info(create_organization_request)
+  data, status_code, headers = Clerk::SDK.organizations.create_organization_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Organization>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->create_organization_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->create_organization_with_http_info: #{e}"
 end
 ```
 
@@ -67,7 +68,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_organization_request** | [**CreateOrganizationRequest**](CreateOrganizationRequest.md) |  |  |
+| **create_organization_request** | [**CreateOrganizationRequest**](CreateOrganizationRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -95,26 +96,25 @@ Deletes the given organization. Please note that deleting an organization will a
 
 ```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::OrganizationsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization to delete
 
 begin
   # Delete an organization
-  result = api_instance.delete_organization(organization_id)
+  result = Clerk::SDK.organizations.delete_organization(organization_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->delete_organization: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->delete_organization: #{e}"
 end
 ```
 
-#### Using the delete_organization_with_http_info variant
+#### Using the `delete_organization_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -123,12 +123,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Delete an organization
-  data, status_code, headers = api_instance.delete_organization_with_http_info(organization_id)
+  data, status_code, headers = Clerk::SDK.organizations.delete_organization_with_http_info(organization_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DeletedObject>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->delete_organization_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->delete_organization_with_http_info: #{e}"
 end
 ```
 
@@ -164,26 +164,25 @@ Delete the organization's logo.
 
 ```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::OrganizationsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization for which the logo will be deleted.
 
 begin
   
-  result = api_instance.delete_organization_logo(organization_id)
+  result = Clerk::SDK.organizations.delete_organization_logo(organization_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->delete_organization_logo: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->delete_organization_logo: #{e}"
 end
 ```
 
-#### Using the delete_organization_logo_with_http_info variant
+#### Using the `delete_organization_logo_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -192,12 +191,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   
-  data, status_code, headers = api_instance.delete_organization_logo_with_http_info(organization_id)
+  data, status_code, headers = Clerk::SDK.organizations.delete_organization_logo_with_http_info(organization_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Organization>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->delete_organization_logo_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->delete_organization_logo_with_http_info: #{e}"
 end
 ```
 
@@ -233,14 +232,13 @@ Fetches the organization whose ID or slug matches the provided `id_or_slug` URL
 
 ```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::OrganizationsApi.new
 organization_id = 'organization_id_example' # String | The ID or slug of the organization
 opts = {
   include_members_count: true # Boolean | Flag to denote whether or not the organization's members count should be included in the response.
@@ -248,14 +246,14 @@ opts = {
 
 begin
   # Retrieve an organization by ID or slug
-  result = api_instance.get_organization(organization_id, opts)
+  result = Clerk::SDK.organizations.get_organization(organization_id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->get_organization: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->get_organization: #{e}"
 end
 ```
 
-#### Using the get_organization_with_http_info variant
+#### Using the `get_organization_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -264,12 +262,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve an organization by ID or slug
-  data, status_code, headers = api_instance.get_organization_with_http_info(organization_id, opts)
+  data, status_code, headers = Clerk::SDK.organizations.get_organization_with_http_info(organization_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Organization>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->get_organization_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->get_organization_with_http_info: #{e}"
 end
 ```
 
@@ -306,14 +304,13 @@ This request returns the list of organizations for an instance. Results can be p
 
 ```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::OrganizationsApi.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`.
@@ -324,14 +321,14 @@ opts = {
 
 begin
   # Get a list of organizations for an instance
-  result = api_instance.list_organizations(opts)
+  result = Clerk::SDK.organizations.list_organizations(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->list_organizations: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->list_organizations: #{e}"
 end
 ```
 
-#### Using the list_organizations_with_http_info variant
+#### Using the `list_organizations_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -340,12 +337,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Get a list of organizations for an instance
-  data, status_code, headers = api_instance.list_organizations_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.organizations.list_organizations_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Organizations>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->list_organizations_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->list_organizations_with_http_info: #{e}"
 end
 ```
 
@@ -385,27 +382,26 @@ Update organization metadata attributes by merging existing values with the prov
 
 ```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::OrganizationsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization for which metadata will be merged or updated
 merge_organization_metadata_request = ClerkHttpClient::MergeOrganizationMetadataRequest.new # MergeOrganizationMetadataRequest | 
 
 begin
   # Merge and update metadata for an organization
-  result = api_instance.merge_organization_metadata(organization_id, merge_organization_metadata_request)
+  result = Clerk::SDK.organizations.merge_organization_metadata(organization_id, merge_organization_metadata_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->merge_organization_metadata: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->merge_organization_metadata: #{e}"
 end
 ```
 
-#### Using the merge_organization_metadata_with_http_info variant
+#### Using the `merge_organization_metadata_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -414,12 +410,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Merge and update metadata for an organization
-  data, status_code, headers = api_instance.merge_organization_metadata_with_http_info(organization_id, merge_organization_metadata_request)
+  data, status_code, headers = Clerk::SDK.organizations.merge_organization_metadata_with_http_info(organization_id, merge_organization_metadata_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Organization>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->merge_organization_metadata_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->merge_organization_metadata_with_http_info: #{e}"
 end
 ```
 
@@ -456,27 +452,26 @@ Updates an existing 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::OrganizationsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization to update
 update_organization_request = ClerkHttpClient::UpdateOrganizationRequest.new # UpdateOrganizationRequest | 
 
 begin
   # Update an organization
-  result = api_instance.update_organization(organization_id, update_organization_request)
+  result = Clerk::SDK.organizations.update_organization(organization_id, update_organization_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->update_organization: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->update_organization: #{e}"
 end
 ```
 
-#### Using the update_organization_with_http_info variant
+#### Using the `update_organization_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -485,12 +480,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Update an organization
-  data, status_code, headers = api_instance.update_organization_with_http_info(organization_id, update_organization_request)
+  data, status_code, headers = Clerk::SDK.organizations.update_organization_with_http_info(organization_id, update_organization_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Organization>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->update_organization_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->update_organization_with_http_info: #{e}"
 end
 ```
 
@@ -527,14 +522,13 @@ Set or replace an organization's logo, by uploading an image file. This endpoint
 
 ```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::OrganizationsApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization for which to upload a logo
 file = File.new('/path/to/some/file') # File | 
 opts = {
@@ -543,14 +537,14 @@ opts = {
 
 begin
   # Upload a logo for the organization
-  result = api_instance.upload_organization_logo(organization_id, file, opts)
+  result = Clerk::SDK.organizations.upload_organization_logo(organization_id, file, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->upload_organization_logo: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->upload_organization_logo: #{e}"
 end
 ```
 
-#### Using the upload_organization_logo_with_http_info variant
+#### Using the `upload_organization_logo_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -559,12 +553,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Upload a logo for the organization
-  data, status_code, headers = api_instance.upload_organization_logo_with_http_info(organization_id, file, opts)
+  data, status_code, headers = Clerk::SDK.organizations.upload_organization_logo_with_http_info(organization_id, file, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationWithLogo>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationsApi->upload_organization_logo_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.organizations->upload_organization_logo_with_http_info: #{e}"
 end
 ```