clerk-http-client 0.0.1

data/docs/CreateEmailAddressRequest.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::CreateEmailAddressRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The ID representing the user | [optional] |
+| **email_address** | **String** | The new email address. Must adhere to the RFC 5322 specification for email address format. | [optional] |
+| **verified** | **Boolean** | When created, the email address will be marked as verified. | [optional] |
+| **primary** | **Boolean** | Create this email address as the primary email address for the user. Default: false, unless it is the first email address. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateEmailAddressRequest.new(
+  user_id: null,
+  email_address: null,
+  verified: null,
+  primary: null
+)
+```
+

data/docs/CreateInvitationRequest.md

@@ -0,0 +1,28 @@
+# ClerkHttpClient::CreateInvitationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address the invitation will be sent to |  |
+| **public_metadata** | **Object** | Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | [optional] |
+| **redirect_url** | **String** | Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components. | [optional] |
+| **notify** | **Boolean** | Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true. | [optional][default to true] |
+| **ignore_existing** | **Boolean** | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | [optional][default to false] |
+| **expires_in_days** | **Integer** | The number of days the invitation will be valid for. By default, the invitation does not expire. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateInvitationRequest.new(
+  email_address: null,
+  public_metadata: null,
+  redirect_url: null,
+  notify: null,
+  ignore_existing: null,
+  expires_in_days: null
+)
+```
+

data/docs/CreateJWTTemplateRequest.md

@@ -0,0 +1,30 @@
+# ClerkHttpClient::CreateJWTTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | JWT template name | [optional] |
+| **claims** | **Object** | JWT template claims in JSON format | [optional] |
+| **lifetime** | **Float** | JWT token lifetime | [optional] |
+| **allowed_clock_skew** | **Float** | JWT token allowed clock skew | [optional] |
+| **custom_signing_key** | **Boolean** | Whether a custom signing key/algorithm is also provided for this template | [optional] |
+| **signing_algorithm** | **String** | The custom signing algorithm to use when minting JWTs | [optional] |
+| **signing_key** | **String** | The custom signing private key to use when minting JWTs | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateJWTTemplateRequest.new(
+  name: null,
+  claims: null,
+  lifetime: null,
+  allowed_clock_skew: null,
+  custom_signing_key: null,
+  signing_algorithm: null,
+  signing_key: null
+)
+```
+

data/docs/CreateOAuthApplicationRequest.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::CreateOAuthApplicationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new OAuth application |  |
+| **callback_url** | **String** | The callback URL of the new OAuth application |  |
+| **scopes** | **String** | Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces. | [optional][default to 'profile email'] |
+| **public** | **Boolean** | If true, this client is public and cannot securely store a client secret. Only the authorization code flow with proof key for code exchange (PKCE) may be used. Public clients cannot be updated to be confidential clients, and vice versa. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateOAuthApplicationRequest.new(
+  name: null,
+  callback_url: null,
+  scopes: profile email public_metadata,
+  public: null
+)
+```
+

data/docs/CreateOrganizationDomainRequest.md

@@ -0,0 +1,22 @@
+# ClerkHttpClient::CreateOrganizationDomainRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new domain | [optional] |
+| **enrollment_mode** | **String** | The enrollment_mode for the new domain. This can be `automatic_invitation`, `automatic_suggestion` or `manual_invitation` | [optional] |
+| **verified** | **Boolean** | The status of domain's verification. Defaults to true | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateOrganizationDomainRequest.new(
+  name: null,
+  enrollment_mode: null,
+  verified: null
+)
+```
+

data/docs/CreateOrganizationInvitationBulkRequestInner.md

@@ -0,0 +1,28 @@
+# ClerkHttpClient::CreateOrganizationInvitationBulkRequestInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address of the new member that is going to be invited to the organization |  |
+| **inviter_user_id** | **String** | The ID of the user that invites the new member to the organization. Must be an administrator in the organization. | [optional] |
+| **role** | **String** | The role of the new member in the organization. |  |
+| **public_metadata** | **Object** | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | [optional] |
+| **private_metadata** | **Object** | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | [optional] |
+| **redirect_url** | **String** | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateOrganizationInvitationBulkRequestInner.new(
+  email_address: null,
+  inviter_user_id: null,
+  role: null,
+  public_metadata: null,
+  private_metadata: null,
+  redirect_url: null
+)
+```
+

