README.md

Artifacts

(artifacts)

Overview

REST APIs for working with Registry artifacts

Available Operations

• createRemoteSource - Configure a new remote source
• getBlob - Get blob for a particular digest
• getManifest - Get manifest for a particular reference
• getNamespaces - Each namespace contains many revisions.
• getRevisions
• getTags
• listRemoteSources - Get remote sources attached to a particular namespace
• postTags - Add tags to an existing revision
• preflight - Get access token for communicating with OCI distribution endpoints
• setArchived - Set whether a namespace is archived
• setVisibility - Set visibility of a namespace with an existing metadata entry

createRemoteSource

Configure a new remote source

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.artifacts.createRemoteSource();


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsCreateRemoteSource } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsCreateRemoteSource.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsCreateRemoteSource(speakeasy);

  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.
  useArtifactsCreateRemoteSourceMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsCreateRemoteSource.js";

Parameters

Parameter	Type	Required	Description
request	shared.RemoteSource	✔️	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<void>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

getBlob

Get blob for a particular digest

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.getBlob({
    organizationSlug: "<value>",
    workspaceSlug: "<value>",
    namespaceName: "<value>",
    digest: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsGetBlob } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsGetBlob.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsGetBlob(speakeasy, {
    organizationSlug: "<value>",
    workspaceSlug: "<value>",
    namespaceName: "<value>",
    digest: "<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.
  useArtifactsGetBlob,
  useArtifactsGetBlobSuspense,

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

Parameters

Parameter	Type	Required	Description
request	operations.GetBlobRequest	✔️	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<ReadableStream>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

getManifest

Get manifest for a particular reference

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.getManifest({
    organizationSlug: "<value>",
    workspaceSlug: "<value>",
    namespaceName: "<value>",
    revisionReference: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsGetManifest } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsGetManifest.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsGetManifest(speakeasy, {
    organizationSlug: "<value>",
    workspaceSlug: "<value>",
    namespaceName: "<value>",
    revisionReference: "<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.
  useArtifactsGetManifest,
  useArtifactsGetManifestSuspense,

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

Parameters

Parameter	Type	Required	Description
request	operations.GetManifestRequest	✔️	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<shared.Manifest>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

getNamespaces

Each namespace contains many revisions.

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.getNamespaces();

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsGetNamespaces } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsGetNamespaces.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsGetNamespaces(speakeasy);

  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.
  useArtifactsGetNamespaces,
  useArtifactsGetNamespacesSuspense,

  // Utility for prefetching data during server-side rendering and in React
  // Server Components that will be immediately available to client components
  // using the hooks.
  prefetchArtifactsGetNamespaces,
  
  // Utility to invalidate the query cache for this query in response to
  // mutations and other user actions.
  invalidateAllArtifactsGetNamespaces,
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsGetNamespaces.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<shared.GetNamespacesResponse>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

getRevisions

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.getRevisions({
    namespaceName: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsGetRevisions } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsGetRevisions.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsGetRevisions(speakeasy, {
    namespaceName: "<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.
  useArtifactsGetRevisions,
  useArtifactsGetRevisionsSuspense,

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

Parameters

Parameter	Type	Required	Description
request	operations.GetRevisionsRequest	✔️	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<shared.GetRevisionsResponse>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

getTags

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.getTags({
    namespaceName: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsGetTags } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsGetTags.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsGetTags(speakeasy, {
    namespaceName: "<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.
  useArtifactsGetTags,
  useArtifactsGetTagsSuspense,

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

Parameters

Parameter	Type	Required	Description
request	operations.GetTagsRequest	✔️	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<shared.GetTagsResponse>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

listRemoteSources

Get remote sources attached to a particular namespace

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.listRemoteSources({
    namespaceName: "<value>",
  });

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsListRemoteSources } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsListRemoteSources.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsListRemoteSources(speakeasy, {
    namespaceName: "<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.
  useArtifactsListRemoteSources,
  useArtifactsListRemoteSourcesSuspense,

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

Parameters

Parameter	Type	Required	Description
request	operations.ListRemoteSourcesRequest	✔️	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<shared.RemoteSource>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

postTags

Add tags to an existing revision

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.artifacts.postTags({
    namespaceName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsPostTags } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsPostTags.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsPostTags(speakeasy, {
    namespaceName: "<value>",
  });

  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.
  useArtifactsPostTagsMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsPostTags.js";

Parameters

Parameter	Type	Required	Description
request	operations.PostTagsRequest	✔️	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<void>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

preflight

Get access token for communicating with OCI distribution endpoints

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const result = await speakeasy.artifacts.preflight();

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

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsPreflight } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsPreflight.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsPreflight(speakeasy);

  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.
  useArtifactsPreflightMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsPreflight.js";

Parameters

Parameter	Type	Required	Description
request	shared.PreflightRequest	✔️	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<shared.PreflightToken>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

setArchived

Set whether a namespace is archived

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.artifacts.setArchived({
    namespaceName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsSetArchived } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsSetArchived.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsSetArchived(speakeasy, {
    namespaceName: "<value>",
  });

  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.
  useArtifactsSetArchivedMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsSetArchived.js";

Parameters

Parameter	Type	Required	Description
request	operations.ArchiveNamespaceRequest	✔️	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<void>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*

setVisibility

Set visibility of a namespace with an existing metadata entry

Example Usage

import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";

const speakeasy = new Speakeasy({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  await speakeasy.artifacts.setVisibility({
    namespaceName: "<value>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { SpeakeasyCore } from "@speakeasy-api/speakeasy-client-sdk-typescript/core.js";
import { artifactsSetVisibility } from "@speakeasy-api/speakeasy-client-sdk-typescript/funcs/artifactsSetVisibility.js";

// Use `SpeakeasyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const speakeasy = new SpeakeasyCore({
  security: {
    apiKey: "<YOUR_API_KEY_HERE>",
  },
});

async function run() {
  const res = await artifactsSetVisibility(speakeasy, {
    namespaceName: "<value>",
  });

  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.
  useArtifactsSetVisibilityMutation
} from "@speakeasy-api/speakeasy-client-sdk-typescript/react-query/artifactsSetVisibility.js";

Parameters

Parameter	Type	Required	Description
request	operations.SetVisibilityRequest	✔️	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<void>

Errors

Error Type	Status Code	Content Type
errors.ErrorT	4XX	application/json
errors.SDKError	5XX	*/*