@greensecurity/javascript-sdk 0.9.1 → 0.11.0

package/docs/sdks/user/README.md

@@ -1,348 +0,0 @@
-# User
-(*user*)
-
-## Overview
-
-Operations about user
-
-### Available Operations
-
-* [getCurrentUser](#getcurrentuser) - Get current user
-* [getUserById](#getuserbyid) - Get user by id
-* [logsUserIntoTheSystem](#logsuserintothesystem) - Logs user into the system
-
-## getCurrentUser
-
-Returns a user object for the user represented by the authorization token
-
-### Example Usage
-
-```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.user.getCurrentUser();
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { userGetCurrentUser } from "@greensecurity/javascript-sdk/funcs/userGetCurrentUser.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 userGetCurrentUser(greenSecurity);
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-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.
-  useUserGetCurrentUser,
-  useUserGetCurrentUserSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchUserGetCurrentUser,
-  
-  // Utility to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateAllUserGetCurrentUser,
-} from "@greensecurity/javascript-sdk/react-query/userGetCurrentUser.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `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\<[components.User](../../models/components/user.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |
-
-## getUserById
-
-Returns a user object for the user represented by the identifier in the path.
-
-### Example Usage
-
-```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.user.getUserById({
-    id: 923873,
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { userGetUserById } from "@greensecurity/javascript-sdk/funcs/userGetUserById.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 userGetUserById(greenSecurity, {
-    id: 923873,
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-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.
-  useUserGetUserById,
-  useUserGetUserByIdSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchUserGetUserById,
-  
-  // Utilities to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateUserGetUserById,
-  invalidateAllUserGetUserById,
-} from "@greensecurity/javascript-sdk/react-query/userGetUserById.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetUserByIdRequest](../../models/operations/getuserbyidrequest.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\<[components.User](../../models/components/user.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 401, 403, 404      | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |
-
-## logsUserIntoTheSystem
-
-This endpoint allows a user to authenticate themselves and retrieve a permanent token for access.
-
-Permanent tokens should only ever be stored in an encrypted storage because they represent a fully logged in user.
-
-Users may log in with `email/password`, `SAML`, `magic link` or `mfa`. The application should handle all of the above as equally valid login methods.
-
-The most common way to authenticate a user is to log in with an email and password. If the user provides valid credentials, the server will either respond with a full user object including the token.
-
-When the user's account is protected via MFA, the server will send a 6 digit code to the user via their default MFA provider. You should collect that code and resend the email, password and mfa_code together to get a successful authentication.
-
-The ideal flow for a login sequence is the following:
-
-1. Present an email address field only and allow the user to submit
-2. Send `email` and `return_url` payload to this endpoint
-3. Follow the flow based on the response `requires` field
-
-Requires: `password`
-
-1. Show a password field for the user to fill out
-2. Submit the `email` and `password` to this endpoint
-3. If the response is `200`, the login is done. If the response is `201`, then check if `requires: mfa_code` is returned and show MFA flow
-4. Submit `email`, `password`, `mfa_code` to this endpoint
-5. If the response is `200`, the login is done. Otherwise, show the appropriate error to the user and go back to step 1 or 3 depending on the error.
-
-Requires: `saml_login`
-
-1. [Open a browser](https://docs.expo.dev/versions/latest/sdk/webbrowser/#webbrowseropenauthsessionasyncurl-redirecturl-options) to the url returned in `sso_url`
-2. User completes sign-in using their configured SAML IdP
-3. Site redirects to your selected `return_url`
-4. The `user_token` will be appended as a query string parameter to your `return_url` - you must parse this token and store it
-5. Fetch the user object from `/users/me` using the token
-
-### Example Usage
-
-```typescript
-import { GreenSecurity } from "@greensecurity/javascript-sdk";
-
-const greenSecurity = new GreenSecurity();
-
-async function run() {
-  const result = await greenSecurity.user.logsUserIntoTheSystem({
-    email: "user@example.com",
-    mfaCode: "123456",
-    password: "Hunter2",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { userLogsUserIntoTheSystem } from "@greensecurity/javascript-sdk/funcs/userLogsUserIntoTheSystem.js";
-
-// Use `GreenSecurityCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const greenSecurity = new GreenSecurityCore();
-
-async function run() {
-  const res = await userLogsUserIntoTheSystem(greenSecurity, {
-    email: "user@example.com",
-    mfaCode: "123456",
-    password: "Hunter2",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-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.
-  useUserLogsUserIntoTheSystemMutation
-} from "@greensecurity/javascript-sdk/react-query/userLogsUserIntoTheSystem.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.LogsUserIntoTheSystemRequestBody](../../models/operations/logsuserintothesystemrequestbody.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.LogsUserIntoTheSystemResponse](../../models/operations/logsuserintothesystemresponse.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 401, 404           | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |

package/docs/sdks/vendors/README.md

@@ -1,219 +0,0 @@
-# Vendors
-(*vendors*)
-
-## Overview
-
-Vendors includes anyone that sells goods or services to `Organizations`. Someone is a vendor when they have a contract with a hospital (or looking to establish one).
-
-### Available Operations
-
-* [createVendorRegistration](#createvendorregistration) - Create vendor registration
-* [listVendorJobTitles](#listvendorjobtitles) - List vendor job titles
-
-## createVendorRegistration
-
-Create an initial vendor registration. Once successful, the vendor will be able to continue to filling out the rest of their onboarding profile.
-
-### Example Usage
-
-```typescript
-import { GreenSecurity } from "@greensecurity/javascript-sdk";
-
-const greenSecurity = new GreenSecurity();
-
-async function run() {
-  const result = await greenSecurity.vendors.createVendorRegistration({
-    email: "user@example.com",
-    password: "Abcdef123!",
-    timezone: "America/Chicago",
-    affiliateId: 123,
-    vendorGroupId: 123,
-    managingCompanyId: 123,
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { vendorsCreateVendorRegistration } from "@greensecurity/javascript-sdk/funcs/vendorsCreateVendorRegistration.js";
-
-// Use `GreenSecurityCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const greenSecurity = new GreenSecurityCore();
-
-async function run() {
-  const res = await vendorsCreateVendorRegistration(greenSecurity, {
-    email: "user@example.com",
-    password: "Abcdef123!",
-    timezone: "America/Chicago",
-    affiliateId: 123,
-    vendorGroupId: 123,
-    managingCompanyId: 123,
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-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.
-  useVendorsCreateVendorRegistrationMutation
-} from "@greensecurity/javascript-sdk/react-query/vendorsCreateVendorRegistration.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.CreateVendorRegistrationRequestBody](../../models/operations/createvendorregistrationrequestbody.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.CreateVendorRegistrationResponseBody](../../models/operations/createvendorregistrationresponsebody.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 400, 401, 403, 409      | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |
-
-## listVendorJobTitles
-
-List valid job titles for Vendors. This can be used during sign up or in a filter.
-
-### Example Usage
-
-```typescript
-import { GreenSecurity } from "@greensecurity/javascript-sdk";
-
-const greenSecurity = new GreenSecurity();
-
-async function run() {
-  const result = await greenSecurity.vendors.listVendorJobTitles({
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-    jobLike: "job",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { GreenSecurityCore } from "@greensecurity/javascript-sdk/core.js";
-import { vendorsListVendorJobTitles } from "@greensecurity/javascript-sdk/funcs/vendorsListVendorJobTitles.js";
-
-// Use `GreenSecurityCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const greenSecurity = new GreenSecurityCore();
-
-async function run() {
-  const res = await vendorsListVendorJobTitles(greenSecurity, {
-    sort: "job",
-    desc: true,
-    itemsPerPage: 25,
-    jobLike: "job",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-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.
-  useVendorsListVendorJobTitles,
-  useVendorsListVendorJobTitlesSuspense,
-
-  // Utility for prefetching data during server-side rendering and in React
-  // Server Components that will be immediately available to client components
-  // using the hooks.
-  prefetchVendorsListVendorJobTitles,
-  
-  // Utilities to invalidate the query cache for this query in response to
-  // mutations and other user actions.
-  invalidateVendorsListVendorJobTitles,
-  invalidateAllVendorsListVendorJobTitles,
-} from "@greensecurity/javascript-sdk/react-query/vendorsListVendorJobTitles.js";
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListVendorJobTitlesRequest](../../models/operations/listvendorjobtitlesrequest.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.ListVendorJobTitlesResponseBody](../../models/operations/listvendorjobtitlesresponsebody.md)\>**
-
-### Errors
-
-| Error Type              | Status Code             | Content Type            |
-| ----------------------- | ----------------------- | ----------------------- |
-| errors.ApiErrorResponse | 403                     | application/json        |
-| errors.ApiErrorResponse | 500                     | application/json        |
-| errors.APIError         | 4XX, 5XX                | \*/\*                   |