data/docs/CreateOrganizationInvitationRequest.md

@@ -0,0 +1,28 @@
+# ClerkHttpClient::CreateOrganizationInvitationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address of the new member that is going to be invited to the organization |  |
+| **inviter_user_id** | **String** | The ID of the user that invites the new member to the organization. Must be an administrator in the organization. | [optional] |
+| **role** | **String** | The role of the new member in the organization |  |
+| **public_metadata** | **Object** | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | [optional] |
+| **private_metadata** | **Object** | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | [optional] |
+| **redirect_url** | **String** | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateOrganizationInvitationRequest.new(
+  email_address: null,
+  inviter_user_id: null,
+  role: null,
+  public_metadata: null,
+  private_metadata: null,
+  redirect_url: null
+)
+```
+

data/docs/CreateOrganizationMembershipRequest.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::CreateOrganizationMembershipRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The ID of the user that will be added as a member in the organization. The user needs to exist in the same instance as the organization and must not be a member of the given organization already. |  |
+| **role** | **String** | The role that the new member will have in the organization. |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateOrganizationMembershipRequest.new(
+  user_id: null,
+  role: null
+)
+```
+

data/docs/CreateOrganizationRequest.md

@@ -0,0 +1,30 @@
+# ClerkHttpClient::CreateOrganizationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the new organization. May not contain URLs or HTML. |  |
+| **created_by** | **String** | The ID of the User who will become the administrator for the new organization |  |
+| **private_metadata** | **Object** | Metadata saved on the organization, accessible only from the Backend API | [optional] |
+| **public_metadata** | **Object** | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | [optional] |
+| **slug** | **String** | A slug for the new organization. Can contain only lowercase alphanumeric characters and the dash \"-\". Must be unique for the instance. | [optional] |
+| **max_allowed_memberships** | **Integer** | The maximum number of memberships allowed for this organization | [optional] |
+| **created_at** | **String** | A custom date/time denoting _when_ the organization was created, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateOrganizationRequest.new(
+  name: null,
+  created_by: null,
+  private_metadata: null,
+  public_metadata: null,
+  slug: null,
+  max_allowed_memberships: null,
+  created_at: null
+)
+```
+

data/docs/CreatePhoneNumberRequest.md

@@ -0,0 +1,26 @@
+# ClerkHttpClient::CreatePhoneNumberRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The ID representing the user | [optional] |
+| **phone_number** | **String** | The new phone number. Must adhere to the E.164 standard for phone number format. | [optional] |
+| **verified** | **Boolean** | When created, the phone number will be marked as verified. | [optional] |
+| **primary** | **Boolean** | Create this phone number as the primary phone number for the user. Default: false, unless it is the first phone number. | [optional] |
+| **reserved_for_second_factor** | **Boolean** | Create this phone number as reserved for multi-factor authentication. The phone number must also be verified. If there are no other reserved second factors, the phone number will be set as the default second factor. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreatePhoneNumberRequest.new(
+  user_id: null,
+  phone_number: null,
+  verified: null,
+  primary: null,
+  reserved_for_second_factor: null
+)
+```
+

