@greensecurity/javascript-sdk 0.43.1-beta.9 → 0.43.1-beta.90

package/src/funcs/paymentProfileGetPaymentProfile.ts

@@ -0,0 +1,153 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get payment profile information
+ *
+ * @remarks
+ * Returns payment profile information for the logged-in user (vendor or company manager).
+ * This includes credit_balance and payment_profile which are account-level data, not invoice-specific.
+ *
+ * Only vendors and company managers can access this endpoint.
+ */
+export function paymentProfileGetPaymentProfile(
+  client: GreenSecurityCore,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PaymentProfileInfo,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PaymentProfileInfo,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/payment-profile")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getPaymentProfile",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.PaymentProfileInfo,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PaymentProfileInfo$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/supportArticlesGetSupportArticle.ts

@@ -176,9 +176,8 @@ async function $do(
   >(
     M.json(200, components.SupportArticle$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/supportArticlesListOrSearchSupportArticles.ts

@@ -182,9 +182,8 @@ async function $do(
       key: "Result",
     }),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [haltIterator(result), {

package/src/funcs/systemsListSystems.ts

@@ -189,9 +189,8 @@ async function $do(
       key: "Result",
     }),
     M.jsonErr(403, errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [haltIterator(result), {

package/src/funcs/usersChangePassword.ts

@@ -164,9 +164,8 @@ async function $do(
   >(
     M.json(200, operations.ChangePasswordChangePasswordOk$inboundSchema),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersGetCurrentUser.ts

@@ -139,9 +139,8 @@ async function $do(
   >(
     M.json(200, components.User$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersGetLinkedUsers.ts

@@ -0,0 +1,177 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get linked users
+ *
+ * @remarks
+ * Returns a list of users linked to the authenticated user.
+ *
+ * For regular users, returns their own linked users.
+ *
+ * For API users, the `user_id` parameter is required. The API user must
+ * have an active app activation for the requested user.
+ */
+export function usersGetLinkedUsers(
+  client: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetLinkedUsersGetLinkedUsersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetLinkedUsersRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetLinkedUsersGetLinkedUsersOk,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetLinkedUsersRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/users/linked-users")();
+
+  const query = encodeFormQuery({
+    "user_id": payload.user_id,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getLinkedUsers",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "422", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetLinkedUsersGetLinkedUsersOk,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetLinkedUsersGetLinkedUsersOk$inboundSchema),
+    M.jsonErr([400, 401, 403, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/usersGetUserById.ts

@@ -164,9 +164,8 @@ async function $do(
   >(
     M.json(200, components.User$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersMagiclink.ts

@@ -157,9 +157,8 @@ async function $do(
   >(
     M.json(200, operations.MagiclinkMagiclinkOk$inboundSchema),
     M.jsonErr(404, errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersPassword.ts

@@ -158,9 +158,8 @@ async function $do(
   >(
     M.json(200, operations.PasswordPasswordOk$inboundSchema),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersPasswordResetRequest.ts

@@ -161,9 +161,8 @@ async function $do(
       operations.PasswordResetRequestPasswordResetRequestOk$inboundSchema,
     ),
     M.jsonErr([400, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersPostAuthenticate.ts

@@ -184,9 +184,8 @@ async function $do(
     M.json(200, operations.PostAuthenticateResponse$inboundSchema),
     M.json(202, operations.PostAuthenticateResponse$inboundSchema),
     M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/usersRotateApiKey.ts

@@ -139,9 +139,8 @@ async function $do(
   >(
     M.json(200, operations.RotateApiKeyRotateApiKeyOk$inboundSchema),
     M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
-    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
-    M.fail("5XX"),
+    M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];

package/src/funcs/vendorScansGetNextScreeningQuestion.ts

@@ -0,0 +1,192 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get the next unanswered screening questions for a vendor scan
+ *
+ * @remarks
+ * Retrieve the next unanswered screening question for the specified vendor scan.
+ * If a question exists, the endpoint returns the question and its available answers.
+ *
+ * Available `expand` scopes are:
+ *
+ * screening_question.screening_answers
+ */
+export function vendorScansGetNextScreeningQuestion(
+  client: GreenSecurityCore,
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetNextScreeningQuestionResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetNextScreeningQuestionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetNextScreeningQuestionResponseBody,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetNextScreeningQuestionRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/vendor-scans/{id}/screening-questions/next-question",
+  )(pathParams);
+
+  const query = queryJoin(
+    encodeFormQuery({
+      "expand": payload.expand,
+    }, { explode: false }),
+    encodeFormQuery({
+      "vendor_id": payload.vendor_id,
+    }),
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getNextScreeningQuestion",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetNextScreeningQuestionResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetNextScreeningQuestionResponseBody$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}