@greensecurity/javascript-sdk 0.43.1-beta.40 → 0.43.1-beta.44

package/src/funcs/invoicesListInvoices.ts

@@ -0,0 +1,270 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, queryJoin } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
+
+/**
+ * List invoices
+ *
+ * @remarks
+ * List invoices. The result set is automatically scoped based on the authenticated user's role.
+ * API users may filter results by **only one** of the following query parameters:
+ *   - vendor_id
+ *   - company_id
+ *   - facility_id
+ *   - system_id
+ * Supplying more than one will return `400 Bad Request`.
+ * If none are provided, the request falls back to all authorized resources.
+ *
+ * Available `expand` scopes are:
+ * - invoice.line_items
+ * - invoice.invoice_transactions
+ * - invoice.representative
+ */
+export function invoicesListInvoices(
+  client: GreenSecurityCore,
+  request: operations.ListInvoicesRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.ListInvoicesResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.ListInvoicesRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.ListInvoicesResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.ListInvoicesRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/invoices")();
+
+  const query = queryJoin(
+    encodeFormQuery({
+      "expand": payload.expand,
+    }, { explode: false }),
+    encodeFormQuery({
+      "company_id": payload.company_id,
+      "desc": payload.desc,
+      "facility_id": payload.facility_id,
+      "invoice_financial_status": payload.invoice_financial_status,
+      "invoice_number": payload.invoice_number,
+      "items_per_page": payload.items_per_page,
+      "page": payload.page,
+      "representative": payload.representative,
+      "sort": payload.sort,
+      "system_id": payload.system_id,
+      "vendor_id": payload.vendor_id,
+    }),
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listInvoices",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [haltIterator(requestRes), { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "403", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [haltIterator(doResult), { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result, raw] = await M.match<
+    operations.ListInvoicesResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.ListInvoicesResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "5XX"]),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
+  }
+
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListInvoicesResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "items");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      invoicesListInvoices(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
+}

package/src/lib/config.ts

@@ -80,8 +80,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.11",
-  sdkVersion: "0.43.1-beta.38",
+  sdkVersion: "0.43.1-beta.42",
   genVersion: "2.794.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.43.1-beta.38 2.794.1 0.0.11 @greensecurity/javascript-sdk",
+    "speakeasy-sdk/typescript 0.43.1-beta.42 2.794.1 0.0.11 @greensecurity/javascript-sdk",
 } as const;

package/src/models/components/expand.ts

