LukeParke/clerk-sdk-java
1
0
Fork 0
mirror of https://github.com/LukeHagar/clerk-sdk-java.git synced 2025-12-06 04:19:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

initial commit with code

Browse Source
This commit is contained in:
Kyle MacDonald
2024-06-13 13:51:50 -04:00
parent 0d66e8ff7b
commit 0d763fc89a
1109 changed files with 130690 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.gitattributes vendored Normal file
View File

@@ -0,0 +1,12 @@
#
# https://help.github.com/articles/dealing-with-line-endings/
#
# Linux start script should use lf
/gradlew text eol=lf
# These are Windows script files and should use crlf
*.bat text eol=crlf
# This allows generated code to be indexed correctly
*.java linguist-generated=false

25
.github/workflows/sdk_generation.yaml vendored Normal file
View File

@@ -0,0 +1,25 @@
name: Generate
permissions:
checks: write
contents: write
pull-requests: write
statuses: write
"on":
workflow_dispatch:
inputs:
force:
description: Force generation of SDKs
type: boolean
default: false
schedule:
- cron: 0 0 * * *
jobs:
generate:
uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15
with:
force: ${{ github.event.inputs.force }}
mode: pr
speakeasy_version: latest
secrets:
github_access_token: ${{ secrets.GITHUB_TOKEN }}
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}

9
.gitignore vendored Normal file
View File

@@ -0,0 +1,9 @@
# Ignore Gradle project-specific cache directory
.gradle
# Ignore Gradle build output directory
build
bin/
# Ignore IDE-specific configs
.project
.settings/
.DS_Store

1129
.speakeasy/gen.lock Executable file
View File

File diff suppressed because it is too large Load Diff

38
.speakeasy/gen.yaml Executable file
View File

@@ -0,0 +1,38 @@
configVersion: 2.0.0
generation:
sdkClassName: Clerk
maintainOpenAPIOrder: true
usageSnippets:
optionalPropertyRendering: withExample
useClassNamesForArrayFields: true
fixes:
nameResolutionDec2023: true
parameterOrderingFeb2024: true
requestResponseComponentNamesFeb2024: true
auth:
oAuth2ClientCredentialsEnabled: true
java:
version: 0.0.1
additionalDependencies: []
additionalPlugins: []
artifactID: backend-api
clientServerStatusCodesAsErrors: true
companyEmail: info@mycompany.com
companyName: My Company
companyURL: www.mycompany.com
flattenGlobalSecurity: true
githubURL: github.com/owner/repo
groupID: com.clerk
imports:
option: openapi
paths:
callbacks: models/callbacks
errors: models/errors
operations: models/operations
shared: models/components
webhooks: models/webhooks
inputModelSuffix: input
maxMethodParams: 4
outputModelSuffix: output
projectName: openapi
templateVersion: v2

27
.speakeasy/workflow.lock Normal file
View File

@@ -0,0 +1,27 @@
speakeasyVersion: 1.307.1
sources:
clerk-java-sdk:
sourceNamespace: clerk-java-sdk
sourceRevisionDigest: sha256:671a76348ffa42f50e48f36d00117419df09deedf8c407f5998533e01a8b64cb
sourceBlobDigest: sha256:e23b66a7b10f867245e42a1cd46af66f9ebee2db346f6a3bfcec0aa79ae2ac86
tags:
- latest
targets:
my-first-target:
source: clerk-java-sdk
sourceNamespace: clerk-java-sdk
sourceRevisionDigest: sha256:671a76348ffa42f50e48f36d00117419df09deedf8c407f5998533e01a8b64cb
sourceBlobDigest: sha256:e23b66a7b10f867245e42a1cd46af66f9ebee2db346f6a3bfcec0aa79ae2ac86
outLocation: /Users/kylemac/Sites/clerk/java-sdk/~/Sites/clerk/java-sdk
workflow:
workflowVersion: 1.0.0
sources:
clerk-java-sdk:
inputs:
- location: ../../../../openapi.yml
registry:
location: registry.speakeasyapi.dev/clerk/clerk/clerk-java-sdk
targets:
my-first-target:
target: java
source: clerk-java-sdk

11
.speakeasy/workflow.yaml Normal file
View File

@@ -0,0 +1,11 @@
workflowVersion: 1.0.0
sources:
clerk-java-sdk:
inputs:
- location: ../../../../openapi.yml
registry:
location: registry.speakeasyapi.dev/clerk/clerk/clerk-java-sdk
targets:
my-first-target:
target: java
source: clerk-java-sdk

112
USAGE.md Normal file
View File

