Skip to content

Latest commit

 

History

History
325 lines (228 loc) · 25.8 KB

README.md

File metadata and controls

325 lines (228 loc) · 25.8 KB

AtprotoIdentity

(atprotoIdentity)

Overview

Available Operations

Request an email with a code to in order to request a signed PLC operation. Requires Auth.

Resolves a handle (domain name) to a DID.

Signs a PLC operation to update some value(s) in the requesting DID's document.

requestPlcOperationSignature

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Request an email with a code to in order to request a signed PLC operation. Requires Auth.

Example Usage

import { Bluesky } from "@speakeasy-api/bluesky";

const bluesky = new Bluesky({
  bearer: process.env["BLUESKY_BEARER"] ?? "",
});

async function run() {
  await bluesky.atprotoIdentity.requestPlcOperationSignature();


}

run();

Standalone function

The standalone function version of this method:

import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { atprotoIdentityRequestPlcOperationSignature } from "@speakeasy-api/bluesky/funcs/atprotoIdentityRequestPlcOperationSignature.js";

// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
  bearer: process.env["BLUESKY_BEARER"] ?? "",
});

async function run() {
  const res = await atprotoIdentityRequestPlcOperationSignature(bluesky);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useAtprotoIdentityRequestPlcOperationSignatureMutation
} from "@speakeasy-api/bluesky/react-query/atprotoIdentityRequestPlcOperationSignature.js";

Parameters

Parameter Type Required Description
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type Status Code Content Type
errors.ComAtprotoIdentityRequestPlcOperationSignatureResponseBody 400 application/json
errors.ComAtprotoIdentityRequestPlcOperationSignatureAtprotoIdentityResponseBody 401 application/json
errors.Unauthorized 403, 407, 511 application/json
errors.NotFound 404, 501, 505 application/json
errors.Timeout 408, 504 application/json
errors.BadRequest 413, 414, 415, 422, 431, 510 application/json
errors.RateLimited 429 application/json
errors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
errors.APIError 4XX, 5XX */*

resolveHandle

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Resolves a handle (domain name) to a DID.

Example Usage

import { Bluesky } from "@speakeasy-api/bluesky";

const bluesky = new Bluesky({
  bearer: process.env["BLUESKY_BEARER"] ?? "",
});

async function run() {
  const result = await bluesky.atprotoIdentity.resolveHandle({
    handle: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { atprotoIdentityResolveHandle } from "@speakeasy-api/bluesky/funcs/atprotoIdentityResolveHandle.js";

// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
  bearer: process.env["BLUESKY_BEARER"] ?? "",
});

async function run() {
  const res = await atprotoIdentityResolveHandle(bluesky, {
    handle: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Query hooks for fetching data.
  useDidForProfile,
  useDidForProfileSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchDidForProfile,
  
  // Utilities to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateDidForProfile,
  invalidateAllDidForProfile,
} from "@speakeasy-api/bluesky/react-query/atprotoIdentityResolveHandle.js";

Parameters

Parameter Type Required Description
request operations.ComAtprotoIdentityResolveHandleRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ComAtprotoIdentityResolveHandleResponseBody>

Errors

Error Type Status Code Content Type
errors.ComAtprotoIdentityResolveHandleResponseBody 400 application/json
errors.ComAtprotoIdentityResolveHandleAtprotoIdentityResponseBody 401 application/json
errors.Unauthorized 403, 407, 511 application/json
errors.NotFound 404, 501, 505 application/json
errors.Timeout 408, 504 application/json
errors.BadRequest 413, 414, 415, 422, 431, 510 application/json
errors.RateLimited 429 application/json
errors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
errors.APIError 4XX, 5XX */*

signPlcOperation

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Signs a PLC operation to update some value(s) in the requesting DID's document.

Example Usage

import { Bluesky } from "@speakeasy-api/bluesky";

const bluesky = new Bluesky({
  bearer: process.env["BLUESKY_BEARER"] ?? "",
});

async function run() {
  const result = await bluesky.atprotoIdentity.signPlcOperation();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { BlueskyCore } from "@speakeasy-api/bluesky/core.js";
import { atprotoIdentitySignPlcOperation } from "@speakeasy-api/bluesky/funcs/atprotoIdentitySignPlcOperation.js";

// Use `BlueskyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const bluesky = new BlueskyCore({
  bearer: process.env["BLUESKY_BEARER"] ?? "",
});

async function run() {
  const res = await atprotoIdentitySignPlcOperation(bluesky);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

React hooks and utilities

This method can be used in React components through the following hooks and associated utilities.

Check out this guide for information about each of the utilities below and how to get started using React hooks.

import {
  // Mutation hook for triggering the API call.
  useAtprotoIdentitySignPlcOperationMutation
} from "@speakeasy-api/bluesky/react-query/atprotoIdentitySignPlcOperation.js";

Parameters

Parameter Type Required Description
request operations.ComAtprotoIdentitySignPlcOperationRequestBody ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.ComAtprotoIdentitySignPlcOperationResponseBody>

Errors

Error Type Status Code Content Type
errors.ComAtprotoIdentitySignPlcOperationResponseBody 400 application/json
errors.ComAtprotoIdentitySignPlcOperationAtprotoIdentityResponseBody 401 application/json
errors.Unauthorized 403, 407, 511 application/json
errors.NotFound 404, 501, 505 application/json
errors.Timeout 408, 504 application/json
errors.BadRequest 413, 414, 415, 422, 431, 510 application/json
errors.RateLimited 429 application/json
errors.InternalServerError 500, 502, 503, 506, 507, 508 application/json
errors.APIError 4XX, 5XX */*