Files
clerk-sdk-java/docs/sdks/signups/README.md
2024-06-13 13:51:50 -04:00

79 lines
4.2 KiB
Markdown

# SignUps
(*signUps()*)
### Available Operations
* [update](#update) - Update a sign-up
## update
Update the sign-up with the given ID
### Example 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();
UpdateSignUpResponse res = sdk.signUps().update()
.id("<value>")
.requestBody(UpdateSignUpRequestBody.builder()
.build())
.call();
if (res.signUp().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;
}
}
}
```
### Parameters
| Parameter | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *String* | :heavy_check_mark: | The ID of the sign-up to update |
| `requestBody` | [Optional<? extends com.clerk.backend_api.models.operations.UpdateSignUpRequestBody>](../../models/operations/UpdateSignUpRequestBody.md) | :heavy_minus_sign: | N/A |
### Response
**[Optional<? extends com.clerk.backend_api.models.operations.UpdateSignUpResponse>](../../models/operations/UpdateSignUpResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
| ------------------------- | ------------------------- | ------------------------- |
| models/errors/ClerkErrors | 403 | application/json |
| models/errors/SDKError | 4xx-5xx | */* |