@greensecurity/javascript-sdk 0.45.0 → 0.46.0-beta.10

package/src/models/operations/getnextscreeningquestion.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetNextScreeningQuestionRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
@@ -29,7 +29,7 @@ export type GetNextScreeningQuestionRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the next unanswered screening question for the vendor scan, or `null` when none remain.
  */
 export type GetNextScreeningQuestionResponseBody = {
   success?: boolean | undefined;

package/src/models/operations/getnextunansweredscreeningquestion.ts

@@ -15,14 +15,14 @@ export type GetNextUnansweredScreeningQuestionRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   /**
-   * When provided, filters questions to those belonging to the specified facility. The facility must be targeted by the vendor.
+   * When provided, filters questions to those belonging to the specified facility. The vendor must target the facility.
    */
   facilityId?: number | undefined;
   /**
@@ -32,14 +32,14 @@ export type GetNextUnansweredScreeningQuestionRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the next unanswered screening question for the vendor and the vendor's current response, if any. Both are `null` when no questions remain.
  */
 export type GetNextUnansweredScreeningQuestionGetNextUnansweredScreeningQuestionOk =
   {
     screeningQuestion: components.ScreeningQuestion | null;
     screeningResponse: components.ScreeningResponse | null;
     /**
-     * Name of the facility the questions are scoped to. Null when facility_id query param is omitted.
+     * Name of the facility the questions apply to. Null when the request omits the `facility_id` query parameter.
      */
     facilityName: string | null;
     success: boolean;

package/src/models/operations/getsecurityzone.ts

@@ -7,7 +7,7 @@ import * as components from "../components/index.js";
 
 export type GetSecurityZoneRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**

package/src/models/operations/getsubscription.ts

@@ -14,9 +14,9 @@ export type GetSubscriptionRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
@@ -27,11 +27,11 @@ export type GetSubscriptionRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the vendor's current subscription.
  */
 export type GetSubscriptionGetSubscriptionOk = {
   /**
-   * Reduced list of attributes of the Subscription record
+   * Reduced list of attributes of the subscription record
    */
   subscription?: components.Subscription | null | undefined;
 };

package/src/models/operations/getsupportarticle.ts

@@ -7,7 +7,7 @@ import * as components from "../components/index.js";
 
 export type GetSupportArticleRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**

package/src/models/operations/getuserbyid.ts

@@ -10,7 +10,7 @@ export type GetUserByIdRequest = {
    * Either `me` for the authenticated user, or a positive integer user ID.
    *
    * @remarks
-   * Other values (including `0` and non-numeric strings) are rejected with
+   * Other values (including `0` and non-numeric strings) cause the server to return
    * a `422 Unprocessable Entity`.
    */
   id: string;

package/src/models/operations/getvendorcredentialdetails.ts

@@ -14,14 +14,14 @@ export type GetVendorCredentialDetailsRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
@@ -31,7 +31,7 @@ export type GetVendorCredentialDetailsRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the requested vendor credential.
  */
 export type GetVendorCredentialDetailsGetVendorCredentialDetailsOk = {
   /**

package/src/models/operations/getvendorcredentialfile.ts

@@ -12,7 +12,7 @@ export type GetVendorCredentialFileRequest = {
    */
   vendorCredentialId: number;
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**

package/src/models/operations/getvendorinvoicedetails.ts

@@ -7,7 +7,7 @@ import * as components from "../components/index.js";
 
 export type GetVendorInvoiceDetailsRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**

package/src/models/operations/getvendorinvoicereceipt.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetVendorInvoiceReceiptRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
 };
@@ -29,7 +29,7 @@ export type GetVendorInvoiceReceiptGetVendorInvoiceReceiptOk = {
    */
   filename?: string | undefined;
   /**
-   * MIME type of the PDF.
+   * Multipurpose Internet Mail Extensions (MIME) type of the PDF.
    */
   contentType?: string | undefined;
 };

package/src/models/operations/getvendorlegalname.ts

@@ -14,16 +14,16 @@ export type GetVendorLegalNameRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the vendor's legal first, middle, and last name.
  */
 export type GetVendorLegalNameGetVendorLegalNameOk = {
   firstName?: string | undefined;

package/src/models/operations/getvendorpaymentresponsibility.ts

@@ -18,14 +18,14 @@ export type GetVendorPaymentResponsibilityRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * The payment responsibility record for the vendor.
  */
 export type GetVendorPaymentResponsibilityGetVendorPaymentResponsibilityOk = {
   /**
    * Records which party (vendor or company manager) is responsible for each
    *
    * @remarks
-   * payment category for a given vendor–company relationship. A `null`
+   * payment category for a given vendor-company relationship. A `null`
    * `_user_id` field means responsibility defaults to the vendor.
    */
   paymentResponsibility?:

package/src/models/operations/getvendorscreeningquestions.ts

@@ -15,9 +15,9 @@ export type GetVendorScreeningQuestionsRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
@@ -28,7 +28,7 @@ export type GetVendorScreeningQuestionsRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * A page of the target-facility screening questions that apply to the vendor at the given facility, each with the vendor's answer if one exists.
  */
 export type GetVendorScreeningQuestionsGetVendorScreeningQuestionsOk = {
   /**
@@ -37,7 +37,7 @@ export type GetVendorScreeningQuestionsGetVendorScreeningQuestionsOk = {
   pager: components.Pager;
   items: Array<components.VendorTargetFacilityScreeningResponse>;
   /**
-   * Name of the facility the questions are scoped to.
+   * Name of the facility that the questions apply to.
    */
   facilityName: string | null;
 };

package/src/models/operations/getvendorsdetails.ts

@@ -11,9 +11,9 @@ export type GetVendorsDetailsRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;

package/src/models/operations/getvendortargetfacilities.ts

@@ -10,15 +10,24 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Filters to target facilities with this status.
+ */
 export const GetVendorTargetFacilitiesQueryParamStatus = {
   Pending: "pending",
   Approved: "approved",
   Denied: "denied",
 } as const;
+/**
+ * Filters to target facilities with this status.
+ */
 export type GetVendorTargetFacilitiesQueryParamStatus = ClosedEnum<
   typeof GetVendorTargetFacilitiesQueryParamStatus
 >;
 
+/**
+ * The field to sort results by. Defaults to `facility_name`.
+ */
 export const GetVendorTargetFacilitiesQueryParamSort = {
   FacilityName: "facility_name",
   SystemName: "system_name",
@@ -26,6 +35,9 @@ export const GetVendorTargetFacilitiesQueryParamSort = {
   QuestionsAnswered: "questions_answered",
   DateCreated: "date_created",
 } as const;
+/**
+ * The field to sort results by. Defaults to `facility_name`.
+ */
 export type GetVendorTargetFacilitiesQueryParamSort = ClosedEnum<
   typeof GetVendorTargetFacilitiesQueryParamSort
 >;
@@ -35,22 +47,43 @@ export type GetVendorTargetFacilitiesRequest = {
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
+  /**
+   * Filters to target facilities whose facility name contains this text, case-insensitive.
+   */
   facilityNameLike?: string | undefined;
+  /**
+   * Filters to target facilities whose system name contains this text, case-insensitive.
+   */
   systemNameLike?: string | undefined;
   /**
    * Search across facility name and system name.
    */
   searchLike?: string | undefined;
+  /**
+   * Filters to target facilities with this status.
+   */
   status?: GetVendorTargetFacilitiesQueryParamStatus | undefined;
+  /**
+   * The page number of results to return, starting at 1.
+   */
   page?: number | undefined;
+  /**
+   * The maximum number of items to return per page.
+   */
   itemsPerPage?: number | undefined;
+  /**
+   * The field to sort results by. Defaults to `facility_name`.
+   */
   sort?: GetVendorTargetFacilitiesQueryParamSort | undefined;
+  /**
+   * If true, sorts results in descending order; if false, in ascending order.
+   */
   desc?: boolean | undefined;
   /**
    * An array-style parameter to identify which sections of an object to expand. See documentation for the endpoint for a list of valid expansion values.
@@ -59,7 +92,7 @@ export type GetVendorTargetFacilitiesRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the vendor's target facilities, with the status and screening question progress of each.
  */
 export type GetVendorTargetFacilitiesGetVendorTargetFacilitiesOk = {
   /**

package/src/models/operations/getvendoruploadhistory.ts

@@ -15,31 +15,31 @@ export type GetVendorUploadHistoryRequest = {
    */
   sort?: string | null | undefined;
   /**
-   * Sort desc
+   * Sort desc.
    */
   desc?: components.Desc | undefined;
   /**
-   * A 1-based offset for which page to request (defaults to 1)
+   * A 1-based offset for which page to request (defaults to `1`)
    */
   page?: number | undefined;
   /**
-   * Number of items to show in a given page
+   * Number of items to show in a given page.
    */
   itemsPerPage?: number | undefined;
   /**
    * Vendor identifier. Depending on the endpoint, accepts one or more of:
    *
    * @remarks
-   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - A numeric vendor ID (positive integer, for example, `42`)
    * - The keyword `me` to represent the authenticated vendor
-   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   * - An active QR code (alphanumeric, hyphen-separated, for example, `ABC-123-DEF`),
    *   supported only on endpoints that explicitly document QR-code lookup
    */
   vendorIdOrMe: string;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the vendor's uploaded credential files, newest first, and pagination details.
  */
 export type GetVendorUploadHistoryGetVendorUploadHistoryOk = {
   /**

package/src/models/operations/getwebhookendpoint.ts

@@ -6,7 +6,7 @@ import * as z from "zod/v3";
 
 export type GetWebhookEndpointRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
 };

package/src/models/operations/heartbeatappdevsession.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type HeartbeatAppDevSessionRequest = {
+  /**
+   * The marketplace app's id.
+   */
+  appId: number;
+  /**
+   * The dev session's id.
+   */
+  id: string;
+};
+
+/**
+ * The session is active.
+ */
+export type HeartbeatAppDevSessionHeartbeatAppDevSessionOk = {
+  /**
+   * The dev session's id.
+   */
+  id: string;
+  /**
+   * When the session expires, in milliseconds since the Unix epoch.
+   */
+  expiresAt: number;
+};
+
+/** @internal */
+export type HeartbeatAppDevSessionRequest$Outbound = {
+  app_id: number;
+  id: string;
+};
+
+/** @internal */
+export const HeartbeatAppDevSessionRequest$outboundSchema: z.ZodType<
+  HeartbeatAppDevSessionRequest$Outbound,
+  z.ZodTypeDef,
+  HeartbeatAppDevSessionRequest
+> = z.object({
+  appId: z.number().int(),
+  id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    appId: "app_id",
+  });
+});
+
+export function heartbeatAppDevSessionRequestToJSON(
+  heartbeatAppDevSessionRequest: HeartbeatAppDevSessionRequest,
+): string {
+  return JSON.stringify(
+    HeartbeatAppDevSessionRequest$outboundSchema.parse(
+      heartbeatAppDevSessionRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const HeartbeatAppDevSessionHeartbeatAppDevSessionOk$inboundSchema:
+  z.ZodType<
+    HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    id: types.string(),
+    expires_at: types.number(),
+  }).transform((v) => {
+    return remap$(v, {
+      "expires_at": "expiresAt",
+    });
+  });
+
+export function heartbeatAppDevSessionHeartbeatAppDevSessionOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  HeartbeatAppDevSessionHeartbeatAppDevSessionOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      HeartbeatAppDevSessionHeartbeatAppDevSessionOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'HeartbeatAppDevSessionHeartbeatAppDevSessionOk' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -4,6 +4,7 @@
 
 export * from "./acceptinvitation.js";
 export * from "./acceptvendorcredential.js";
+export * from "./addappdeveloper.js";
 export * from "./addcompanymanager.js";
 export * from "./adddatarequestfile.js";
 export * from "./addmobiledevice.js";
@@ -15,7 +16,9 @@ export * from "./cancelhandoff.js";
 export * from "./changepassword.js";
 export * from "./changesubscription.js";
 export * from "./checkdownloadcode.js";
+export * from "./closeappdevsession.js";
 export * from "./convertquote.js";
+export * from "./createappdevsession.js";
 export * from "./createcompanytargetfacility.js";
 export * from "./createevent.js";
 export * from "./createinvoice.js";
@@ -49,6 +52,7 @@ export * from "./expeditetimeremaining.js";
 export * from "./exportcompanytargetfacilities.js";
 export * from "./exportfacilityvendors.js";
 export * from "./exportvendorscans.js";
+export * from "./findappsecret.js";
 export * from "./getcompany.js";
 export * from "./getcompanytargetfacilitiesexportstatus.js";
 export * from "./getcurrentuser.js";
@@ -85,6 +89,7 @@ export * from "./getvendorsexportstatus.js";
 export * from "./getvendortargetfacilities.js";
 export * from "./getvendoruploadhistory.js";
 export * from "./getwebhookendpoint.js";
+export * from "./heartbeatappdevsession.js";
 export * from "./initiatescheduledreport.js";
 export * from "./invoicesexport.js";
 export * from "./listalerts.js";
@@ -94,6 +99,10 @@ export * from "./listallmedicalproductcategories.js";
 export * from "./listallmedicalproductfamilies.js";
 export * from "./listallmedicalproducts.js";
 export * from "./listallwebhookendpoints.js";
+export * from "./listappactivations.js";
+export * from "./listappdevelopers.js";
+export * from "./listappsecrets.js";
+export * from "./listappversions.js";
 export * from "./listcompanycredentials.js";
 export * from "./listcompanycredits.js";
 export * from "./listcompanymanagercontacts.js";
@@ -145,8 +154,12 @@ export * from "./patchmedicalproduct.js";
 export * from "./patchmedicalproductcategory.js";
 export * from "./patchmedicalproductfamily.js";
 export * from "./postauthenticate.js";
+export * from "./publishappmanifest.js";
 export * from "./purchasescrubcredits.js";
+export * from "./removeappdeveloper.js";
+export * from "./revoketoken.js";
 export * from "./rotateapikey.js";
+export * from "./rotateappwebhookendpointsecret.js";
 export * from "./securityzonecheckin.js";
 export * from "./senddownloadcode.js";
 export * from "./submitscreeningresponse.js";

package/src/models/operations/initiatescheduledreport.ts

@@ -17,11 +17,11 @@ export type InitiateScheduledReportRequest = {
 };
 
 /**
- * A new report run was queued for generation.
+ * The API queued a report run for generation.
  */
 export type InitiateScheduledReportInitiateScheduledReportOk = {
   /**
-   * URL to poll for the generated report's status via `GET /reports/{full_report_id}`.
+   * URL to poll for the generated report's status using `GET /reports/{full_report_id}`.
    */
   pollUrl: string;
   success: boolean;

package/src/models/operations/invoicesexport.ts

@@ -8,28 +8,28 @@ import { ClosedEnum } from "../../types/enums.js";
 import * as components from "../components/index.js";
 
 /**
- * Filter by financial status (paid or unpaid).
+ * Filter by financial status (`paid` or `unpaid`).
  */
 export const InvoiceFinancialStatus = {
   Paid: "paid",
   Unpaid: "unpaid",
 } as const;
 /**
- * Filter by financial status (paid or unpaid).
+ * Filter by financial status (`paid` or `unpaid`).
  */
 export type InvoiceFinancialStatus = ClosedEnum<typeof InvoiceFinancialStatus>;
 
 export type InvoicesExportRequest = {
   /**
-   * Filter by invoice number (e.g., `CM-123` or `123-1`).
+   * Filter by invoice number (for example, `CM-123` or `123-1`).
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter by financial status (paid or unpaid).
+   * Filter by financial status (`paid` or `unpaid`).
    */
   invoiceFinancialStatus?: InvoiceFinancialStatus | undefined;
   /**
-   * Case-insensitive search across representative name (vendor user full name) or the word "Company".
+   * Case-insensitive search across representative name (vendor user full name) or the word `Company`.
    */
   representative?: string | undefined;
   /**
@@ -41,19 +41,23 @@ export type InvoicesExportRequest = {
    */
   datePaidLte?: string | undefined;
   /**
-   * Scope to a specific vendor (API users only; must be authorized by MarketplaceAppActivation).
+   * For vendors, `me` or their own vendor ID.
+   *
+   * @remarks
+   * For company managers, a numeric vendor ID; narrows the export to that vendor's invoices within the company's scope.
+   * For API users, the ID of a vendor the app can read.
    */
   vendorId?: string | undefined;
   /**
-   * Scope to a specific company (API users only; must be authorized by MarketplaceAppActivation).
+   * Filter by a specific authorized company ID.
    */
   companyId?: number | undefined;
   /**
-   * Scope to a specific facility (API users only; must be authorized by MarketplaceAppActivation).
+   * Filter by a specific authorized facility ID.
    */
   facilityId?: number | undefined;
   /**
-   * Scope to a specific system (API users only; must be authorized by MarketplaceAppActivation).
+   * Filter by a specific authorized system ID.
    */
   systemId?: number | undefined;
   /**
@@ -61,7 +65,7 @@ export type InvoicesExportRequest = {
    */
   sort?: string | undefined;
   /**
-   * Sort desc
+   * Sort desc.
    */
   desc?: components.Desc | undefined;
   /**