@greensecurity/javascript-sdk 0.40.8-beta.3 → 0.40.8-beta.30

package/src/funcs/vendorsGetNextUnansweredScreeningQuestion.ts

@@ -0,0 +1,188 @@
+/*
+ * 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 { 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 question
+ *
+ * @remarks
+ * Returns the next unanswered screening question for the vendor specified by the vendor_id_or_me path parameter.
+ */
+export function vendorsGetNextUnansweredScreeningQuestion(
+  client: GreenSecurityCore,
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetNextUnansweredScreeningQuestionResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.GetNextUnansweredScreeningQuestionRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetNextUnansweredScreeningQuestionResponseBody,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetNextUnansweredScreeningQuestionRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    vendor_id_or_me: encodeSimple("vendor_id_or_me", payload.vendor_id_or_me, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/vendors/{vendor_id_or_me}/screening-questions/next-unanswered-question",
+  )(pathParams);
+
+  const query = encodeFormQuery({
+    "expand": payload.expand,
+  }, { explode: false });
+
+  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: "getNextUnansweredScreeningQuestion",
+    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,
+    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: ["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.GetNextUnansweredScreeningQuestionResponseBody,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.GetNextUnansweredScreeningQuestionResponseBody$inboundSchema,
+    ),
+    M.jsonErr([403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr(500, errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail("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/vendorsGetVendorsDetails.ts

@@ -54,6 +54,7 @@ import { Result } from "../types/fp.js";
  * vendor.pending_invoice
  * vendor.vendor_groups
  * vendor.has_credentialed_facilities
+ * vendor.has_emerald_status
  */
 export function vendorsGetVendorsDetails(
   client: GreenSecurityCore,

package/src/index.extras.ts

@@ -19,7 +19,12 @@ import { subscriptionGetVendorTypes } from "./admin-funcs/subscriptionGetVendorT
 import { subscriptionUpdateVendorType } from "./admin-funcs/subscriptionUpdateVendorType.js";
 import { subscriptionGetPaymentProfile } from "./admin-funcs/subscriptionGetPaymentProfile.js";
 import { subscriptionUpdatePaymentProfile } from "./admin-funcs/subscriptionUpdatePaymentProfile.js";
-import {submitUserFeedback} from "./admin-funcs/submitUserFeedback.js";
+import { submitUserFeedback } from "./admin-funcs/submitUserFeedback.js";
+
+import { submitEmailStep } from "./admin-funcs/registerEmail.js";
+import { submitPassword } from "./admin-funcs/registerPassword.js";
+import { submitGeneralInfo } from "./admin-funcs/registerGeneralInfo.js";
+import { submitCompany } from "./admin-funcs/registerCompanies.js";
 
 export const __internal = {
   getInternalCore,
@@ -49,5 +54,13 @@ export const __internal = {
     updateVendorType: subscriptionUpdateVendorType,
     getPaymentProfile: subscriptionGetPaymentProfile,
     updatePaymentProfile: subscriptionUpdatePaymentProfile
+  },
+
+  registration:
+  {
+    submitEmailStep,
+    submitPassword,
+    submitGeneralInfo,
+    submitCompany
   }
 };

package/src/lib/config.ts

@@ -79,9 +79,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "0.0.4",
-  sdkVersion: "0.40.8-beta.2",
-  genVersion: "2.687.1",
+  openapiDocVersion: "0.0.6",
+  sdkVersion: "0.40.8-beta.29",
+  genVersion: "2.716.10",
   userAgent:
-    "speakeasy-sdk/typescript 0.40.8-beta.2 2.687.1 0.0.4 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.40.8-beta.29 2.716.10 0.0.6 @greensecurity/javascript-sdk",
 } as const;

package/src/lib/url.ts

@@ -10,7 +10,7 @@ export function pathToFunc(
   pathPattern: string,
   options?: { charEncoding?: "percent" | "none" },
 ): (params?: Params) => string {
-  const paramRE = /\{([a-zA-Z0-9_]+?)\}/g;
+  const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
 
   return function buildURLPath(params: Record<string, unknown> = {}): string {
     return pathPattern.replace(paramRE, function (_, placeholder) {

package/src/models/components/alert.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Type = {
+  Error: "Error",
+  Warning: "Warning",
+  Info: "Info",
+} as const;
+export type Type = ClosedEnum<typeof Type>;
+
+/**
+ * A simplified representation of a Alert, typically used in list views.
+ */
+export type Alert = {
+  id?: number | undefined;
+  dateAdded?: string | null | undefined;
+  dateStarts?: string | null | undefined;
+  message?: string | null | undefined;
+  status?: string | null | undefined;
+  type?: Type | null | undefined;
+  title?: string | null | undefined;
+  plainText?: string | null | undefined;
+  viewed?: boolean | null | undefined;
+  dateViewed?: string | null | undefined;
+};
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
+}
+
+/** @internal */
+export const Alert$inboundSchema: z.ZodType<Alert, z.ZodTypeDef, unknown> = z
+  .object({
+    id: z.number().int().optional(),
+    date_added: z.nullable(z.string()).optional(),
+    date_starts: z.nullable(z.string()).optional(),
+    message: z.nullable(z.string()).optional(),
+    status: z.nullable(z.string()).optional(),
+    type: z.nullable(Type$inboundSchema).optional(),
+    title: z.nullable(z.string()).optional(),
+    plain_text: z.nullable(z.string()).optional(),
+    viewed: z.nullable(z.boolean()).optional(),
+    date_viewed: z.nullable(z.string()).optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "date_added": "dateAdded",
+      "date_starts": "dateStarts",
+      "plain_text": "plainText",
+      "date_viewed": "dateViewed",
+    });
+  });
+
+/** @internal */
+export type Alert$Outbound = {
+  id?: number | undefined;
+  date_added?: string | null | undefined;
+  date_starts?: string | null | undefined;
+  message?: string | null | undefined;
+  status?: string | null | undefined;
+  type?: string | null | undefined;
+  title?: string | null | undefined;
+  plain_text?: string | null | undefined;
+  viewed?: boolean | null | undefined;
+  date_viewed?: string | null | undefined;
+};
+
+/** @internal */
+export const Alert$outboundSchema: z.ZodType<
+  Alert$Outbound,
+  z.ZodTypeDef,
+  Alert
+> = z.object({
+  id: z.number().int().optional(),
+  dateAdded: z.nullable(z.string()).optional(),
+  dateStarts: z.nullable(z.string()).optional(),
+  message: z.nullable(z.string()).optional(),
+  status: z.nullable(z.string()).optional(),
+  type: z.nullable(Type$outboundSchema).optional(),
+  title: z.nullable(z.string()).optional(),
+  plainText: z.nullable(z.string()).optional(),
+  viewed: z.nullable(z.boolean()).optional(),
+  dateViewed: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    dateAdded: "date_added",
+    dateStarts: "date_starts",
+    plainText: "plain_text",
+    dateViewed: "date_viewed",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Alert$ {
+  /** @deprecated use `Alert$inboundSchema` instead. */
+  export const inboundSchema = Alert$inboundSchema;
+  /** @deprecated use `Alert$outboundSchema` instead. */
+  export const outboundSchema = Alert$outboundSchema;
+  /** @deprecated use `Alert$Outbound` instead. */
+  export type Outbound = Alert$Outbound;
+}
+
+export function alertToJSON(alert: Alert): string {
+  return JSON.stringify(Alert$outboundSchema.parse(alert));
+}
+
+export function alertFromJSON(
+  jsonString: string,
+): SafeParseResult<Alert, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Alert$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Alert' from JSON`,
+  );
+}

package/src/models/components/credential.ts

@@ -45,11 +45,12 @@ export type CredentialStatus1 = ClosedEnum<typeof CredentialStatus1>;
  */
 export type Credential = {
   id: number;
+  appliesToCompany?: boolean | undefined;
   name?: string | null | undefined;
   description?: string | null | undefined;
   credentialType?: CredentialType | undefined;
   validFor?: ValidFor | undefined;
-  status?: CredentialStatus1 | undefined;
+  status?: CredentialStatus1 | null | undefined;
   hasPricing?: boolean | undefined;
   allowDecline?: boolean | undefined;
   jsSchema?: string | null | undefined;
@@ -61,7 +62,7 @@ export type Credential = {
   declineSubmittingText?: string | null | undefined;
   declineDescription?: string | null | undefined;
   requireDeclineFile?: boolean | undefined;
-  credentialDocuments?: Array<CredentialDocument | null> | undefined;
+  credentialDocuments?: Array<CredentialDocument | null> | null | undefined;
   fileUrl?: string | null | undefined;
   declineFileUrl?: string | null | undefined;
 };
@@ -134,11 +135,12 @@ export const Credential$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.number().int(),
+  applies_to_company: z.boolean().optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
   credential_type: CredentialType$inboundSchema.optional(),
   valid_for: ValidFor$inboundSchema.optional(),
-  status: CredentialStatus1$inboundSchema.optional(),
+  status: z.nullable(CredentialStatus1$inboundSchema).optional(),
   has_pricing: z.boolean().optional(),
   allow_decline: z.boolean().optional(),
   js_schema: z.nullable(z.string()).optional(),
@@ -150,13 +152,14 @@ export const Credential$inboundSchema: z.ZodType<
   decline_submitting_text: z.nullable(z.string()).optional(),
   decline_description: z.nullable(z.string()).optional(),
   require_decline_file: z.boolean().optional(),
-  credential_documents: z.array(
-    z.nullable(z.lazy(() => CredentialDocument$inboundSchema)),
+  credential_documents: z.nullable(
+    z.array(z.nullable(z.lazy(() => CredentialDocument$inboundSchema))),
   ).optional(),
   file_url: z.nullable(z.string()).optional(),
   decline_file_url: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    "applies_to_company": "appliesToCompany",
     "credential_type": "credentialType",
     "valid_for": "validFor",
     "has_pricing": "hasPricing",
@@ -178,11 +181,12 @@ export const Credential$inboundSchema: z.ZodType<
 /** @internal */
 export type Credential$Outbound = {
   id: number;
+  applies_to_company?: boolean | undefined;
   name?: string | null | undefined;
   description?: string | null | undefined;
   credential_type?: string | undefined;
   valid_for?: string | undefined;
-  status?: string | undefined;
+  status?: string | null | undefined;
   has_pricing?: boolean | undefined;
   allow_decline?: boolean | undefined;
   js_schema?: string | null | undefined;
@@ -194,7 +198,10 @@ export type Credential$Outbound = {
   decline_submitting_text?: string | null | undefined;
   decline_description?: string | null | undefined;
   require_decline_file?: boolean | undefined;
-  credential_documents?: Array<CredentialDocument$Outbound | null> | undefined;
+  credential_documents?:
+    | Array<CredentialDocument$Outbound | null>
+    | null
+    | undefined;
   file_url?: string | null | undefined;
   decline_file_url?: string | null | undefined;
 };
@@ -206,11 +213,12 @@ export const Credential$outboundSchema: z.ZodType<
   Credential
 > = z.object({
   id: z.number().int(),
+  appliesToCompany: z.boolean().optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
   credentialType: CredentialType$outboundSchema.optional(),
   validFor: ValidFor$outboundSchema.optional(),
-  status: CredentialStatus1$outboundSchema.optional(),
+  status: z.nullable(CredentialStatus1$outboundSchema).optional(),
   hasPricing: z.boolean().optional(),
   allowDecline: z.boolean().optional(),
   jsSchema: z.nullable(z.string()).optional(),
@@ -222,13 +230,14 @@ export const Credential$outboundSchema: z.ZodType<
   declineSubmittingText: z.nullable(z.string()).optional(),
   declineDescription: z.nullable(z.string()).optional(),
   requireDeclineFile: z.boolean().optional(),
-  credentialDocuments: z.array(
-    z.nullable(z.lazy(() => CredentialDocument$outboundSchema)),
+  credentialDocuments: z.nullable(
+    z.array(z.nullable(z.lazy(() => CredentialDocument$outboundSchema))),
   ).optional(),
   fileUrl: z.nullable(z.string()).optional(),
   declineFileUrl: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
+    appliesToCompany: "applies_to_company",
     credentialType: "credential_type",
     validFor: "valid_for",
     hasPricing: "has_pricing",

package/src/models/components/credentialstatus.ts

@@ -17,6 +17,7 @@ export const CredentialStatus = {
   Denied: "Denied",
   Approved: "Approved",
   Expiring30: "expiring_30",
+  NotApproved: "Not Approved",
 } as const;
 /**
  * Status values

package/src/models/components/expand.ts

@@ -44,6 +44,7 @@ export const Expand = {
   VendorPendingInvoice: "vendor.pending_invoice",
   VendorVendorGroups: "vendor.vendor_groups",
   VendorHasCredentialedFacilities: "vendor.has_credentialed_facilities",
+  VendorHasEmeraldStatus: "vendor.has_emerald_status",
   SupportArticleDescription: "support_article.description",
   SupportArticlePublished: "support_article.published",
   SupportArticleNotes: "support_article.notes",
@@ -89,6 +90,7 @@ export const Expand = {
   SubscriptionExpeditedOffer: "subscription.expedited_offer",
   DepartmentMembershipContact: "department_membership.contact",
   DepartmentMembershipDepartment: "department_membership.department",
+  ScreeningQuestionScreeningAnswers: "screening_question.screening_answers",
 } as const;
 /**
  * An expansion scope that is valid for the object being requested.