@greensecurity/javascript-sdk 0.43.1-beta.137 → 0.43.1-beta.139

package/src/funcs/vendorsGetVendorUploadHistory.ts

@@ -0,0 +1,260 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: abdc070ccf3f
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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";
+
+/**
+ * Get vendor upload history
+ *
+ * @remarks
+ * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+ *
+ * If set, this operation will use {@link Security.bearerJwt} from the global security.
+ */
+export function vendorsGetVendorUploadHistory(
+  client: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): APIPromise<
+  PageIterator<
+    Result<
+      operations.GetVendorUploadHistoryResponse,
+      | 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.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    PageIterator<
+      Result<
+        operations.GetVendorUploadHistoryResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetVendorUploadHistoryRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [haltIterator(parsed), { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    vendor_id_or_me: encodeSimple("vendor_id_or_me", payload.vendor_id_or_me, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/vendors/{vendor_id_or_me}/credentials/files")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "desc": payload.desc,
+    "items_per_page": payload.items_per_page,
+    "page": payload.page,
+    "sort": payload.sort,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput, [1]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getVendorUploadHistory",
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "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.GetVendorUploadHistoryResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetVendorUploadHistoryResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 404], 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.GetVendorUploadHistoryResponse,
+        | 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 = () =>
+      vendorsGetVendorUploadHistory(
+        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

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

package/src/models/components/index.ts

@@ -66,6 +66,7 @@ export * from "./subscription.js";
 export * from "./supervisor.js";
 export * from "./supportarticle.js";
 export * from "./systemsummary.js";
+export * from "./uploadhistoryitem.js";
 export * from "./user.js";
 export * from "./userdetails.js";
 export * from "./userlocation.js";

package/src/models/components/uploadhistoryitem.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a1eae6e10877
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type UploadHistoryItem = {
+  id: number;
+  filename: string;
+  dateUploaded?: Date | null | undefined;
+  vendorCredentialId: number;
+  credentialName?: string | null | undefined;
+};
+
+/** @internal */
+export const UploadHistoryItem$inboundSchema: z.ZodType<
+  UploadHistoryItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.number(),
+  filename: types.string(),
+  date_uploaded: z.nullable(types.date()).optional(),
+  vendor_credential_id: types.number(),
+  credential_name: z.nullable(types.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "date_uploaded": "dateUploaded",
+    "vendor_credential_id": "vendorCredentialId",
+    "credential_name": "credentialName",
+  });
+});
+
+export function uploadHistoryItemFromJSON(
+  jsonString: string,
+): SafeParseResult<UploadHistoryItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UploadHistoryItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UploadHistoryItem' from JSON`,
+  );
+}

package/src/models/operations/getvendoruploadhistory.ts

@@ -0,0 +1,144 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a5888855de07
+ */
+
+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 components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetVendorUploadHistoryRequest = {
+  /**
+   * 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;
+  /**
+   * Vendor identifier. Depending on the endpoint, accepts one or more of:
+   *
+   * @remarks
+   * - A numeric vendor ID (positive integer, e.g. `42`)
+   * - The keyword `me` to represent the authenticated vendor
+   * - An active QR code (alphanumeric, hyphen-separated, e.g. `ABC-123-DEF`) —
+   *   supported only on endpoints that explicitly document QR-code lookup
+   */
+  vendorIdOrMe: string;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ */
+export type GetVendorUploadHistoryGetVendorUploadHistoryOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<components.UploadHistoryItem>;
+};
+
+export type GetVendorUploadHistoryResponse = {
+  result: GetVendorUploadHistoryGetVendorUploadHistoryOk;
+};
+
+/** @internal */
+export type GetVendorUploadHistoryRequest$Outbound = {
+  sort?: string | null | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  vendor_id_or_me: string;
+};
+
+/** @internal */
+export const GetVendorUploadHistoryRequest$outboundSchema: z.ZodType<
+  GetVendorUploadHistoryRequest$Outbound,
+  z.ZodTypeDef,
+  GetVendorUploadHistoryRequest
+> = z.object({
+  sort: z.nullable(z.string()).optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  vendorIdOrMe: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+    vendorIdOrMe: "vendor_id_or_me",
+  });
+});
+
+export function getVendorUploadHistoryRequestToJSON(
+  getVendorUploadHistoryRequest: GetVendorUploadHistoryRequest,
+): string {
+  return JSON.stringify(
+    GetVendorUploadHistoryRequest$outboundSchema.parse(
+      getVendorUploadHistoryRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetVendorUploadHistoryGetVendorUploadHistoryOk$inboundSchema:
+  z.ZodType<
+    GetVendorUploadHistoryGetVendorUploadHistoryOk,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    pager: components.Pager$inboundSchema,
+    items: z.array(components.UploadHistoryItem$inboundSchema),
+  });
+
+export function getVendorUploadHistoryGetVendorUploadHistoryOkFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetVendorUploadHistoryGetVendorUploadHistoryOk,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetVendorUploadHistoryGetVendorUploadHistoryOk$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetVendorUploadHistoryGetVendorUploadHistoryOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetVendorUploadHistoryResponse$inboundSchema: z.ZodType<
+  GetVendorUploadHistoryResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() =>
+    GetVendorUploadHistoryGetVendorUploadHistoryOk$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function getVendorUploadHistoryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetVendorUploadHistoryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetVendorUploadHistoryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetVendorUploadHistoryResponse' from JSON`,
+  );
+}

