mirror of https://github.com/LukeHagar/dub-node.git synced 2025-12-06 12:27:48 +00:00

Files

github-actions[bot] 9e5a1351bd ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.295.1 (#110 )

Co-authored-by: speakeasybot <bot@speakeasyapi.dev>

2024-05-23 16:46:33 +05:30

35 KiB

Raw Blame History

Domains

(domains)

Available Operations

list - Retrieve a list of domains
add - Add a domain
delete - Delete a domain
update - Update a domain
setPrimary - Set a domain as primary
transfer - Transfer a domain

list

Retrieve a list of domains associated with the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.domains.list({});

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

run();

Parameters

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

Response

Promise<components.DomainSchema[]>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

add

Add a domain to the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.domains.add({
    slug: "acme.com",
  });

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

run();

Parameters

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

Response

Promise<components.DomainSchema>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

delete

Delete a domain from a workspace. It cannot be undone. This will also delete all the links associated with the domain.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.domains.delete("acme.com");

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

run();

Parameters

Parameter	Type	Required	Description	Example
`slug`	string	✔️	The domain name.	[object Object]
`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.

Response

Promise<operations.DeleteDomainResponseBody>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

update

Update a domain for the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.domains.update("acme.com", {});

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

run();

Parameters

Parameter	Type	Required	Description	Example
`slug`	string	✔️	The domain name.	[object Object]
`requestBody`	operations.UpdateDomainRequestBody	➖	N/A
`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.

Response

Promise<components.DomainSchema>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

setPrimary

Set a domain as primary for the authenticated workspace.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.domains.setPrimary("acme.com");

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

run();

Parameters

Parameter	Type	Required	Description	Example
`slug`	string	✔️	The domain name.	[object Object]
`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.

Response

Promise<components.DomainSchema>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

transfer

Transfer a domain to another workspace within the authenticated account.

Example Usage

import { Dub } from "dub";

const dub = new Dub({
  token: "DUB_API_KEY",
  workspaceId: "<value>",
});

async function run() {
  const result = await dub.domains.transfer("acme.com", {
    newWorkspaceId: "<value>",
  });

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

run();

Parameters

Parameter	Type	Required	Description	Example
`slug`	string	✔️	The domain name.	[object Object]
`requestBody`	operations.TransferDomainRequestBody	➖	N/A
`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.

Response

Promise<components.DomainSchema>

Errors

Error Object	Status Code	Content Type
errors.BadRequest	400	application/json
errors.Unauthorized	401	application/json
errors.Forbidden	403	application/json
errors.NotFound	404	application/json
errors.Conflict	409	application/json
errors.InviteExpired	410	application/json
errors.UnprocessableEntity	422	application/json
errors.RateLimitExceeded	429	application/json
errors.InternalServerError	500	application/json
errors.SDKError	4xx-5xx	/

35 KiB Raw Blame History Unescape Escape

Domains

Available Operations

list

Example Usage

Parameters

Response

Errors

add

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

setPrimary

Example Usage

Parameters

Response

Errors

transfer

Example Usage

Parameters

Response

Errors

35 KiB

Raw Blame History