data/docs/CreateRedirectURLRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::CreateRedirectURLRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The full url value prefixed with `https://` or a custom scheme e.g. `\"https://my-app.com/oauth-callback\"` or `\"my-app://oauth-callback\"` | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateRedirectURLRequest.new(
+  url: null
+)
+```
+

data/docs/CreateSAMLConnectionRequest.md

@@ -0,0 +1,34 @@
+# ClerkHttpClient::CreateSAMLConnectionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name to use as a label for this SAML Connection |  |
+| **domain** | **String** | The domain of your organization. Sign in flows using an email with this domain, will use this SAML Connection. |  |
+| **provider** | **String** | The IdP provider of the connection. |  |
+| **idp_entity_id** | **String** | The Entity ID as provided by the IdP | [optional] |
+| **idp_sso_url** | **String** | The Single-Sign On URL as provided by the IdP | [optional] |
+| **idp_certificate** | **String** | The X.509 certificate as provided by the IdP | [optional] |
+| **idp_metadata_url** | **String** | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties | [optional] |
+| **idp_metadata** | **String** | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | [optional] |
+| **attribute_mapping** | [**CreateSAMLConnectionRequestAttributeMapping**](CreateSAMLConnectionRequestAttributeMapping.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSAMLConnectionRequest.new(
+  name: null,
+  domain: null,
+  provider: null,
+  idp_entity_id: null,
+  idp_sso_url: null,
+  idp_certificate: null,
+  idp_metadata_url: null,
+  idp_metadata: null,
+  attribute_mapping: null
+)
+```
+

data/docs/CreateSAMLConnectionRequestAttributeMapping.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::CreateSAMLConnectionRequestAttributeMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSAMLConnectionRequestAttributeMapping.new(
+  user_id: null,
+  email_address: null,
+  first_name: null,
+  last_name: null
+)
+```
+

data/docs/CreateSessionTokenFromTemplate200Response.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::CreateSessionTokenFromTemplate200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **jwt** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSessionTokenFromTemplate200Response.new(
+  object: null,
+  jwt: null
+)
+```
+

