@greensecurity/javascript-sdk 0.39.61-beta.0 → 0.40.3

package/docs/sdks/greensecurity/README.md

@@ -0,0 +1,14 @@
+# GreenSecurity SDK
+
+## Overview
+
+API Reference: The Green Security API is organized around [REST](https://en.wikipedia.org/wiki/Representational_State_Transfer). 
+Our API has predictable resource-oriented URLs, accepts [JSON-encoded](https://www.json.org/) request bodies, 
+returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
+
+The API is updated frequently, so be sure to check back often for the latest information.
+
+Some useful links:
+- [OpenAPI Reference](https://www.speakeasy.com/openapi)
+
+### Available Operations

package/docs/sdks/invoices/README.md

@@ -0,0 +1,324 @@
+# Invoices
+(*invoices*)
+
+## Overview
+
+### Available Operations
+
+* [createInvoice](#createinvoice) - Create invoice
+* [updateInvoice](#updateinvoice) - Update invoice
+* [makePayment](#makepayment) - Make payment for the invoice
+
+## createInvoice
+
+It will create an invoice based on the lines passed as parameter.
+- Exactly one of vendor_id, company_id, facility_id, or system_id must be provided. - variant_id is required for the line - payment_handler_data must be set in the following format:
+    1. for the 'vendor credential' and 'expedited credential' payment_handlers this should be a JSON
+       with a key 'vendor_credential_id' and value as integer
+    2. for the 'credentialing subscription' payment handler this should be a JSON
+       with the following keys and values:
+         - old_vendor_type_id: required, must be nil or integer
+         - new_vendor_type_id: required, must be integer
+         - old_facility_ids:   required, must be an array of integers (can be empty)
+         - new_facility_ids:   required, must be array of integers
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createInvoice" method="post" path="/invoices" -->
+```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.invoices.createInvoice({
+    systemId: 278007,
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { invoicesCreateInvoice } from "@greensecurity/javascript-sdk/funcs/invoicesCreateInvoice.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 invoicesCreateInvoice(greenSecurity, {
+    systemId: 278007,
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("invoicesCreateInvoice 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.
+  useInvoicesCreateInvoiceMutation
+} from "@greensecurity/javascript-sdk/react-query/invoicesCreateInvoice.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CreateInvoiceRequestBody](../../models/operations/createinvoicerequestbody.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.CreateInvoiceResponseBody](../../models/operations/createinvoiceresponsebody.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                | \*/\*                   |
+
+## updateInvoice
+
+It will replace all the lines with the lines passed as parameter
+- Exactly one of vendor_id, company_id, facility_id, or system_id must be provided. - variant_id is required for the line - payment_handler_data must be set in the following format:
+    1. for the 'vendor credential' and 'expedited credential' payment_handlers this should be a JSON
+       with a key 'vendor_credential_id' and value as integer
+    2. for the 'credentialing subscription' payment handler this should be a JSON
+       with the following keys and values:
+         - old_vendor_type_id: required, must be nil or integer
+         - new_vendor_type_id: required, must be integer
+         - old_facility_ids:   required, must be an array of integers (can be empty)
+         - new_facility_ids:   required, must be array of integers
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="updateInvoice" method="put" path="/invoices/{id}" -->
+```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.invoices.updateInvoice({
+    id: 801666,
+    requestBody: {
+      systemId: 761923,
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { invoicesUpdateInvoice } from "@greensecurity/javascript-sdk/funcs/invoicesUpdateInvoice.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 invoicesUpdateInvoice(greenSecurity, {
+    id: 801666,
+    requestBody: {
+      systemId: 761923,
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("invoicesUpdateInvoice 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.
+  useInvoicesUpdateInvoiceMutation
+} from "@greensecurity/javascript-sdk/react-query/invoicesUpdateInvoice.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateInvoiceRequest](../../models/operations/updateinvoicerequest.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\<[boolean](../../models/.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                | \*/\*                   |
+
+## makePayment
+
+Make payment for the invoice
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="makePayment" method="post" path="/invoices/{id}/payment" -->
+```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.invoices.makePayment({
+    id: 711595,
+    requestBody: {},
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
+import { invoicesMakePayment } from "@greensecurity/javascript-sdk/funcs/invoicesMakePayment.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 invoicesMakePayment(greenSecurity, {
+    id: 711595,
+    requestBody: {},
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("invoicesMakePayment 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.
+  useInvoicesMakePaymentMutation
+} from "@greensecurity/javascript-sdk/react-query/invoicesMakePayment.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.MakePaymentRequest](../../models/operations/makepaymentrequest.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.MakePaymentResponseBody](../../models/operations/makepaymentresponsebody.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                | \*/\*                   |