@@ -0,0 +1,112 @@
<!-- Start SDK Example Usage [usage] -->
```java
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
GetClientListResponse res = sdk.clients().list()
.limit(10L)
.offset(0L)
.call();
while (true) {
if (res.clientList().isPresent()) {
// handle response
Optional<GetClientListResponse> nextRes = res.next();
if (nextRes.isPresent()) {
res = nextRes.get();
} else {
break;
}
}
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (com.clerk.backend_api.models.errors.SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
```
### Create Actor Tokens
This example shows how to create an actor token that can be used to impersonate the given user.
```java
package hello.world;
import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.components.*;
import com.clerk.backend_api.models.components.Security;
import com.clerk.backend_api.models.operations.*;
import com.clerk.backend_api.utils.EventStream;
import java.math.BigDecimal;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import org.openapitools.jackson.nullable.JsonNullable;
import static java.util.Map.entry;
public class Application {
public static void main(String[] args) throws Exception {
try {
Clerk sdk = Clerk.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
CreateActorTokenRequestBody req = CreateActorTokenRequestBody.builder()
.userId("<value>")
.actor(java.util.Map.ofEntries(
entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb")))
.build();
CreateActorTokenResponse res = sdk.actors().createToken()
.request(req)
.call();
if (res.actorToken().isPresent()) {
// handle response
}
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
// handle exception
throw e;
} catch (com.clerk.backend_api.models.errors.SDKError e) {
// handle exception
throw e;
} catch (Exception e) {
// handle exception
throw e;
}
}
}
```
<!-- End SDK Example Usage [usage] -->

4
build-extras.gradle Normal file
View File

@@ -0,0 +1,4 @@
// This file
// * is referred to in an `apply from` command in `build.gradle`
// * can be used to customise `build.gradle`
// * is generated once and not overwritten in SDK generation updates

43
build.gradle Normal file
View File

@@ -0,0 +1,43 @@
////////////////////////////////////////////////////////////////////////////////////////////
// This file is generated by Speakeasy and any edits will be lost in generation updates.
//
// If you wish to customize this file then place those customizations in `build-extras.gradle` which
// is not touched by generation updates.
//
// Additions to the plugins block can be made by setting the `additionalPlugins` property (an array
// of string where each string value is an additional line in the block) in gen.yaml.
////////////////////////////////////////////////////////////////////////////////////////////
plugins {
// Apply the java-library plugin for API and implementation separation.
id 'java-library'
}
compileJava.options.encoding = "UTF-8"
compileJava.options.compilerArgs += '-Xlint:unchecked'
compileTestJava.options.encoding = "UTF-8"
repositories {
// Use Maven Central for resolving dependencies.
mavenCentral()
}
tasks.withType(Javadoc) {
failOnError false
options.addStringOption('Xdoclint:none', '-quiet')
}
dependencies {
implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.0'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.0'
implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.17.0'
implementation 'org.openapitools:jackson-databind-nullable:0.2.6'
implementation 'org.apache.httpcomponents:httpclient:4.5.14'
implementation 'org.apache.httpcomponents:httpmime:4.5.14'
implementation 'commons-io:commons-io:2.15.1'
implementation 'com.jayway.jsonpath:json-path:2.9.0'
}
apply from: 'build-extras.gradle'

7
docs/models/components/Actor.md Normal file
View File

@@ -0,0 +1,7 @@
# Actor
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

16
docs/models/components/ActorToken.md Normal file
View File