data/docs/CreateSignInTokenRequest.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::CreateSignInTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The ID of the user that can use the newly created sign in token | [optional] |
+| **expires_in_seconds** | **Integer** | Optional parameter to specify the life duration of the sign in token in seconds. By default, the duration is 30 days. | [optional][default to 2592000] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSignInTokenRequest.new(
+  user_id: null,
+  expires_in_seconds: null
+)
+```
+

data/docs/CreateUserRequest.md

@@ -0,0 +1,62 @@
+# ClerkHttpClient::CreateUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. | [optional] |
+| **first_name** | **String** | The first name to assign to the user | [optional] |
+| **last_name** | **String** | The last name to assign to the user | [optional] |
+| **email_address** | **Array<String>** | Email addresses to add to the user. Must be unique across your instance. The first email address will be set as the user's primary email address. | [optional] |
+| **phone_number** | **Array<String>** | Phone numbers to add to the user. Must be unique across your instance. The first phone number will be set as the user's primary phone number. | [optional] |
+| **web3_wallet** | **Array<String>** | Web3 wallets to add to the user. Must be unique across your instance. The first wallet will be set as the user's primary wallet. | [optional] |
+| **username** | **String** | The username to give to the user. It must be unique across your instance. | [optional] |
+| **password** | **String** | The plaintext password to give the user. Must be at least 8 characters long, and can not be in any list of hacked passwords. | [optional] |
+| **password_digest** | **String** | In case you already have the password digests and not the passwords, you can use them for the newly created user via this property. The digests should be generated with one of the supported algorithms. The hashing algorithm can be specified using the `password_hasher` property. | [optional] |
+| **password_hasher** | **String** | The hashing algorithm that was used to generate the password digest.  The algorithms we support at the moment are [`bcrypt`](https://en.wikipedia.org/wiki/Bcrypt), [`bcrypt_sha256_django`](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [`md5`](https://en.wikipedia.org/wiki/MD5), `pbkdf2_sha1`, `pbkdf2_sha256`, [`pbkdf2_sha256_django`](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [`phpass`](https://www.openwall.com/phpass/), [`scrypt_firebase`](https://firebaseopensource.com/projects/firebase/scrypt/), [`scrypt_werkzeug`](https://werkzeug.palletsprojects.com/en/3.0.x/utils/#werkzeug.security.generate_password_hash), [`sha256`](https://en.wikipedia.org/wiki/SHA-2), and the [`argon2`](https://argon2.online/) variants: `argon2i` and `argon2id`.  Each of the supported hashers expects the incoming digest to be in a particular format. See the [Clerk docs](https://clerk.com/docs/references/backend/user/create-user) for more information. | [optional] |
+| **skip_password_checks** | **Boolean** | When set to `true` all password checks are skipped. It is recommended to use this method only when migrating plaintext passwords to Clerk. Upon migration the user base should be prompted to pick stronger password. | [optional] |
+| **skip_password_requirement** | **Boolean** | When set to `true`, `password` is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance. | [optional] |
+| **totp_secret** | **String** | In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. Please note that currently the supported options are: * Period: 30 seconds * Code length: 6 digits * Algorithm: SHA1 | [optional] |
+| **backup_codes** | **Array<String>** | If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest. | [optional] |
+| **public_metadata** | **Object** | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | [optional] |
+| **private_metadata** | **Object** | Metadata saved on the user, that is only visible to your Backend API | [optional] |
+| **unsafe_metadata** | **Object** | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | [optional] |
+| **delete_self_enabled** | **Boolean** | If enabled, user can delete themselves via FAPI.  | [optional] |
+| **legal_accepted_at** | **String** | A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | [optional] |
+| **skip_legal_checks** | **Boolean** | When set to `true` all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk. | [optional] |
+| **create_organization_enabled** | **Boolean** | If enabled, user can create organizations via FAPI.  | [optional] |
+| **create_organizations_limit** | **Integer** | The maximum number of organizations the user can create. 0 means unlimited.  | [optional] |
+| **created_at** | **String** | A custom date/time denoting _when_ the user signed up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateUserRequest.new(
+  external_id: null,
+  first_name: null,
+  last_name: null,
+  email_address: null,
+  phone_number: null,
+  web3_wallet: null,
+  username: null,
+  password: null,
+  password_digest: null,
+  password_hasher: null,
+  skip_password_checks: null,
+  skip_password_requirement: null,
+  totp_secret: null,
+  backup_codes: null,
+  public_metadata: null,
+  private_metadata: null,
+  unsafe_metadata: null,
+  delete_self_enabled: null,
+  legal_accepted_at: null,
+  skip_legal_checks: null,
+  create_organization_enabled: null,
+  create_organizations_limit: null,
+  created_at: null
+)
+```
+

data/docs/DeletedObject.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::DeletedObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  | [optional] |
+| **slug** | **String** |  | [optional] |
+| **deleted** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::DeletedObject.new(
+  object: null,
+  id: null,
+  slug: null,
+  deleted: null
+)
+```
+

data/docs/DisableMFA200Response.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::DisableMFA200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::DisableMFA200Response.new(
+  user_id: null
+)
+```
+

data/docs/Domain.md

@@ -0,0 +1,34 @@
+# ClerkHttpClient::Domain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **is_satellite** | **Boolean** |  |  |
+| **frontend_api_url** | **String** |  |  |
+| **accounts_portal_url** | **String** | Null for satellite domains.  | [optional] |
+| **proxy_url** | **String** |  | [optional] |
+| **development_origin** | **String** |  |  |
+| **cname_targets** | [**Array<CNameTarget>**](CNameTarget.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Domain.new(
+  object: null,
+  id: null,
+  name: null,
+  is_satellite: null,
+  frontend_api_url: null,
+  accounts_portal_url: null,
+  proxy_url: null,
+  development_origin: null,
+  cname_targets: null
+)
+```
+

data/docs/Domains.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::Domains
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Domain>**](Domain.md) |  |  |
+| **total_count** | **Integer** | Total number of domains  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Domains.new(
+  data: null,
+  total_count: null
+)
+```
+