clerk-http-client 0.0.1

data/docs/UpdateSAMLConnectionRequestAttributeMapping.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::UpdateSAMLConnectionRequestAttributeMapping
+
+## 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::UpdateSAMLConnectionRequestAttributeMapping.new(
+  user_id: null,
+  email_address: null,
+  first_name: null,
+  last_name: null
+)
+```
+

data/docs/UpdateSignUpRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::UpdateSignUpRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | The ID of the guest attempting to sign up as used in your external systems or your previous authentication solution. This will be copied to the resulting user when the sign-up is completed. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::UpdateSignUpRequest.new(
+  external_id: null
+)
+```
+

data/docs/UpdateUserMetadataRequest.md

@@ -0,0 +1,22 @@
+# ClerkHttpClient::UpdateUserMetadataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the user, that is visible to both your frontend and backend. The new object will be merged with the existing value. | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the user that is only visible to your backend. The new object will be merged with the existing value. | [optional] |
+| **unsafe_metadata** | **Hash<String, Object>** | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. The new object will be merged with the existing value.  Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::UpdateUserMetadataRequest.new(
+  public_metadata: null,
+  private_metadata: null,
+  unsafe_metadata: null
+)
+```
+

data/docs/UpdateUserRequest.md

@@ -0,0 +1,66 @@
+# ClerkHttpClient::UpdateUserRequest
+
+## 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] |
+| **primary_email_address_id** | **String** | The ID of the email address to set as primary. It must be verified, and present on the current user. | [optional] |
+| **notify_primary_email_address_changed** | **Boolean** | If set to `true`, the user will be notified that their primary email address has changed. By default, no notification is sent. | [optional][default to false] |
+| **primary_phone_number_id** | **String** | The ID of the phone number to set as primary. It must be verified, and present on the current user. | [optional] |
+| **primary_web3_wallet_id** | **String** | The ID of the web3 wallets to set as primary. It must be verified, and present on the current user. | [optional] |
+| **username** | **String** | The username to give to the user. It must be unique across your instance. | [optional] |
+| **profile_image_id** | **String** | The ID of the image to set as the user's profile image | [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** | Set it to `true` if you're updating the user's password and want to skip any password policy settings check. This parameter can only be used when providing a `password`. | [optional] |
+| **sign_out_of_other_sessions** | **Boolean** | Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`. | [optional] |
+| **totp_secret** | **String** | In case TOTP is configured on the instance, you can provide the secret to enable it on the specific 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 specific 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 true, the user can delete themselves with the Frontend API. | [optional] |
+| **create_organization_enabled** | **Boolean** | If true, the user can create organizations with the Frontend API. | [optional] |
+| **legal_accepted_at** | **String** | A custom timestamps 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_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::UpdateUserRequest.new(
+  external_id: null,
+  first_name: null,
+  last_name: null,
+  primary_email_address_id: null,
+  notify_primary_email_address_changed: null,
+  primary_phone_number_id: null,
+  primary_web3_wallet_id: null,
+  username: null,
+  profile_image_id: null,
+  password: null,
+  password_digest: null,
+  password_hasher: null,
+  skip_password_checks: null,
+  sign_out_of_other_sessions: null,
+  totp_secret: null,
+  backup_codes: null,
+  public_metadata: null,
+  private_metadata: null,
+  unsafe_metadata: null,
+  delete_self_enabled: null,
+  create_organization_enabled: null,
+  legal_accepted_at: null,
+  skip_legal_checks: null,
+  create_organizations_limit: null,
+  created_at: null
+)
+```
+

data/docs/UpsertTemplateRequest.md

@@ -0,0 +1,30 @@
+# ClerkHttpClient::UpsertTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The user-friendly name of the template | [optional] |
+| **subject** | **String** | The email subject. Applicable only to email templates. | [optional] |
+| **markup** | **String** | The editor markup used to generate the body of the template | [optional] |
+| **body** | **String** | The template body before variable interpolation | [optional] |
+| **delivered_by_clerk** | **Boolean** | Whether Clerk should deliver emails or SMS messages based on the current template | [optional] |
+| **from_email_name** | **String** | The local part of the From email address that will be used for emails. For example, in the address 'hello@example.com', the local part is 'hello'. Applicable only to email templates. | [optional] |
+| **reply_to_email_name** | **String** | The local part of the Reply To email address that will be used for emails. For example, in the address 'hello@example.com', the local part is 'hello'. Applicable only to email templates. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::UpsertTemplateRequest.new(
+  name: null,
+  subject: null,
+  markup: null,
+  body: null,
+  delivered_by_clerk: null,
+  from_email_name: null,
+  reply_to_email_name: null
+)
+```
+

