@greensecurity/javascript-sdk 0.46.0-beta.4 → 0.46.0-beta.6

package/src/models/operations/listcompanycredentials.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";
 
+/**
+ * Sorts the results by the given field.
+ */
 export const ListCompanyCredentialsQueryParamSort = {
   CredentialName: "credential_name",
   Status: "status",
   DateExpires: "date_expires",
 } as const;
+/**
+ * Sorts the results by the given field.
+ */
 export type ListCompanyCredentialsQueryParamSort = ClosedEnum<
   typeof ListCompanyCredentialsQueryParamSort
 >;
 
+/**
+ * Filters credentials by status.
+ */
 export const ListCompanyCredentialsQueryParamStatus = {
   PendingVendor: "Pending Vendor",
   PendingApproval: "Pending Approval",
@@ -29,6 +38,9 @@ export const ListCompanyCredentialsQueryParamStatus = {
   Suspended: "Suspended",
   PendingClassification: "Pending Classification",
 } as const;
+/**
+ * Filters credentials by status.
+ */
 export type ListCompanyCredentialsQueryParamStatus = ClosedEnum<
   typeof ListCompanyCredentialsQueryParamStatus
 >;
@@ -40,33 +52,45 @@ export type Expand = ClosedEnum<typeof Expand>;
 
 export type ListCompanyCredentialsRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
-   * 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;
   /**
-   * Sort desc
+   * Sort desc.
    */
   desc?: components.Desc | undefined;
+  /**
+   * Sorts the results by the given field.
+   */
   sort?: ListCompanyCredentialsQueryParamSort | undefined;
+  /**
+   * Filters credentials by credential name (case-insensitive contains).
+   */
   credentialNameLike?: string | undefined;
+  /**
+   * Filters credentials by status.
+   */
   status?: ListCompanyCredentialsQueryParamStatus | undefined;
   /**
    * Filter by credential expiry date on or before this date (YYYY-MM-DD).
    */
   dateExpiresLte?: string | undefined;
+  /**
+   * Expands related objects in the response. Pass `vendor_credential.systems` to include the systems of each vendor credential.
+   */
   expand?: Array<Expand> | undefined;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of credentials that belong to vendors of the company, with pagination details.
  */
 export type ListCompanyCredentialsListCompanyCredentialsOk = {
   items: Array<components.CompanyCredentialListItem>;

package/src/models/operations/listcompanycredits.ts

@@ -31,7 +31,7 @@ export type ListCompanyCreditsQueryParamSort = ClosedEnum<
 
 export type ListCompanyCreditsRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
@@ -39,15 +39,15 @@ export type ListCompanyCreditsRequest = {
    */
   sort?: ListCompanyCreditsQueryParamSort | 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;
   /**
@@ -57,7 +57,7 @@ export type ListCompanyCreditsRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the company's credit transactions and the company's current credit balance.
  */
 export type ListCompanyCreditsListCompanyCreditsOk = {
   /**

package/src/models/operations/listcompanymanagercontacts.ts

@@ -11,13 +11,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListCompanyManagerContactsRequest = {
   /**
-   * Id of the company whose managers are being listed.
+   * ID of the company whose managers to list.
    */
   companyId: number;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns the contact details of the company's managers.
  */
 export type ListCompanyManagerContactsListCompanyManagerContactsOk = {
   items: Array<components.CompanyManagerLookup>;

package/src/models/operations/listcompanymanagers.ts

@@ -28,7 +28,7 @@ export type ListCompanyManagersQueryParamStatus = ClosedEnum<
 
 export type ListCompanyManagersRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
@@ -40,21 +40,21 @@ export type ListCompanyManagersRequest = {
    */
   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;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the company's managers and pagination details.
  */
 export type ListCompanyManagersListCompanyManagersOk = {
   /**

package/src/models/operations/listcompanytargetfacilities.ts

@@ -38,26 +38,26 @@ export const HasIndividual = {
 export type HasIndividual = ClosedEnum<typeof HasIndividual>;
 
 /**
- * Like `has_individual`, but only counts individuals whose credentialing subscription is active.
+ * Like `has_individual`, but only counts individuals whose credentialing subscription is active. Accepts `true` or `false`, with the same meanings as for `has_individual`.
  */
 export const HasActiveIndividual = {
   True: "true",
   False: "false",
 } as const;
 /**
- * Like `has_individual`, but only counts individuals whose credentialing subscription is active.
+ * Like `has_individual`, but only counts individuals whose credentialing subscription is active. Accepts `true` or `false`, with the same meanings as for `has_individual`.
  */
 export type HasActiveIndividual = ClosedEnum<typeof HasActiveIndividual>;
 
 /**
- * When `true`, returns every non-deleted facility reachable via LEFT JOIN against the caller's potential-target scope — the public, listed facility directory plus the caller's own read scope for facility/system/vendor/company-manager callers, or just the caller's own read scope (no directory) for an API-user caller. Targeted rows carry their CTF id and status; non-targeted rows have `id: null` and `status: "Not Targeted"`.
+ * When `true`, returns every non-deleted facility, targeted or not, from the caller's potential-target scope. That scope is the public, listed facility directory plus the caller's own read scope for facility/system/vendor/company-manager callers, or the caller's own read scope (no directory) for an API-user caller. Targeted rows carry their link `id` and `status`; non-targeted rows have `id: null` and `status: "Not Targeted"`. When `false`, returns only the facilities the company has targeted.
  */
 export const IncludePotentialTargets = {
   True: "true",
   False: "false",
 } as const;
 /**
- * When `true`, returns every non-deleted facility reachable via LEFT JOIN against the caller's potential-target scope — the public, listed facility directory plus the caller's own read scope for facility/system/vendor/company-manager callers, or just the caller's own read scope (no directory) for an API-user caller. Targeted rows carry their CTF id and status; non-targeted rows have `id: null` and `status: "Not Targeted"`.
+ * When `true`, returns every non-deleted facility, targeted or not, from the caller's potential-target scope. That scope is the public, listed facility directory plus the caller's own read scope for facility/system/vendor/company-manager callers, or the caller's own read scope (no directory) for an API-user caller. Targeted rows carry their link `id` and `status`; non-targeted rows have `id: null` and `status: "Not Targeted"`. When `false`, returns only the facilities the company has targeted.
  */
 export type IncludePotentialTargets = ClosedEnum<
   typeof IncludePotentialTargets
@@ -99,11 +99,11 @@ export type ListCompanyTargetFacilitiesRequest = {
    */
   hasIndividual?: HasIndividual | undefined;
   /**
-   * Like `has_individual`, but only counts individuals whose credentialing subscription is active.
+   * Like `has_individual`, but only counts individuals whose credentialing subscription is active. Accepts `true` or `false`, with the same meanings as for `has_individual`.
    */
   hasActiveIndividual?: HasActiveIndividual | undefined;
   /**
-   * When `true`, returns every non-deleted facility reachable via LEFT JOIN against the caller's potential-target scope — the public, listed facility directory plus the caller's own read scope for facility/system/vendor/company-manager callers, or just the caller's own read scope (no directory) for an API-user caller. Targeted rows carry their CTF id and status; non-targeted rows have `id: null` and `status: "Not Targeted"`.
+   * When `true`, returns every non-deleted facility, targeted or not, from the caller's potential-target scope. That scope is the public, listed facility directory plus the caller's own read scope for facility/system/vendor/company-manager callers, or the caller's own read scope (no directory) for an API-user caller. Targeted rows carry their link `id` and `status`; non-targeted rows have `id: null` and `status: "Not Targeted"`. When `false`, returns only the facilities the company has targeted.
    */
   includePotentialTargets?: IncludePotentialTargets | undefined;
   /**
@@ -131,7 +131,7 @@ export type ListCompanyTargetFacilitiesRequest = {
    */
   systemIds?: Array<number> | undefined;
   /**
-   * Case-insensitive partial match across facility name, city, state, street address, and system name (OR logic). Use this for a single search-box query; use the field-specific `*_like` params for multi-field AND filtering.
+   * Case-insensitive partial match across facility name, city, state, street address, and system name (a match on any of them counts). Use this for a single search-box query; use the field-specific `*_like` params to filter on several fields at once.
    */
   searchLike?: string | undefined;
   /**
@@ -139,21 +139,21 @@ export type ListCompanyTargetFacilitiesRequest = {
    */
   sort?: QueryParamSort | 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;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the company's target facilities, along with pagination details.
  */
 export type ListCompanyTargetFacilitiesListCompanyTargetFacilitiesOk = {
   /**

package/src/models/operations/listfacilityvendors.ts

@@ -13,7 +13,7 @@ import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Filter rows to a single facility access status. Omit for "All".
+ * Filter rows to a single facility access status. Omit to return all statuses.
  */
 export const ListFacilityVendorsQueryParamStatus = {
   Approved: "approved",
@@ -21,7 +21,7 @@ export const ListFacilityVendorsQueryParamStatus = {
   Denied: "denied",
 } as const;
 /**
- * Filter rows to a single facility access status. Omit for "All".
+ * Filter rows to a single facility access status. Omit to return all statuses.
  */
 export type ListFacilityVendorsQueryParamStatus = ClosedEnum<
   typeof ListFacilityVendorsQueryParamStatus
@@ -50,11 +50,11 @@ export type ListFacilityVendorsRequest = {
    */
   id: number;
   /**
-   * API users only — the company whose vendors to list. Ignored for company managers / vendors (resolved from the session).
+   * API users only—the company whose vendors to list. Ignored for company managers / vendors (resolved from the session).
    */
   companyId?: number | undefined;
   /**
-   * Filter rows to a single facility access status. Omit for "All".
+   * Filter rows to a single facility access status. Omit to return all statuses.
    */
   status?: ListFacilityVendorsQueryParamStatus | undefined;
   /**
@@ -66,11 +66,11 @@ export type ListFacilityVendorsRequest = {
    */
   search?: string | 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;
   /**
@@ -78,7 +78,7 @@ export type ListFacilityVendorsRequest = {
    */
   sort?: ListFacilityVendorsQueryParamSort | undefined;
   /**
-   * Sort desc
+   * Sort desc.
    */
   desc?: components.Desc | undefined;
 };
@@ -136,7 +136,7 @@ export type Items = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * A page of vendors that target the facility.
  */
 export type ListFacilityVendorsListFacilityVendorsOk = {
   /**

package/src/models/operations/listfeed.ts

@@ -15,39 +15,39 @@ export type ListFeedRequest = {
    */
   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;
   /**
-   * An ID representing a Hospital
+   * An ID representing a hospital.
    */
   facilityId?: number | undefined;
   /**
-   * An ID representing a Department
+   * An ID representing a department.
    */
   departmentId?: number | undefined;
   /**
-   * An ID representing a User
+   * An ID representing a user.
    */
   userId?: number | undefined;
   /**
-   * JSON-encoded array of facility_ids.
+   * JSON-encoded array of `facility_ids`.
    */
   facilityIds?: string | undefined;
   /**
-   * JSON-encoded array of department_ids.
+   * JSON-encoded array of `department_ids`.
    */
   departmentIds?: string | undefined;
   /**
-   * JSON-encoded array of user_ids.
+   * JSON-encoded array of `user_ids`.
    */
   userIds?: string | undefined;
   /**
@@ -59,25 +59,25 @@ export type ListFeedRequest = {
    */
   endDate?: number | undefined;
   /**
-   * Status_pending_approver value.
+   * Whether to include events with the pending approver status.
    */
   statusPendingApprover?: boolean | undefined;
   /**
-   * Status_pending_invitee value.
+   * Whether to include events with the pending invitee status.
    */
   statusPendingInvitee?: boolean | undefined;
   /**
-   * Status_approved value.
+   * Whether to include events with the approved status.
    */
   statusApproved?: boolean | undefined;
   /**
-   * Status_denied value.
+   * Whether to include events with the denied status.
    */
   statusDenied?: boolean | undefined;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of events in the feed.
  */
 export type ListFeedListFeedOk = {
   /**

package/src/models/operations/listinvoices.ts

@@ -16,15 +16,15 @@ export type ListInvoicesRequest = {
    */
   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;
   /**
@@ -36,7 +36,7 @@ export type ListInvoicesRequest = {
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter invoices by financial status
+   * Filter invoices by financial status.
    */
   invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
   /**
@@ -52,11 +52,11 @@ export type ListInvoicesRequest = {
    */
   datePaidLte?: string | undefined;
   /**
-   * For vendors, "me" or their own vendor ID.
+   * For vendors, `me` or their own vendor ID.
    *
    * @remarks
    * For company managers, a vendor ID; narrows the list to that vendor's invoices within the company's scope.
-   * For API users, the ID of a vendor the app is authorized to read.
+   * For API users, the ID of a vendor the app can read.
    */
   vendorId?: string | undefined;
   /**
@@ -74,7 +74,7 @@ export type ListInvoicesRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource.
+ * Returns a page of invoices matching the filters.
  */
 export type ListInvoicesListCompanyManagerInvoicesOk = {
   items: Array<components.Invoice | null>;

package/src/models/operations/listlocations.ts

@@ -16,23 +16,23 @@ export type ListLocationsRequest = {
    */
   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;
   /**
-   * JSON-encoded array of invitee_user_ids. Only one of `invitee_user_ids`/`invitee_department_ids` or `event_id` is allowed.
+   * JSON-encoded array of `invitee_user_ids`. Only one of `invitee_user_ids`/`invitee_department_ids` or `event_id` is allowed.
    */
   inviteeUserIds?: string | undefined;
   /**
-   * JSON-encoded array of invitee_department_ids. Only one of `invitee_user_ids`/`invitee_department_ids` or `event_id` is allowed.
+   * JSON-encoded array of `invitee_department_ids`. Only one of `invitee_user_ids`/`invitee_department_ids` or `event_id` is allowed.
    */
   inviteeDepartmentIds?: string | undefined;
   /**
@@ -47,7 +47,7 @@ export type ListLocationsItems = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of meeting locations, each with an ID and a display label.
  */
 export type ListLocationsListLocationsOk = {
   items: Array<ListLocationsItems>;

package/src/models/operations/listlookupsystems.ts

@@ -39,7 +39,7 @@ export type ListLookupSystemsRequest = {
 };
 
 /**
- * The request was successful.
+ * Returns the systems available to the caller, with their facilities when requested through `expand`.
  */
 export type ListLookupSystemsResponseBody = {
   systems: Array<components.SystemSummary>;

package/src/models/operations/listoffhirconfigurations.ts

@@ -15,21 +15,21 @@ export type ListOfFhirConfigurationsRequest = {
    */
   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;
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * A page of FHIR configurations, with pagination details.
  */
 export type ListOfFhirConfigurationsListOfFhirConfigurationsOk = {
   /**

package/src/models/operations/listorsearchcompanies.ts

@@ -16,15 +16,15 @@ export type ListOrSearchCompaniesRequest = {
    */
   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;
   /**
@@ -32,7 +32,7 @@ export type ListOrSearchCompaniesRequest = {
    */
   nameLike?: string | undefined;
   /**
-   * A string representing an email domain
+   * A string representing an email domain.
    */
   domain?: string | undefined;
   /**
@@ -42,7 +42,7 @@ export type ListOrSearchCompaniesRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * A page of companies matching the search and filter criteria.
  */
 export type ListOrSearchCompaniesListOrSearchCompaniesOK = {
   /**

package/src/models/operations/listorsearchdepartmentcontacts.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListOrSearchDepartmentContactsRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
@@ -20,19 +20,19 @@ export type ListOrSearchDepartmentContactsRequest = {
    */
   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;
   /**
-   * Search for objects by the search string
+   * Search for objects by the search string.
    */
   search?: string | undefined;
   /**
@@ -42,7 +42,7 @@ export type ListOrSearchDepartmentContactsRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the department's contacts and pagination details.
  */
 export type ListOrSearchDepartmentContactsListOrSearchDepartmentContactsOk = {
   /**

package/src/models/operations/listorsearchdepartments.ts

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ListOrSearchDepartmentsRequest = {
   /**
-   * The identifier of the object
+   * The identifier of the object.
    */
   id: number;
   /**
@@ -20,15 +20,15 @@ export type ListOrSearchDepartmentsRequest = {
    */
   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;
   /**
@@ -38,7 +38,7 @@ export type ListOrSearchDepartmentsRequest = {
 };
 
 /**
- * The request was successful, and the server has returned the requested resource in the response body.
+ * Returns a page of the departments at the facility.
  */
 export type ListOrSearchDepartmentsListOrSearchDepartmentsOk = {
   /**