@greensecurity/javascript-sdk 0.15.0 → 0.16.0

package/src/funcs/supportArticlesGetSupportArticle.ts

@@ -0,0 +1,181 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } 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 * as components from "../models/components/index.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.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 support article
+ *
+ * @remarks
+ * Retrieve an individual support article.
+ *
+ * Available `expand` scopes are:
+ *
+ * - support_article.description
+ * - support_article.published
+ * - support_article.notes
+ * - support_article.support_category
+ */
+export function supportArticlesGetSupportArticle(
+  client: GreenSecurityCore,
+  request: operations.GetSupportArticleRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.SupportArticle,
+    | errors.ApiErrorResponse
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetSupportArticleRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.SupportArticle,
+      | errors.ApiErrorResponse
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetSupportArticleRequest$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("/support_articles/{id}")(pathParams);
+
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getSupportArticle",
+    oAuth2Scopes: [],
+
+    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,
+    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: ["404", "4XX", "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.SupportArticle,
+    | errors.ApiErrorResponse
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.SupportArticle$inboundSchema),
+    M.jsonErr(404, errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/supportArticlesListOrSearchSupportArticles.ts

@@ -0,0 +1,165 @@
+/*
+ * 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 { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.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";
+
+/**
+ * List or search support articles
+ *
+ * @remarks
+ * List or search support articles for FAQ.
+ */
+export function supportArticlesListOrSearchSupportArticles(
+  client: GreenSecurityCore,
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListOrSearchSupportArticlesListOrSearchArticlesOk,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListOrSearchSupportArticlesRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.ListOrSearchSupportArticlesListOrSearchArticlesOk,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListOrSearchSupportArticlesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/support_articles")();
+
+  const query = encodeFormQuery({
+    "desc": payload.desc,
+    "items_per_page": payload.items_per_page,
+    "page": payload.page,
+    "sort": payload.sort,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listOrSearchSupportArticles",
+    oAuth2Scopes: [],
+
+    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,
+    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: ["4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    operations.ListOrSearchSupportArticlesListOrSearchArticlesOk,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(
+      200,
+      operations
+        .ListOrSearchSupportArticlesListOrSearchArticlesOk$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/{userGetCurrentUser.ts → usersGetCurrentUser.ts}

@@ -28,7 +28,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Returns a user object for the user represented by the authorization token
  */
-export function userGetCurrentUser(
+export function usersGetCurrentUser(
   client: GreenSecurityCore,
   options?: RequestOptions,
 ): APIPromise<

package/src/funcs/{userGetUserById.ts → usersGetUserById.ts}

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Returns a user object for the user represented by the identifier in the path.
  */
-export function userGetUserById(
+export function usersGetUserById(
   client: GreenSecurityCore,
   request: operations.GetUserByIdRequest,
   options?: RequestOptions,

package/src/funcs/{userLogsUserIntoTheSystem.ts → usersLogsUserIntoTheSystem.ts}

@@ -59,7 +59,7 @@ import { Result } from "../types/fp.js";
  * 4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
  * 5. Fetch the user object from `/users/me` using the token
  */
-export function userLogsUserIntoTheSystem(
+export function usersLogsUserIntoTheSystem(
   client: GreenSecurityCore,
   request: operations.LogsUserIntoTheSystemRequestBody,
   options?: RequestOptions,

package/src/funcs/{userMagiclink.ts → usersMagiclink.ts}

@@ -30,13 +30,13 @@ import { Result } from "../types/fp.js";
  * @remarks
  * It sends an email with a magic link to allow the user to log in.
  */
-export function userMagiclink(
+export function usersMagiclink(
   client: GreenSecurityCore,
   request: operations.MagiclinkRequestBody,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.MagiclinkResponseBody,
+    operations.MagiclinkMagiclinkOk,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -61,7 +61,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.MagiclinkResponseBody,
+      operations.MagiclinkMagiclinkOk,
       | errors.ApiErrorResponse
       | APIError
       | SDKValidationError
@@ -139,7 +139,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.MagiclinkResponseBody,
+    operations.MagiclinkMagiclinkOk,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -149,7 +149,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.MagiclinkResponseBody$inboundSchema),
+    M.json(200, operations.MagiclinkMagiclinkOk$inboundSchema),
     M.jsonErr(404, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{userPassword.ts → usersPassword.ts}

@@ -31,13 +31,13 @@ import { Result } from "../types/fp.js";
  * Resets the a user's password using a password_reset_id that was sent to them via email.
  * See /users/passwordresetrequest to initiate a password reset flow.
  */
-export function userPassword(
+export function usersPassword(
   client: GreenSecurityCore,
   request: operations.PasswordRequestBody,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.PasswordResponseBody,
+    operations.PasswordPasswordOk,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -62,7 +62,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.PasswordResponseBody,
+      operations.PasswordPasswordOk,
       | errors.ApiErrorResponse
       | APIError
       | SDKValidationError
@@ -140,7 +140,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.PasswordResponseBody,
+    operations.PasswordPasswordOk,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -150,7 +150,7 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.PasswordResponseBody$inboundSchema),
+    M.json(200, operations.PasswordPasswordOk$inboundSchema),
     M.jsonErr(404, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/{userPasswordResetRequest.ts → usersPasswordResetRequest.ts}

@@ -30,13 +30,13 @@ import { Result } from "../types/fp.js";
  * @remarks
  * It sends an email with a link for resetting a user's password.
  */
-export function userPasswordResetRequest(
+export function usersPasswordResetRequest(
   client: GreenSecurityCore,
   request: operations.PasswordResetRequestRequestBody,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.PasswordResetRequestResponseBody,
+    operations.PasswordResetRequestPasswordResetRequestOk,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -61,7 +61,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.PasswordResetRequestResponseBody,
+      operations.PasswordResetRequestPasswordResetRequestOk,
       | errors.ApiErrorResponse
       | APIError
       | SDKValidationError
@@ -140,7 +140,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.PasswordResetRequestResponseBody,
+    operations.PasswordResetRequestPasswordResetRequestOk,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -150,7 +150,10 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(200, operations.PasswordResetRequestResponseBody$inboundSchema),
+    M.json(
+      200,
+      operations.PasswordResetRequestPasswordResetRequestOk$inboundSchema,
+    ),
     M.jsonErr(404, errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/vendorsCreateVendorRegistration.ts

@@ -35,7 +35,7 @@ export function vendorsCreateVendorRegistration(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.CreateVendorRegistrationResponseBody,
+    operations.CreateVendorRegistrationCreateVendorRegistrationCreated,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -60,7 +60,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateVendorRegistrationResponseBody,
+      operations.CreateVendorRegistrationCreateVendorRegistrationCreated,
       | errors.ApiErrorResponse
       | APIError
       | SDKValidationError
@@ -137,7 +137,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.CreateVendorRegistrationResponseBody,
+    operations.CreateVendorRegistrationCreateVendorRegistrationCreated,
     | errors.ApiErrorResponse
     | APIError
     | SDKValidationError
@@ -147,7 +147,11 @@ async function $do(
     | RequestTimeoutError
     | ConnectionError
   >(
-    M.json(201, operations.CreateVendorRegistrationResponseBody$inboundSchema),
+    M.json(
+      201,
+      operations
+        .CreateVendorRegistrationCreateVendorRegistrationCreated$inboundSchema,
+    ),
     M.jsonErr([400, 401, 403, 409], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),