package/src/models/operations/index.ts

@@ -55,6 +55,7 @@ export * from "./getvendorinvoicereceipt.js";
 export * from "./getvendorlegalname.js";
 export * from "./getvendorscan.js";
 export * from "./getvendorsdetails.js";
+export * from "./getvendoruploadhistory.js";
 export * from "./getwebhookendpoint.js";
 export * from "./invoicesexport.js";
 export * from "./listalerts.js";

package/src/react-query/index.ts

@@ -95,6 +95,7 @@ export * from "./vendorsGetVendorInvoiceDetails.js";
 export * from "./vendorsGetVendorInvoiceReceipt.js";
 export * from "./vendorsGetVendorLegalName.js";
 export * from "./vendorsGetVendorsDetails.js";
+export * from "./vendorsGetVendorUploadHistory.js";
 export * from "./vendorsListVendorAdditionalFacilityFields.js";
 export * from "./vendorsListVendorCredentialDataRequests.js";
 export * from "./vendorsListVendorCredentialFiles.js";

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

@@ -0,0 +1,199 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e3ca8c943345
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { vendorsGetVendorUploadHistory } from "../funcs/vendorsGetVendorUploadHistory.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { pageIteratorToJSON } from "./_types.js";
+export type VendorsGetVendorUploadHistoryQueryData =
+  operations.GetVendorUploadHistoryResponse;
+
+export type VendorsGetVendorUploadHistoryInfiniteQueryData = PageIterator<
+  operations.GetVendorUploadHistoryResponse,
+  { page: number }
+>;
+
+export type VendorsGetVendorUploadHistoryPageParams = PageIterator<
+  operations.GetVendorUploadHistoryResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchVendorsGetVendorUploadHistory(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildVendorsGetVendorUploadHistoryQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchVendorsGetVendorUploadHistoryInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildVendorsGetVendorUploadHistoryInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as VendorsGetVendorUploadHistoryPageParams,
+    getNextPageParam: (
+      previousPage: VendorsGetVendorUploadHistoryInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildVendorsGetVendorUploadHistoryQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<VendorsGetVendorUploadHistoryQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorUploadHistory(request.vendorIdOrMe, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+    }),
+    queryFn: async function vendorsGetVendorUploadHistoryQueryFn(
+      ctx,
+    ): Promise<VendorsGetVendorUploadHistoryQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(vendorsGetVendorUploadHistory(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildVendorsGetVendorUploadHistoryInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.GetVendorUploadHistoryRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      VendorsGetVendorUploadHistoryPageParams
+    >,
+  ) => Promise<VendorsGetVendorUploadHistoryInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyVendorsGetVendorUploadHistoryInfinite(
+      request.vendorIdOrMe,
+      {
+        sort: request.sort,
+        desc: request.desc,
+        page: request.page,
+        itemsPerPage: request.itemsPerPage,
+      },
+    ),
+    queryFn: async function vendorsGetVendorUploadHistoryQuery(
+      ctx,
+    ): Promise<VendorsGetVendorUploadHistoryInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          vendorsGetVendorUploadHistory(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        vendorsGetVendorUploadHistory(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyVendorsGetVendorUploadHistory(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorUploadHistory",
+    vendorIdOrMe,
+    parameters,
+  ];
+}
+
+export function queryKeyVendorsGetVendorUploadHistoryInfinite(
+  vendorIdOrMe: string,
+  parameters: {
+    sort?: string | null | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "vendors",
+    "getVendorUploadHistory",
+    "infinite",
+    vendorIdOrMe,
+    parameters,
+  ];
+}