@@ -52,6 +52,7 @@ export const Expand = {
   SupportArticleSupportCategory: "support_article.support_category",
   InvoiceLineItems: "invoice.line_items",
   InvoiceInvoiceTransactions: "invoice.invoice_transactions",
+  InvoiceRepresentative: "invoice.representative",
   VendorCredentialCredential: "vendor_credential.credential",
   VendorCredentialVendor: "vendor_credential.vendor",
   VendorCredentialInvoice: "vendor_credential.invoice",

package/src/models/components/index.ts

@@ -34,6 +34,7 @@ export * from "./financialstatus.js";
 export * from "./imageset.js";
 export * from "./invitee.js";
 export * from "./invoice.js";
+export * from "./invoicefinancialstatus.js";
 export * from "./invoiceitem.js";
 export * from "./invoicetransaction.js";
 export * from "./loginemailandpassword.js";

package/src/models/components/invoice.ts

@@ -33,6 +33,7 @@ export type Invoice = {
   discount?: number | undefined;
   lines?: Array<InvoiceItem | null> | null | undefined;
   transactions?: Array<InvoiceTransaction> | null | undefined;
+  representative?: string | null | undefined;
 };
 
 /** @internal */
@@ -55,6 +56,7 @@ export const Invoice$inboundSchema: z.ZodType<Invoice, z.ZodTypeDef, unknown> =
       .optional(),
     transactions: z.nullable(z.array(InvoiceTransaction$inboundSchema))
       .optional(),
+    representative: z.nullable(types.string()).optional(),
   }).transform((v) => {
     return remap$(v, {
       "invoice_number": "invoiceNumber",

package/src/models/components/invoicefinancialstatus.ts

@@ -0,0 +1,17 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const InvoiceFinancialStatus = {
+  Paid: "paid",
+  Unpaid: "unpaid",
+} as const;
+export type InvoiceFinancialStatus = ClosedEnum<typeof InvoiceFinancialStatus>;
+
+/** @internal */
+export const InvoiceFinancialStatus$outboundSchema: z.ZodNativeEnum<
+  typeof InvoiceFinancialStatus
+> = z.nativeEnum(InvoiceFinancialStatus);

package/src/models/components/supervisor.ts

@@ -13,7 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export type Supervisor = {
   name?: string | null | undefined;
-  email?: any | undefined;
+  email?: string | null | undefined;
   phone?: string | null | undefined;
 };
 
@@ -24,13 +24,13 @@ export const Supervisor$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.nullable(types.string()).optional(),
-  email: types.optional(z.any()),
+  email: z.nullable(types.string()).optional(),
   phone: z.nullable(types.string()).optional(),
 });
 /** @internal */
 export type Supervisor$Outbound = {
   name?: string | null | undefined;
-  email?: any | undefined;
+  email?: string | null | undefined;
   phone?: string | null | undefined;
 };
 
@@ -41,7 +41,7 @@ export const Supervisor$outboundSchema: z.ZodType<
   Supervisor
 > = z.object({
   name: z.nullable(z.string()).optional(),
-  email: z.any().optional(),
+  email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
 });
 

package/src/models/components/vendor.ts

@@ -35,7 +35,7 @@ import { VendorType, VendorType$inboundSchema } from "./vendortype.js";
 export type One = {
   id?: number | undefined;
   firstName?: string | null | undefined;
-  lastName?: any | undefined;
+  lastName?: string | null | undefined;
   email?: string | null | undefined;
   phone?: string | null | undefined;
   mobilePhone?: string | null | undefined;
@@ -188,7 +188,7 @@ export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
   .object({
     id: types.optional(types.number()),
     first_name: z.nullable(types.string()).optional(),
-    last_name: types.optional(z.any()),
+    last_name: z.nullable(types.string()).optional(),
     email: z.nullable(types.string()).optional(),
     phone: z.nullable(types.string()).optional(),
     mobile_phone: z.nullable(types.string()).optional(),

package/src/models/operations/index.ts

@@ -44,6 +44,7 @@ export * from "./getwebhookendpoint.js";
 export * from "./listalerts.js";
 export * from "./listallwebhookendpoints.js";
 export * from "./listfeed.js";
+export * from "./listinvoices.js";
 export * from "./listlocations.js";
 export * from "./listoffhirconfigurations.js";
 export * from "./listorsearchcompanies.js";

package/src/models/operations/listalerts.ts

@@ -26,6 +26,10 @@ export type ListAlertsRequest = {
    * Number of items to show in a given page
    */
   itemsPerPage?: number | undefined;
+  /**
+   * Either the ID of the user rep or the keyword "me" to represent the current user.
+   */
+  userIdOrMe?: string | undefined;
 };
 
 /**
@@ -49,6 +53,7 @@ export type ListAlertsRequest$Outbound = {
   desc?: components.Desc$Outbound | undefined;
   page?: number | undefined;
   items_per_page?: number | undefined;
+  user_id_or_me?: string | undefined;
 };
 
 /** @internal */
@@ -61,9 +66,11 @@ export const ListAlertsRequest$outboundSchema: z.ZodType<
   desc: components.Desc$outboundSchema.optional(),
   page: z.number().int().optional(),
   itemsPerPage: z.number().int().optional(),
+  userIdOrMe: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
+    userIdOrMe: "user_id_or_me",
   });
 });
 

package/src/models/operations/listinvoices.ts

@@ -0,0 +1,181 @@
+/*
+ * 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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListInvoicesRequest = {
+  /**
+   * A comma-separated list of object attributes to sort on.
+   */
+  sort?: string | null | undefined;
+  /**
+   * Sort desc
+   */
+  desc?: components.Desc | undefined;
+  /**
+   * A 1-based offset for which page to request (defaults to 1)
+   */
+  page?: number | undefined;
+  /**
+   * Number of items to show in a given page
+   */
+  itemsPerPage?: number | 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.
+   */
+  expand?: Array<components.Expand> | undefined;
+  /**
+   * Filter invoices by invoice number (digits or digits-digits)
+   */
+  invoiceNumber?: string | undefined;
+  /**
+   * Filter invoices by financial status
+   */
+  invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
+  /**
+   * Filter by the representative's name.
+   */
+  representative?: string | undefined;
+  /**
+   * Filter by a specific authorized vendor ID.
+   */
+  vendorId?: number | undefined;
+  /**
+   * Filter by a specific authorized company ID.
+   */
+  companyId?: number | undefined;
+  /**
+   * Filter by a specific authorized facility ID.
+   */
+  facilityId?: number | undefined;
+  /**
+   * Filter by a specific authorized system ID.
+   */
+  systemId?: number | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource.
+ */
+export type ListInvoicesListCompanyManagerInvoicesOk = {
+  items: Array<components.Invoice | null>;
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+};
+
+export type ListInvoicesResponse = {
+  result: ListInvoicesListCompanyManagerInvoicesOk;
+};
+
+/** @internal */
+export type ListInvoicesRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  expand?: Array<string> | undefined;
+  invoice_number?: string | undefined;
+  invoice_financial_status?: string | undefined;
+  representative?: string | undefined;
+  vendor_id?: number | undefined;
+  company_id?: number | undefined;
+  facility_id?: number | undefined;
+  system_id?: number | undefined;
+};
+
+/** @internal */
+export const ListInvoicesRequest$outboundSchema: z.ZodType<
+  ListInvoicesRequest$Outbound,
+  z.ZodTypeDef,
+  ListInvoicesRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+  invoiceNumber: z.string().optional(),
+  invoiceFinancialStatus: components.InvoiceFinancialStatus$outboundSchema
+    .optional(),
+  representative: z.string().optional(),
+  vendorId: z.number().int().optional(),
+  companyId: z.number().int().optional(),
+  facilityId: z.number().int().optional(),
+  systemId: z.number().int().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    invoiceNumber: "invoice_number",
+    invoiceFinancialStatus: "invoice_financial_status",
+    vendorId: "vendor_id",
+    companyId: "company_id",
+    facilityId: "facility_id",
+    systemId: "system_id",
+  });
+});
+
+export function listInvoicesRequestToJSON(
+  listInvoicesRequest: ListInvoicesRequest,
+): string {
+  return JSON.stringify(
+    ListInvoicesRequest$outboundSchema.parse(listInvoicesRequest),
+  );
+}
+
+/** @internal */
+export const ListInvoicesListCompanyManagerInvoicesOk$inboundSchema: z.ZodType<
+  ListInvoicesListCompanyManagerInvoicesOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  items: z.array(types.nullable(components.Invoice$inboundSchema)),
+  pager: components.Pager$inboundSchema,
+});
+
+export function listInvoicesListCompanyManagerInvoicesOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  ListInvoicesListCompanyManagerInvoicesOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListInvoicesListCompanyManagerInvoicesOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ListInvoicesListCompanyManagerInvoicesOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListInvoicesResponse$inboundSchema: z.ZodType<
+  ListInvoicesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListInvoicesListCompanyManagerInvoicesOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listInvoicesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListInvoicesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListInvoicesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListInvoicesResponse' from JSON`,
+  );
+}

