@greensecurity/javascript-sdk 0.49.0-beta.6 → 0.49.0-beta.8

package/src/admin-funcs/registerCompanies.ts

@@ -1,9 +1,9 @@
 import { APIPromise } from "../types/async.js";
-import { $doPost, internalApiResult } from "./doAdmin.js";
+import { $doGetSingle, $doPost, internalApiResult } from "./doAdmin.js";
 
 export type companyPayload = {
   name: string;
-  contact_name: string;
+  contact_name?: string;
   contact_email: string;
   address: string;
   city: string;
@@ -21,3 +21,23 @@ export function submitCompany(request: companyPayload): internalApiResult {
     request
   ));
 }
+
+/** Add-company values read from a website's JSON-LD. Resolves to `{ company }`, `{}` when nothing was found. */
+export function prefillCompany(request: { website: string }): internalApiResult {
+  return new APIPromise($doGetSingle("/vendors/register/companies/prefill", request));
+}
+
+export type registrationSupervisor = {
+  name: string;
+  email: string;
+  phone: string | null;
+  kind: "company_manager" | "supervisor";
+};
+
+/** Supervisor suggestions for a company whose name has a word starting with `q` (2+ chars). Resolves to `{ items }`. */
+export function getCompanySupervisors(request: { company_id: number; q: string }): internalApiResult {
+  return new APIPromise($doGetSingle(
+    "/vendors/register/companies/" + request.company_id + "/supervisors",
+    { q: request.q }
+  ));
+}

package/src/admin-funcs/registerGeneralInfo.ts

