dub 0.62.0 → 0.62.2

package/docs/sdks/domains/README.md

@@ -9,6 +9,8 @@
 * [list](#list) - Retrieve a list of domains
 * [update](#update) - Update a domain
 * [delete](#delete) - Delete a domain
+* [register](#register) - Register a domain
+* [checkStatus](#checkstatus) - Check the availability of one or more domains
 
 ## create
 
@@ -26,7 +28,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.domains.create();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -49,15 +50,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await domainsCreate(dub);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("domainsCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -108,7 +106,6 @@ async function run() {
   const result = await dub.domains.list();
 
   for await (const page of result) {
-    // Handle the page
     console.log(page);
   }
 }
@@ -132,17 +129,14 @@ const dub = new DubCore({
 
 async function run() {
   const res = await domainsList(dub);
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  for await (const page of result) {
-    // Handle the page
+  if (res.ok) {
+    const { value: result } = res;
+    for await (const page of result) {
     console.log(page);
   }
+  } else {
+    console.log("domainsList failed:", res.error);
+  }
 }
 
 run();
@@ -192,7 +186,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.domains.update("acme.com");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -215,15 +208,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await domainsUpdate(dub, "acme.com");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("domainsUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -274,7 +264,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.domains.delete("acme.com");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -297,15 +286,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await domainsDelete(dub, "acme.com");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("domainsDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -326,6 +312,164 @@ run();
 
 ### Errors
 
+| Error Type                 | 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                   | \*/\*                      |
+
+## register
+
+Register a domain for the authenticated workspace. Only available for Enterprise Plans.
+
+### Example Usage
+
+```typescript
+import { Dub } from "dub";
+
+const dub = new Dub({
+  token: "DUB_API_KEY",
+});
+
+async function run() {
+  const result = await dub.domains.register();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DubCore } from "dub/core.js";
+import { domainsRegister } from "dub/funcs/domainsRegister.js";
+
+// Use `DubCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const dub = new DubCore({
+  token: "DUB_API_KEY",
+});
+
+async function run() {
+  const res = await domainsRegister(dub);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("domainsRegister failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.RegisterDomainRequestBody](../../models/operations/registerdomainrequestbody.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | 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](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.RegisterDomainResponseBody](../../models/operations/registerdomainresponsebody.md)\>**
+
+### Errors
+
+| Error Type                 | 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                   | \*/\*                      |
+
+## checkStatus
+
+Check if a domain name is available for purchase. You can check multiple domains at once.
+
+### Example Usage
+
+```typescript
+import { Dub } from "dub";
+
+const dub = new Dub({
+  token: "DUB_API_KEY",
+});
+
+async function run() {
+  const result = await dub.domains.checkStatus({
+    domains: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { DubCore } from "dub/core.js";
+import { domainsCheckStatus } from "dub/funcs/domainsCheckStatus.js";
+
+// Use `DubCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const dub = new DubCore({
+  token: "DUB_API_KEY",
+});
+
+async function run() {
+  const res = await domainsCheckStatus(dub, {
+    domains: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("domainsCheckStatus failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CheckDomainStatusRequest](../../models/operations/checkdomainstatusrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | 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](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CheckDomainStatusResponseBody[]](../../models/.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.BadRequest          | 400                        | application/json           |

package/docs/sdks/embedtokens/README.md

@@ -23,7 +23,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.embedTokens.referrals();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -46,15 +45,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await embedTokensReferrals(dub);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("embedTokensReferrals failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/events/README.md

@@ -23,7 +23,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.events.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -46,15 +45,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await eventsList(dub);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("eventsList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/folders/README.md

@@ -26,7 +26,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.folders.create();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -49,15 +48,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await foldersCreate(dub);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("foldersCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -107,7 +103,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.folders.list();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -130,15 +125,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await foldersList(dub);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("foldersList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -188,7 +180,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.folders.update("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -211,15 +202,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await foldersUpdate(dub, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("foldersUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -270,7 +258,6 @@ const dub = new Dub({
 async function run() {
   const result = await dub.folders.delete("<id>");
 
-  // Handle the result
   console.log(result);
 }
 
@@ -293,15 +280,12 @@ const dub = new DubCore({
 
 async function run() {
   const res = await foldersDelete(dub, "<id>");
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("foldersDelete failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();