package/src/models/operations/listvendorinvoices.ts

@@ -5,24 +5,11 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-/**
- * Filter invoices by financial_status
- */
-export const InvoiceFinancialStatus = {
-  Paid: "paid",
-  Unpaid: "unpaid",
-} as const;
-/**
- * Filter invoices by financial_status
- */
-export type InvoiceFinancialStatus = ClosedEnum<typeof InvoiceFinancialStatus>;
-
 export type ListVendorInvoicesRequest = {
   /**
    * A comma-separated list of object attributes to sort on.
@@ -49,13 +36,13 @@ export type ListVendorInvoicesRequest = {
    */
   vendorIdOrMe: string;
   /**
-   * Filter invoices by invoice number
+   * Filter invoices by invoice number (digits or digits-digits)
    */
   invoiceNumber?: string | undefined;
   /**
-   * Filter invoices by financial_status
+   * Filter invoices by financial status
    */
-  invoiceFinancialStatus?: InvoiceFinancialStatus | undefined;
+  invoiceFinancialStatus?: components.InvoiceFinancialStatus | undefined;
 };
 
 /**
@@ -73,11 +60,6 @@ export type ListVendorInvoicesResponse = {
   result: ListVendorInvoicesListVendorInvoicesOk;
 };
 
-/** @internal */
-export const InvoiceFinancialStatus$outboundSchema: z.ZodNativeEnum<
-  typeof InvoiceFinancialStatus
-> = z.nativeEnum(InvoiceFinancialStatus);
-
 /** @internal */
 export type ListVendorInvoicesRequest$Outbound = {
   sort?: string | null | undefined;
@@ -103,7 +85,8 @@ export const ListVendorInvoicesRequest$outboundSchema: z.ZodType<
   expand: z.array(components.Expand$outboundSchema).optional(),
   vendorIdOrMe: z.string(),
   invoiceNumber: z.string().optional(),
-  invoiceFinancialStatus: InvoiceFinancialStatus$outboundSchema.optional(),
+  invoiceFinancialStatus: components.InvoiceFinancialStatus$outboundSchema
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",