@greensecurity/javascript-sdk 0.40.8-beta.31 → 0.40.8-beta.33

package/src/models/components/vendor.ts

@@ -115,7 +115,7 @@ export type VendorVendorType = VendorType | number;
 
 export type Vendor22 = {};
 
-export type VendorPaymentProfile2 = Vendor22 | number;
+export type VendorPaymentProfile2 = number | Vendor22;
 
 export type VendorPaymentProfile1 = {
   id?: number | undefined;
@@ -131,13 +131,13 @@ export type VendorPaymentProfile1 = {
  */
 export type PaymentProfilePaymentProfile =
   | VendorPaymentProfile1
-  | Vendor22
-  | number;
+  | number
+  | Vendor22;
 
 export type VendorPaymentProfile =
   | VendorPaymentProfile1
-  | Vendor22
   | number
+  | Vendor22
   | number;
 
 export type CompanySummary = {
@@ -201,8 +201,8 @@ export type Vendor = {
   imageUrls?: ImageSet | null | undefined;
   paymentProfile?:
     | VendorPaymentProfile1
-    | Vendor22
     | number
+    | Vendor22
     | number
     | null
     | undefined;
@@ -517,17 +517,17 @@ export const VendorPaymentProfile2$inboundSchema: z.ZodType<
   VendorPaymentProfile2,
   z.ZodTypeDef,
   unknown
-> = z.union([z.lazy(() => Vendor22$inboundSchema), z.number().int()]);
+> = z.union([z.number().int(), z.lazy(() => Vendor22$inboundSchema)]);
 
 /** @internal */
-export type VendorPaymentProfile2$Outbound = Vendor22$Outbound | number;
+export type VendorPaymentProfile2$Outbound = number | Vendor22$Outbound;
 
 /** @internal */
 export const VendorPaymentProfile2$outboundSchema: z.ZodType<
   VendorPaymentProfile2$Outbound,
   z.ZodTypeDef,
   VendorPaymentProfile2
-> = z.union([z.lazy(() => Vendor22$outboundSchema), z.number().int()]);
+> = z.union([z.number().int(), z.lazy(() => Vendor22$outboundSchema)]);
 
 /**
  * @internal
@@ -652,14 +652,14 @@ export const PaymentProfilePaymentProfile$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   z.lazy(() => VendorPaymentProfile1$inboundSchema),
-  z.union([z.lazy(() => Vendor22$inboundSchema), z.number().int()]),
+  z.union([z.number().int(), z.lazy(() => Vendor22$inboundSchema)]),
 ]);
 
 /** @internal */
 export type PaymentProfilePaymentProfile$Outbound =
   | VendorPaymentProfile1$Outbound
-  | Vendor22$Outbound
-  | number;
+  | number
+  | Vendor22$Outbound;
 
 /** @internal */
 export const PaymentProfilePaymentProfile$outboundSchema: z.ZodType<
@@ -668,7 +668,7 @@ export const PaymentProfilePaymentProfile$outboundSchema: z.ZodType<
   PaymentProfilePaymentProfile
 > = z.union([
   z.lazy(() => VendorPaymentProfile1$outboundSchema),
-  z.union([z.lazy(() => Vendor22$outboundSchema), z.number().int()]),
+  z.union([z.number().int(), z.lazy(() => Vendor22$outboundSchema)]),
 ]);
 
 /**
@@ -712,7 +712,7 @@ export const VendorPaymentProfile$inboundSchema: z.ZodType<
 > = z.union([
   z.union([
     z.lazy(() => VendorPaymentProfile1$inboundSchema),
-    z.union([z.lazy(() => Vendor22$inboundSchema), z.number().int()]),
+    z.union([z.number().int(), z.lazy(() => Vendor22$inboundSchema)]),
   ]),
   z.number().int(),
 ]);
@@ -720,8 +720,8 @@ export const VendorPaymentProfile$inboundSchema: z.ZodType<
 /** @internal */
 export type VendorPaymentProfile$Outbound =
   | VendorPaymentProfile1$Outbound
-  | Vendor22$Outbound
   | number
+  | Vendor22$Outbound
   | number;
 
 /** @internal */
@@ -732,7 +732,7 @@ export const VendorPaymentProfile$outboundSchema: z.ZodType<
 > = z.union([
   z.union([
     z.lazy(() => VendorPaymentProfile1$outboundSchema),
-    z.union([z.lazy(() => Vendor22$outboundSchema), z.number().int()]),
+    z.union([z.number().int(), z.lazy(() => Vendor22$outboundSchema)]),
   ]),
   z.number().int(),
 ]);
@@ -1077,7 +1077,10 @@ export const Vendor$inboundSchema: z.ZodType<Vendor, z.ZodTypeDef, unknown> = z
       z.union([
         z.union([
           z.lazy(() => VendorPaymentProfile1$inboundSchema),
-          z.union([z.lazy(() => Vendor22$inboundSchema), z.number().int()]),
+          z.union([
+            z.number().int(),
+            z.lazy(() => Vendor22$inboundSchema),
+          ]),
         ]),
         z.number().int(),
       ]),
@@ -1159,8 +1162,8 @@ export type Vendor$Outbound = {
   image_urls?: ImageSet$Outbound | null | undefined;
   payment_profile?:
     | VendorPaymentProfile1$Outbound
-    | Vendor22$Outbound
     | number
+    | Vendor22$Outbound
     | number
     | null
     | undefined;
@@ -1212,7 +1215,10 @@ export const Vendor$outboundSchema: z.ZodType<
     z.union([
       z.union([
         z.lazy(() => VendorPaymentProfile1$outboundSchema),
-        z.union([z.lazy(() => Vendor22$outboundSchema), z.number().int()]),
+        z.union([
+          z.number().int(),
+          z.lazy(() => Vendor22$outboundSchema),
+        ]),
       ]),
       z.number().int(),
     ]),

package/.devcontainer/README.md

@@ -1,35 +0,0 @@
-
-<div align="center">
-    <a href="https://codespaces.new/repconnex/repconnex.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
-</div>
-<br>
-
-> **Remember to shutdown a GitHub Codespace when it is not in use!**
-
-# Dev Containers Quick Start
-
-The default location for usage snippets is the `samples` directory.
-
-## Running a Usage Sample
-
-A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
-
-```
-ts-node root.ts
-```
-
-## Generating Additional Usage Samples
-
-The speakeasy CLI allows you to generate more usage snippets. Here's how:
-
-- To generate a sample for a specific operation by providing an operation ID, use:
-
-```
-speakeasy generate usage -s https://example.com/OVERWRITE_WHEN_SAMPLE_SPEC_IS_WRITTEN -l typescript -i {INPUT_OPERATION_ID} -o ./samples
-```
-
-- To generate samples for an entire namespace (like a tag or group name), use:
-
-```
-speakeasy generate usage -s https://example.com/OVERWRITE_WHEN_SAMPLE_SPEC_IS_WRITTEN -l typescript -n {INPUT_TAG_NAME} -o ./samples
-```

package/docs/sdks/alerts/README.md

@@ -1,219 +0,0 @@
-# Alerts
-(*alerts*)
-
-## Overview
-
-### Available Operations
-
-* [listAlerts](#listalerts) - List alerts
-* [updateUserAlerts](#updateuseralerts) - Update user alerts
-
-## listAlerts
-
-List alerts for user.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="listAlerts" method="get" path="/alerts" -->
-```typescript
-import { GreenSecurity } from "@greensecurity/javascript-sdk";
-
-const greenSecurity = new GreenSecurity({
-  security: {
-    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
-  },
-});
-
-async function run() {
-  const result = await greenSecurity.alerts.listAlerts({
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-  });
-
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { alertsListAlerts } from "@greensecurity/javascript-sdk/funcs/alertsListAlerts.js";
-
-// Use `GreenSecurityCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const greenSecurity = new GreenSecurityCore({
-  security: {
-    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
-  },
-});
-
-async function run() {
-  const res = await alertsListAlerts(greenSecurity, {
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("alertsListAlerts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Query hooks for fetching data.
-  useAlertsListAlerts,
-  useAlertsListAlertsSuspense,
-  // Query hooks suitable for building infinite scrolling or "load more" UIs.
-  useAlertsListAlertsInfinite,
-  useAlertsListAlertsInfiniteSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchAlertsListAlerts,
-  
-  // Utilities to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateAlertsListAlerts,
-  invalidateAllAlertsListAlerts,
-} from "@greensecurity/javascript-sdk/react-query/alertsListAlerts.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListAlertsRequest](../../models/operations/listalertsrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.ListAlertsResponse](../../models/operations/listalertsresponse.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 401, 403           | application/json        |
-| errors.ApiErrorResponse | 500                     | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |
-
-## updateUserAlerts
-
-Update user alerts
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="updateUserAlerts" method="put" path="/user-alerts" -->
-```typescript
-import { GreenSecurity } from "@greensecurity/javascript-sdk";
-
-const greenSecurity = new GreenSecurity({
-  security: {
-    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
-  },
-});
-
-async function run() {
-  const result = await greenSecurity.alerts.updateUserAlerts({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { alertsUpdateUserAlerts } from "@greensecurity/javascript-sdk/funcs/alertsUpdateUserAlerts.js";
-
-// Use `GreenSecurityCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const greenSecurity = new GreenSecurityCore({
-  security: {
-    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
-  },
-});
-
-async function run() {
-  const res = await alertsUpdateUserAlerts(greenSecurity, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("alertsUpdateUserAlerts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Mutation hook for triggering the API call.
-  useAlertsUpdateUserAlertsMutation
-} from "@greensecurity/javascript-sdk/react-query/alertsUpdateUserAlerts.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.UpdateUserAlertsRequestBody](../../models/operations/updateuseralertsrequestbody.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.UpdateUserAlertsResponseBody](../../models/operations/updateuseralertsresponsebody.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
-| errors.ApiErrorResponse | 500                     | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |

package/docs/sdks/companies/README.md

@@ -1,126 +0,0 @@
-# Companies
-(*companies*)
-
-## Overview
-
-### Available Operations
-
-* [listOrSearchCompanies](#listorsearchcompanies) - List or search companies
-
-## listOrSearchCompanies
-
-List or search companies.
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="listOrSearchCompanies" method="get" path="/companies" -->
-```typescript
-import { GreenSecurity } from "@greensecurity/javascript-sdk";
-
-const greenSecurity = new GreenSecurity({
-  security: {
-    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
-  },
-});
-
-async function run() {
-  const result = await greenSecurity.companies.listOrSearchCompanies({
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-  });
-
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { companiesListOrSearchCompanies } from "@greensecurity/javascript-sdk/funcs/companiesListOrSearchCompanies.js";
-
-// Use `GreenSecurityCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const greenSecurity = new GreenSecurityCore({
-  security: {
-    token: process.env["GREEN_SECURITY_TOKEN"] ?? "",
-  },
-});
-
-async function run() {
-  const res = await companiesListOrSearchCompanies(greenSecurity, {
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("companiesListOrSearchCompanies failed:", res.error);
-  }
-}
-
-run();
-```
-
-### React hooks and utilities
-
-This method can be used in React components through the following hooks and
-associated utilities.
-
-> Check out [this guide][hook-guide] for information about each of the utilities
-> below and how to get started using React hooks.
-
-[hook-guide]: ../../../REACT_QUERY.md
-
-```tsx
-import {
-  // Query hooks for fetching data.
-  useCompaniesListOrSearchCompanies,
-  useCompaniesListOrSearchCompaniesSuspense,
-  // Query hooks suitable for building infinite scrolling or "load more" UIs.
-  useCompaniesListOrSearchCompaniesInfinite,
-  useCompaniesListOrSearchCompaniesInfiniteSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchCompaniesListOrSearchCompanies,
-  
-  // Utilities to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateCompaniesListOrSearchCompanies,
-  invalidateAllCompaniesListOrSearchCompanies,
-} from "@greensecurity/javascript-sdk/react-query/companiesListOrSearchCompanies.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListOrSearchCompaniesRequest](../../models/operations/listorsearchcompaniesrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.ListOrSearchCompaniesResponse](../../models/operations/listorsearchcompaniesresponse.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 403                | application/json        |
-| errors.ApiErrorResponse | 500                     | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |