@greensecurity/javascript-sdk 0.44.0-beta.56 → 0.44.0-beta.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -1
- package/dist/commonjs/__tests__/reports.test.d.ts +2 -0
- package/dist/commonjs/__tests__/reports.test.d.ts.map +1 -0
- package/dist/commonjs/__tests__/reports.test.js +53 -0
- package/dist/commonjs/__tests__/reports.test.js.map +1 -0
- package/dist/commonjs/__tests__/smartBadgeGetPsks.test.d.ts +2 -0
- package/dist/commonjs/__tests__/smartBadgeGetPsks.test.d.ts.map +1 -0
- package/dist/commonjs/__tests__/smartBadgeGetPsks.test.js +60 -0
- package/dist/commonjs/__tests__/smartBadgeGetPsks.test.js.map +1 -0
- package/dist/commonjs/__tests__/smartBadgeReportVerifiedPsk.test.d.ts +2 -0
- package/dist/commonjs/__tests__/smartBadgeReportVerifiedPsk.test.d.ts.map +1 -0
- package/dist/commonjs/__tests__/smartBadgeReportVerifiedPsk.test.js +46 -0
- package/dist/commonjs/__tests__/smartBadgeReportVerifiedPsk.test.js.map +1 -0
- package/dist/commonjs/__tests__/vendors.test.js +1 -1
- package/dist/commonjs/__tests__/vendorscans.test.js +44 -0
- package/dist/commonjs/__tests__/vendorscans.test.js.map +1 -1
- package/dist/commonjs/__tests__/webhooks.test.js +1 -1
- package/dist/commonjs/__tests__/webhooks.test.js.map +1 -1
- package/dist/commonjs/__tests__/zones.test.js +12 -15
- package/dist/commonjs/__tests__/zones.test.js.map +1 -1
- package/dist/commonjs/admin-funcs/smartBadgeGetPsks.d.ts +3 -0
- package/dist/commonjs/admin-funcs/smartBadgeGetPsks.d.ts.map +1 -0
- package/dist/commonjs/admin-funcs/smartBadgeGetPsks.js +23 -0
- package/dist/commonjs/admin-funcs/smartBadgeGetPsks.js.map +1 -0
- package/dist/commonjs/admin-funcs/smartBadgeMacAddress.d.ts +2 -0
- package/dist/commonjs/admin-funcs/smartBadgeMacAddress.d.ts.map +1 -0
- package/dist/commonjs/admin-funcs/smartBadgeMacAddress.js +25 -0
- package/dist/commonjs/admin-funcs/smartBadgeMacAddress.js.map +1 -0
- package/dist/commonjs/admin-funcs/smartBadgeReportVerifiedPsk.d.ts +6 -0
- package/dist/commonjs/admin-funcs/smartBadgeReportVerifiedPsk.d.ts.map +1 -0
- package/dist/commonjs/admin-funcs/smartBadgeReportVerifiedPsk.js +18 -0
- package/dist/commonjs/admin-funcs/smartBadgeReportVerifiedPsk.js.map +1 -0
- package/dist/commonjs/funcs/reportsGetFullReport.d.ts +43 -0
- package/dist/commonjs/funcs/reportsGetFullReport.d.ts.map +1 -0
- package/dist/commonjs/funcs/reportsGetFullReport.js +148 -0
- package/dist/commonjs/funcs/reportsGetFullReport.js.map +1 -0
- package/dist/commonjs/funcs/reportsInitiateScheduledReport.d.ts +37 -0
- package/dist/commonjs/funcs/reportsInitiateScheduledReport.d.ts.map +1 -0
- package/dist/commonjs/funcs/reportsInitiateScheduledReport.js +139 -0
- package/dist/commonjs/funcs/reportsInitiateScheduledReport.js.map +1 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsCheckoutConfig.d.ts +18 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsCheckoutConfig.d.ts.map +1 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsCheckoutConfig.js +124 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsCheckoutConfig.js.map +1 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsScanOut.d.ts +20 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsScanOut.d.ts.map +1 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsScanOut.js +126 -0
- package/dist/commonjs/funcs/vendorScansVendorScanGpsScanOut.js.map +1 -0
- package/dist/commonjs/funcs/vendorsUpdateVendorDetails.d.ts +14 -1
- package/dist/commonjs/funcs/vendorsUpdateVendorDetails.d.ts.map +1 -1
- package/dist/commonjs/funcs/vendorsUpdateVendorDetails.js +14 -1
- package/dist/commonjs/funcs/vendorsUpdateVendorDetails.js.map +1 -1
- package/dist/commonjs/index.extras.d.ts +4 -0
- package/dist/commonjs/index.extras.d.ts.map +1 -1
- package/dist/commonjs/index.extras.js +5 -1
- package/dist/commonjs/index.extras.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +3 -3
- package/dist/commonjs/lib/config.js +3 -3
- package/dist/commonjs/models/components/facility.d.ts +10 -0
- package/dist/commonjs/models/components/facility.d.ts.map +1 -1
- package/dist/commonjs/models/components/facility.js +8 -0
- package/dist/commonjs/models/components/facility.js.map +1 -1
- package/dist/commonjs/models/components/zone.d.ts +7 -0
- package/dist/commonjs/models/components/zone.d.ts.map +1 -1
- package/dist/commonjs/models/components/zone.js +8 -0
- package/dist/commonjs/models/components/zone.js.map +1 -1
- package/dist/commonjs/models/errors/apivalidationerrorresponse.d.ts +38 -0
- package/dist/commonjs/models/errors/apivalidationerrorresponse.d.ts.map +1 -0
- package/dist/commonjs/models/errors/apivalidationerrorresponse.js +78 -0
- package/dist/commonjs/models/errors/apivalidationerrorresponse.js.map +1 -0
- package/dist/commonjs/models/errors/index.d.ts +2 -0
- package/dist/commonjs/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/models/errors/index.js +2 -0
- package/dist/commonjs/models/errors/index.js.map +1 -1
- package/dist/commonjs/models/errors/unprocessableentityorvalidationerror.d.ts +13 -0
- package/dist/commonjs/models/errors/unprocessableentityorvalidationerror.d.ts.map +1 -0
- package/dist/commonjs/models/errors/unprocessableentityorvalidationerror.js +20 -0
- package/dist/commonjs/models/errors/unprocessableentityorvalidationerror.js.map +1 -0
- package/dist/commonjs/models/operations/getfullreport.d.ts +73 -0
- package/dist/commonjs/models/operations/getfullreport.d.ts.map +1 -0
- package/dist/commonjs/models/operations/getfullreport.js +107 -0
- package/dist/commonjs/models/operations/getfullreport.js.map +1 -0
- package/dist/commonjs/models/operations/index.d.ts +4 -0
- package/dist/commonjs/models/operations/index.d.ts.map +1 -1
- package/dist/commonjs/models/operations/index.js +4 -0
- package/dist/commonjs/models/operations/index.js.map +1 -1
- package/dist/commonjs/models/operations/initiatescheduledreport.d.ts +30 -0
- package/dist/commonjs/models/operations/initiatescheduledreport.d.ts.map +1 -0
- package/dist/commonjs/models/operations/initiatescheduledreport.js +69 -0
- package/dist/commonjs/models/operations/initiatescheduledreport.js.map +1 -0
- package/dist/commonjs/models/operations/vendorscangpscheckoutconfig.d.ts +57 -0
- package/dist/commonjs/models/operations/vendorscangpscheckoutconfig.d.ts.map +1 -0
- package/dist/commonjs/models/operations/vendorscangpscheckoutconfig.js +81 -0
- package/dist/commonjs/models/operations/vendorscangpscheckoutconfig.js.map +1 -0
- package/dist/commonjs/models/operations/vendorscangpsscanout.d.ts +81 -0
- package/dist/commonjs/models/operations/vendorscangpsscanout.d.ts.map +1 -0
- package/dist/commonjs/models/operations/vendorscangpsscanout.js +96 -0
- package/dist/commonjs/models/operations/vendorscangpsscanout.js.map +1 -0
- package/dist/commonjs/react-query/index.d.ts +4 -0
- package/dist/commonjs/react-query/index.d.ts.map +1 -1
- package/dist/commonjs/react-query/index.js +4 -0
- package/dist/commonjs/react-query/index.js.map +1 -1
- package/dist/commonjs/react-query/reportsGetFullReport.core.d.ts +12 -0
- package/dist/commonjs/react-query/reportsGetFullReport.core.d.ts.map +1 -0
- package/dist/commonjs/react-query/reportsGetFullReport.core.js +39 -0
- package/dist/commonjs/react-query/reportsGetFullReport.core.js.map +1 -0
- package/dist/commonjs/react-query/reportsGetFullReport.d.ts +75 -0
- package/dist/commonjs/react-query/reportsGetFullReport.d.ts.map +1 -0
- package/dist/commonjs/react-query/reportsGetFullReport.js +111 -0
- package/dist/commonjs/react-query/reportsGetFullReport.js.map +1 -0
- package/dist/commonjs/react-query/reportsInitiateScheduledReport.d.ts +46 -0
- package/dist/commonjs/react-query/reportsInitiateScheduledReport.d.ts.map +1 -0
- package/dist/commonjs/react-query/reportsInitiateScheduledReport.js +68 -0
- package/dist/commonjs/react-query/reportsInitiateScheduledReport.js.map +1 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.core.d.ts +12 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.core.d.ts.map +1 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.core.js +39 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.core.js.map +1 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.d.ts +29 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.d.ts.map +1 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.js +69 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsCheckoutConfig.js.map +1 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsScanOut.d.ts +31 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsScanOut.d.ts.map +1 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsScanOut.js +53 -0
- package/dist/commonjs/react-query/vendorScansVendorScanGpsScanOut.js.map +1 -0
- package/dist/commonjs/react-query/vendorsUpdateVendorDetails.d.ts +14 -1
- package/dist/commonjs/react-query/vendorsUpdateVendorDetails.d.ts.map +1 -1
- package/dist/commonjs/react-query/vendorsUpdateVendorDetails.js +14 -1
- package/dist/commonjs/react-query/vendorsUpdateVendorDetails.js.map +1 -1
- package/dist/commonjs/sdk/reports.d.ts +59 -0
- package/dist/commonjs/sdk/reports.d.ts.map +1 -0
- package/dist/commonjs/sdk/reports.js +72 -0
- package/dist/commonjs/sdk/reports.js.map +1 -0
- package/dist/commonjs/sdk/sdk.d.ts +3 -0
- package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/sdk/sdk.js +4 -0
- package/dist/commonjs/sdk/sdk.js.map +1 -1
- package/dist/commonjs/sdk/vendors.d.ts +14 -1
- package/dist/commonjs/sdk/vendors.d.ts.map +1 -1
- package/dist/commonjs/sdk/vendors.js +14 -1
- package/dist/commonjs/sdk/vendors.js.map +1 -1
- package/dist/commonjs/sdk/vendorscans.d.ts +16 -0
- package/dist/commonjs/sdk/vendorscans.d.ts.map +1 -1
- package/dist/commonjs/sdk/vendorscans.js +22 -0
- package/dist/commonjs/sdk/vendorscans.js.map +1 -1
- package/dist/esm/__tests__/reports.test.d.ts +2 -0
- package/dist/esm/__tests__/reports.test.d.ts.map +1 -0
- package/dist/esm/__tests__/reports.test.js +51 -0
- package/dist/esm/__tests__/reports.test.js.map +1 -0
- package/dist/esm/__tests__/smartBadgeGetPsks.test.d.ts +2 -0
- package/dist/esm/__tests__/smartBadgeGetPsks.test.d.ts.map +1 -0
- package/dist/esm/__tests__/smartBadgeGetPsks.test.js +58 -0
- package/dist/esm/__tests__/smartBadgeGetPsks.test.js.map +1 -0
- package/dist/esm/__tests__/smartBadgeReportVerifiedPsk.test.d.ts +2 -0
- package/dist/esm/__tests__/smartBadgeReportVerifiedPsk.test.d.ts.map +1 -0
- package/dist/esm/__tests__/smartBadgeReportVerifiedPsk.test.js +44 -0
- package/dist/esm/__tests__/smartBadgeReportVerifiedPsk.test.js.map +1 -0
- package/dist/esm/__tests__/vendors.test.js +1 -1
- package/dist/esm/__tests__/vendorscans.test.js +44 -0
- package/dist/esm/__tests__/vendorscans.test.js.map +1 -1
- package/dist/esm/__tests__/webhooks.test.js +1 -1
- package/dist/esm/__tests__/webhooks.test.js.map +1 -1
- package/dist/esm/__tests__/zones.test.js +12 -15
- package/dist/esm/__tests__/zones.test.js.map +1 -1
- package/dist/esm/admin-funcs/smartBadgeGetPsks.d.ts +3 -0
- package/dist/esm/admin-funcs/smartBadgeGetPsks.d.ts.map +1 -0
- package/dist/esm/admin-funcs/smartBadgeGetPsks.js +20 -0
- package/dist/esm/admin-funcs/smartBadgeGetPsks.js.map +1 -0
- package/dist/esm/admin-funcs/smartBadgeMacAddress.d.ts +2 -0
- package/dist/esm/admin-funcs/smartBadgeMacAddress.d.ts.map +1 -0
- package/dist/esm/admin-funcs/smartBadgeMacAddress.js +22 -0
- package/dist/esm/admin-funcs/smartBadgeMacAddress.js.map +1 -0
- package/dist/esm/admin-funcs/smartBadgeReportVerifiedPsk.d.ts +6 -0
- package/dist/esm/admin-funcs/smartBadgeReportVerifiedPsk.d.ts.map +1 -0
- package/dist/esm/admin-funcs/smartBadgeReportVerifiedPsk.js +15 -0
- package/dist/esm/admin-funcs/smartBadgeReportVerifiedPsk.js.map +1 -0
- package/dist/esm/funcs/reportsGetFullReport.d.ts +43 -0
- package/dist/esm/funcs/reportsGetFullReport.d.ts.map +1 -0
- package/dist/esm/funcs/reportsGetFullReport.js +112 -0
- package/dist/esm/funcs/reportsGetFullReport.js.map +1 -0
- package/dist/esm/funcs/reportsInitiateScheduledReport.d.ts +37 -0
- package/dist/esm/funcs/reportsInitiateScheduledReport.d.ts.map +1 -0
- package/dist/esm/funcs/reportsInitiateScheduledReport.js +103 -0
- package/dist/esm/funcs/reportsInitiateScheduledReport.js.map +1 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsCheckoutConfig.d.ts +18 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsCheckoutConfig.d.ts.map +1 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsCheckoutConfig.js +88 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsCheckoutConfig.js.map +1 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsScanOut.d.ts +20 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsScanOut.d.ts.map +1 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsScanOut.js +90 -0
- package/dist/esm/funcs/vendorScansVendorScanGpsScanOut.js.map +1 -0
- package/dist/esm/funcs/vendorsUpdateVendorDetails.d.ts +14 -1
- package/dist/esm/funcs/vendorsUpdateVendorDetails.d.ts.map +1 -1
- package/dist/esm/funcs/vendorsUpdateVendorDetails.js +14 -1
- package/dist/esm/funcs/vendorsUpdateVendorDetails.js.map +1 -1
- package/dist/esm/index.extras.d.ts +4 -0
- package/dist/esm/index.extras.d.ts.map +1 -1
- package/dist/esm/index.extras.js +5 -1
- package/dist/esm/index.extras.js.map +1 -1
- package/dist/esm/lib/config.d.ts +3 -3
- package/dist/esm/lib/config.js +3 -3
- package/dist/esm/models/components/facility.d.ts +10 -0
- package/dist/esm/models/components/facility.d.ts.map +1 -1
- package/dist/esm/models/components/facility.js +8 -0
- package/dist/esm/models/components/facility.js.map +1 -1
- package/dist/esm/models/components/zone.d.ts +7 -0
- package/dist/esm/models/components/zone.d.ts.map +1 -1
- package/dist/esm/models/components/zone.js +8 -0
- package/dist/esm/models/components/zone.js.map +1 -1
- package/dist/esm/models/errors/apivalidationerrorresponse.d.ts +38 -0
- package/dist/esm/models/errors/apivalidationerrorresponse.d.ts.map +1 -0
- package/dist/esm/models/errors/apivalidationerrorresponse.js +41 -0
- package/dist/esm/models/errors/apivalidationerrorresponse.js.map +1 -0
- package/dist/esm/models/errors/index.d.ts +2 -0
- package/dist/esm/models/errors/index.d.ts.map +1 -1
- package/dist/esm/models/errors/index.js +2 -0
- package/dist/esm/models/errors/index.js.map +1 -1
- package/dist/esm/models/errors/unprocessableentityorvalidationerror.d.ts +13 -0
- package/dist/esm/models/errors/unprocessableentityorvalidationerror.d.ts.map +1 -0
- package/dist/esm/models/errors/unprocessableentityorvalidationerror.js +16 -0
- package/dist/esm/models/errors/unprocessableentityorvalidationerror.js.map +1 -0
- package/dist/esm/models/operations/getfullreport.d.ts +73 -0
- package/dist/esm/models/operations/getfullreport.d.ts.map +1 -0
- package/dist/esm/models/operations/getfullreport.js +68 -0
- package/dist/esm/models/operations/getfullreport.js.map +1 -0
- package/dist/esm/models/operations/index.d.ts +4 -0
- package/dist/esm/models/operations/index.d.ts.map +1 -1
- package/dist/esm/models/operations/index.js +4 -0
- package/dist/esm/models/operations/index.js.map +1 -1
- package/dist/esm/models/operations/initiatescheduledreport.d.ts +30 -0
- package/dist/esm/models/operations/initiatescheduledreport.d.ts.map +1 -0
- package/dist/esm/models/operations/initiatescheduledreport.js +31 -0
- package/dist/esm/models/operations/initiatescheduledreport.js.map +1 -0
- package/dist/esm/models/operations/vendorscangpscheckoutconfig.d.ts +57 -0
- package/dist/esm/models/operations/vendorscangpscheckoutconfig.d.ts.map +1 -0
- package/dist/esm/models/operations/vendorscangpscheckoutconfig.js +43 -0
- package/dist/esm/models/operations/vendorscangpscheckoutconfig.js.map +1 -0
- package/dist/esm/models/operations/vendorscangpsscanout.d.ts +81 -0
- package/dist/esm/models/operations/vendorscangpsscanout.d.ts.map +1 -0
- package/dist/esm/models/operations/vendorscangpsscanout.js +57 -0
- package/dist/esm/models/operations/vendorscangpsscanout.js.map +1 -0
- package/dist/esm/react-query/index.d.ts +4 -0
- package/dist/esm/react-query/index.d.ts.map +1 -1
- package/dist/esm/react-query/index.js +4 -0
- package/dist/esm/react-query/index.js.map +1 -1
- package/dist/esm/react-query/reportsGetFullReport.core.d.ts +12 -0
- package/dist/esm/react-query/reportsGetFullReport.core.d.ts.map +1 -0
- package/dist/esm/react-query/reportsGetFullReport.core.js +34 -0
- package/dist/esm/react-query/reportsGetFullReport.core.js.map +1 -0
- package/dist/esm/react-query/reportsGetFullReport.d.ts +75 -0
- package/dist/esm/react-query/reportsGetFullReport.d.ts.map +1 -0
- package/dist/esm/react-query/reportsGetFullReport.js +101 -0
- package/dist/esm/react-query/reportsGetFullReport.js.map +1 -0
- package/dist/esm/react-query/reportsInitiateScheduledReport.d.ts +46 -0
- package/dist/esm/react-query/reportsInitiateScheduledReport.d.ts.map +1 -0
- package/dist/esm/react-query/reportsInitiateScheduledReport.js +63 -0
- package/dist/esm/react-query/reportsInitiateScheduledReport.js.map +1 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.core.d.ts +12 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.core.d.ts.map +1 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.core.js +34 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.core.js.map +1 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.d.ts +29 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.d.ts.map +1 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.js +59 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsCheckoutConfig.js.map +1 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsScanOut.d.ts +31 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsScanOut.d.ts.map +1 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsScanOut.js +48 -0
- package/dist/esm/react-query/vendorScansVendorScanGpsScanOut.js.map +1 -0
- package/dist/esm/react-query/vendorsUpdateVendorDetails.d.ts +14 -1
- package/dist/esm/react-query/vendorsUpdateVendorDetails.d.ts.map +1 -1
- package/dist/esm/react-query/vendorsUpdateVendorDetails.js +14 -1
- package/dist/esm/react-query/vendorsUpdateVendorDetails.js.map +1 -1
- package/dist/esm/sdk/reports.d.ts +59 -0
- package/dist/esm/sdk/reports.d.ts.map +1 -0
- package/dist/esm/sdk/reports.js +68 -0
- package/dist/esm/sdk/reports.js.map +1 -0
- package/dist/esm/sdk/sdk.d.ts +3 -0
- package/dist/esm/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/sdk/sdk.js +4 -0
- package/dist/esm/sdk/sdk.js.map +1 -1
- package/dist/esm/sdk/vendors.d.ts +14 -1
- package/dist/esm/sdk/vendors.d.ts.map +1 -1
- package/dist/esm/sdk/vendors.js +14 -1
- package/dist/esm/sdk/vendors.js.map +1 -1
- package/dist/esm/sdk/vendorscans.d.ts +16 -0
- package/dist/esm/sdk/vendorscans.d.ts.map +1 -1
- package/dist/esm/sdk/vendorscans.js +22 -0
- package/dist/esm/sdk/vendorscans.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/__tests__/reports.test.ts +57 -0
- package/src/__tests__/smartBadgeGetPsks.test.ts +76 -0
- package/src/__tests__/smartBadgeReportVerifiedPsk.test.ts +61 -0
- package/src/__tests__/vendors.test.ts +1 -1
- package/src/__tests__/vendorscans.test.ts +50 -0
- package/src/__tests__/webhooks.test.ts +1 -1
- package/src/__tests__/zones.test.ts +12 -15
- package/src/admin-funcs/smartBadgeGetPsks.ts +23 -0
- package/src/admin-funcs/smartBadgeMacAddress.ts +25 -0
- package/src/admin-funcs/smartBadgeReportVerifiedPsk.ts +25 -0
- package/src/funcs/reportsGetFullReport.ts +204 -0
- package/src/funcs/reportsInitiateScheduledReport.ts +205 -0
- package/src/funcs/vendorScansVendorScanGpsCheckoutConfig.ts +180 -0
- package/src/funcs/vendorScansVendorScanGpsScanOut.ts +182 -0
- package/src/funcs/vendorsUpdateVendorDetails.ts +14 -1
- package/src/index.extras.ts +5 -1
- package/src/lib/config.ts +3 -3
- package/src/models/components/facility.ts +18 -0
- package/src/models/components/zone.ts +15 -0
- package/src/models/errors/apivalidationerrorresponse.ts +71 -0
- package/src/models/errors/index.ts +2 -0
- package/src/models/errors/unprocessableentityorvalidationerror.ts +45 -0
- package/src/models/operations/getfullreport.ts +159 -0
- package/src/models/operations/index.ts +4 -0
- package/src/models/operations/initiatescheduledreport.ts +87 -0
- package/src/models/operations/vendorscangpscheckoutconfig.ts +118 -0
- package/src/models/operations/vendorscangpsscanout.ts +167 -0
- package/src/react-query/index.ts +4 -0
- package/src/react-query/reportsGetFullReport.core.ts +76 -0
- package/src/react-query/reportsGetFullReport.ts +190 -0
- package/src/react-query/reportsInitiateScheduledReport.ts +133 -0
- package/src/react-query/vendorScansVendorScanGpsCheckoutConfig.core.ts +78 -0
- package/src/react-query/vendorScansVendorScanGpsCheckoutConfig.ts +150 -0
- package/src/react-query/vendorScansVendorScanGpsScanOut.ts +117 -0
- package/src/react-query/vendorsUpdateVendorDetails.ts +14 -1
- package/src/sdk/reports.ts +85 -0
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/vendors.ts +14 -1
- package/src/sdk/vendorscans.ts +40 -0
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as z from "zod/v3";
|
|
6
|
+
import { remap as remap$ } from "../../lib/primitives.js";
|
|
7
|
+
import { safeParse } from "../../lib/schemas.js";
|
|
8
|
+
import * as openEnums from "../../types/enums.js";
|
|
9
|
+
import { OpenEnum } from "../../types/enums.js";
|
|
10
|
+
import { Result as SafeParseResult } from "../../types/fp.js";
|
|
11
|
+
import * as types from "../../types/primitives.js";
|
|
12
|
+
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
|
|
13
|
+
|
|
14
|
+
export type VendorScanGpsScanOutVendorScanGpsScanOutRequest = {
|
|
15
|
+
/**
|
|
16
|
+
* Reported latitude, between -90 and 90.
|
|
17
|
+
*/
|
|
18
|
+
latitude: number;
|
|
19
|
+
/**
|
|
20
|
+
* Reported longitude, between -180 and 180.
|
|
21
|
+
*/
|
|
22
|
+
longitude: number;
|
|
23
|
+
/**
|
|
24
|
+
* Reported accuracy radius in FEET (not meters). The vendor is only checked out when the distance beyond the geofence exceeds it and it is no wider than 328 ft (100 m); a wider margin can earn a reminder but never a check-out.
|
|
25
|
+
*/
|
|
26
|
+
accuracy?: number | null | undefined;
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export type VendorScanGpsScanOutRequest = {
|
|
30
|
+
/**
|
|
31
|
+
* The identifier of the object
|
|
32
|
+
*/
|
|
33
|
+
id: number;
|
|
34
|
+
requestBody: VendorScanGpsScanOutVendorScanGpsScanOutRequest;
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Which branch the server took. `possibly_left` means the vendor was only reminded and the check-in is still open, so a client watching a geofence should stay armed — it is the one case that answers `success: false` without being a refusal like `checkout_failed`.
|
|
39
|
+
*/
|
|
40
|
+
export const Outcome = {
|
|
41
|
+
CheckedOut: "checked_out",
|
|
42
|
+
PossiblyLeft: "possibly_left",
|
|
43
|
+
InsideRadius: "inside_radius",
|
|
44
|
+
AlreadyCheckedOut: "already_checked_out",
|
|
45
|
+
CheckoutFailed: "checkout_failed",
|
|
46
|
+
} as const;
|
|
47
|
+
/**
|
|
48
|
+
* Which branch the server took. `possibly_left` means the vendor was only reminded and the check-in is still open, so a client watching a geofence should stay armed — it is the one case that answers `success: false` without being a refusal like `checkout_failed`.
|
|
49
|
+
*/
|
|
50
|
+
export type Outcome = OpenEnum<typeof Outcome>;
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* The request was successful, and the server has returned the requested resource in the response body.
|
|
54
|
+
*/
|
|
55
|
+
export type VendorScanGpsScanOutVendorScanGpsScanOutOk = {
|
|
56
|
+
error?: string | null | undefined;
|
|
57
|
+
reason?: string | null | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Smart badge LED payload data. Only present when the scan-out response can update a smart badge locally.
|
|
60
|
+
*/
|
|
61
|
+
badgeData?: string | null | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* True when the vendor was checked out, was already checked out, or is still inside the geofence. False when the check-out was refused, and when the position was too imprecise to act on and only earned a reminder.
|
|
64
|
+
*/
|
|
65
|
+
success: boolean;
|
|
66
|
+
/**
|
|
67
|
+
* Which branch the server took. `possibly_left` means the vendor was only reminded and the check-in is still open, so a client watching a geofence should stay armed — it is the one case that answers `success: false` without being a refusal like `checkout_failed`.
|
|
68
|
+
*/
|
|
69
|
+
outcome: Outcome;
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
/** @internal */
|
|
73
|
+
export type VendorScanGpsScanOutVendorScanGpsScanOutRequest$Outbound = {
|
|
74
|
+
latitude: number;
|
|
75
|
+
longitude: number;
|
|
76
|
+
accuracy?: number | null | undefined;
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
/** @internal */
|
|
80
|
+
export const VendorScanGpsScanOutVendorScanGpsScanOutRequest$outboundSchema:
|
|
81
|
+
z.ZodType<
|
|
82
|
+
VendorScanGpsScanOutVendorScanGpsScanOutRequest$Outbound,
|
|
83
|
+
z.ZodTypeDef,
|
|
84
|
+
VendorScanGpsScanOutVendorScanGpsScanOutRequest
|
|
85
|
+
> = z.object({
|
|
86
|
+
latitude: z.number(),
|
|
87
|
+
longitude: z.number(),
|
|
88
|
+
accuracy: z.nullable(z.number()).optional(),
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
export function vendorScanGpsScanOutVendorScanGpsScanOutRequestToJSON(
|
|
92
|
+
vendorScanGpsScanOutVendorScanGpsScanOutRequest:
|
|
93
|
+
VendorScanGpsScanOutVendorScanGpsScanOutRequest,
|
|
94
|
+
): string {
|
|
95
|
+
return JSON.stringify(
|
|
96
|
+
VendorScanGpsScanOutVendorScanGpsScanOutRequest$outboundSchema.parse(
|
|
97
|
+
vendorScanGpsScanOutVendorScanGpsScanOutRequest,
|
|
98
|
+
),
|
|
99
|
+
);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
/** @internal */
|
|
103
|
+
export type VendorScanGpsScanOutRequest$Outbound = {
|
|
104
|
+
id: number;
|
|
105
|
+
RequestBody: VendorScanGpsScanOutVendorScanGpsScanOutRequest$Outbound;
|
|
106
|
+
};
|
|
107
|
+
|
|
108
|
+
/** @internal */
|
|
109
|
+
export const VendorScanGpsScanOutRequest$outboundSchema: z.ZodType<
|
|
110
|
+
VendorScanGpsScanOutRequest$Outbound,
|
|
111
|
+
z.ZodTypeDef,
|
|
112
|
+
VendorScanGpsScanOutRequest
|
|
113
|
+
> = z.object({
|
|
114
|
+
id: z.number().int(),
|
|
115
|
+
requestBody: z.lazy(() =>
|
|
116
|
+
VendorScanGpsScanOutVendorScanGpsScanOutRequest$outboundSchema
|
|
117
|
+
),
|
|
118
|
+
}).transform((v) => {
|
|
119
|
+
return remap$(v, {
|
|
120
|
+
requestBody: "RequestBody",
|
|
121
|
+
});
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
export function vendorScanGpsScanOutRequestToJSON(
|
|
125
|
+
vendorScanGpsScanOutRequest: VendorScanGpsScanOutRequest,
|
|
126
|
+
): string {
|
|
127
|
+
return JSON.stringify(
|
|
128
|
+
VendorScanGpsScanOutRequest$outboundSchema.parse(
|
|
129
|
+
vendorScanGpsScanOutRequest,
|
|
130
|
+
),
|
|
131
|
+
);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/** @internal */
|
|
135
|
+
export const Outcome$inboundSchema: z.ZodType<Outcome, z.ZodTypeDef, unknown> =
|
|
136
|
+
openEnums.inboundSchema(Outcome);
|
|
137
|
+
|
|
138
|
+
/** @internal */
|
|
139
|
+
export const VendorScanGpsScanOutVendorScanGpsScanOutOk$inboundSchema:
|
|
140
|
+
z.ZodType<VendorScanGpsScanOutVendorScanGpsScanOutOk, z.ZodTypeDef, unknown> =
|
|
141
|
+
z.object({
|
|
142
|
+
error: z.nullable(types.string()).optional(),
|
|
143
|
+
reason: z.nullable(types.string()).optional(),
|
|
144
|
+
badge_data: z.nullable(types.string()).optional(),
|
|
145
|
+
success: types.boolean(),
|
|
146
|
+
outcome: Outcome$inboundSchema,
|
|
147
|
+
}).transform((v) => {
|
|
148
|
+
return remap$(v, {
|
|
149
|
+
"badge_data": "badgeData",
|
|
150
|
+
});
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
export function vendorScanGpsScanOutVendorScanGpsScanOutOkFromJSON(
|
|
154
|
+
jsonString: string,
|
|
155
|
+
): SafeParseResult<
|
|
156
|
+
VendorScanGpsScanOutVendorScanGpsScanOutOk,
|
|
157
|
+
SDKValidationError
|
|
158
|
+
> {
|
|
159
|
+
return safeParse(
|
|
160
|
+
jsonString,
|
|
161
|
+
(x) =>
|
|
162
|
+
VendorScanGpsScanOutVendorScanGpsScanOutOk$inboundSchema.parse(
|
|
163
|
+
JSON.parse(x),
|
|
164
|
+
),
|
|
165
|
+
`Failed to parse 'VendorScanGpsScanOutVendorScanGpsScanOutOk' from JSON`,
|
|
166
|
+
);
|
|
167
|
+
}
|
package/src/react-query/index.ts
CHANGED
|
@@ -59,6 +59,8 @@ export * from "./organizationsListOrSearchDepartments.js";
|
|
|
59
59
|
export * from "./organizationsListOrSearchFacilities.js";
|
|
60
60
|
export * from "./paymentProfileDeletePaymentProfile.js";
|
|
61
61
|
export * from "./paymentProfileGetPaymentProfile.js";
|
|
62
|
+
export * from "./reportsGetFullReport.js";
|
|
63
|
+
export * from "./reportsInitiateScheduledReport.js";
|
|
62
64
|
export * from "./supportArticlesGetSupportArticle.js";
|
|
63
65
|
export * from "./supportArticlesListOrSearchSupportArticles.js";
|
|
64
66
|
export * from "./systemsListSystems.js";
|
|
@@ -89,6 +91,8 @@ export * from "./vendorScansGetVendorScan.js";
|
|
|
89
91
|
export * from "./vendorScansGetVendorScansExportStatus.js";
|
|
90
92
|
export * from "./vendorScansListVendorScans.js";
|
|
91
93
|
export * from "./vendorScansSubmitScreeningResponse.js";
|
|
94
|
+
export * from "./vendorScansVendorScanGpsCheckoutConfig.js";
|
|
95
|
+
export * from "./vendorScansVendorScanGpsScanOut.js";
|
|
92
96
|
export * from "./vendorScansVendorScanOut.js";
|
|
93
97
|
export * from "./vendorsChangeSubscription.js";
|
|
94
98
|
export * from "./vendorsCheckDownloadCode.js";
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import {
|
|
6
|
+
QueryClient,
|
|
7
|
+
QueryFunctionContext,
|
|
8
|
+
QueryKey,
|
|
9
|
+
} from "@tanstack/react-query";
|
|
10
|
+
import { GreenSecurityCore } from "../core.js";
|
|
11
|
+
import { reportsGetFullReport } from "../funcs/reportsGetFullReport.js";
|
|
12
|
+
import { combineSignals } from "../lib/primitives.js";
|
|
13
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
14
|
+
import * as operations from "../models/operations/index.js";
|
|
15
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
16
|
+
export type ReportsGetFullReportQueryData =
|
|
17
|
+
operations.GetFullReportGetFullReportOk;
|
|
18
|
+
|
|
19
|
+
export function prefetchReportsGetFullReport(
|
|
20
|
+
queryClient: QueryClient,
|
|
21
|
+
client$: GreenSecurityCore,
|
|
22
|
+
request: operations.GetFullReportRequest,
|
|
23
|
+
options?: RequestOptions,
|
|
24
|
+
): Promise<void> {
|
|
25
|
+
return queryClient.prefetchQuery({
|
|
26
|
+
...buildReportsGetFullReportQuery(
|
|
27
|
+
client$,
|
|
28
|
+
request,
|
|
29
|
+
options,
|
|
30
|
+
),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export function buildReportsGetFullReportQuery(
|
|
35
|
+
client$: GreenSecurityCore,
|
|
36
|
+
request: operations.GetFullReportRequest,
|
|
37
|
+
options?: RequestOptions,
|
|
38
|
+
): {
|
|
39
|
+
queryKey: QueryKey;
|
|
40
|
+
queryFn: (
|
|
41
|
+
context: QueryFunctionContext,
|
|
42
|
+
) => Promise<ReportsGetFullReportQueryData>;
|
|
43
|
+
} {
|
|
44
|
+
return {
|
|
45
|
+
queryKey: queryKeyReportsGetFullReport(request.fullReportId),
|
|
46
|
+
queryFn: async function reportsGetFullReportQueryFn(
|
|
47
|
+
ctx,
|
|
48
|
+
): Promise<ReportsGetFullReportQueryData> {
|
|
49
|
+
const sig = combineSignals(
|
|
50
|
+
ctx.signal,
|
|
51
|
+
options?.signal,
|
|
52
|
+
options?.fetchOptions?.signal,
|
|
53
|
+
);
|
|
54
|
+
const mergedOptions = {
|
|
55
|
+
...options?.fetchOptions,
|
|
56
|
+
...options,
|
|
57
|
+
signal: sig,
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
return unwrapAsync(reportsGetFullReport(
|
|
61
|
+
client$,
|
|
62
|
+
request,
|
|
63
|
+
mergedOptions,
|
|
64
|
+
));
|
|
65
|
+
},
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function queryKeyReportsGetFullReport(fullReportId: number): QueryKey {
|
|
70
|
+
return [
|
|
71
|
+
"@greensecurity/javascript-sdk",
|
|
72
|
+
"reports",
|
|
73
|
+
"getFullReport",
|
|
74
|
+
fullReportId,
|
|
75
|
+
];
|
|
76
|
+
}
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import {
|
|
6
|
+
InvalidateQueryFilters,
|
|
7
|
+
QueryClient,
|
|
8
|
+
useQuery,
|
|
9
|
+
UseQueryResult,
|
|
10
|
+
useSuspenseQuery,
|
|
11
|
+
UseSuspenseQueryResult,
|
|
12
|
+
} from "@tanstack/react-query";
|
|
13
|
+
import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
|
|
14
|
+
import {
|
|
15
|
+
ConnectionError,
|
|
16
|
+
InvalidRequestError,
|
|
17
|
+
RequestAbortedError,
|
|
18
|
+
RequestTimeoutError,
|
|
19
|
+
UnexpectedClientError,
|
|
20
|
+
} from "../models/errors/httpclienterrors.js";
|
|
21
|
+
import * as errors from "../models/errors/index.js";
|
|
22
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
23
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
24
|
+
import * as operations from "../models/operations/index.js";
|
|
25
|
+
import { useGreenSecurityContext } from "./_context.js";
|
|
26
|
+
import {
|
|
27
|
+
QueryHookOptions,
|
|
28
|
+
SuspenseQueryHookOptions,
|
|
29
|
+
TupleToPrefixes,
|
|
30
|
+
} from "./_types.js";
|
|
31
|
+
import {
|
|
32
|
+
buildReportsGetFullReportQuery,
|
|
33
|
+
prefetchReportsGetFullReport,
|
|
34
|
+
queryKeyReportsGetFullReport,
|
|
35
|
+
ReportsGetFullReportQueryData,
|
|
36
|
+
} from "./reportsGetFullReport.core.js";
|
|
37
|
+
export {
|
|
38
|
+
buildReportsGetFullReportQuery,
|
|
39
|
+
prefetchReportsGetFullReport,
|
|
40
|
+
queryKeyReportsGetFullReport,
|
|
41
|
+
type ReportsGetFullReportQueryData,
|
|
42
|
+
};
|
|
43
|
+
|
|
44
|
+
export type ReportsGetFullReportQueryError =
|
|
45
|
+
| errors.ApiErrorResponse
|
|
46
|
+
| errors.UnprocessableEntityOrValidationError
|
|
47
|
+
| GreenSecurityError
|
|
48
|
+
| ResponseValidationError
|
|
49
|
+
| ConnectionError
|
|
50
|
+
| RequestAbortedError
|
|
51
|
+
| RequestTimeoutError
|
|
52
|
+
| InvalidRequestError
|
|
53
|
+
| UnexpectedClientError
|
|
54
|
+
| SDKValidationError;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Get a generated report's status and download URL
|
|
58
|
+
*
|
|
59
|
+
* @remarks
|
|
60
|
+
* Returns a completed report run and a short-lived signed `report_url` (valid 5 minutes).
|
|
61
|
+
*
|
|
62
|
+
* Only a completed run returns the `full_report` payload. A run that has not finished does
|
|
63
|
+
* **not** come back with a `status` field to inspect — it returns an error envelope. Poll on
|
|
64
|
+
* the status code alone; `409` is the only retryable outcome, so no error-message matching is
|
|
65
|
+
* needed:
|
|
66
|
+
*
|
|
67
|
+
* | Status | Meaning | What to do |
|
|
68
|
+
* | --- | --- | --- |
|
|
69
|
+
* | `200` | The run finished. | Download `full_report.report_url` within 5 minutes. |
|
|
70
|
+
* | `409` | Still pending or processing. | Retry, but bound it — see below. |
|
|
71
|
+
* | `422` | Terminal: the run was canceled or failed, or the id is not a positive integer. | Stop. |
|
|
72
|
+
* | `404` | No such run, or it is outside your access scope. | Stop. |
|
|
73
|
+
* | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
|
|
74
|
+
*
|
|
75
|
+
* **Bound your polling.** A `409` is not a promise that the run will finish. Report
|
|
76
|
+
* generation has no terminal failure state today, so a run whose generation crashed part way
|
|
77
|
+
* through stays in `processing` and keeps answering `409` indefinitely. Apply your own
|
|
78
|
+
* timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
|
|
79
|
+
*
|
|
80
|
+
* Access control: the URL's `full_report_id` must be in the caller's read scope for
|
|
81
|
+
* `FullReport` — the facility or system it was run for, a recipient of the schedule that
|
|
82
|
+
* produced it, or a report whose app is activated for the API user. Callers outside that
|
|
83
|
+
* scope receive `404 Full report not found`.
|
|
84
|
+
*/
|
|
85
|
+
export function useReportsGetFullReport(
|
|
86
|
+
request: operations.GetFullReportRequest,
|
|
87
|
+
options?: QueryHookOptions<
|
|
88
|
+
ReportsGetFullReportQueryData,
|
|
89
|
+
ReportsGetFullReportQueryError
|
|
90
|
+
>,
|
|
91
|
+
): UseQueryResult<
|
|
92
|
+
ReportsGetFullReportQueryData,
|
|
93
|
+
ReportsGetFullReportQueryError
|
|
94
|
+
> {
|
|
95
|
+
const client = useGreenSecurityContext();
|
|
96
|
+
return useQuery({
|
|
97
|
+
...buildReportsGetFullReportQuery(
|
|
98
|
+
client,
|
|
99
|
+
request,
|
|
100
|
+
options,
|
|
101
|
+
),
|
|
102
|
+
...options,
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Get a generated report's status and download URL
|
|
108
|
+
*
|
|
109
|
+
* @remarks
|
|
110
|
+
* Returns a completed report run and a short-lived signed `report_url` (valid 5 minutes).
|
|
111
|
+
*
|
|
112
|
+
* Only a completed run returns the `full_report` payload. A run that has not finished does
|
|
113
|
+
* **not** come back with a `status` field to inspect — it returns an error envelope. Poll on
|
|
114
|
+
* the status code alone; `409` is the only retryable outcome, so no error-message matching is
|
|
115
|
+
* needed:
|
|
116
|
+
*
|
|
117
|
+
* | Status | Meaning | What to do |
|
|
118
|
+
* | --- | --- | --- |
|
|
119
|
+
* | `200` | The run finished. | Download `full_report.report_url` within 5 minutes. |
|
|
120
|
+
* | `409` | Still pending or processing. | Retry, but bound it — see below. |
|
|
121
|
+
* | `422` | Terminal: the run was canceled or failed, or the id is not a positive integer. | Stop. |
|
|
122
|
+
* | `404` | No such run, or it is outside your access scope. | Stop. |
|
|
123
|
+
* | `403` | Your account is locked, or lacks the `scheduled_reports` view permission. | Stop. |
|
|
124
|
+
*
|
|
125
|
+
* **Bound your polling.** A `409` is not a promise that the run will finish. Report
|
|
126
|
+
* generation has no terminal failure state today, so a run whose generation crashed part way
|
|
127
|
+
* through stays in `processing` and keeps answering `409` indefinitely. Apply your own
|
|
128
|
+
* timeout or maximum attempt count and treat exhaustion as a failure; do not retry forever.
|
|
129
|
+
*
|
|
130
|
+
* Access control: the URL's `full_report_id` must be in the caller's read scope for
|
|
131
|
+
* `FullReport` — the facility or system it was run for, a recipient of the schedule that
|
|
132
|
+
* produced it, or a report whose app is activated for the API user. Callers outside that
|
|
133
|
+
* scope receive `404 Full report not found`.
|
|
134
|
+
*/
|
|
135
|
+
export function useReportsGetFullReportSuspense(
|
|
136
|
+
request: operations.GetFullReportRequest,
|
|
137
|
+
options?: SuspenseQueryHookOptions<
|
|
138
|
+
ReportsGetFullReportQueryData,
|
|
139
|
+
ReportsGetFullReportQueryError
|
|
140
|
+
>,
|
|
141
|
+
): UseSuspenseQueryResult<
|
|
142
|
+
ReportsGetFullReportQueryData,
|
|
143
|
+
ReportsGetFullReportQueryError
|
|
144
|
+
> {
|
|
145
|
+
const client = useGreenSecurityContext();
|
|
146
|
+
return useSuspenseQuery({
|
|
147
|
+
...buildReportsGetFullReportQuery(
|
|
148
|
+
client,
|
|
149
|
+
request,
|
|
150
|
+
options,
|
|
151
|
+
),
|
|
152
|
+
...options,
|
|
153
|
+
});
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
export function setReportsGetFullReportData(
|
|
157
|
+
client: QueryClient,
|
|
158
|
+
queryKeyBase: [fullReportId: number],
|
|
159
|
+
data: ReportsGetFullReportQueryData,
|
|
160
|
+
): ReportsGetFullReportQueryData | undefined {
|
|
161
|
+
const key = queryKeyReportsGetFullReport(...queryKeyBase);
|
|
162
|
+
|
|
163
|
+
return client.setQueryData<ReportsGetFullReportQueryData>(key, data);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
export function invalidateReportsGetFullReport(
|
|
167
|
+
client: QueryClient,
|
|
168
|
+
queryKeyBase: TupleToPrefixes<[fullReportId: number]>,
|
|
169
|
+
filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
|
|
170
|
+
): Promise<void> {
|
|
171
|
+
return client.invalidateQueries({
|
|
172
|
+
...filters,
|
|
173
|
+
queryKey: [
|
|
174
|
+
"@greensecurity/javascript-sdk",
|
|
175
|
+
"reports",
|
|
176
|
+
"getFullReport",
|
|
177
|
+
...queryKeyBase,
|
|
178
|
+
],
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
export function invalidateAllReportsGetFullReport(
|
|
183
|
+
client: QueryClient,
|
|
184
|
+
filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
|
|
185
|
+
): Promise<void> {
|
|
186
|
+
return client.invalidateQueries({
|
|
187
|
+
...filters,
|
|
188
|
+
queryKey: ["@greensecurity/javascript-sdk", "reports", "getFullReport"],
|
|
189
|
+
});
|
|
190
|
+
}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import {
|
|
6
|
+
MutationKey,
|
|
7
|
+
useMutation,
|
|
8
|
+
UseMutationResult,
|
|
9
|
+
} from "@tanstack/react-query";
|
|
10
|
+
import { GreenSecurityCore } from "../core.js";
|
|
11
|
+
import { reportsInitiateScheduledReport } from "../funcs/reportsInitiateScheduledReport.js";
|
|
12
|
+
import { combineSignals } from "../lib/primitives.js";
|
|
13
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
14
|
+
import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
|
|
15
|
+
import {
|
|
16
|
+
ConnectionError,
|
|
17
|
+
InvalidRequestError,
|
|
18
|
+
RequestAbortedError,
|
|
19
|
+
RequestTimeoutError,
|
|
20
|
+
UnexpectedClientError,
|
|
21
|
+
} from "../models/errors/httpclienterrors.js";
|
|
22
|
+
import * as errors from "../models/errors/index.js";
|
|
23
|
+
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
|
|
24
|
+
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
|
|
25
|
+
import * as operations from "../models/operations/index.js";
|
|
26
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
27
|
+
import { useGreenSecurityContext } from "./_context.js";
|
|
28
|
+
import { MutationHookOptions } from "./_types.js";
|
|
29
|
+
|
|
30
|
+
export type ReportsInitiateScheduledReportMutationVariables = {
|
|
31
|
+
request: operations.InitiateScheduledReportRequest;
|
|
32
|
+
options?: RequestOptions;
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
export type ReportsInitiateScheduledReportMutationData =
|
|
36
|
+
operations.InitiateScheduledReportInitiateScheduledReportOk;
|
|
37
|
+
|
|
38
|
+
export type ReportsInitiateScheduledReportMutationError =
|
|
39
|
+
| errors.ApiErrorResponse
|
|
40
|
+
| errors.UnprocessableEntityOrValidationError
|
|
41
|
+
| GreenSecurityError
|
|
42
|
+
| ResponseValidationError
|
|
43
|
+
| ConnectionError
|
|
44
|
+
| RequestAbortedError
|
|
45
|
+
| RequestTimeoutError
|
|
46
|
+
| InvalidRequestError
|
|
47
|
+
| UnexpectedClientError
|
|
48
|
+
| SDKValidationError;
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Generate a scheduled report now
|
|
52
|
+
*
|
|
53
|
+
* @remarks
|
|
54
|
+
* Immediately generates a new report run for a scheduled report, independent of its
|
|
55
|
+
* configured schedule. Returns a `poll_url` for the generated `FullReport`.
|
|
56
|
+
*
|
|
57
|
+
* Generation is asynchronous. Poll `GET /reports/{full_report_id}` on the **status code**,
|
|
58
|
+
* not on a status field: while the run is pending or processing that endpoint returns `409`
|
|
59
|
+
* with an error envelope and no `status` to read. Retry the `409` until it turns into `200`,
|
|
60
|
+
* which carries the `full_report` payload and the signed download URL. `409` is the only
|
|
61
|
+
* retryable status — a canceled or failed run returns `422`, so no error-message matching is
|
|
62
|
+
* needed to decide when to give up.
|
|
63
|
+
*
|
|
64
|
+
* Bound the retries with your own timeout or attempt limit. Report generation has no terminal
|
|
65
|
+
* failure state today, so a run whose generation crashed stays in `processing` and answers
|
|
66
|
+
* `409` indefinitely rather than turning into a `422`.
|
|
67
|
+
*
|
|
68
|
+
* Access control: the URL's `scheduled_report_id` must be in the caller's read scope
|
|
69
|
+
* for `ScheduledReport` — the facility or system it belongs to, a scheduled report the
|
|
70
|
+
* caller is an explicit recipient of, or a scheduled report whose app is activated for
|
|
71
|
+
* the API user. Callers outside that scope receive `404 Scheduled report not found`.
|
|
72
|
+
*/
|
|
73
|
+
export function useReportsInitiateScheduledReportMutation(
|
|
74
|
+
options?: MutationHookOptions<
|
|
75
|
+
ReportsInitiateScheduledReportMutationData,
|
|
76
|
+
ReportsInitiateScheduledReportMutationError,
|
|
77
|
+
ReportsInitiateScheduledReportMutationVariables
|
|
78
|
+
>,
|
|
79
|
+
): UseMutationResult<
|
|
80
|
+
ReportsInitiateScheduledReportMutationData,
|
|
81
|
+
ReportsInitiateScheduledReportMutationError,
|
|
82
|
+
ReportsInitiateScheduledReportMutationVariables
|
|
83
|
+
> {
|
|
84
|
+
const client = useGreenSecurityContext();
|
|
85
|
+
return useMutation({
|
|
86
|
+
...buildReportsInitiateScheduledReportMutation(client, options),
|
|
87
|
+
...options,
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function mutationKeyReportsInitiateScheduledReport(): MutationKey {
|
|
92
|
+
return [
|
|
93
|
+
"@greensecurity/javascript-sdk",
|
|
94
|
+
"reports",
|
|
95
|
+
"initiateScheduledReport",
|
|
96
|
+
];
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export function buildReportsInitiateScheduledReportMutation(
|
|
100
|
+
client$: GreenSecurityCore,
|
|
101
|
+
hookOptions?: RequestOptions,
|
|
102
|
+
): {
|
|
103
|
+
mutationKey: MutationKey;
|
|
104
|
+
mutationFn: (
|
|
105
|
+
variables: ReportsInitiateScheduledReportMutationVariables,
|
|
106
|
+
) => Promise<ReportsInitiateScheduledReportMutationData>;
|
|
107
|
+
} {
|
|
108
|
+
return {
|
|
109
|
+
mutationKey: mutationKeyReportsInitiateScheduledReport(),
|
|
110
|
+
mutationFn: function reportsInitiateScheduledReportMutationFn({
|
|
111
|
+
request,
|
|
112
|
+
options,
|
|
113
|
+
}): Promise<ReportsInitiateScheduledReportMutationData> {
|
|
114
|
+
const mergedOptions = {
|
|
115
|
+
...hookOptions,
|
|
116
|
+
...options,
|
|
117
|
+
fetchOptions: {
|
|
118
|
+
...hookOptions?.fetchOptions,
|
|
119
|
+
...options?.fetchOptions,
|
|
120
|
+
signal: combineSignals(
|
|
121
|
+
hookOptions?.fetchOptions?.signal,
|
|
122
|
+
options?.fetchOptions?.signal,
|
|
123
|
+
),
|
|
124
|
+
},
|
|
125
|
+
};
|
|
126
|
+
return unwrapAsync(reportsInitiateScheduledReport(
|
|
127
|
+
client$,
|
|
128
|
+
request,
|
|
129
|
+
mergedOptions,
|
|
130
|
+
));
|
|
131
|
+
},
|
|
132
|
+
};
|
|
133
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import {
|
|
6
|
+
QueryClient,
|
|
7
|
+
QueryFunctionContext,
|
|
8
|
+
QueryKey,
|
|
9
|
+
} from "@tanstack/react-query";
|
|
10
|
+
import { GreenSecurityCore } from "../core.js";
|
|
11
|
+
import { vendorScansVendorScanGpsCheckoutConfig } from "../funcs/vendorScansVendorScanGpsCheckoutConfig.js";
|
|
12
|
+
import { combineSignals } from "../lib/primitives.js";
|
|
13
|
+
import { RequestOptions } from "../lib/sdks.js";
|
|
14
|
+
import * as operations from "../models/operations/index.js";
|
|
15
|
+
import { unwrapAsync } from "../types/fp.js";
|
|
16
|
+
export type VendorScansVendorScanGpsCheckoutConfigQueryData =
|
|
17
|
+
operations.VendorScanGpsCheckoutConfigVendorScanGpsCheckoutConfigOk;
|
|
18
|
+
|
|
19
|
+
export function prefetchVendorScansVendorScanGpsCheckoutConfig(
|
|
20
|
+
queryClient: QueryClient,
|
|
21
|
+
client$: GreenSecurityCore,
|
|
22
|
+
request: operations.VendorScanGpsCheckoutConfigRequest,
|
|
23
|
+
options?: RequestOptions,
|
|
24
|
+
): Promise<void> {
|
|
25
|
+
return queryClient.prefetchQuery({
|
|
26
|
+
...buildVendorScansVendorScanGpsCheckoutConfigQuery(
|
|
27
|
+
client$,
|
|
28
|
+
request,
|
|
29
|
+
options,
|
|
30
|
+
),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export function buildVendorScansVendorScanGpsCheckoutConfigQuery(
|
|
35
|
+
client$: GreenSecurityCore,
|
|
36
|
+
request: operations.VendorScanGpsCheckoutConfigRequest,
|
|
37
|
+
options?: RequestOptions,
|
|
38
|
+
): {
|
|
39
|
+
queryKey: QueryKey;
|
|
40
|
+
queryFn: (
|
|
41
|
+
context: QueryFunctionContext,
|
|
42
|
+
) => Promise<VendorScansVendorScanGpsCheckoutConfigQueryData>;
|
|
43
|
+
} {
|
|
44
|
+
return {
|
|
45
|
+
queryKey: queryKeyVendorScansVendorScanGpsCheckoutConfig(request.id),
|
|
46
|
+
queryFn: async function vendorScansVendorScanGpsCheckoutConfigQueryFn(
|
|
47
|
+
ctx,
|
|
48
|
+
): Promise<VendorScansVendorScanGpsCheckoutConfigQueryData> {
|
|
49
|
+
const sig = combineSignals(
|
|
50
|
+
ctx.signal,
|
|
51
|
+
options?.signal,
|
|
52
|
+
options?.fetchOptions?.signal,
|
|
53
|
+
);
|
|
54
|
+
const mergedOptions = {
|
|
55
|
+
...options?.fetchOptions,
|
|
56
|
+
...options,
|
|
57
|
+
signal: sig,
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
return unwrapAsync(vendorScansVendorScanGpsCheckoutConfig(
|
|
61
|
+
client$,
|
|
62
|
+
request,
|
|
63
|
+
mergedOptions,
|
|
64
|
+
));
|
|
65
|
+
},
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function queryKeyVendorScansVendorScanGpsCheckoutConfig(
|
|
70
|
+
id: number,
|
|
71
|
+
): QueryKey {
|
|
72
|
+
return [
|
|
73
|
+
"@greensecurity/javascript-sdk",
|
|
74
|
+
"vendor_scans",
|
|
75
|
+
"vendorScanGpsCheckoutConfig",
|
|
76
|
+
id,
|
|
77
|
+
];
|
|
78
|
+
}
|