data/docs/User.md

@@ -0,0 +1,94 @@
+# ClerkHttpClient::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value.  | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **primary_email_address_id** | **String** |  | [optional] |
+| **primary_phone_number_id** | **String** |  | [optional] |
+| **primary_web3_wallet_id** | **String** |  | [optional] |
+| **username** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **profile_image_url** | **String** |  | [optional] |
+| **image_url** | **String** |  | [optional] |
+| **has_image** | **Boolean** |  | [optional] |
+| **public_metadata** | **Object** |  | [optional] |
+| **private_metadata** | **Object** |  | [optional] |
+| **unsafe_metadata** | **Object** |  | [optional] |
+| **email_addresses** | [**Array<EmailAddress>**](EmailAddress.md) |  | [optional] |
+| **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
+| **web3_wallets** | [**Array<Web3Wallet>**](Web3Wallet.md) |  | [optional] |
+| **passkeys** | [**Array<SchemasPasskey>**](SchemasPasskey.md) |  | [optional] |
+| **password_enabled** | **Boolean** |  | [optional] |
+| **two_factor_enabled** | **Boolean** |  | [optional] |
+| **totp_enabled** | **Boolean** |  | [optional] |
+| **backup_code_enabled** | **Boolean** |  | [optional] |
+| **mfa_enabled_at** | **Integer** | Unix timestamp of when MFA was last enabled for this user. It should be noted that this field is not nullified if MFA is disabled.  | [optional] |
+| **mfa_disabled_at** | **Integer** | Unix timestamp of when MFA was last disabled for this user. It should be noted that this field is not nullified if MFA is enabled again.  | [optional] |
+| **external_accounts** | **Array<Object>** |  | [optional] |
+| **saml_accounts** | [**Array<SAMLAccount>**](SAMLAccount.md) |  | [optional] |
+| **last_sign_in_at** | **Integer** | Unix timestamp of last sign-in.  | [optional] |
+| **banned** | **Boolean** | Flag to denote whether user is banned or not.  | [optional] |
+| **locked** | **Boolean** | Flag to denote whether user is currently locked, i.e. restricted from signing in or not.  | [optional] |
+| **lockout_expires_in_seconds** | **Integer** | The number of seconds remaining until the lockout period expires for a locked user. A null value for a locked user indicates that lockout never expires.  | [optional] |
+| **verification_attempts_remaining** | **Integer** | The number of verification attempts remaining until the user is locked. Null if account lockout is not enabled. Note: if a user is locked explicitly via the Backend API, they may still have verification attempts remaining.  | [optional] |
+| **updated_at** | **Integer** | Unix timestamp of last update.  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation.  | [optional] |
+| **delete_self_enabled** | **Boolean** | If enabled, user can delete themselves via FAPI.  | [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] |
+| **last_active_at** | **Integer** | Unix timestamp of the latest session activity, with day precision.  | [optional] |
+| **legal_accepted_at** | **Integer** | Unix timestamp of when the user accepted the legal requirements.  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::User.new(
+  id: null,
+  object: null,
+  external_id: null,
+  primary_email_address_id: null,
+  primary_phone_number_id: null,
+  primary_web3_wallet_id: null,
+  username: null,
+  first_name: null,
+  last_name: null,
+  profile_image_url: null,
+  image_url: null,
+  has_image: null,
+  public_metadata: null,
+  private_metadata: null,
+  unsafe_metadata: null,
+  email_addresses: null,
+  phone_numbers: null,
+  web3_wallets: null,
+  passkeys: null,
+  password_enabled: null,
+  two_factor_enabled: null,
+  totp_enabled: null,
+  backup_code_enabled: null,
+  mfa_enabled_at: null,
+  mfa_disabled_at: null,
+  external_accounts: null,
+  saml_accounts: null,
+  last_sign_in_at: null,
+  banned: null,
+  locked: null,
+  lockout_expires_in_seconds: null,
+  verification_attempts_remaining: null,
+  updated_at: null,
+  created_at: null,
+  delete_self_enabled: null,
+  create_organization_enabled: null,
+  create_organizations_limit: null,
+  last_active_at: 1700690400000,
+  legal_accepted_at: 1700690400000
+)
+```
+