@greensecurity/javascript-sdk 0.44.0-beta.1 → 0.44.0-beta.3

package/src/models/operations/listcompanycredits.ts

@@ -0,0 +1,233 @@
+/*
+ * 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 * as openEnums from "../../types/enums.js";
+import { ClosedEnum, OpenEnum } 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";
+
+/**
+ * Field to sort results by.
+ */
+export const QueryParamSort = {
+  Id: "id",
+  Date: "date",
+  Action: "action",
+  Amount: "amount",
+  FromCompanyId: "from_company_id",
+  ToCompanyId: "to_company_id",
+} as const;
+/**
+ * Field to sort results by.
+ */
+export type QueryParamSort = ClosedEnum<typeof QueryParamSort>;
+
+export type ListCompanyCreditsRequest = {
+  /**
+   * The identifier of the object
+   */
+  id: number;
+  /**
+   * Field to sort results by.
+   */
+  sort?: QueryParamSort | 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;
+};
+
+export const Action = {
+  Credit: "credit",
+  Debit: "debit",
+  Transfer: "transfer",
+} as const;
+export type Action = OpenEnum<typeof Action>;
+
+export type ListCompanyCreditsItems = {
+  id?: number | undefined;
+  date?: string | null | undefined;
+  action?: Action | undefined;
+  amount?: number | undefined;
+  balance?: number | undefined;
+  from?: string | null | undefined;
+  to?: string | null | undefined;
+  invoiceNumber?: string | null | undefined;
+  /**
+   * Expanded entity payload when `expand=entity` is requested.
+   */
+  entity?: { [k: string]: any } | undefined;
+  /**
+   * Expanded source entity payload when `expand=from_entity` is requested.
+   */
+  fromEntity?: { [k: string]: any } | undefined;
+  /**
+   * Expanded destination entity payload when `expand=to_entity` is requested.
+   */
+  toEntity?: { [k: string]: any } | undefined;
+};
+
+/**
+ * The request was successful, and the server has returned the requested resource in the response body.
+ *
+ * @remarks
+ *
+ * Available `expand` scopes are:
+ *
+ * - entity
+ * - from_entity
+ * - to_entity
+ */
+export type ListCompanyCreditsListCompanyCreditsOk = {
+  /**
+   * Pagination information for a pageable list
+   */
+  pager: components.Pager;
+  items: Array<ListCompanyCreditsItems>;
+};
+
+export type ListCompanyCreditsResponse = {
+  result: ListCompanyCreditsListCompanyCreditsOk;
+};
+
+/** @internal */
+export const QueryParamSort$outboundSchema: z.ZodNativeEnum<
+  typeof QueryParamSort
+> = z.nativeEnum(QueryParamSort);
+
+/** @internal */
+export type ListCompanyCreditsRequest$Outbound = {
+  id: number;
+  sort?: string | undefined;
+  desc?: components.Desc$Outbound | undefined;
+  page?: number | undefined;
+  items_per_page?: number | undefined;
+  expand?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ListCompanyCreditsRequest$outboundSchema: z.ZodType<
+  ListCompanyCreditsRequest$Outbound,
+  z.ZodTypeDef,
+  ListCompanyCreditsRequest
+> = z.object({
+  id: z.number().int(),
+  sort: QueryParamSort$outboundSchema.optional(),
+  desc: components.Desc$outboundSchema.optional(),
+  page: z.number().int().optional(),
+  itemsPerPage: z.number().int().optional(),
+  expand: z.array(components.Expand$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    itemsPerPage: "items_per_page",
+  });
+});
+
+export function listCompanyCreditsRequestToJSON(
+  listCompanyCreditsRequest: ListCompanyCreditsRequest,
+): string {
+  return JSON.stringify(
+    ListCompanyCreditsRequest$outboundSchema.parse(listCompanyCreditsRequest),
+  );
+}
+
+/** @internal */
+export const Action$inboundSchema: z.ZodType<Action, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Action);
+
+/** @internal */
+export const ListCompanyCreditsItems$inboundSchema: z.ZodType<
+  ListCompanyCreditsItems,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: types.optional(types.number()),
+  date: z.nullable(types.string()).optional(),
+  action: types.optional(Action$inboundSchema),
+  amount: types.optional(types.number()),
+  balance: types.optional(types.number()),
+  from: z.nullable(types.string()).optional(),
+  to: z.nullable(types.string()).optional(),
+  invoice_number: z.nullable(types.string()).optional(),
+  entity: types.optional(z.record(z.any())),
+  from_entity: types.optional(z.record(z.any())),
+  to_entity: types.optional(z.record(z.any())),
+}).transform((v) => {
+  return remap$(v, {
+    "invoice_number": "invoiceNumber",
+    "from_entity": "fromEntity",
+    "to_entity": "toEntity",
+  });
+});
+
+export function listCompanyCreditsItemsFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCompanyCreditsItems, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCompanyCreditsItems$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyCreditsItems' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCompanyCreditsListCompanyCreditsOk$inboundSchema: z.ZodType<
+  ListCompanyCreditsListCompanyCreditsOk,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pager: components.Pager$inboundSchema,
+  items: z.array(z.lazy(() => ListCompanyCreditsItems$inboundSchema)),
+});
+
+export function listCompanyCreditsListCompanyCreditsOkFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCompanyCreditsListCompanyCreditsOk, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListCompanyCreditsListCompanyCreditsOk$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyCreditsListCompanyCreditsOk' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListCompanyCreditsResponse$inboundSchema: z.ZodType<
+  ListCompanyCreditsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Result: z.lazy(() => ListCompanyCreditsListCompanyCreditsOk$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "Result": "result",
+  });
+});
+
+export function listCompanyCreditsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListCompanyCreditsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListCompanyCreditsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListCompanyCreditsResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesListCompanyCredits } from "../funcs/companiesListCompanyCredits.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 CompaniesListCompanyCreditsQueryData =
+  operations.ListCompanyCreditsResponse;
+
+export type CompaniesListCompanyCreditsInfiniteQueryData = PageIterator<
+  operations.ListCompanyCreditsResponse,
+  { page: number }
+>;
+
+export type CompaniesListCompanyCreditsPageParams = PageIterator<
+  operations.ListCompanyCreditsResponse,
+  { page: number }
+>["~next"];
+
+export function prefetchCompaniesListCompanyCredits(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListCompanyCreditsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function prefetchCompaniesListCompanyCreditsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildCompaniesListCompanyCreditsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as CompaniesListCompanyCreditsPageParams,
+    getNextPageParam: (
+      previousPage: CompaniesListCompanyCreditsInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
+export function buildCompaniesListCompanyCreditsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListCompanyCreditsQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyCredits(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function companiesListCompanyCreditsQueryFn(
+      ctx,
+    ): Promise<CompaniesListCompanyCreditsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesListCompanyCredits(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function buildCompaniesListCompanyCreditsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyCreditsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      CompaniesListCompanyCreditsPageParams
+    >,
+  ) => Promise<CompaniesListCompanyCreditsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyCreditsInfinite(request.id, {
+      sort: request.sort,
+      desc: request.desc,
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      expand: request.expand,
+    }),
+    queryFn: async function companiesListCompanyCreditsQuery(
+      ctx,
+    ): Promise<CompaniesListCompanyCreditsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          companiesListCompanyCredits(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(companiesListCompanyCredits(
+        client$,
+        {
+          ...request,
+          page: ctx.pageParam.page,
+        },
+        mergedOptions,
+      ));
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
+export function queryKeyCompaniesListCompanyCredits(
+  id: number,
+  parameters: {
+    sort?: operations.QueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyCredits",
+    id,
+    parameters,
+  ];
+}
+
+export function queryKeyCompaniesListCompanyCreditsInfinite(
+  id: number,
+  parameters: {
+    sort?: operations.QueryParamSort | undefined;
+    desc?: components.Desc | undefined;
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    expand?: Array<components.Expand> | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyCredits",
+    "infinite",
+    id,
+    parameters,
+  ];
+}

package/src/react-query/companiesListCompanyCredits.ts

@@ -0,0 +1,268 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InfiniteData,
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
+  useQuery,
+  UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import * as components from "../models/components/index.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 { useGreenSecurityContext } from "./_context.js";
+import {
+  InfiniteQueryHookOptions,
+  QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildCompaniesListCompanyCreditsInfiniteQuery,
+  buildCompaniesListCompanyCreditsQuery,
+  CompaniesListCompanyCreditsInfiniteQueryData,
+  CompaniesListCompanyCreditsPageParams,
+  CompaniesListCompanyCreditsQueryData,
+  prefetchCompaniesListCompanyCredits,
+  prefetchCompaniesListCompanyCreditsInfinite,
+  queryKeyCompaniesListCompanyCredits,
+  queryKeyCompaniesListCompanyCreditsInfinite,
+} from "./companiesListCompanyCredits.core.js";
+export {
+  buildCompaniesListCompanyCreditsInfiniteQuery,
+  buildCompaniesListCompanyCreditsQuery,
+  type CompaniesListCompanyCreditsInfiniteQueryData,
+  type CompaniesListCompanyCreditsPageParams,
+  type CompaniesListCompanyCreditsQueryData,
+  prefetchCompaniesListCompanyCredits,
+  prefetchCompaniesListCompanyCreditsInfinite,
+  queryKeyCompaniesListCompanyCredits,
+  queryKeyCompaniesListCompanyCreditsInfinite,
+};
+
+export type CompaniesListCompanyCreditsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List credits related to a company
+ *
+ * @remarks
+ * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ */
+export function useCompaniesListCompanyCredits(
+  request: operations.ListCompanyCreditsRequest,
+  options?: QueryHookOptions<
+    CompaniesListCompanyCreditsQueryData,
+    CompaniesListCompanyCreditsQueryError
+  >,
+): UseQueryResult<
+  CompaniesListCompanyCreditsQueryData,
+  CompaniesListCompanyCreditsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildCompaniesListCompanyCreditsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List credits related to a company
+ *
+ * @remarks
+ * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ */
+export function useCompaniesListCompanyCreditsSuspense(
+  request: operations.ListCompanyCreditsRequest,
+  options?: SuspenseQueryHookOptions<
+    CompaniesListCompanyCreditsQueryData,
+    CompaniesListCompanyCreditsQueryError
+  >,
+): UseSuspenseQueryResult<
+  CompaniesListCompanyCreditsQueryData,
+  CompaniesListCompanyCreditsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildCompaniesListCompanyCreditsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List credits related to a company
+ *
+ * @remarks
+ * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ */
+export function useCompaniesListCompanyCreditsInfinite(
+  request: operations.ListCompanyCreditsRequest,
+  options?: InfiniteQueryHookOptions<
+    CompaniesListCompanyCreditsInfiniteQueryData,
+    CompaniesListCompanyCreditsQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    CompaniesListCompanyCreditsInfiniteQueryData,
+    CompaniesListCompanyCreditsPageParams
+  >,
+  CompaniesListCompanyCreditsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    CompaniesListCompanyCreditsInfiniteQueryData,
+    CompaniesListCompanyCreditsQueryError,
+    InfiniteData<
+      CompaniesListCompanyCreditsInfiniteQueryData,
+      CompaniesListCompanyCreditsPageParams
+    >,
+    QueryKey,
+    CompaniesListCompanyCreditsPageParams
+  >({
+    ...buildCompaniesListCompanyCreditsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List credits related to a company
+ *
+ * @remarks
+ * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ */
+export function useCompaniesListCompanyCreditsInfiniteSuspense(
+  request: operations.ListCompanyCreditsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    CompaniesListCompanyCreditsInfiniteQueryData,
+    CompaniesListCompanyCreditsQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    CompaniesListCompanyCreditsInfiniteQueryData,
+    CompaniesListCompanyCreditsPageParams
+  >,
+  CompaniesListCompanyCreditsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    CompaniesListCompanyCreditsInfiniteQueryData,
+    CompaniesListCompanyCreditsQueryError,
+    InfiniteData<
+      CompaniesListCompanyCreditsInfiniteQueryData,
+      CompaniesListCompanyCreditsPageParams
+    >,
+    QueryKey,
+    CompaniesListCompanyCreditsPageParams
+  >({
+    ...buildCompaniesListCompanyCreditsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+export function setCompaniesListCompanyCreditsData(
+  client: QueryClient,
+  queryKeyBase: [
+    id: number,
+    parameters: {
+      sort?: operations.QueryParamSort | undefined;
+      desc?: components.Desc | undefined;
+      page?: number | undefined;
+      itemsPerPage?: number | undefined;
+      expand?: Array<components.Expand> | undefined;
+    },
+  ],
+  data: CompaniesListCompanyCreditsQueryData,
+): CompaniesListCompanyCreditsQueryData | undefined {
+  const key = queryKeyCompaniesListCompanyCredits(...queryKeyBase);
+
+  return client.setQueryData<CompaniesListCompanyCreditsQueryData>(key, data);
+}
+
+export function invalidateCompaniesListCompanyCredits(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      id: number,
+      parameters: {
+        sort?: operations.QueryParamSort | undefined;
+        desc?: components.Desc | undefined;
+        page?: number | undefined;
+        itemsPerPage?: number | undefined;
+        expand?: Array<components.Expand> | undefined;
+      },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyCredits",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllCompaniesListCompanyCredits(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyCredits",
+    ],
+  });
+}

package/src/react-query/index.ts

@@ -9,6 +9,7 @@ export * from "./alertsListAlerts.js";
 export * from "./alertsUpdateUserAlerts.js";
 export * from "./companiesAddCompanyManager.js";
 export * from "./companiesGetCompany.js";
+export * from "./companiesListCompanyCredits.js";
 export * from "./companiesListCompanyManagers.js";
 export * from "./companiesListOrSearchCompanies.js";
 export * from "./companiesLookupCompanies.js";