@@ -0,0 +1,16 @@
# ActorToken
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.ActorTokenObject](../../models/components/ActorTokenObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `status` | [com.clerk.backend_api.models.components.ActorTokenStatus](../../models/components/ActorTokenStatus.md) | :heavy_check_mark: | N/A |
| `userId` | *String* | :heavy_check_mark: | N/A |
| `actor` | [com.clerk.backend_api.models.components.ActorTokenActor](../../models/components/ActorTokenActor.md) | :heavy_check_mark: | N/A |
| `token` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A |
| `url` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |

7
docs/models/components/ActorTokenActor.md Normal file
View File

@@ -0,0 +1,7 @@
# ActorTokenActor
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

8
docs/models/components/ActorTokenObject.md Normal file
View File

@@ -0,0 +1,8 @@
# ActorTokenObject
## Values
| Name | Value |
| ------------- | ------------- |
| `ACTOR_TOKEN` | actor_token |

10
docs/models/components/ActorTokenStatus.md Normal file
View File

@@ -0,0 +1,10 @@
# ActorTokenStatus
## Values
| Name | Value |
| ---------- | ---------- |
| `PENDING` | pending |
| `ACCEPTED` | accepted |
| `REVOKED` | revoked |

11
docs/models/components/Admin.md Normal file
View File

@@ -0,0 +1,11 @@
# Admin
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `status` | [com.clerk.backend_api.models.components.AdminVerificationStatus](../../models/components/AdminVerificationStatus.md) | :heavy_check_mark: | N/A |
| `strategy` | [com.clerk.backend_api.models.components.VerificationStrategy](../../models/components/VerificationStrategy.md) | :heavy_check_mark: | N/A |
| `attempts` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | N/A |
| `expireAt` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | N/A |

8
docs/models/components/AdminVerificationPhoneNumberStatus.md Normal file
View File

@@ -0,0 +1,8 @@
# AdminVerificationPhoneNumberStatus
## Values
| Name | Value |
| ---------- | ---------- |
| `VERIFIED` | verified |

8
docs/models/components/AdminVerificationStatus.md Normal file
View File

@@ -0,0 +1,8 @@
# AdminVerificationStatus
## Values
| Name | Value |
| ---------- | ---------- |
| `VERIFIED` | verified |

8
docs/models/components/AdminVerificationStrategy.md Normal file
View File

@@ -0,0 +1,8 @@
# AdminVerificationStrategy
## Values
| Name | Value |
| ------- | ------- |
| `ADMIN` | admin |

8
docs/models/components/AdminVerificationWeb3WalletStatus.md Normal file
View File

@@ -0,0 +1,8 @@
# AdminVerificationWeb3WalletStatus
## Values
| Name | Value |
| ---------- | ---------- |
| `VERIFIED` | verified |

8
docs/models/components/AdminVerificationWeb3WalletStrategy.md Normal file
View File

@@ -0,0 +1,8 @@
# AdminVerificationWeb3WalletStrategy
## Values
| Name | Value |
| ------- | ------- |
| `ADMIN` | admin |

15
docs/models/components/AllowlistIdentifier.md Normal file
View File

@@ -0,0 +1,15 @@
# AllowlistIdentifier
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [Optional<? extends com.clerk.backend_api.models.components.AllowlistIdentifierObject>](../../models/components/AllowlistIdentifierObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.<br/> |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `invitationId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | An email address or a phone number.<br/> |
| `identifierType` | [Optional<? extends com.clerk.backend_api.models.components.IdentifierType>](../../models/components/IdentifierType.md) | :heavy_minus_sign: | N/A |
| `instanceId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of creation<br/> |
| `updatedAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last update.<br/> |

11
docs/models/components/AllowlistIdentifierObject.md Normal file
View File

@@ -0,0 +1,11 @@
# AllowlistIdentifierObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ---------------------- | ---------------------- |
| `ALLOWLIST_IDENTIFIER` | allowlist_identifier |

11
docs/models/components/AttributeMapping.md Normal file
View File

@@ -0,0 +1,11 @@
# AttributeMapping
## Fields
| Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `userId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `emailAddress` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `firstName` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `lastName` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |

14
docs/models/components/BlocklistIdentifier.md Normal file
View File

@@ -0,0 +1,14 @@
# BlocklistIdentifier
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [Optional<? extends com.clerk.backend_api.models.components.BlocklistIdentifierObject>](../../models/components/BlocklistIdentifierObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.<br/> |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `identifier` | *Optional<? extends String>* | :heavy_minus_sign: | An email address, email domain, phone number or web3 wallet.<br/> |
| `identifierType` | [Optional<? extends com.clerk.backend_api.models.components.BlocklistIdentifierIdentifierType>](../../models/components/BlocklistIdentifierIdentifierType.md) | :heavy_minus_sign: | N/A |
| `instanceId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of creation<br/> |
| `updatedAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last update.<br/> |

10
docs/models/components/BlocklistIdentifierIdentifierType.md Normal file
View File

@@ -0,0 +1,10 @@
# BlocklistIdentifierIdentifierType
## Values
| Name | Value |
| --------------- | --------------- |
| `EMAIL_ADDRESS` | email_address |
| `PHONE_NUMBER` | phone_number |
| `WEB3_WALLET` | web3_wallet |

11
docs/models/components/BlocklistIdentifierObject.md Normal file
View File

@@ -0,0 +1,11 @@
# BlocklistIdentifierObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ---------------------- | ---------------------- |
| `BLOCKLIST_IDENTIFIER` | blocklist_identifier |

9
docs/models/components/BlocklistIdentifiers.md Normal file
View File

@@ -0,0 +1,9 @@
# BlocklistIdentifiers
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `data` | List<[com.clerk.backend_api.models.components.BlocklistIdentifier](../../models/components/BlocklistIdentifier.md)> | :heavy_check_mark: | N/A |
| `totalCount` | *long* | :heavy_check_mark: | Total number of blocklist identifiers<br/> |

10
docs/models/components/CNameTarget.md Normal file
View File

@@ -0,0 +1,10 @@
# CNameTarget
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `host` | *String* | :heavy_check_mark: | N/A |
| `value` | *String* | :heavy_check_mark: | N/A |
| `required` | *boolean* | :heavy_check_mark: | Denotes whether this CNAME target is required to be set in order for the domain to be considered deployed.<br/> |

7
docs/models/components/Claims.md Normal file
View File

@@ -0,0 +1,7 @@
# Claims
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

12
docs/models/components/ClerkError.md Normal file
View File

@@ -0,0 +1,12 @@
# ClerkError
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `message` | *String* | :heavy_check_mark: | N/A |
| `longMessage` | *String* | :heavy_check_mark: | N/A |
| `code` | *String* | :heavy_check_mark: | N/A |
| `meta` | [Optional<? extends com.clerk.backend_api.models.components.Meta>](../../models/components/Meta.md) | :heavy_minus_sign: | N/A |
| `clerkTraceId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |

7
docs/models/components/ClerkErrorErrorMeta.md Normal file
View File

@@ -0,0 +1,7 @@
# ClerkErrorErrorMeta
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

16
docs/models/components/Client.md Normal file
View File

@@ -0,0 +1,16 @@
# Client
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.Object](../../models/components/Object.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.<br/> |
| `id` | *String* | :heavy_check_mark: | String representing the identifier of the session.<br/> |
| `sessionIds` | List<*String*> | :heavy_check_mark: | N/A |
| `sessions` | List<[com.clerk.backend_api.models.components.Session](../../models/components/Session.md)> | :heavy_check_mark: | N/A |
| `signInId` | *Optional<? extends String>* | :heavy_check_mark: | N/A |
| `signUpId` | *Optional<? extends String>* | :heavy_check_mark: | N/A |
| `lastActiveSessionId` | *Optional<? extends String>* | :heavy_check_mark: | Last active session_id.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |

11
docs/models/components/DeletedObject.md Normal file
View File

@@ -0,0 +1,11 @@
# DeletedObject
## Fields
| Field | Type | Required | Description |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `object` | *String* | :heavy_check_mark: | N/A |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `slug` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `deleted` | *boolean* | :heavy_check_mark: | N/A |

16
docs/models/components/Domain.md Normal file
View File

@@ -0,0 +1,16 @@
# Domain
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.DomainObject](../../models/components/DomainObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `isSatellite` | *boolean* | :heavy_check_mark: | N/A |
| `frontendApiUrl` | *String* | :heavy_check_mark: | N/A |
| `accountsPortalUrl` | *JsonNullable<? extends String>* | :heavy_minus_sign: | Null for satellite domains.<br/> |
| `proxyUrl` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A |
| `developmentOrigin` | *String* | :heavy_check_mark: | N/A |
| `cnameTargets` | List<[com.clerk.backend_api.models.components.CNameTarget](../../models/components/CNameTarget.md)> | :heavy_minus_sign: | N/A |

8
docs/models/components/DomainObject.md Normal file
View File

@@ -0,0 +1,8 @@
# DomainObject
## Values
| Name | Value |
| -------- | -------- |
| `DOMAIN` | domain |

9
docs/models/components/Domains.md Normal file
View File

@@ -0,0 +1,9 @@
# Domains
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `data` | List<[com.clerk.backend_api.models.components.Domain](../../models/components/Domain.md)> | :heavy_check_mark: | N/A |
| `totalCount` | *long* | :heavy_check_mark: | Total number of domains<br/> |

10
docs/models/components/DomainsEnrollmentModes.md Normal file
View File

@@ -0,0 +1,10 @@
# DomainsEnrollmentModes
## Values
| Name | Value |
| ---------------------- | ---------------------- |
| `MANUAL_INVITATION` | manual_invitation |
| `AUTOMATIC_INVITATION` | automatic_invitation |
| `AUTOMATIC_SUGGESTION` | automatic_suggestion |

15
docs/models/components/EmailAddress.md Normal file
View File

@@ -0,0 +1,15 @@
# EmailAddress
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `object` | [com.clerk.backend_api.models.components.EmailAddressObject](../../models/components/EmailAddressObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.<br/> |
| `emailAddress` | *String* | :heavy_check_mark: | N/A |
| `reserved` | *boolean* | :heavy_check_mark: | N/A |
| `verification` | [Optional<? extends com.clerk.backend_api.models.components.Verification>](../../models/components/Verification.md) | :heavy_check_mark: | N/A |
| `linkedTo` | List<[com.clerk.backend_api.models.components.IdentificationLink](../../models/components/IdentificationLink.md)> | :heavy_check_mark: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation<br/> |

11
docs/models/components/EmailAddressObject.md Normal file
View File

@@ -0,0 +1,11 @@
# EmailAddressObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| --------------- | --------------- |
| `EMAIL_ADDRESS` | email_address |

2
docs/models/components/Error.md Normal file
View File

@@ -0,0 +1,2 @@
# Error

12
docs/models/components/ErrorClerkError.md Normal file
View File

@@ -0,0 +1,12 @@
# ErrorClerkError
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `message` | *String* | :heavy_check_mark: | N/A |
| `longMessage` | *String* | :heavy_check_mark: | N/A |
| `code` | *String* | :heavy_check_mark: | N/A |
| `meta` | [Optional<? extends com.clerk.backend_api.models.components.ErrorMeta>](../../models/components/ErrorMeta.md) | :heavy_minus_sign: | N/A |
| `clerkTraceId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |

7
docs/models/components/ErrorMeta.md Normal file
View File

@@ -0,0 +1,7 @@
# ErrorMeta
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/models/components/ExternalAccount.md Normal file
View File

@@ -0,0 +1,7 @@
# ExternalAccount
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/models/components/ExternalAccounts.md Normal file
View File

@@ -0,0 +1,7 @@
# ExternalAccounts
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/models/components/IdentificationLink.md Normal file
View File

@@ -0,0 +1,9 @@
# IdentificationLink
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `type` | [com.clerk.backend_api.models.components.Type](../../models/components/Type.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |

10
docs/models/components/IdentifierType.md Normal file
View File

@@ -0,0 +1,10 @@
# IdentifierType
## Values
| Name | Value |
| --------------- | --------------- |
| `EMAIL_ADDRESS` | email_address |
| `PHONE_NUMBER` | phone_number |
| `WEB3_WALLET` | web3_wallet |

12
docs/models/components/InstanceRestrictions.md Normal file
View File

@@ -0,0 +1,12 @@
# InstanceRestrictions
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [Optional<? extends com.clerk.backend_api.models.components.InstanceRestrictionsObject>](../../models/components/InstanceRestrictionsObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. |
| `allowlist` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `blocklist` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `blockEmailSubaddresses` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `ignoreDotsForGmailAddresses` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |

10
docs/models/components/InstanceRestrictionsObject.md Normal file
View File

@@ -0,0 +1,10 @@
# InstanceRestrictionsObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ----------------------- | ----------------------- |
| `INSTANCE_RESTRICTIONS` | instance_restrictions |

13
docs/models/components/InstanceSettings.md Normal file
View File

@@ -0,0 +1,13 @@
# InstanceSettings
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [Optional<? extends com.clerk.backend_api.models.components.InstanceSettingsObject>](../../models/components/InstanceSettingsObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `restrictedToAllowlist` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `fromEmailAddress` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `progressiveSignUp` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `enhancedEmailDeliverability` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |

10
docs/models/components/InstanceSettingsObject.md Normal file
View File

@@ -0,0 +1,10 @@
# InstanceSettingsObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ------------------- | ------------------- |
| `INSTANCE_SETTINGS` | instance_settings |

16
docs/models/components/Invitation.md Normal file
View File

@@ -0,0 +1,16 @@
# Invitation
## Fields
| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.InvitationObject](../../models/components/InvitationObject.md) | :heavy_check_mark: | N/A | |
| `id` | *String* | :heavy_check_mark: | N/A | |
| `emailAddress` | *String* | :heavy_check_mark: | N/A | |
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.components.InvitationPublicMetadata>](../../models/components/InvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | |
| `revoked` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | false |
| `status` | [com.clerk.backend_api.models.components.InvitationStatus](../../models/components/InvitationStatus.md) | :heavy_check_mark: | N/A | pending |
| `url` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> | |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> | |

8
docs/models/components/InvitationObject.md Normal file
View File

@@ -0,0 +1,8 @@
# InvitationObject
## Values
| Name | Value |
| ------------ | ------------ |
| `INVITATION` | invitation |

7
docs/models/components/InvitationPublicMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# InvitationPublicMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

16
docs/models/components/InvitationRevoked.md Normal file
View File

@@ -0,0 +1,16 @@
# InvitationRevoked
## Fields
| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.InvitationRevokedObject](../../models/components/InvitationRevokedObject.md) | :heavy_check_mark: | N/A | |
| `id` | *String* | :heavy_check_mark: | N/A | |
| `emailAddress` | *String* | :heavy_check_mark: | N/A | |
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.components.InvitationRevokedPublicMetadata>](../../models/components/InvitationRevokedPublicMetadata.md) | :heavy_minus_sign: | N/A | |
| `revoked` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A | true |
| `status` | [com.clerk.backend_api.models.components.InvitationRevokedStatus](../../models/components/InvitationRevokedStatus.md) | :heavy_check_mark: | N/A | revoked |
| `url` | *JsonNullable<? extends String>* | :heavy_minus_sign: | N/A | |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> | |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> | |

8
docs/models/components/InvitationRevokedObject.md Normal file
View File

@@ -0,0 +1,8 @@
# InvitationRevokedObject
## Values
| Name | Value |
| ------------ | ------------ |
| `INVITATION` | invitation |

7
docs/models/components/InvitationRevokedPublicMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# InvitationRevokedPublicMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

8
docs/models/components/InvitationRevokedStatus.md Normal file
View File

@@ -0,0 +1,8 @@
# InvitationRevokedStatus
## Values
| Name | Value |
| --------- | --------- |
| `REVOKED` | revoked |

10
docs/models/components/InvitationStatus.md Normal file
View File

@@ -0,0 +1,10 @@
# InvitationStatus
## Values
| Name | Value |
| ---------- | ---------- |
| `PENDING` | pending |
| `ACCEPTED` | accepted |
| `REVOKED` | revoked |

17
docs/models/components/JWTTemplate.md Normal file
View File

@@ -0,0 +1,17 @@
# JWTTemplate
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.JWTTemplateObject](../../models/components/JWTTemplateObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `claims` | [com.clerk.backend_api.models.components.Claims](../../models/components/Claims.md) | :heavy_check_mark: | N/A |
| `lifetime` | *long* | :heavy_check_mark: | N/A |
| `allowedClockSkew` | *long* | :heavy_check_mark: | N/A |
| `customSigningKey` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `signingAlgorithm` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |

8
docs/models/components/JWTTemplateObject.md Normal file
View File

@@ -0,0 +1,8 @@
# JWTTemplateObject
## Values
| Name | Value |
| -------------- | -------------- |
| `JWT_TEMPLATE` | jwt_template |

7
docs/models/components/Meta.md Normal file
View File

@@ -0,0 +1,7 @@
# Meta
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

8
docs/models/components/Nonce.md Normal file
View File

@@ -0,0 +1,8 @@
# Nonce
## Values
| Name | Value |
| ------- | ------- |
| `NONCE` | nonce |

20
docs/models/components/OAuthApplication.md Normal file
View File

@@ -0,0 +1,20 @@
# OAuthApplication
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.OAuthApplicationObject](../../models/components/OAuthApplicationObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `instanceId` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `clientId` | *String* | :heavy_check_mark: | N/A |
| `public_` | *boolean* | :heavy_check_mark: | N/A |
| `scopes` | *String* | :heavy_check_mark: | N/A |
| `callbackUrl` | *String* | :heavy_check_mark: | N/A |
| `authorizeUrl` | *String* | :heavy_check_mark: | N/A |
| `tokenFetchUrl` | *String* | :heavy_check_mark: | N/A |
| `userInfoUrl` | *String* | :heavy_check_mark: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |

8
docs/models/components/OAuthApplicationObject.md Normal file
View File

@@ -0,0 +1,8 @@
# OAuthApplicationObject
## Values
| Name | Value |
| ------------------- | ------------------- |
| `OAUTH_APPLICATION` | oauth_application |

21
docs/models/components/OAuthApplicationWithSecret.md Normal file
View File

@@ -0,0 +1,21 @@
# OAuthApplicationWithSecret
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.OAuthApplicationWithSecretObject](../../models/components/OAuthApplicationWithSecretObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `instanceId` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `clientId` | *String* | :heavy_check_mark: | N/A |
| `public_` | *boolean* | :heavy_check_mark: | N/A |
| `scopes` | *String* | :heavy_check_mark: | N/A |
| `callbackUrl` | *String* | :heavy_check_mark: | N/A |
| `authorizeUrl` | *String* | :heavy_check_mark: | N/A |
| `tokenFetchUrl` | *String* | :heavy_check_mark: | N/A |
| `userInfoUrl` | *String* | :heavy_check_mark: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |
| `clientSecret` | *Optional<? extends String>* | :heavy_minus_sign: | Empty if public client.<br/> |

8
docs/models/components/OAuthApplicationWithSecretObject.md Normal file
View File

@@ -0,0 +1,8 @@
# OAuthApplicationWithSecretObject
## Values
| Name | Value |
| ------------------- | ------------------- |
| `OAUTH_APPLICATION` | oauth_application |

9
docs/models/components/OAuthApplications.md Normal file
View File

@@ -0,0 +1,9 @@
# OAuthApplications
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| `data` | List<[com.clerk.backend_api.models.components.OAuthApplication](../../models/components/OAuthApplication.md)> | :heavy_check_mark: | N/A |
| `totalCount` | *long* | :heavy_check_mark: | Total number of OAuth applications<br/> |

11
docs/models/components/OTPVerificationStatus.md Normal file
View File

@@ -0,0 +1,11 @@
# OTPVerificationStatus
## Values
| Name | Value |
| ------------ | ------------ |
| `UNVERIFIED` | unverified |
| `VERIFIED` | verified |
| `FAILED` | failed |
| `EXPIRED` | expired |

10
docs/models/components/OTPVerificationStrategy.md Normal file
View File

@@ -0,0 +1,10 @@
# OTPVerificationStrategy
## Values
| Name | Value |
| --------------------------- | --------------------------- |
| `PHONE_CODE` | phone_code |
| `EMAIL_CODE` | email_code |
| `RESET_PASSWORD_EMAIL_CODE` | reset_password_email_code |

13
docs/models/components/Oauth.md Normal file
View File

@@ -0,0 +1,13 @@
# Oauth
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `status` | [com.clerk.backend_api.models.components.OauthVerificationStatus](../../models/components/OauthVerificationStatus.md) | :heavy_check_mark: | N/A |
| `strategy` | [com.clerk.backend_api.models.components.OauthVerificationStrategy](../../models/components/OauthVerificationStrategy.md) | :heavy_check_mark: | N/A |
| `externalVerificationRedirectUrl` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `error` | [JsonNullable<? extends com.clerk.backend_api.models.components.Error>](../../models/components/Error.md) | :heavy_minus_sign: | N/A |
| `expireAt` | *long* | :heavy_check_mark: | N/A |
| `attempts` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | N/A |

12
docs/models/components/OauthVerificationStatus.md Normal file
View File

@@ -0,0 +1,12 @@
# OauthVerificationStatus
## Values
| Name | Value |
| -------------- | -------------- |
| `UNVERIFIED` | unverified |
| `VERIFIED` | verified |
| `FAILED` | failed |
| `EXPIRED` | expired |
| `TRANSFERABLE` | transferable |

9
docs/models/components/OauthVerificationStrategy.md Normal file
View File

@@ -0,0 +1,9 @@
# OauthVerificationStrategy
## Values
| Name | Value |
| -------------- | -------------- |
| `OAUTH_GOOGLE` | oauth_google |
| `OAUTH_MOCK` | oauth_mock |

11
docs/models/components/Object.md Normal file
View File

@@ -0,0 +1,11 @@
# Object
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| -------- | -------- |
| `CLIENT` | client |

19
docs/models/components/Organization.md Normal file
View File

@@ -0,0 +1,19 @@
# Organization
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.OrganizationObject](../../models/components/OrganizationObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `slug` | *String* | :heavy_check_mark: | N/A |
| `membersCount` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | N/A |
| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A |
| `adminDeleteEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `publicMetadata` | [com.clerk.backend_api.models.components.OrganizationPublicMetadata](../../models/components/OrganizationPublicMetadata.md) | :heavy_check_mark: | N/A |
| `privateMetadata` | [com.clerk.backend_api.models.components.OrganizationPrivateMetadata](../../models/components/OrganizationPrivateMetadata.md) | :heavy_check_mark: | N/A |
| `createdBy` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |

19
docs/models/components/OrganizationInvitation.md Normal file
View File

@@ -0,0 +1,19 @@
# OrganizationInvitation
An organization invitation
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `object` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationInvitationObject>](../../models/components/OrganizationInvitationObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.<br/> |
| `emailAddress` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `role` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `organizationId` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `status` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationInvitationPublicMetadata>](../../models/components/OrganizationInvitationPublicMetadata.md) | :heavy_minus_sign: | N/A |
| `privateMetadata` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationInvitationPrivateMetadata>](../../models/components/OrganizationInvitationPrivateMetadata.md) | :heavy_minus_sign: | N/A |
| `createdAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of creation. |
| `updatedAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last update. |

11
docs/models/components/OrganizationInvitationObject.md Normal file
View File

@@ -0,0 +1,11 @@
# OrganizationInvitationObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ------------------------- | ------------------------- |
| `ORGANIZATION_INVITATION` | organization_invitation |

7
docs/models/components/OrganizationInvitationPrivateMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationInvitationPrivateMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/models/components/OrganizationInvitationPublicMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationInvitationPublicMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/models/components/OrganizationInvitations.md Normal file
View File

@@ -0,0 +1,9 @@
# OrganizationInvitations
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `data` | List<[com.clerk.backend_api.models.components.OrganizationInvitation](../../models/components/OrganizationInvitation.md)> | :heavy_check_mark: | N/A |
| `totalCount` | *long* | :heavy_check_mark: | Total number of organization invitations<br/> |

19
docs/models/components/OrganizationMembership.md Normal file
View File

@@ -0,0 +1,19 @@
# OrganizationMembership
Hello world
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `object` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationMembershipObject>](../../models/components/OrganizationMembershipObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.<br/> |
| `role` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `permissions` | List<*String*> | :heavy_minus_sign: | N/A |
| `publicMetadata` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationMembershipPublicMetadata>](../../models/components/OrganizationMembershipPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs |
| `privateMetadata` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationMembershipPrivateMetadata>](../../models/components/OrganizationMembershipPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible only from the Backend API |
| `organization` | [Optional<? extends com.clerk.backend_api.models.components.OrganizationMembershipOrganization>](../../models/components/OrganizationMembershipOrganization.md) | :heavy_minus_sign: | N/A |
| `publicUserData` | [Optional<? extends com.clerk.backend_api.models.components.PublicUserData>](../../models/components/PublicUserData.md) | :heavy_minus_sign: | N/A |
| `createdAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of creation. |
| `updatedAt` | *Optional<? extends Long>* | :heavy_minus_sign: | Unix timestamp of last update. |

11
docs/models/components/OrganizationMembershipObject.md Normal file
View File

@@ -0,0 +1,11 @@
# OrganizationMembershipObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ------------------------- | ------------------------- |
| `ORGANIZATION_MEMBERSHIP` | organization_membership |

19
docs/models/components/OrganizationMembershipOrganization.md Normal file
View File

@@ -0,0 +1,19 @@
# OrganizationMembershipOrganization
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.OrganizationMembershipOrganizationObject](../../models/components/OrganizationMembershipOrganizationObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `slug` | *String* | :heavy_check_mark: | N/A |
| `membersCount` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | N/A |
| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A |
| `adminDeleteEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `publicMetadata` | [com.clerk.backend_api.models.components.OrganizationMembershipOrganizationPublicMetadata](../../models/components/OrganizationMembershipOrganizationPublicMetadata.md) | :heavy_check_mark: | N/A |
| `privateMetadata` | [com.clerk.backend_api.models.components.OrganizationMembershipOrganizationPrivateMetadata](../../models/components/OrganizationMembershipOrganizationPrivateMetadata.md) | :heavy_check_mark: | N/A |
| `createdBy` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |

8
docs/models/components/OrganizationMembershipOrganizationObject.md Normal file
View File

@@ -0,0 +1,8 @@
# OrganizationMembershipOrganizationObject
## Values
| Name | Value |
| -------------- | -------------- |
| `ORGANIZATION` | organization |

7
docs/models/components/OrganizationMembershipOrganizationPrivateMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationMembershipOrganizationPrivateMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/models/components/OrganizationMembershipOrganizationPublicMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationMembershipOrganizationPublicMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/models/components/OrganizationMembershipPrivateMetadata.md Normal file
View File

@@ -0,0 +1,9 @@
# OrganizationMembershipPrivateMetadata
Metadata saved on the organization membership, accessible only from the Backend API
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/models/components/OrganizationMembershipPublicMetadata.md Normal file
View File

@@ -0,0 +1,9 @@
# OrganizationMembershipPublicMetadata
Metadata saved on the organization membership, accessible from both Frontend and Backend APIs
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/models/components/OrganizationMemberships.md Normal file
View File

@@ -0,0 +1,9 @@
# OrganizationMemberships
## Fields
| Field | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `data` | List<[com.clerk.backend_api.models.components.OrganizationMembership](../../models/components/OrganizationMembership.md)> | :heavy_check_mark: | N/A |
| `totalCount` | *long* | :heavy_check_mark: | Total number of organization memberships<br/> |

8
docs/models/components/OrganizationObject.md Normal file
View File

@@ -0,0 +1,8 @@
# OrganizationObject
## Values
| Name | Value |
| -------------- | -------------- |
| `ORGANIZATION` | organization |

7
docs/models/components/OrganizationPrivateMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationPrivateMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/models/components/OrganizationPublicMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationPublicMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

17
docs/models/components/OrganizationSettings.md Normal file
View File

@@ -0,0 +1,17 @@
# OrganizationSettings
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.OrganizationSettingsObject](../../models/components/OrganizationSettingsObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value. |
| `enabled` | *boolean* | :heavy_check_mark: | N/A |
| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A |
| `maxAllowedRoles` | *Optional<? extends Long>* | :heavy_minus_sign: | N/A |
| `maxAllowedPermissions` | *Optional<? extends Long>* | :heavy_minus_sign: | N/A |
| `creatorRole` | *String* | :heavy_check_mark: | The role key that a user will be assigned after creating an organization. |
| `adminDeleteEnabled` | *boolean* | :heavy_check_mark: | The default for whether an admin can delete an organization with the Frontend API. |
| `domainsEnabled` | *boolean* | :heavy_check_mark: | N/A |
| `domainsEnrollmentModes` | List<[com.clerk.backend_api.models.components.DomainsEnrollmentModes](../../models/components/DomainsEnrollmentModes.md)> | :heavy_check_mark: | N/A |
| `domainsDefaultRole` | *String* | :heavy_check_mark: | The role key that it will be used in order to create an organization invitation or suggestion. |

10
docs/models/components/OrganizationSettingsObject.md Normal file
View File

@@ -0,0 +1,10 @@
# OrganizationSettingsObject
String representing the object's type. Objects of the same type share the same value.
## Values
| Name | Value |
| ----------------------- | ----------------------- |
| `ORGANIZATION_SETTINGS` | organization_settings |

22
docs/models/components/OrganizationWithLogo.md Normal file
View File

@@ -0,0 +1,22 @@
# OrganizationWithLogo
## Fields
| Field | Type | Required | Description |
| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `object` | [com.clerk.backend_api.models.components.OrganizationWithLogoObject](../../models/components/OrganizationWithLogoObject.md) | :heavy_check_mark: | N/A |
| `id` | *String* | :heavy_check_mark: | N/A |
| `name` | *String* | :heavy_check_mark: | N/A |
| `slug` | *String* | :heavy_check_mark: | N/A |
| `membersCount` | *JsonNullable<? extends Long>* | :heavy_minus_sign: | N/A |
| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A |
| `adminDeleteEnabled` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |
| `publicMetadata` | [com.clerk.backend_api.models.components.OrganizationWithLogoPublicMetadata](../../models/components/OrganizationWithLogoPublicMetadata.md) | :heavy_check_mark: | N/A |
| `privateMetadata` | [com.clerk.backend_api.models.components.OrganizationWithLogoPrivateMetadata](../../models/components/OrganizationWithLogoPrivateMetadata.md) | :heavy_check_mark: | N/A |
| `createdBy` | *Optional<? extends String>* | :heavy_minus_sign: | N/A |
| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.<br/> |
| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.<br/> |
| ~~`logoUrl`~~ | *Optional<? extends String>* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. |
| `imageUrl` | *String* | :heavy_check_mark: | N/A |
| `hasImage` | *Optional<? extends Boolean>* | :heavy_minus_sign: | N/A |

8
docs/models/components/OrganizationWithLogoObject.md Normal file
View File

@@ -0,0 +1,8 @@
# OrganizationWithLogoObject
## Values
| Name | Value |
| -------------- | -------------- |
| `ORGANIZATION` | organization |

7
docs/models/components/OrganizationWithLogoPrivateMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationWithLogoPrivateMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

7
docs/models/components/OrganizationWithLogoPublicMetadata.md Normal file
View File

@@ -0,0 +1,7 @@
# OrganizationWithLogoPublicMetadata
## Fields
| Field | Type | Required | Description |
| ----------- | ----------- | ----------- | ----------- |

9
docs/models/components/Organizations.md Normal file
View File

@@ -0,0 +1,9 @@
# Organizations
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `data` | List<[com.clerk.backend_api.models.components.Organization](../../models/components/Organization.md)> | :heavy_check_mark: | N/A |
| `totalCount` | *long* | :heavy_check_mark: | Total number of organizations<br/> |

11
docs/models/components/Otp.md Normal file
View File

@@ -0,0 +1,11 @@
# Otp
## Fields
| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `status` | [com.clerk.backend_api.models.components.VerificationStatus](../../models/components/VerificationStatus.md) | :heavy_check_mark: | N/A |
| `strategy` | [com.clerk.backend_api.models.components.Strategy](../../models/components/Strategy.md) | :heavy_check_mark: | N/A |
| `attempts` | *long* | :heavy_check_mark: | N/A |
| `expireAt` | *long* | :heavy_check_mark: | N/A |

Some files were not shown because too many files have changed in this diff Show More