@@ -2,7 +2,6 @@ import { APIPromise } from "../types/async.js";
 import { $doPost, internalApiResult } from "./doAdmin.js";
 
 export type formInputs = {
-  federal: string;
   first_name: string;
   last_name: string;
   vendor_job_id: number;
@@ -11,9 +10,11 @@ export type formInputs = {
   fax: string;
   timezone: string;
   company_id: string;
-  supervisor_name: string;
-  supervisor_email: string;
-  supervisor_phone: string;
+  /** When true the supervisor fields are omitted and cleared. */
+  no_supervisor?: boolean;
+  supervisor_name?: string;
+  supervisor_email?: string;
+  supervisor_phone?: string;
   /** Contact emails; the login stays the email the vendor registered with, which must be one of the two. */
   work_email?: string;
   personal_email?: string;

package/src/admin-funcs/registerPassword.ts

@@ -3,7 +3,8 @@ import { $doPost, internalApiResult } from "./doAdmin.js";
 
 export type passwordRegisterData = {
   password: string | null;
-  password_confirm: string | null;
+  /** Omitted by the single-field form. */
+  password_confirm?: string | null;
 };
 
 export function submitPassword(request: passwordRegisterData): internalApiResult {

package/src/funcs/companiesLookupCompanies.ts

@@ -113,9 +113,11 @@ async function $do(
   const query = encodeFormQuery({
     "desc": payload.desc,
     "items_per_page": payload.items_per_page,
+    "match_email_domain": payload.match_email_domain,
     "name_like": payload.name_like,
     "page": payload.page,
     "sort": payload.sort,
+    "tax_id": payload.tax_id,
   });
 
   const headers = new Headers(compactMap({

package/src/index.extras.ts

@@ -32,7 +32,11 @@ import { handoffStayAlive } from "./admin-funcs/handoffStayAlive.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";
+import {
+  getCompanySupervisors,
+  prefillCompany,
+  submitCompany,
+} from "./admin-funcs/registerCompanies.js";
 import {
   clearComplete,
   clearCreateSession,
@@ -134,7 +138,9 @@ export const __internal = {
     submitEmailStep,
     submitPassword,
     submitGeneralInfo,
-    submitCompany
+    submitCompany,
+    prefillCompany,
+    getCompanySupervisors
   },
 
   clear: {

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.48.0",
-  sdkVersion: "0.49.0-beta.6",
-  genVersion: "2.956.1",
+  sdkVersion: "0.49.0-beta.8",
+  genVersion: "2.960.8",
   userAgent:
-    "speakeasy-sdk/typescript 0.49.0-beta.6 2.956.1 0.48.0 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.49.0-beta.8 2.960.8 0.48.0 @greensecurity/javascript-sdk",
 } as const;

package/src/lib/env.ts

@@ -15,9 +15,15 @@ export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
   GREEN_SECURITY_TOKEN: z.string().optional(),
   GREEN_SECURITY_BEARER_JWT: z.string().optional(),
 
-  GREEN_SECURITY_DEBUG: z.coerce.boolean().optional(),
+  GREEN_SECURITY_DEBUG: z.unknown().transform(parseEnvFlag).optional(),
 });
 
+function parseEnvFlag(value: unknown): boolean {
+  return ["true", "1", "yes", "on"].includes(
+    String(value).trim().toLowerCase(),
+  );
+}
+
 /**
  * Checks for the existence of the Deno global object to determine the environment.
  * @returns {boolean} True if the runtime is Deno, false otherwise.

package/src/models/components/companylookup.ts

@@ -9,7 +9,7 @@ import * as types from "../../types/primitives.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * A minimal reference to a company, used in lookups.
+ * A minimal reference to a company, used in lookups. Never includes the tax ID.
  */
 export type CompanyLookup = {
   /**
@@ -20,6 +20,26 @@ export type CompanyLookup = {
    * The name of the company, or `null` if none.
    */
   name: string | null;
+  /**
+   * The company status, such as `Active`, or `Inactive` while it awaits review.
+   */
+  status?: string | null | undefined;
+  /**
+   * The company's first email domain, else its website host, or `null` if neither.
+   */
+  domain?: string | null | undefined;
+  /**
+   * The company website, or `null` if none.
+   */
+  website?: string | null | undefined;
+  /**
+   * The company city, or `null` if none.
+   */
+  city?: string | null | undefined;
+  /**
+   * The company state or province, or `null` if none.
+   */
+  state?: string | null | undefined;
 };
 
 /** @internal */
@@ -30,6 +50,11 @@ export const CompanyLookup$inboundSchema: z.ZodType<
 > = z.object({
   id: types.number(),
   name: types.nullable(types.string()),
+  status: z.nullable(types.string()).optional(),
+  domain: z.nullable(types.string()).optional(),
+  website: z.nullable(types.string()).optional(),
+  city: z.nullable(types.string()).optional(),
+  state: z.nullable(types.string()).optional(),
 });
 
 export function companyLookupFromJSON(

package/src/models/operations/createvendor.ts

@@ -49,10 +49,6 @@ export type CreateVendorRequestBody = {
    * Rails timezone name (for example, Eastern Time (US and Canada))
    */
   timezone?: string | undefined;
-  /**
-   * Whether a federal agency has listed the vendor as disbarred or excluded
-   */
-  federal?: boolean | undefined;
   /**
    * ID of the vendor's primary facility
    */
@@ -122,7 +118,6 @@ export type CreateVendorRequestBody$Outbound = {
   mobile_phone?: string | undefined;
   fax?: string | undefined;
   timezone?: string | undefined;
-  federal?: boolean | undefined;
   primary_facility_id: number;
   supervisor_name: string;
   supervisor_email: string;
@@ -150,7 +145,6 @@ export const CreateVendorRequestBody$outboundSchema: z.ZodType<
   mobilePhone: z.string().optional(),
   fax: z.string().optional(),
   timezone: z.string().optional(),
-  federal: z.boolean().optional(),
   primaryFacilityId: z.number().int(),
   supervisorName: z.string(),
   supervisorEmail: z.string(),

package/src/models/operations/lookupcompanies.ts

@@ -30,6 +30,17 @@ export type LookupCompaniesRequest = {
    * A partial string to search in the object name. Do not include any wildcard characters. Searches are not case-sensitive by default.
    */
   nameLike?: string | undefined;
+  /**
+   * Only the company holding this federal tax ID (EIN or SSN format, dash optional).
+   */
+  taxId?: string | undefined;
+  /**
+   * Only companies that own the caller's login email domain, or whose vendors sign in with it.
+   *
+   * @remarks
+   * Free-mail domains such as gmail.com match nothing.
+   */
+  matchEmailDomain?: boolean | undefined;
 };
 
 /**
@@ -54,6 +65,8 @@ export type LookupCompaniesRequest$Outbound = {
   page?: number | undefined;
   items_per_page: number;
   name_like?: string | undefined;
+  tax_id?: string | undefined;
+  match_email_domain?: boolean | undefined;
 };
 
 /** @internal */
@@ -67,10 +80,14 @@ export const LookupCompaniesRequest$outboundSchema: z.ZodType<
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().default(25),
   nameLike: z.string().optional(),
+  taxId: z.string().optional(),
+  matchEmailDomain: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
     nameLike: "name_like",
+    taxId: "tax_id",
+    matchEmailDomain: "match_email_domain",
   });
 });
 

package/src/react-query/companiesLookupCompanies.core.ts

@@ -80,6 +80,8 @@ export function buildCompaniesLookupCompaniesQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       nameLike: request.nameLike,
+      taxId: request.taxId,
+      matchEmailDomain: request.matchEmailDomain,
     }),
     queryFn: async function companiesLookupCompaniesQueryFn(
       ctx,
@@ -121,6 +123,8 @@ export function buildCompaniesLookupCompaniesInfiniteQuery(
       page: request.page,
       itemsPerPage: request.itemsPerPage,
       nameLike: request.nameLike,
+      taxId: request.taxId,
+      matchEmailDomain: request.matchEmailDomain,
     }),
     queryFn: async function companiesLookupCompaniesQuery(
       ctx,
@@ -159,6 +163,8 @@ export function queryKeyCompaniesLookupCompanies(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     nameLike?: string | undefined;
+    taxId?: string | undefined;
+    matchEmailDomain?: boolean | undefined;
   },
 ): QueryKey {
   return [
@@ -176,6 +182,8 @@ export function queryKeyCompaniesLookupCompaniesInfinite(
     page?: number | undefined;
     itemsPerPage?: number | undefined;
     nameLike?: string | undefined;
+    taxId?: string | undefined;
+    matchEmailDomain?: boolean | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/companiesLookupCompanies.ts

@@ -236,6 +236,8 @@ export function setCompaniesLookupCompaniesData(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       nameLike?: string | undefined;
+      taxId?: string | undefined;
+      matchEmailDomain?: boolean | undefined;
     },
   ],
   data: CompaniesLookupCompaniesQueryData,
@@ -254,6 +256,8 @@ export function invalidateCompaniesLookupCompanies(
       page?: number | undefined;
       itemsPerPage?: number | undefined;
       nameLike?: string | undefined;
+      taxId?: string | undefined;
+      matchEmailDomain?: boolean | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,