@hookdeck/outpost-sdk 0.7.0 → 0.9.0

package/src/funcs/tenantsDelete.ts

@@ -18,6 +18,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { OutpostError } from "../models/errors/outposterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
@@ -33,11 +34,14 @@ import { Result } from "../types/fp.js";
  */
 export function tenantsDelete(
   client: OutpostCore,
-  request: operations.DeleteTenantRequest,
+  tenantId: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.SuccessResponse,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -50,19 +54,22 @@ export function tenantsDelete(
 > {
   return new APIPromise($do(
     client,
-    request,
+    tenantId,
     options,
   ));
 }
 
 async function $do(
   client: OutpostCore,
-  request: operations.DeleteTenantRequest,
+  tenantId: string,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
       components.SuccessResponse,
+      | errors.UnauthorizedError
+      | errors.NotFoundError
+      | errors.InternalServerError
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -75,8 +82,12 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.DeleteTenantRequest = {
+    tenantId: tenantId,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.DeleteTenantRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
@@ -87,11 +98,10 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
+    tenant_id: encodeSimple("tenant_id", payload.tenant_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
   };
 
   const path = pathToFunc("/tenants/{tenant_id}")(pathParams);
@@ -100,7 +110,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -111,7 +122,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -135,7 +146,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["401", "404", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -144,8 +155,15 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     components.SuccessResponse,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -156,9 +174,12 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.SuccessResponse$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.jsonErr(401, errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(404, errors.NotFoundError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/tenantsGet.ts

@@ -18,6 +18,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { OutpostError } from "../models/errors/outposterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
@@ -33,11 +34,14 @@ import { Result } from "../types/fp.js";
  */
 export function tenantsGet(
   client: OutpostCore,
-  request: operations.GetTenantRequest,
+  tenantId: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.Tenant,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -50,19 +54,22 @@ export function tenantsGet(
 > {
   return new APIPromise($do(
     client,
-    request,
+    tenantId,
     options,
   ));
 }
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetTenantRequest,
+  tenantId: string,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
       components.Tenant,
+      | errors.UnauthorizedError
+      | errors.NotFoundError
+      | errors.InternalServerError
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -75,8 +82,12 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.GetTenantRequest = {
+    tenantId: tenantId,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.GetTenantRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
@@ -87,11 +98,10 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
+    tenant_id: encodeSimple("tenant_id", payload.tenant_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
   };
 
   const path = pathToFunc("/tenants/{tenant_id}")(pathParams);
@@ -100,7 +110,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -111,7 +122,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -135,7 +146,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["401", "404", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -144,8 +155,15 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     components.Tenant,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -156,9 +174,12 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.Tenant$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.jsonErr(401, errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(404, errors.NotFoundError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/tenantsGetPortalUrl.ts

@@ -18,6 +18,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { OutpostError } from "../models/errors/outposterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
@@ -29,15 +30,19 @@ import { Result } from "../types/fp.js";
  * Get Portal Redirect URL
  *
  * @remarks
- * Returns a redirect URL containing a JWT to authenticate the user with the portal.
+ * Returns a redirect URL containing a JWT to authenticate the user with the portal. Requires Admin API Key.
  */
 export function tenantsGetPortalUrl(
   client: OutpostCore,
-  request: operations.GetTenantPortalUrlRequest,
+  tenantId: string,
+  theme?: operations.Theme | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.PortalRedirect,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -50,19 +55,24 @@ export function tenantsGetPortalUrl(
 > {
   return new APIPromise($do(
     client,
-    request,
+    tenantId,
+    theme,
     options,
   ));
 }
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetTenantPortalUrlRequest,
+  tenantId: string,
+  theme?: operations.Theme | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
       components.PortalRedirect,
+      | errors.UnauthorizedError
+      | errors.NotFoundError
+      | errors.InternalServerError
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -75,8 +85,13 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.GetTenantPortalUrlRequest = {
+    tenantId: tenantId,
+    theme: theme,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.GetTenantPortalUrlRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
@@ -87,11 +102,10 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
+    tenant_id: encodeSimple("tenant_id", payload.tenant_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
   };
 
   const path = pathToFunc("/tenants/{tenant_id}/portal")(pathParams);
@@ -104,7 +118,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -115,7 +130,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -140,7 +155,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["401", "404", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -149,8 +164,15 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     components.PortalRedirect,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -161,9 +183,12 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.PortalRedirect$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.jsonErr(401, errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(404, errors.NotFoundError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/tenantsGetToken.ts

@@ -18,6 +18,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { OutpostError } from "../models/errors/outposterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
@@ -29,15 +30,18 @@ import { Result } from "../types/fp.js";
  * Get Tenant JWT Token
  *
  * @remarks
- * Returns a JWT token scoped to the tenant for safe browser API calls.
+ * Returns a JWT token scoped to the tenant for safe browser API calls. Requires Admin API Key.
  */
 export function tenantsGetToken(
   client: OutpostCore,
-  request: operations.GetTenantTokenRequest,
+  tenantId: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.TenantToken,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -50,19 +54,22 @@ export function tenantsGetToken(
 > {
   return new APIPromise($do(
     client,
-    request,
+    tenantId,
     options,
   ));
 }
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetTenantTokenRequest,
+  tenantId: string,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
       components.TenantToken,
+      | errors.UnauthorizedError
+      | errors.NotFoundError
+      | errors.InternalServerError
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -75,8 +82,12 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.GetTenantTokenRequest = {
+    tenantId: tenantId,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.GetTenantTokenRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
@@ -87,11 +98,10 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
+    tenant_id: encodeSimple("tenant_id", payload.tenant_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
   };
 
   const path = pathToFunc("/tenants/{tenant_id}/token")(pathParams);
@@ -100,7 +110,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -111,7 +122,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -135,7 +146,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["401", "404", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -144,8 +155,15 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     components.TenantToken,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -156,9 +174,12 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.TenantToken$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.jsonErr(401, errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(404, errors.NotFoundError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }