From 0b880607839a6e66c554630a3593dc7a09aed0f1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Salazar?=
<73718835+joshrs23@users.noreply.github.com>
Date: Fri, 12 Dec 2025 09:58:43 -0500
Subject: [PATCH] adding new line to ignore dataconnect for front web free
---
.gitignore | 1 +
.../dataconnect-generated/.guides/config.json | 9 -
.../dataconnect-generated/.guides/setup.md | 62 -
.../dataconnect-generated/.guides/usage.md | 109 -
.../src/dataconnect-generated/README.md | 16647 ----------------
.../dataconnect-generated/esm/index.esm.js | 1798 --
.../dataconnect-generated/esm/package.json | 1 -
.../src/dataconnect-generated/index.cjs.js | 1969 --
.../src/dataconnect-generated/index.d.ts | 4032 ----
.../src/dataconnect-generated/package.json | 32 -
.../src/dataconnect-generated/react/README.md | 13609 -------------
.../react/esm/index.esm.js | 970 -
.../react/esm/package.json | 1 -
.../dataconnect-generated/react/index.cjs.js | 970 -
.../dataconnect-generated/react/index.d.ts | 420 -
.../dataconnect-generated/react/package.json | 17 -
16 files changed, 1 insertion(+), 40646 deletions(-)
delete mode 100644 frontend-web-free/src/dataconnect-generated/.guides/config.json
delete mode 100644 frontend-web-free/src/dataconnect-generated/.guides/setup.md
delete mode 100644 frontend-web-free/src/dataconnect-generated/.guides/usage.md
delete mode 100644 frontend-web-free/src/dataconnect-generated/README.md
delete mode 100644 frontend-web-free/src/dataconnect-generated/esm/index.esm.js
delete mode 100644 frontend-web-free/src/dataconnect-generated/esm/package.json
delete mode 100644 frontend-web-free/src/dataconnect-generated/index.cjs.js
delete mode 100644 frontend-web-free/src/dataconnect-generated/index.d.ts
delete mode 100644 frontend-web-free/src/dataconnect-generated/package.json
delete mode 100644 frontend-web-free/src/dataconnect-generated/react/README.md
delete mode 100644 frontend-web-free/src/dataconnect-generated/react/esm/index.esm.js
delete mode 100644 frontend-web-free/src/dataconnect-generated/react/esm/package.json
delete mode 100644 frontend-web-free/src/dataconnect-generated/react/index.cjs.js
delete mode 100644 frontend-web-free/src/dataconnect-generated/react/index.d.ts
delete mode 100644 frontend-web-free/src/dataconnect-generated/react/package.json
diff --git a/.gitignore b/.gitignore
index 0e48b5c2..8c05e022 100644
--- a/.gitignore
+++ b/.gitignore
@@ -37,6 +37,7 @@ frontend-web/coverage/
frontend-web/.vite/
/frontend-web/src/dataconnect-generated/
/internal-api-harness/src/dataconnect-generated/
+frontend-web-free/src/dataconnect-generated/
# Mobile (Flutter)
diff --git a/frontend-web-free/src/dataconnect-generated/.guides/config.json b/frontend-web-free/src/dataconnect-generated/.guides/config.json
deleted file mode 100644
index e37ed06f..00000000
--- a/frontend-web-free/src/dataconnect-generated/.guides/config.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "description": "A set of guides for interacting with the generated firebase dataconnect sdk",
- "mcpServers": {
- "firebase": {
- "command": "npx",
- "args": ["-y", "firebase-tools@latest", "experimental:mcp"]
- }
- }
-}
diff --git a/frontend-web-free/src/dataconnect-generated/.guides/setup.md b/frontend-web-free/src/dataconnect-generated/.guides/setup.md
deleted file mode 100644
index 64a49286..00000000
--- a/frontend-web-free/src/dataconnect-generated/.guides/setup.md
+++ /dev/null
@@ -1,62 +0,0 @@
-# Setup
-
-If the user hasn't already installed the SDK, always run the user's node package manager of choice, and install the package in the directory ../package.json.
-For more information on where the library is located, look at the connector.yaml file.
-
-```ts
-import { initializeApp } from 'firebase/app';
-
-initializeApp({
- // fill in your project config here using the values from your Firebase project or from the `firebase_get_sdk_config` tool from the Firebase MCP server.
-});
-```
-
-Then, you can run the SDK as needed.
-```ts
-import { ... } from '@dataconnect/generated';
-```
-
-
-
-
-## React
-### Setup
-
-The user should make sure to install the `@tanstack/react-query` package, along with `@tanstack-query-firebase/react` and `firebase`.
-
-Then, they should initialize Firebase:
-```ts
-import { initializeApp } from 'firebase/app';
-initializeApp(firebaseConfig); /* your config here. To generate this, you can use the `firebase_sdk_config` MCP tool */
-```
-
-Then, they should add a `QueryClientProvider` to their root of their application.
-
-Here's an example:
-
-```ts
-import { initializeApp } from 'firebase/app';
-import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
-
-const firebaseConfig = {
- /* your config here. To generate this, you can use the `firebase_sdk_config` MCP tool */
-};
-
-// Initialize Firebase
-const app = initializeApp(firebaseConfig);
-
-// Create a TanStack Query client instance
-const queryClient = new QueryClient();
-
-function App() {
- return (
- // Provide the client to your App
-
-
-
- )
-}
-
-render(, document.getElementById('root'));
-```
-
diff --git a/frontend-web-free/src/dataconnect-generated/.guides/usage.md b/frontend-web-free/src/dataconnect-generated/.guides/usage.md
deleted file mode 100644
index 4e5a55ce..00000000
--- a/frontend-web-free/src/dataconnect-generated/.guides/usage.md
+++ /dev/null
@@ -1,109 +0,0 @@
-# Basic Usage
-
-Always prioritize using a supported framework over using the generated SDK
-directly. Supported frameworks simplify the developer experience and help ensure
-best practices are followed.
-
-
-
-
-### React
-For each operation, there is a wrapper hook that can be used to call the operation.
-
-Here are all of the hooks that get generated:
-```ts
-import { useListTeamMember, useGetTeamMemberById, useFilterTeamMember, useCreateUser, useUpdateUser, useDeleteUser, useListUsers, useGetUserById, useFilterUsers, useCreateAssignment } from '@dataconnect/generated/react';
-// The types of these hooks are available in react/index.d.ts
-
-const { data, isPending, isSuccess, isError, error } = useListTeamMember();
-
-const { data, isPending, isSuccess, isError, error } = useGetTeamMemberById(getTeamMemberByIdVars);
-
-const { data, isPending, isSuccess, isError, error } = useFilterTeamMember(filterTeamMemberVars);
-
-const { data, isPending, isSuccess, isError, error } = useCreateUser(createUserVars);
-
-const { data, isPending, isSuccess, isError, error } = useUpdateUser(updateUserVars);
-
-const { data, isPending, isSuccess, isError, error } = useDeleteUser(deleteUserVars);
-
-const { data, isPending, isSuccess, isError, error } = useListUsers();
-
-const { data, isPending, isSuccess, isError, error } = useGetUserById(getUserByIdVars);
-
-const { data, isPending, isSuccess, isError, error } = useFilterUsers(filterUsersVars);
-
-const { data, isPending, isSuccess, isError, error } = useCreateAssignment(createAssignmentVars);
-
-```
-
-Here's an example from a different generated SDK:
-
-```ts
-import { useListAllMovies } from '@dataconnect/generated/react';
-
-function MyComponent() {
- const { isLoading, data, error } = useListAllMovies();
- if(isLoading) {
- return Loading...
- }
- if(error) {
- return An Error Occurred: {error}
- }
-}
-
-// App.tsx
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-import MyComponent from './my-component';
-
-function App() {
- const queryClient = new QueryClient();
- return
-
-
-}
-```
-
-
-
-## Advanced Usage
-If a user is not using a supported framework, they can use the generated SDK directly.
-
-Here's an example of how to use it with the first 5 operations:
-
-```js
-import { listTeamMember, getTeamMemberById, filterTeamMember, createUser, updateUser, deleteUser, listUsers, getUserById, filterUsers, createAssignment } from '@dataconnect/generated';
-
-
-// Operation listTeamMember:
-const { data } = await ListTeamMember(dataConnect);
-
-// Operation getTeamMemberById: For variables, look at type GetTeamMemberByIdVars in ../index.d.ts
-const { data } = await GetTeamMemberById(dataConnect, getTeamMemberByIdVars);
-
-// Operation filterTeamMember: For variables, look at type FilterTeamMemberVars in ../index.d.ts
-const { data } = await FilterTeamMember(dataConnect, filterTeamMemberVars);
-
-// Operation CreateUser: For variables, look at type CreateUserVars in ../index.d.ts
-const { data } = await CreateUser(dataConnect, createUserVars);
-
-// Operation UpdateUser: For variables, look at type UpdateUserVars in ../index.d.ts
-const { data } = await UpdateUser(dataConnect, updateUserVars);
-
-// Operation DeleteUser: For variables, look at type DeleteUserVars in ../index.d.ts
-const { data } = await DeleteUser(dataConnect, deleteUserVars);
-
-// Operation listUsers:
-const { data } = await ListUsers(dataConnect);
-
-// Operation getUserById: For variables, look at type GetUserByIdVars in ../index.d.ts
-const { data } = await GetUserById(dataConnect, getUserByIdVars);
-
-// Operation filterUsers: For variables, look at type FilterUsersVars in ../index.d.ts
-const { data } = await FilterUsers(dataConnect, filterUsersVars);
-
-// Operation CreateAssignment: For variables, look at type CreateAssignmentVars in ../index.d.ts
-const { data } = await CreateAssignment(dataConnect, createAssignmentVars);
-
-
-```
\ No newline at end of file
diff --git a/frontend-web-free/src/dataconnect-generated/README.md b/frontend-web-free/src/dataconnect-generated/README.md
deleted file mode 100644
index 9dd4d6b3..00000000
--- a/frontend-web-free/src/dataconnect-generated/README.md
+++ /dev/null
@@ -1,16647 +0,0 @@
-# Generated TypeScript README
-This README will guide you through the process of using the generated JavaScript SDK package for the connector `krow-connector`. It will also provide examples on how to use your generated SDK to call your Data Connect queries and mutations.
-
-**If you're looking for the `React README`, you can find it at [`dataconnect-generated/react/README.md`](./react/README.md)**
-
-***NOTE:** This README is generated alongside the generated SDK. If you make changes to this file, they will be overwritten when the SDK is regenerated.*
-
-# Table of Contents
-- [**Overview**](#generated-javascript-readme)
-- [**Accessing the connector**](#accessing-the-connector)
- - [*Connecting to the local Emulator*](#connecting-to-the-local-emulator)
-- [**Queries**](#queries)
- - [*listTeamMember*](#listteammember)
- - [*getTeamMemberById*](#getteammemberbyid)
- - [*filterTeamMember*](#filterteammember)
- - [*listUsers*](#listusers)
- - [*getUserById*](#getuserbyid)
- - [*filterUsers*](#filterusers)
- - [*listOrder*](#listorder)
- - [*getOrderById*](#getorderbyid)
- - [*filterOrder*](#filterorder)
- - [*listVendorDefaultSettings*](#listvendordefaultsettings)
- - [*getVendorDefaultSettingById*](#getvendordefaultsettingbyid)
- - [*filterVendorDefaultSettings*](#filtervendordefaultsettings)
- - [*listActivityLog*](#listactivitylog)
- - [*getActivityLogById*](#getactivitylogbyid)
- - [*filterActivityLog*](#filteractivitylog)
- - [*listConversation*](#listconversation)
- - [*getConversationById*](#getconversationbyid)
- - [*filterConversation*](#filterconversation)
- - [*listBusiness*](#listbusiness)
- - [*getBusinessById*](#getbusinessbyid)
- - [*filterBusiness*](#filterbusiness)
- - [*listStaff*](#liststaff)
- - [*getStaffById*](#getstaffbyid)
- - [*filterStaff*](#filterstaff)
- - [*listTeamMemberInvite*](#listteammemberinvite)
- - [*getTeamMemberInviteById*](#getteammemberinvitebyid)
- - [*filterTeamMemberInvite*](#filterteammemberinvite)
- - [*listCertification*](#listcertification)
- - [*getCertificationById*](#getcertificationbyid)
- - [*filterCertification*](#filtercertification)
- - [*listTeam*](#listteam)
- - [*getTeamById*](#getteambyid)
- - [*filterTeam*](#filterteam)
- - [*listTeamHub*](#listteamhub)
- - [*getTeamHubById*](#getteamhubbyid)
- - [*filterTeamHub*](#filterteamhub)
- - [*listVendor*](#listvendor)
- - [*getVendorById*](#getvendorbyid)
- - [*filterVendors*](#filtervendors)
- - [*listInvoice*](#listinvoice)
- - [*getInvoiceById*](#getinvoicebyid)
- - [*filterInvoices*](#filterinvoices)
- - [*listMessage*](#listmessage)
- - [*getMessageById*](#getmessagebyid)
- - [*filterMessage*](#filtermessage)
- - [*listPartner*](#listpartner)
- - [*getPartnerById*](#getpartnerbyid)
- - [*filterPartner*](#filterpartner)
- - [*listVendorRate*](#listvendorrate)
- - [*getVendorRateById*](#getvendorratebyid)
- - [*filterVendorRates*](#filtervendorrates)
- - [*listAssignment*](#listassignment)
- - [*getAssignmentById*](#getassignmentbyid)
- - [*filterAssignment*](#filterassignment)
- - [*listWorkforce*](#listworkforce)
- - [*getWorkforceById*](#getworkforcebyid)
- - [*filterWorkforce*](#filterworkforce)
- - [*listEnterprise*](#listenterprise)
- - [*getEnterpriseById*](#getenterprisebyid)
- - [*filterEnterprise*](#filterenterprise)
- - [*listEvents*](#listevents)
- - [*getEventById*](#geteventbyid)
- - [*filterEvents*](#filterevents)
- - [*listSector*](#listsector)
- - [*getSectorById*](#getsectorbyid)
- - [*filterSector*](#filtersector)
- - [*listShift*](#listshift)
- - [*getShiftById*](#getshiftbyid)
- - [*filterShift*](#filtershift)
-- [**Mutations**](#mutations)
- - [*CreateUser*](#createuser)
- - [*UpdateUser*](#updateuser)
- - [*DeleteUser*](#deleteuser)
- - [*CreateAssignment*](#createassignment)
- - [*UpdateAssignment*](#updateassignment)
- - [*DeleteAssignment*](#deleteassignment)
- - [*CreateEnterprise*](#createenterprise)
- - [*UpdateEnterprise*](#updateenterprise)
- - [*DeleteEnterprise*](#deleteenterprise)
- - [*CreateCertification*](#createcertification)
- - [*UpdateCertification*](#updatecertification)
- - [*DeleteCertification*](#deletecertification)
- - [*CreateTeamHub*](#createteamhub)
- - [*UpdateTeamHub*](#updateteamhub)
- - [*DeleteTeamHub*](#deleteteamhub)
- - [*CreateVendor*](#createvendor)
- - [*UpdateVendor*](#updatevendor)
- - [*DeleteVendor*](#deletevendor)
- - [*CreateActivityLog*](#createactivitylog)
- - [*UpdateActivityLog*](#updateactivitylog)
- - [*DeleteActivityLog*](#deleteactivitylog)
- - [*CreateConversation*](#createconversation)
- - [*UpdateConversation*](#updateconversation)
- - [*DeleteConversation*](#deleteconversation)
- - [*CreateStaff*](#createstaff)
- - [*UpdateStaff*](#updatestaff)
- - [*DeleteStaff*](#deletestaff)
- - [*CreateTeamMemberInvite*](#createteammemberinvite)
- - [*UpdateTeamMemberInvite*](#updateteammemberinvite)
- - [*DeleteTeamMemberInvite*](#deleteteammemberinvite)
- - [*CreateVendorRate*](#createvendorrate)
- - [*UpdateVendorRate*](#updatevendorrate)
- - [*DeleteVendorRate*](#deletevendorrate)
- - [*CreateEvent*](#createevent)
- - [*UpdateEvent*](#updateevent)
- - [*DeleteEvent*](#deleteevent)
- - [*CreateMessage*](#createmessage)
- - [*UpdateMessage*](#updatemessage)
- - [*DeleteMessage*](#deletemessage)
- - [*CreateOrder*](#createorder)
- - [*UpdateOrder*](#updateorder)
- - [*DeleteOrder*](#deleteorder)
- - [*CreateTeamMember*](#createteammember)
- - [*UpdateTeamMember*](#updateteammember)
- - [*DeleteTeamMember*](#deleteteammember)
- - [*CreateWorkforce*](#createworkforce)
- - [*UpdateWorkforce*](#updateworkforce)
- - [*DeleteWorkforce*](#deleteworkforce)
- - [*CreateInvoice*](#createinvoice)
- - [*UpdateInvoice*](#updateinvoice)
- - [*DeleteInvoice*](#deleteinvoice)
- - [*CreateTeam*](#createteam)
- - [*UpdateTeam*](#updateteam)
- - [*DeleteTeam*](#deleteteam)
- - [*CreateBusiness*](#createbusiness)
- - [*UpdateBusiness*](#updatebusiness)
- - [*DeleteBusiness*](#deletebusiness)
- - [*CreatePartner*](#createpartner)
- - [*UpdatePartner*](#updatepartner)
- - [*DeletePartner*](#deletepartner)
- - [*CreateShift*](#createshift)
- - [*UpdateShift*](#updateshift)
- - [*DeleteShift*](#deleteshift)
- - [*CreateVendorDefaultSetting*](#createvendordefaultsetting)
- - [*UpdateVendorDefaultSetting*](#updatevendordefaultsetting)
- - [*DeleteVendorDefaultSetting*](#deletevendordefaultsetting)
- - [*CreateSector*](#createsector)
- - [*UpdateSector*](#updatesector)
- - [*DeleteSector*](#deletesector)
-
-# Accessing the connector
-A connector is a collection of Queries and Mutations. One SDK is generated for each connector - this SDK is generated for the connector `krow-connector`. You can find more information about connectors in the [Data Connect documentation](https://firebase.google.com/docs/data-connect#how-does).
-
-You can use this generated SDK by importing from the package `@dataconnect/generated` as shown below. Both CommonJS and ESM imports are supported.
-
-You can also follow the instructions from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#set-client).
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig } from '@dataconnect/generated';
-
-const dataConnect = getDataConnect(connectorConfig);
-```
-
-## Connecting to the local Emulator
-By default, the connector will connect to the production service.
-
-To connect to the emulator, you can use the following code.
-You can also follow the emulator instructions from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#instrument-clients).
-
-```typescript
-import { connectDataConnectEmulator, getDataConnect } from 'firebase/data-connect';
-import { connectorConfig } from '@dataconnect/generated';
-
-const dataConnect = getDataConnect(connectorConfig);
-connectDataConnectEmulator(dataConnect, 'localhost', 9399);
-```
-
-After it's initialized, you can call your Data Connect [queries](#queries) and [mutations](#mutations) from your generated SDK.
-
-# Queries
-
-There are two ways to execute a Data Connect Query using the generated Web SDK:
-- Using a Query Reference function, which returns a `QueryRef`
- - The `QueryRef` can be used as an argument to `executeQuery()`, which will execute the Query and return a `QueryPromise`
-- Using an action shortcut function, which returns a `QueryPromise`
- - Calling the action shortcut function will execute the Query and return a `QueryPromise`
-
-The following is true for both the action shortcut function and the `QueryRef` function:
-- The `QueryPromise` returned will resolve to the result of the Query once it has finished executing
-- If the Query accepts arguments, both the action shortcut function and the `QueryRef` function accept a single argument: an object that contains all the required variables (and the optional variables) for the Query
-- Both functions can be called with or without passing in a `DataConnect` instance as an argument. If no `DataConnect` argument is passed in, then the generated SDK will call `getDataConnect(connectorConfig)` behind the scenes for you.
-
-Below are examples of how to use the `krow-connector` connector's generated functions to execute each query. You can also follow the examples from the [Data Connect documentation](https://firebase.google.com/docs/data-connect/web-sdk#using-queries).
-
-## listTeamMember
-You can execute the `listTeamMember` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listTeamMember(): QueryPromise;
-
-interface ListTeamMemberRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listTeamMemberRef: ListTeamMemberRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listTeamMember(dc: DataConnect): QueryPromise;
-
-interface ListTeamMemberRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listTeamMemberRef: ListTeamMemberRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listTeamMemberRef:
-```typescript
-const name = listTeamMemberRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listTeamMember` query has no variables.
-### Return Type
-Recall that executing the `listTeamMember` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListTeamMemberData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListTeamMemberData {
- teamMembers: ({
- id: UUIDString;
- teamId: UUIDString;
- memberName: string;
- email: string;
- role?: TeamMemberRole | null;
- isActive?: boolean | null;
- } & TeamMember_Key)[];
-}
-```
-### Using `listTeamMember`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listTeamMember } from '@dataconnect/generated';
-
-
-// Call the `listTeamMember()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listTeamMember();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listTeamMember(dataConnect);
-
-console.log(data.teamMembers);
-
-// Or, you can use the `Promise` API.
-listTeamMember().then((response) => {
- const data = response.data;
- console.log(data.teamMembers);
-});
-```
-
-### Using `listTeamMember`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listTeamMemberRef } from '@dataconnect/generated';
-
-
-// Call the `listTeamMemberRef()` function to get a reference to the query.
-const ref = listTeamMemberRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listTeamMemberRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamMembers);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamMembers);
-});
-```
-
-## getTeamMemberById
-You can execute the `getTeamMemberById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getTeamMemberById(vars: GetTeamMemberByIdVariables): QueryPromise;
-
-interface GetTeamMemberByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetTeamMemberByIdVariables): QueryRef;
-}
-export const getTeamMemberByIdRef: GetTeamMemberByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getTeamMemberById(dc: DataConnect, vars: GetTeamMemberByIdVariables): QueryPromise;
-
-interface GetTeamMemberByIdRef {
- ...
- (dc: DataConnect, vars: GetTeamMemberByIdVariables): QueryRef;
-}
-export const getTeamMemberByIdRef: GetTeamMemberByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getTeamMemberByIdRef:
-```typescript
-const name = getTeamMemberByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getTeamMemberById` query requires an argument of type `GetTeamMemberByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetTeamMemberByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getTeamMemberById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetTeamMemberByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetTeamMemberByIdData {
- teamMember?: {
- id: UUIDString;
- teamId: UUIDString;
- memberName: string;
- email: string;
- role?: TeamMemberRole | null;
- isActive?: boolean | null;
- } & TeamMember_Key;
-}
-```
-### Using `getTeamMemberById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getTeamMemberById, GetTeamMemberByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamMemberById` query requires an argument of type `GetTeamMemberByIdVariables`:
-const getTeamMemberByIdVars: GetTeamMemberByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamMemberById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getTeamMemberById(getTeamMemberByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getTeamMemberById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getTeamMemberById(dataConnect, getTeamMemberByIdVars);
-
-console.log(data.teamMember);
-
-// Or, you can use the `Promise` API.
-getTeamMemberById(getTeamMemberByIdVars).then((response) => {
- const data = response.data;
- console.log(data.teamMember);
-});
-```
-
-### Using `getTeamMemberById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getTeamMemberByIdRef, GetTeamMemberByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamMemberById` query requires an argument of type `GetTeamMemberByIdVariables`:
-const getTeamMemberByIdVars: GetTeamMemberByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamMemberByIdRef()` function to get a reference to the query.
-const ref = getTeamMemberByIdRef(getTeamMemberByIdVars);
-// Variables can be defined inline as well.
-const ref = getTeamMemberByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getTeamMemberByIdRef(dataConnect, getTeamMemberByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamMember);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamMember);
-});
-```
-
-## filterTeamMember
-You can execute the `filterTeamMember` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterTeamMember(vars?: FilterTeamMemberVariables): QueryPromise;
-
-interface FilterTeamMemberRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterTeamMemberVariables): QueryRef;
-}
-export const filterTeamMemberRef: FilterTeamMemberRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterTeamMember(dc: DataConnect, vars?: FilterTeamMemberVariables): QueryPromise;
-
-interface FilterTeamMemberRef {
- ...
- (dc: DataConnect, vars?: FilterTeamMemberVariables): QueryRef;
-}
-export const filterTeamMemberRef: FilterTeamMemberRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterTeamMemberRef:
-```typescript
-const name = filterTeamMemberRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterTeamMember` query has an optional argument of type `FilterTeamMemberVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterTeamMemberVariables {
- teamId?: UUIDString | null;
- memberName?: string | null;
- email?: string | null;
- role?: TeamMemberRole | null;
- isActive?: boolean | null;
-}
-```
-### Return Type
-Recall that executing the `filterTeamMember` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterTeamMemberData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterTeamMemberData {
- teamMembers: ({
- id: UUIDString;
- teamId: UUIDString;
- memberName: string;
- email: string;
- role?: TeamMemberRole | null;
- isActive?: boolean | null;
- } & TeamMember_Key)[];
-}
-```
-### Using `filterTeamMember`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterTeamMember, FilterTeamMemberVariables } from '@dataconnect/generated';
-
-// The `filterTeamMember` query has an optional argument of type `FilterTeamMemberVariables`:
-const filterTeamMemberVars: FilterTeamMemberVariables = {
- teamId: ..., // optional
- memberName: ..., // optional
- email: ..., // optional
- role: ..., // optional
- isActive: ..., // optional
-};
-
-// Call the `filterTeamMember()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterTeamMember(filterTeamMemberVars);
-// Variables can be defined inline as well.
-const { data } = await filterTeamMember({ teamId: ..., memberName: ..., email: ..., role: ..., isActive: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamMemberVariables` argument.
-const { data } = await filterTeamMember();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterTeamMember(dataConnect, filterTeamMemberVars);
-
-console.log(data.teamMembers);
-
-// Or, you can use the `Promise` API.
-filterTeamMember(filterTeamMemberVars).then((response) => {
- const data = response.data;
- console.log(data.teamMembers);
-});
-```
-
-### Using `filterTeamMember`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterTeamMemberRef, FilterTeamMemberVariables } from '@dataconnect/generated';
-
-// The `filterTeamMember` query has an optional argument of type `FilterTeamMemberVariables`:
-const filterTeamMemberVars: FilterTeamMemberVariables = {
- teamId: ..., // optional
- memberName: ..., // optional
- email: ..., // optional
- role: ..., // optional
- isActive: ..., // optional
-};
-
-// Call the `filterTeamMemberRef()` function to get a reference to the query.
-const ref = filterTeamMemberRef(filterTeamMemberVars);
-// Variables can be defined inline as well.
-const ref = filterTeamMemberRef({ teamId: ..., memberName: ..., email: ..., role: ..., isActive: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamMemberVariables` argument.
-const ref = filterTeamMemberRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterTeamMemberRef(dataConnect, filterTeamMemberVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamMembers);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamMembers);
-});
-```
-
-## listUsers
-You can execute the `listUsers` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listUsers(): QueryPromise;
-
-interface ListUsersRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listUsersRef: ListUsersRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listUsers(dc: DataConnect): QueryPromise;
-
-interface ListUsersRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listUsersRef: ListUsersRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listUsersRef:
-```typescript
-const name = listUsersRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listUsers` query has no variables.
-### Return Type
-Recall that executing the `listUsers` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListUsersData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListUsersData {
- users: ({
- id: string;
- email: string;
- fullName: string;
- role: UserBaseRole;
- userRole?: string | null;
- createdDate?: TimestampString | null;
- updatedDate?: TimestampString | null;
- } & User_Key)[];
-}
-```
-### Using `listUsers`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listUsers } from '@dataconnect/generated';
-
-
-// Call the `listUsers()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listUsers();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listUsers(dataConnect);
-
-console.log(data.users);
-
-// Or, you can use the `Promise` API.
-listUsers().then((response) => {
- const data = response.data;
- console.log(data.users);
-});
-```
-
-### Using `listUsers`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listUsersRef } from '@dataconnect/generated';
-
-
-// Call the `listUsersRef()` function to get a reference to the query.
-const ref = listUsersRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listUsersRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.users);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.users);
-});
-```
-
-## getUserById
-You can execute the `getUserById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getUserById(vars: GetUserByIdVariables): QueryPromise;
-
-interface GetUserByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetUserByIdVariables): QueryRef;
-}
-export const getUserByIdRef: GetUserByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getUserById(dc: DataConnect, vars: GetUserByIdVariables): QueryPromise;
-
-interface GetUserByIdRef {
- ...
- (dc: DataConnect, vars: GetUserByIdVariables): QueryRef;
-}
-export const getUserByIdRef: GetUserByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getUserByIdRef:
-```typescript
-const name = getUserByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getUserById` query requires an argument of type `GetUserByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetUserByIdVariables {
- id: string;
-}
-```
-### Return Type
-Recall that executing the `getUserById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetUserByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetUserByIdData {
- user?: {
- id: string;
- email: string;
- fullName: string;
- role: UserBaseRole;
- userRole?: string | null;
- } & User_Key;
-}
-```
-### Using `getUserById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getUserById, GetUserByIdVariables } from '@dataconnect/generated';
-
-// The `getUserById` query requires an argument of type `GetUserByIdVariables`:
-const getUserByIdVars: GetUserByIdVariables = {
- id: ...,
-};
-
-// Call the `getUserById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getUserById(getUserByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getUserById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getUserById(dataConnect, getUserByIdVars);
-
-console.log(data.user);
-
-// Or, you can use the `Promise` API.
-getUserById(getUserByIdVars).then((response) => {
- const data = response.data;
- console.log(data.user);
-});
-```
-
-### Using `getUserById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getUserByIdRef, GetUserByIdVariables } from '@dataconnect/generated';
-
-// The `getUserById` query requires an argument of type `GetUserByIdVariables`:
-const getUserByIdVars: GetUserByIdVariables = {
- id: ...,
-};
-
-// Call the `getUserByIdRef()` function to get a reference to the query.
-const ref = getUserByIdRef(getUserByIdVars);
-// Variables can be defined inline as well.
-const ref = getUserByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getUserByIdRef(dataConnect, getUserByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.user);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.user);
-});
-```
-
-## filterUsers
-You can execute the `filterUsers` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterUsers(vars?: FilterUsersVariables): QueryPromise;
-
-interface FilterUsersRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterUsersVariables): QueryRef;
-}
-export const filterUsersRef: FilterUsersRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterUsers(dc: DataConnect, vars?: FilterUsersVariables): QueryPromise;
-
-interface FilterUsersRef {
- ...
- (dc: DataConnect, vars?: FilterUsersVariables): QueryRef;
-}
-export const filterUsersRef: FilterUsersRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterUsersRef:
-```typescript
-const name = filterUsersRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterUsers` query has an optional argument of type `FilterUsersVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterUsersVariables {
- id?: string | null;
- email?: string | null;
- role?: UserBaseRole | null;
- userRole?: string | null;
-}
-```
-### Return Type
-Recall that executing the `filterUsers` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterUsersData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterUsersData {
- users: ({
- id: string;
- email: string;
- fullName: string;
- role: UserBaseRole;
- userRole?: string | null;
- } & User_Key)[];
-}
-```
-### Using `filterUsers`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterUsers, FilterUsersVariables } from '@dataconnect/generated';
-
-// The `filterUsers` query has an optional argument of type `FilterUsersVariables`:
-const filterUsersVars: FilterUsersVariables = {
- id: ..., // optional
- email: ..., // optional
- role: ..., // optional
- userRole: ..., // optional
-};
-
-// Call the `filterUsers()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterUsers(filterUsersVars);
-// Variables can be defined inline as well.
-const { data } = await filterUsers({ id: ..., email: ..., role: ..., userRole: ..., });
-// Since all variables are optional for this query, you can omit the `FilterUsersVariables` argument.
-const { data } = await filterUsers();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterUsers(dataConnect, filterUsersVars);
-
-console.log(data.users);
-
-// Or, you can use the `Promise` API.
-filterUsers(filterUsersVars).then((response) => {
- const data = response.data;
- console.log(data.users);
-});
-```
-
-### Using `filterUsers`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterUsersRef, FilterUsersVariables } from '@dataconnect/generated';
-
-// The `filterUsers` query has an optional argument of type `FilterUsersVariables`:
-const filterUsersVars: FilterUsersVariables = {
- id: ..., // optional
- email: ..., // optional
- role: ..., // optional
- userRole: ..., // optional
-};
-
-// Call the `filterUsersRef()` function to get a reference to the query.
-const ref = filterUsersRef(filterUsersVars);
-// Variables can be defined inline as well.
-const ref = filterUsersRef({ id: ..., email: ..., role: ..., userRole: ..., });
-// Since all variables are optional for this query, you can omit the `FilterUsersVariables` argument.
-const ref = filterUsersRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterUsersRef(dataConnect, filterUsersVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.users);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.users);
-});
-```
-
-## listOrder
-You can execute the `listOrder` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listOrder(): QueryPromise;
-
-interface ListOrderRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listOrderRef: ListOrderRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listOrder(dc: DataConnect): QueryPromise;
-
-interface ListOrderRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listOrderRef: ListOrderRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listOrderRef:
-```typescript
-const name = listOrderRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listOrder` query has no variables.
-### Return Type
-Recall that executing the `listOrder` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListOrderData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListOrderData {
- orders: ({
- id: UUIDString;
- orderNumber: string;
- partnerId: UUIDString;
- orderType?: OrderType | null;
- orderStatus?: OrderStatus | null;
- } & Order_Key)[];
-}
-```
-### Using `listOrder`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listOrder } from '@dataconnect/generated';
-
-
-// Call the `listOrder()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listOrder();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listOrder(dataConnect);
-
-console.log(data.orders);
-
-// Or, you can use the `Promise` API.
-listOrder().then((response) => {
- const data = response.data;
- console.log(data.orders);
-});
-```
-
-### Using `listOrder`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listOrderRef } from '@dataconnect/generated';
-
-
-// Call the `listOrderRef()` function to get a reference to the query.
-const ref = listOrderRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listOrderRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.orders);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.orders);
-});
-```
-
-## getOrderById
-You can execute the `getOrderById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getOrderById(vars: GetOrderByIdVariables): QueryPromise;
-
-interface GetOrderByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetOrderByIdVariables): QueryRef;
-}
-export const getOrderByIdRef: GetOrderByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getOrderById(dc: DataConnect, vars: GetOrderByIdVariables): QueryPromise;
-
-interface GetOrderByIdRef {
- ...
- (dc: DataConnect, vars: GetOrderByIdVariables): QueryRef;
-}
-export const getOrderByIdRef: GetOrderByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getOrderByIdRef:
-```typescript
-const name = getOrderByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getOrderById` query requires an argument of type `GetOrderByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetOrderByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getOrderById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetOrderByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetOrderByIdData {
- order?: {
- id: UUIDString;
- orderNumber: string;
- partnerId: UUIDString;
- orderType?: OrderType | null;
- orderStatus?: OrderStatus | null;
- } & Order_Key;
-}
-```
-### Using `getOrderById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getOrderById, GetOrderByIdVariables } from '@dataconnect/generated';
-
-// The `getOrderById` query requires an argument of type `GetOrderByIdVariables`:
-const getOrderByIdVars: GetOrderByIdVariables = {
- id: ...,
-};
-
-// Call the `getOrderById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getOrderById(getOrderByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getOrderById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getOrderById(dataConnect, getOrderByIdVars);
-
-console.log(data.order);
-
-// Or, you can use the `Promise` API.
-getOrderById(getOrderByIdVars).then((response) => {
- const data = response.data;
- console.log(data.order);
-});
-```
-
-### Using `getOrderById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getOrderByIdRef, GetOrderByIdVariables } from '@dataconnect/generated';
-
-// The `getOrderById` query requires an argument of type `GetOrderByIdVariables`:
-const getOrderByIdVars: GetOrderByIdVariables = {
- id: ...,
-};
-
-// Call the `getOrderByIdRef()` function to get a reference to the query.
-const ref = getOrderByIdRef(getOrderByIdVars);
-// Variables can be defined inline as well.
-const ref = getOrderByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getOrderByIdRef(dataConnect, getOrderByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.order);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.order);
-});
-```
-
-## filterOrder
-You can execute the `filterOrder` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterOrder(vars?: FilterOrderVariables): QueryPromise;
-
-interface FilterOrderRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterOrderVariables): QueryRef;
-}
-export const filterOrderRef: FilterOrderRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterOrder(dc: DataConnect, vars?: FilterOrderVariables): QueryPromise;
-
-interface FilterOrderRef {
- ...
- (dc: DataConnect, vars?: FilterOrderVariables): QueryRef;
-}
-export const filterOrderRef: FilterOrderRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterOrderRef:
-```typescript
-const name = filterOrderRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterOrder` query has an optional argument of type `FilterOrderVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterOrderVariables {
- orderNumber?: string | null;
- partnerId?: UUIDString | null;
- orderType?: OrderType | null;
- orderStatus?: OrderStatus | null;
-}
-```
-### Return Type
-Recall that executing the `filterOrder` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterOrderData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterOrderData {
- orders: ({
- id: UUIDString;
- orderNumber: string;
- partnerId: UUIDString;
- orderType?: OrderType | null;
- orderStatus?: OrderStatus | null;
- } & Order_Key)[];
-}
-```
-### Using `filterOrder`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterOrder, FilterOrderVariables } from '@dataconnect/generated';
-
-// The `filterOrder` query has an optional argument of type `FilterOrderVariables`:
-const filterOrderVars: FilterOrderVariables = {
- orderNumber: ..., // optional
- partnerId: ..., // optional
- orderType: ..., // optional
- orderStatus: ..., // optional
-};
-
-// Call the `filterOrder()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterOrder(filterOrderVars);
-// Variables can be defined inline as well.
-const { data } = await filterOrder({ orderNumber: ..., partnerId: ..., orderType: ..., orderStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterOrderVariables` argument.
-const { data } = await filterOrder();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterOrder(dataConnect, filterOrderVars);
-
-console.log(data.orders);
-
-// Or, you can use the `Promise` API.
-filterOrder(filterOrderVars).then((response) => {
- const data = response.data;
- console.log(data.orders);
-});
-```
-
-### Using `filterOrder`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterOrderRef, FilterOrderVariables } from '@dataconnect/generated';
-
-// The `filterOrder` query has an optional argument of type `FilterOrderVariables`:
-const filterOrderVars: FilterOrderVariables = {
- orderNumber: ..., // optional
- partnerId: ..., // optional
- orderType: ..., // optional
- orderStatus: ..., // optional
-};
-
-// Call the `filterOrderRef()` function to get a reference to the query.
-const ref = filterOrderRef(filterOrderVars);
-// Variables can be defined inline as well.
-const ref = filterOrderRef({ orderNumber: ..., partnerId: ..., orderType: ..., orderStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterOrderVariables` argument.
-const ref = filterOrderRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterOrderRef(dataConnect, filterOrderVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.orders);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.orders);
-});
-```
-
-## listVendorDefaultSettings
-You can execute the `listVendorDefaultSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listVendorDefaultSettings(): QueryPromise;
-
-interface ListVendorDefaultSettingsRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listVendorDefaultSettings(dc: DataConnect): QueryPromise;
-
-interface ListVendorDefaultSettingsRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listVendorDefaultSettingsRef: ListVendorDefaultSettingsRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorDefaultSettingsRef:
-```typescript
-const name = listVendorDefaultSettingsRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listVendorDefaultSettings` query has no variables.
-### Return Type
-Recall that executing the `listVendorDefaultSettings` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListVendorDefaultSettingsData {
- vendorDefaultSettings: ({
- id: UUIDString;
- vendorName: string;
- defaultMarkupPercentage: number;
- defaultVendorFeePercentage: number;
- } & VendorDefaultSetting_Key)[];
-}
-```
-### Using `listVendorDefaultSettings`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listVendorDefaultSettings } from '@dataconnect/generated';
-
-
-// Call the `listVendorDefaultSettings()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listVendorDefaultSettings();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listVendorDefaultSettings(dataConnect);
-
-console.log(data.vendorDefaultSettings);
-
-// Or, you can use the `Promise` API.
-listVendorDefaultSettings().then((response) => {
- const data = response.data;
- console.log(data.vendorDefaultSettings);
-});
-```
-
-### Using `listVendorDefaultSettings`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listVendorDefaultSettingsRef } from '@dataconnect/generated';
-
-
-// Call the `listVendorDefaultSettingsRef()` function to get a reference to the query.
-const ref = listVendorDefaultSettingsRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listVendorDefaultSettingsRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendorDefaultSettings);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendorDefaultSettings);
-});
-```
-
-## getVendorDefaultSettingById
-You can execute the `getVendorDefaultSettingById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getVendorDefaultSettingById(vars: GetVendorDefaultSettingByIdVariables): QueryPromise;
-
-interface GetVendorDefaultSettingByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetVendorDefaultSettingByIdVariables): QueryRef;
-}
-export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getVendorDefaultSettingById(dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryPromise;
-
-interface GetVendorDefaultSettingByIdRef {
- ...
- (dc: DataConnect, vars: GetVendorDefaultSettingByIdVariables): QueryRef;
-}
-export const getVendorDefaultSettingByIdRef: GetVendorDefaultSettingByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorDefaultSettingByIdRef:
-```typescript
-const name = getVendorDefaultSettingByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetVendorDefaultSettingByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getVendorDefaultSettingById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetVendorDefaultSettingByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetVendorDefaultSettingByIdData {
- vendorDefaultSetting?: {
- id: UUIDString;
- vendorName: string;
- defaultMarkupPercentage: number;
- defaultVendorFeePercentage: number;
- } & VendorDefaultSetting_Key;
-}
-```
-### Using `getVendorDefaultSettingById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getVendorDefaultSettingById, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated';
-
-// The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`:
-const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = {
- id: ...,
-};
-
-// Call the `getVendorDefaultSettingById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getVendorDefaultSettingById(getVendorDefaultSettingByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getVendorDefaultSettingById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getVendorDefaultSettingById(dataConnect, getVendorDefaultSettingByIdVars);
-
-console.log(data.vendorDefaultSetting);
-
-// Or, you can use the `Promise` API.
-getVendorDefaultSettingById(getVendorDefaultSettingByIdVars).then((response) => {
- const data = response.data;
- console.log(data.vendorDefaultSetting);
-});
-```
-
-### Using `getVendorDefaultSettingById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getVendorDefaultSettingByIdRef, GetVendorDefaultSettingByIdVariables } from '@dataconnect/generated';
-
-// The `getVendorDefaultSettingById` query requires an argument of type `GetVendorDefaultSettingByIdVariables`:
-const getVendorDefaultSettingByIdVars: GetVendorDefaultSettingByIdVariables = {
- id: ...,
-};
-
-// Call the `getVendorDefaultSettingByIdRef()` function to get a reference to the query.
-const ref = getVendorDefaultSettingByIdRef(getVendorDefaultSettingByIdVars);
-// Variables can be defined inline as well.
-const ref = getVendorDefaultSettingByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getVendorDefaultSettingByIdRef(dataConnect, getVendorDefaultSettingByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendorDefaultSetting);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendorDefaultSetting);
-});
-```
-
-## filterVendorDefaultSettings
-You can execute the `filterVendorDefaultSettings` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterVendorDefaultSettings(vars?: FilterVendorDefaultSettingsVariables): QueryPromise;
-
-interface FilterVendorDefaultSettingsRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterVendorDefaultSettingsVariables): QueryRef;
-}
-export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterVendorDefaultSettings(dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryPromise;
-
-interface FilterVendorDefaultSettingsRef {
- ...
- (dc: DataConnect, vars?: FilterVendorDefaultSettingsVariables): QueryRef;
-}
-export const filterVendorDefaultSettingsRef: FilterVendorDefaultSettingsRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorDefaultSettingsRef:
-```typescript
-const name = filterVendorDefaultSettingsRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterVendorDefaultSettingsVariables {
- vendorName?: string | null;
- defaultMarkupPercentage?: number | null;
- defaultVendorFeePercentage?: number | null;
-}
-```
-### Return Type
-Recall that executing the `filterVendorDefaultSettings` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterVendorDefaultSettingsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterVendorDefaultSettingsData {
- vendorDefaultSettings: ({
- id: UUIDString;
- vendorName: string;
- defaultMarkupPercentage: number;
- defaultVendorFeePercentage: number;
- } & VendorDefaultSetting_Key)[];
-}
-```
-### Using `filterVendorDefaultSettings`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterVendorDefaultSettings, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated';
-
-// The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`:
-const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = {
- vendorName: ..., // optional
- defaultMarkupPercentage: ..., // optional
- defaultVendorFeePercentage: ..., // optional
-};
-
-// Call the `filterVendorDefaultSettings()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterVendorDefaultSettings(filterVendorDefaultSettingsVars);
-// Variables can be defined inline as well.
-const { data } = await filterVendorDefaultSettings({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., });
-// Since all variables are optional for this query, you can omit the `FilterVendorDefaultSettingsVariables` argument.
-const { data } = await filterVendorDefaultSettings();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterVendorDefaultSettings(dataConnect, filterVendorDefaultSettingsVars);
-
-console.log(data.vendorDefaultSettings);
-
-// Or, you can use the `Promise` API.
-filterVendorDefaultSettings(filterVendorDefaultSettingsVars).then((response) => {
- const data = response.data;
- console.log(data.vendorDefaultSettings);
-});
-```
-
-### Using `filterVendorDefaultSettings`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterVendorDefaultSettingsRef, FilterVendorDefaultSettingsVariables } from '@dataconnect/generated';
-
-// The `filterVendorDefaultSettings` query has an optional argument of type `FilterVendorDefaultSettingsVariables`:
-const filterVendorDefaultSettingsVars: FilterVendorDefaultSettingsVariables = {
- vendorName: ..., // optional
- defaultMarkupPercentage: ..., // optional
- defaultVendorFeePercentage: ..., // optional
-};
-
-// Call the `filterVendorDefaultSettingsRef()` function to get a reference to the query.
-const ref = filterVendorDefaultSettingsRef(filterVendorDefaultSettingsVars);
-// Variables can be defined inline as well.
-const ref = filterVendorDefaultSettingsRef({ vendorName: ..., defaultMarkupPercentage: ..., defaultVendorFeePercentage: ..., });
-// Since all variables are optional for this query, you can omit the `FilterVendorDefaultSettingsVariables` argument.
-const ref = filterVendorDefaultSettingsRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterVendorDefaultSettingsRef(dataConnect, filterVendorDefaultSettingsVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendorDefaultSettings);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendorDefaultSettings);
-});
-```
-
-## listActivityLog
-You can execute the `listActivityLog` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listActivityLog(): QueryPromise;
-
-interface ListActivityLogRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listActivityLogRef: ListActivityLogRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listActivityLog(dc: DataConnect): QueryPromise;
-
-interface ListActivityLogRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listActivityLogRef: ListActivityLogRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listActivityLogRef:
-```typescript
-const name = listActivityLogRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listActivityLog` query has no variables.
-### Return Type
-Recall that executing the `listActivityLog` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListActivityLogData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListActivityLogData {
- activityLogs: ({
- id: UUIDString;
- title: string;
- description: string;
- activityType: ActivityType;
- userId: string;
- isRead?: boolean | null;
- } & ActivityLog_Key)[];
-}
-```
-### Using `listActivityLog`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listActivityLog } from '@dataconnect/generated';
-
-
-// Call the `listActivityLog()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listActivityLog();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listActivityLog(dataConnect);
-
-console.log(data.activityLogs);
-
-// Or, you can use the `Promise` API.
-listActivityLog().then((response) => {
- const data = response.data;
- console.log(data.activityLogs);
-});
-```
-
-### Using `listActivityLog`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listActivityLogRef } from '@dataconnect/generated';
-
-
-// Call the `listActivityLogRef()` function to get a reference to the query.
-const ref = listActivityLogRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listActivityLogRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.activityLogs);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.activityLogs);
-});
-```
-
-## getActivityLogById
-You can execute the `getActivityLogById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getActivityLogById(vars: GetActivityLogByIdVariables): QueryPromise;
-
-interface GetActivityLogByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetActivityLogByIdVariables): QueryRef;
-}
-export const getActivityLogByIdRef: GetActivityLogByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getActivityLogById(dc: DataConnect, vars: GetActivityLogByIdVariables): QueryPromise;
-
-interface GetActivityLogByIdRef {
- ...
- (dc: DataConnect, vars: GetActivityLogByIdVariables): QueryRef;
-}
-export const getActivityLogByIdRef: GetActivityLogByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getActivityLogByIdRef:
-```typescript
-const name = getActivityLogByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getActivityLogById` query requires an argument of type `GetActivityLogByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetActivityLogByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getActivityLogById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetActivityLogByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetActivityLogByIdData {
- activityLog?: {
- id: UUIDString;
- title: string;
- description: string;
- activityType: ActivityType;
- userId: string;
- isRead?: boolean | null;
- } & ActivityLog_Key;
-}
-```
-### Using `getActivityLogById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getActivityLogById, GetActivityLogByIdVariables } from '@dataconnect/generated';
-
-// The `getActivityLogById` query requires an argument of type `GetActivityLogByIdVariables`:
-const getActivityLogByIdVars: GetActivityLogByIdVariables = {
- id: ...,
-};
-
-// Call the `getActivityLogById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getActivityLogById(getActivityLogByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getActivityLogById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getActivityLogById(dataConnect, getActivityLogByIdVars);
-
-console.log(data.activityLog);
-
-// Or, you can use the `Promise` API.
-getActivityLogById(getActivityLogByIdVars).then((response) => {
- const data = response.data;
- console.log(data.activityLog);
-});
-```
-
-### Using `getActivityLogById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getActivityLogByIdRef, GetActivityLogByIdVariables } from '@dataconnect/generated';
-
-// The `getActivityLogById` query requires an argument of type `GetActivityLogByIdVariables`:
-const getActivityLogByIdVars: GetActivityLogByIdVariables = {
- id: ...,
-};
-
-// Call the `getActivityLogByIdRef()` function to get a reference to the query.
-const ref = getActivityLogByIdRef(getActivityLogByIdVars);
-// Variables can be defined inline as well.
-const ref = getActivityLogByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getActivityLogByIdRef(dataConnect, getActivityLogByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.activityLog);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.activityLog);
-});
-```
-
-## filterActivityLog
-You can execute the `filterActivityLog` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterActivityLog(vars?: FilterActivityLogVariables): QueryPromise;
-
-interface FilterActivityLogRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterActivityLogVariables): QueryRef;
-}
-export const filterActivityLogRef: FilterActivityLogRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterActivityLog(dc: DataConnect, vars?: FilterActivityLogVariables): QueryPromise;
-
-interface FilterActivityLogRef {
- ...
- (dc: DataConnect, vars?: FilterActivityLogVariables): QueryRef;
-}
-export const filterActivityLogRef: FilterActivityLogRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterActivityLogRef:
-```typescript
-const name = filterActivityLogRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterActivityLog` query has an optional argument of type `FilterActivityLogVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterActivityLogVariables {
- userId?: string | null;
- activityType?: ActivityType | null;
- isRead?: boolean | null;
-}
-```
-### Return Type
-Recall that executing the `filterActivityLog` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterActivityLogData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterActivityLogData {
- activityLogs: ({
- id: UUIDString;
- title: string;
- description: string;
- activityType: ActivityType;
- userId: string;
- isRead?: boolean | null;
- } & ActivityLog_Key)[];
-}
-```
-### Using `filterActivityLog`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterActivityLog, FilterActivityLogVariables } from '@dataconnect/generated';
-
-// The `filterActivityLog` query has an optional argument of type `FilterActivityLogVariables`:
-const filterActivityLogVars: FilterActivityLogVariables = {
- userId: ..., // optional
- activityType: ..., // optional
- isRead: ..., // optional
-};
-
-// Call the `filterActivityLog()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterActivityLog(filterActivityLogVars);
-// Variables can be defined inline as well.
-const { data } = await filterActivityLog({ userId: ..., activityType: ..., isRead: ..., });
-// Since all variables are optional for this query, you can omit the `FilterActivityLogVariables` argument.
-const { data } = await filterActivityLog();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterActivityLog(dataConnect, filterActivityLogVars);
-
-console.log(data.activityLogs);
-
-// Or, you can use the `Promise` API.
-filterActivityLog(filterActivityLogVars).then((response) => {
- const data = response.data;
- console.log(data.activityLogs);
-});
-```
-
-### Using `filterActivityLog`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterActivityLogRef, FilterActivityLogVariables } from '@dataconnect/generated';
-
-// The `filterActivityLog` query has an optional argument of type `FilterActivityLogVariables`:
-const filterActivityLogVars: FilterActivityLogVariables = {
- userId: ..., // optional
- activityType: ..., // optional
- isRead: ..., // optional
-};
-
-// Call the `filterActivityLogRef()` function to get a reference to the query.
-const ref = filterActivityLogRef(filterActivityLogVars);
-// Variables can be defined inline as well.
-const ref = filterActivityLogRef({ userId: ..., activityType: ..., isRead: ..., });
-// Since all variables are optional for this query, you can omit the `FilterActivityLogVariables` argument.
-const ref = filterActivityLogRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterActivityLogRef(dataConnect, filterActivityLogVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.activityLogs);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.activityLogs);
-});
-```
-
-## listConversation
-You can execute the `listConversation` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listConversation(): QueryPromise;
-
-interface ListConversationRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listConversationRef: ListConversationRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listConversation(dc: DataConnect): QueryPromise;
-
-interface ListConversationRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listConversationRef: ListConversationRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listConversationRef:
-```typescript
-const name = listConversationRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listConversation` query has no variables.
-### Return Type
-Recall that executing the `listConversation` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListConversationData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListConversationData {
- conversations: ({
- id: UUIDString;
- participants: string;
- conversationType: ConversationType;
- relatedTo: UUIDString;
- status?: ConversationStatus | null;
- } & Conversation_Key)[];
-}
-```
-### Using `listConversation`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listConversation } from '@dataconnect/generated';
-
-
-// Call the `listConversation()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listConversation();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listConversation(dataConnect);
-
-console.log(data.conversations);
-
-// Or, you can use the `Promise` API.
-listConversation().then((response) => {
- const data = response.data;
- console.log(data.conversations);
-});
-```
-
-### Using `listConversation`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listConversationRef } from '@dataconnect/generated';
-
-
-// Call the `listConversationRef()` function to get a reference to the query.
-const ref = listConversationRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listConversationRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.conversations);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.conversations);
-});
-```
-
-## getConversationById
-You can execute the `getConversationById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getConversationById(vars: GetConversationByIdVariables): QueryPromise;
-
-interface GetConversationByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetConversationByIdVariables): QueryRef;
-}
-export const getConversationByIdRef: GetConversationByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getConversationById(dc: DataConnect, vars: GetConversationByIdVariables): QueryPromise;
-
-interface GetConversationByIdRef {
- ...
- (dc: DataConnect, vars: GetConversationByIdVariables): QueryRef;
-}
-export const getConversationByIdRef: GetConversationByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getConversationByIdRef:
-```typescript
-const name = getConversationByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getConversationById` query requires an argument of type `GetConversationByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetConversationByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getConversationById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetConversationByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetConversationByIdData {
- conversation?: {
- id: UUIDString;
- participants: string;
- conversationType: ConversationType;
- relatedTo: UUIDString;
- status?: ConversationStatus | null;
- } & Conversation_Key;
-}
-```
-### Using `getConversationById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getConversationById, GetConversationByIdVariables } from '@dataconnect/generated';
-
-// The `getConversationById` query requires an argument of type `GetConversationByIdVariables`:
-const getConversationByIdVars: GetConversationByIdVariables = {
- id: ...,
-};
-
-// Call the `getConversationById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getConversationById(getConversationByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getConversationById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getConversationById(dataConnect, getConversationByIdVars);
-
-console.log(data.conversation);
-
-// Or, you can use the `Promise` API.
-getConversationById(getConversationByIdVars).then((response) => {
- const data = response.data;
- console.log(data.conversation);
-});
-```
-
-### Using `getConversationById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getConversationByIdRef, GetConversationByIdVariables } from '@dataconnect/generated';
-
-// The `getConversationById` query requires an argument of type `GetConversationByIdVariables`:
-const getConversationByIdVars: GetConversationByIdVariables = {
- id: ...,
-};
-
-// Call the `getConversationByIdRef()` function to get a reference to the query.
-const ref = getConversationByIdRef(getConversationByIdVars);
-// Variables can be defined inline as well.
-const ref = getConversationByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getConversationByIdRef(dataConnect, getConversationByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.conversation);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.conversation);
-});
-```
-
-## filterConversation
-You can execute the `filterConversation` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterConversation(vars?: FilterConversationVariables): QueryPromise;
-
-interface FilterConversationRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterConversationVariables): QueryRef;
-}
-export const filterConversationRef: FilterConversationRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterConversation(dc: DataConnect, vars?: FilterConversationVariables): QueryPromise;
-
-interface FilterConversationRef {
- ...
- (dc: DataConnect, vars?: FilterConversationVariables): QueryRef;
-}
-export const filterConversationRef: FilterConversationRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterConversationRef:
-```typescript
-const name = filterConversationRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterConversation` query has an optional argument of type `FilterConversationVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterConversationVariables {
- conversationType?: ConversationType | null;
- status?: ConversationStatus | null;
- relatedTo?: UUIDString | null;
-}
-```
-### Return Type
-Recall that executing the `filterConversation` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterConversationData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterConversationData {
- conversations: ({
- id: UUIDString;
- participants: string;
- conversationType: ConversationType;
- relatedTo: UUIDString;
- status?: ConversationStatus | null;
- } & Conversation_Key)[];
-}
-```
-### Using `filterConversation`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterConversation, FilterConversationVariables } from '@dataconnect/generated';
-
-// The `filterConversation` query has an optional argument of type `FilterConversationVariables`:
-const filterConversationVars: FilterConversationVariables = {
- conversationType: ..., // optional
- status: ..., // optional
- relatedTo: ..., // optional
-};
-
-// Call the `filterConversation()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterConversation(filterConversationVars);
-// Variables can be defined inline as well.
-const { data } = await filterConversation({ conversationType: ..., status: ..., relatedTo: ..., });
-// Since all variables are optional for this query, you can omit the `FilterConversationVariables` argument.
-const { data } = await filterConversation();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterConversation(dataConnect, filterConversationVars);
-
-console.log(data.conversations);
-
-// Or, you can use the `Promise` API.
-filterConversation(filterConversationVars).then((response) => {
- const data = response.data;
- console.log(data.conversations);
-});
-```
-
-### Using `filterConversation`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterConversationRef, FilterConversationVariables } from '@dataconnect/generated';
-
-// The `filterConversation` query has an optional argument of type `FilterConversationVariables`:
-const filterConversationVars: FilterConversationVariables = {
- conversationType: ..., // optional
- status: ..., // optional
- relatedTo: ..., // optional
-};
-
-// Call the `filterConversationRef()` function to get a reference to the query.
-const ref = filterConversationRef(filterConversationVars);
-// Variables can be defined inline as well.
-const ref = filterConversationRef({ conversationType: ..., status: ..., relatedTo: ..., });
-// Since all variables are optional for this query, you can omit the `FilterConversationVariables` argument.
-const ref = filterConversationRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterConversationRef(dataConnect, filterConversationVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.conversations);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.conversations);
-});
-```
-
-## listBusiness
-You can execute the `listBusiness` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listBusiness(): QueryPromise;
-
-interface ListBusinessRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listBusinessRef: ListBusinessRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listBusiness(dc: DataConnect): QueryPromise;
-
-interface ListBusinessRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listBusinessRef: ListBusinessRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listBusinessRef:
-```typescript
-const name = listBusinessRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listBusiness` query has no variables.
-### Return Type
-Recall that executing the `listBusiness` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListBusinessData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListBusinessData {
- businesses: ({
- id: UUIDString;
- businessName: string;
- contactName: string;
- email?: string | null;
- sector?: BusinessSector | null;
- rateGroup: BusinessRateGroup;
- status?: BusinessStatus | null;
- } & Business_Key)[];
-}
-```
-### Using `listBusiness`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listBusiness } from '@dataconnect/generated';
-
-
-// Call the `listBusiness()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listBusiness();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listBusiness(dataConnect);
-
-console.log(data.businesses);
-
-// Or, you can use the `Promise` API.
-listBusiness().then((response) => {
- const data = response.data;
- console.log(data.businesses);
-});
-```
-
-### Using `listBusiness`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listBusinessRef } from '@dataconnect/generated';
-
-
-// Call the `listBusinessRef()` function to get a reference to the query.
-const ref = listBusinessRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listBusinessRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.businesses);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.businesses);
-});
-```
-
-## getBusinessById
-You can execute the `getBusinessById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getBusinessById(vars: GetBusinessByIdVariables): QueryPromise;
-
-interface GetBusinessByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetBusinessByIdVariables): QueryRef;
-}
-export const getBusinessByIdRef: GetBusinessByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getBusinessById(dc: DataConnect, vars: GetBusinessByIdVariables): QueryPromise;
-
-interface GetBusinessByIdRef {
- ...
- (dc: DataConnect, vars: GetBusinessByIdVariables): QueryRef;
-}
-export const getBusinessByIdRef: GetBusinessByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getBusinessByIdRef:
-```typescript
-const name = getBusinessByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getBusinessById` query requires an argument of type `GetBusinessByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetBusinessByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getBusinessById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetBusinessByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetBusinessByIdData {
- business?: {
- id: UUIDString;
- businessName: string;
- contactName: string;
- email?: string | null;
- sector?: BusinessSector | null;
- rateGroup: BusinessRateGroup;
- status?: BusinessStatus | null;
- } & Business_Key;
-}
-```
-### Using `getBusinessById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getBusinessById, GetBusinessByIdVariables } from '@dataconnect/generated';
-
-// The `getBusinessById` query requires an argument of type `GetBusinessByIdVariables`:
-const getBusinessByIdVars: GetBusinessByIdVariables = {
- id: ...,
-};
-
-// Call the `getBusinessById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getBusinessById(getBusinessByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getBusinessById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getBusinessById(dataConnect, getBusinessByIdVars);
-
-console.log(data.business);
-
-// Or, you can use the `Promise` API.
-getBusinessById(getBusinessByIdVars).then((response) => {
- const data = response.data;
- console.log(data.business);
-});
-```
-
-### Using `getBusinessById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getBusinessByIdRef, GetBusinessByIdVariables } from '@dataconnect/generated';
-
-// The `getBusinessById` query requires an argument of type `GetBusinessByIdVariables`:
-const getBusinessByIdVars: GetBusinessByIdVariables = {
- id: ...,
-};
-
-// Call the `getBusinessByIdRef()` function to get a reference to the query.
-const ref = getBusinessByIdRef(getBusinessByIdVars);
-// Variables can be defined inline as well.
-const ref = getBusinessByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getBusinessByIdRef(dataConnect, getBusinessByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.business);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.business);
-});
-```
-
-## filterBusiness
-You can execute the `filterBusiness` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterBusiness(vars?: FilterBusinessVariables): QueryPromise;
-
-interface FilterBusinessRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterBusinessVariables): QueryRef;
-}
-export const filterBusinessRef: FilterBusinessRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterBusiness(dc: DataConnect, vars?: FilterBusinessVariables): QueryPromise;
-
-interface FilterBusinessRef {
- ...
- (dc: DataConnect, vars?: FilterBusinessVariables): QueryRef;
-}
-export const filterBusinessRef: FilterBusinessRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterBusinessRef:
-```typescript
-const name = filterBusinessRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterBusiness` query has an optional argument of type `FilterBusinessVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterBusinessVariables {
- businessName?: string | null;
- contactName?: string | null;
- sector?: BusinessSector | null;
- rateGroup?: BusinessRateGroup | null;
- status?: BusinessStatus | null;
-}
-```
-### Return Type
-Recall that executing the `filterBusiness` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterBusinessData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterBusinessData {
- businesses: ({
- id: UUIDString;
- businessName: string;
- contactName: string;
- email?: string | null;
- sector?: BusinessSector | null;
- rateGroup: BusinessRateGroup;
- status?: BusinessStatus | null;
- } & Business_Key)[];
-}
-```
-### Using `filterBusiness`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterBusiness, FilterBusinessVariables } from '@dataconnect/generated';
-
-// The `filterBusiness` query has an optional argument of type `FilterBusinessVariables`:
-const filterBusinessVars: FilterBusinessVariables = {
- businessName: ..., // optional
- contactName: ..., // optional
- sector: ..., // optional
- rateGroup: ..., // optional
- status: ..., // optional
-};
-
-// Call the `filterBusiness()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterBusiness(filterBusinessVars);
-// Variables can be defined inline as well.
-const { data } = await filterBusiness({ businessName: ..., contactName: ..., sector: ..., rateGroup: ..., status: ..., });
-// Since all variables are optional for this query, you can omit the `FilterBusinessVariables` argument.
-const { data } = await filterBusiness();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterBusiness(dataConnect, filterBusinessVars);
-
-console.log(data.businesses);
-
-// Or, you can use the `Promise` API.
-filterBusiness(filterBusinessVars).then((response) => {
- const data = response.data;
- console.log(data.businesses);
-});
-```
-
-### Using `filterBusiness`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterBusinessRef, FilterBusinessVariables } from '@dataconnect/generated';
-
-// The `filterBusiness` query has an optional argument of type `FilterBusinessVariables`:
-const filterBusinessVars: FilterBusinessVariables = {
- businessName: ..., // optional
- contactName: ..., // optional
- sector: ..., // optional
- rateGroup: ..., // optional
- status: ..., // optional
-};
-
-// Call the `filterBusinessRef()` function to get a reference to the query.
-const ref = filterBusinessRef(filterBusinessVars);
-// Variables can be defined inline as well.
-const ref = filterBusinessRef({ businessName: ..., contactName: ..., sector: ..., rateGroup: ..., status: ..., });
-// Since all variables are optional for this query, you can omit the `FilterBusinessVariables` argument.
-const ref = filterBusinessRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterBusinessRef(dataConnect, filterBusinessVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.businesses);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.businesses);
-});
-```
-
-## listStaff
-You can execute the `listStaff` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listStaff(): QueryPromise;
-
-interface ListStaffRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listStaffRef: ListStaffRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listStaff(dc: DataConnect): QueryPromise;
-
-interface ListStaffRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listStaffRef: ListStaffRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listStaffRef:
-```typescript
-const name = listStaffRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listStaff` query has no variables.
-### Return Type
-Recall that executing the `listStaff` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListStaffData {
- staffs: ({
- id: UUIDString;
- employeeName: string;
- vendorId?: UUIDString | null;
- vendorName?: string | null;
- manager?: string | null;
- contactNumber?: string | null;
- email?: string | null;
- department?: StaffDepartment | null;
- hubLocation?: string | null;
- track?: string | null;
- position?: string | null;
- profileType?: ProfileType | null;
- employmentType: EmploymentType;
- english?: EnglishLevel | null;
- rate?: number | null;
- rating?: number | null;
- reliabilityScore?: number | null;
- backgroundCheckStatus: BackgroundCheckStatus;
- notes?: string | null;
- } & Staff_Key)[];
-}
-```
-### Using `listStaff`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listStaff } from '@dataconnect/generated';
-
-
-// Call the `listStaff()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listStaff();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listStaff(dataConnect);
-
-console.log(data.staffs);
-
-// Or, you can use the `Promise` API.
-listStaff().then((response) => {
- const data = response.data;
- console.log(data.staffs);
-});
-```
-
-### Using `listStaff`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listStaffRef } from '@dataconnect/generated';
-
-
-// Call the `listStaffRef()` function to get a reference to the query.
-const ref = listStaffRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listStaffRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.staffs);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.staffs);
-});
-```
-
-## getStaffById
-You can execute the `getStaffById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getStaffById(vars: GetStaffByIdVariables): QueryPromise;
-
-interface GetStaffByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetStaffByIdVariables): QueryRef;
-}
-export const getStaffByIdRef: GetStaffByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getStaffById(dc: DataConnect, vars: GetStaffByIdVariables): QueryPromise;
-
-interface GetStaffByIdRef {
- ...
- (dc: DataConnect, vars: GetStaffByIdVariables): QueryRef;
-}
-export const getStaffByIdRef: GetStaffByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getStaffByIdRef:
-```typescript
-const name = getStaffByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getStaffById` query requires an argument of type `GetStaffByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetStaffByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getStaffById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetStaffByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetStaffByIdData {
- staff?: {
- id: UUIDString;
- employeeName: string;
- vendorId?: UUIDString | null;
- vendorName?: string | null;
- manager?: string | null;
- contactNumber?: string | null;
- email?: string | null;
- department?: StaffDepartment | null;
- hubLocation?: string | null;
- track?: string | null;
- position?: string | null;
- profileType?: ProfileType | null;
- employmentType: EmploymentType;
- english?: EnglishLevel | null;
- rate?: number | null;
- rating?: number | null;
- reliabilityScore?: number | null;
- backgroundCheckStatus: BackgroundCheckStatus;
- notes?: string | null;
- } & Staff_Key;
-}
-```
-### Using `getStaffById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getStaffById, GetStaffByIdVariables } from '@dataconnect/generated';
-
-// The `getStaffById` query requires an argument of type `GetStaffByIdVariables`:
-const getStaffByIdVars: GetStaffByIdVariables = {
- id: ...,
-};
-
-// Call the `getStaffById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getStaffById(getStaffByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getStaffById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getStaffById(dataConnect, getStaffByIdVars);
-
-console.log(data.staff);
-
-// Or, you can use the `Promise` API.
-getStaffById(getStaffByIdVars).then((response) => {
- const data = response.data;
- console.log(data.staff);
-});
-```
-
-### Using `getStaffById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getStaffByIdRef, GetStaffByIdVariables } from '@dataconnect/generated';
-
-// The `getStaffById` query requires an argument of type `GetStaffByIdVariables`:
-const getStaffByIdVars: GetStaffByIdVariables = {
- id: ...,
-};
-
-// Call the `getStaffByIdRef()` function to get a reference to the query.
-const ref = getStaffByIdRef(getStaffByIdVars);
-// Variables can be defined inline as well.
-const ref = getStaffByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getStaffByIdRef(dataConnect, getStaffByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.staff);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.staff);
-});
-```
-
-## filterStaff
-You can execute the `filterStaff` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterStaff(vars?: FilterStaffVariables): QueryPromise;
-
-interface FilterStaffRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterStaffVariables): QueryRef;
-}
-export const filterStaffRef: FilterStaffRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterStaff(dc: DataConnect, vars?: FilterStaffVariables): QueryPromise;
-
-interface FilterStaffRef {
- ...
- (dc: DataConnect, vars?: FilterStaffVariables): QueryRef;
-}
-export const filterStaffRef: FilterStaffRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterStaffRef:
-```typescript
-const name = filterStaffRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterStaff` query has an optional argument of type `FilterStaffVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterStaffVariables {
- employeeName?: string | null;
- vendorId?: UUIDString | null;
- department?: StaffDepartment | null;
- employmentType?: EmploymentType | null;
- english?: EnglishLevel | null;
- backgroundCheckStatus?: BackgroundCheckStatus | null;
-}
-```
-### Return Type
-Recall that executing the `filterStaff` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterStaffData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterStaffData {
- staffs: ({
- id: UUIDString;
- employeeName: string;
- vendorId?: UUIDString | null;
- vendorName?: string | null;
- department?: StaffDepartment | null;
- position?: string | null;
- employmentType: EmploymentType;
- english?: EnglishLevel | null;
- rate?: number | null;
- rating?: number | null;
- reliabilityScore?: number | null;
- backgroundCheckStatus: BackgroundCheckStatus;
- notes?: string | null;
- } & Staff_Key)[];
-}
-```
-### Using `filterStaff`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterStaff, FilterStaffVariables } from '@dataconnect/generated';
-
-// The `filterStaff` query has an optional argument of type `FilterStaffVariables`:
-const filterStaffVars: FilterStaffVariables = {
- employeeName: ..., // optional
- vendorId: ..., // optional
- department: ..., // optional
- employmentType: ..., // optional
- english: ..., // optional
- backgroundCheckStatus: ..., // optional
-};
-
-// Call the `filterStaff()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterStaff(filterStaffVars);
-// Variables can be defined inline as well.
-const { data } = await filterStaff({ employeeName: ..., vendorId: ..., department: ..., employmentType: ..., english: ..., backgroundCheckStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterStaffVariables` argument.
-const { data } = await filterStaff();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterStaff(dataConnect, filterStaffVars);
-
-console.log(data.staffs);
-
-// Or, you can use the `Promise` API.
-filterStaff(filterStaffVars).then((response) => {
- const data = response.data;
- console.log(data.staffs);
-});
-```
-
-### Using `filterStaff`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterStaffRef, FilterStaffVariables } from '@dataconnect/generated';
-
-// The `filterStaff` query has an optional argument of type `FilterStaffVariables`:
-const filterStaffVars: FilterStaffVariables = {
- employeeName: ..., // optional
- vendorId: ..., // optional
- department: ..., // optional
- employmentType: ..., // optional
- english: ..., // optional
- backgroundCheckStatus: ..., // optional
-};
-
-// Call the `filterStaffRef()` function to get a reference to the query.
-const ref = filterStaffRef(filterStaffVars);
-// Variables can be defined inline as well.
-const ref = filterStaffRef({ employeeName: ..., vendorId: ..., department: ..., employmentType: ..., english: ..., backgroundCheckStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterStaffVariables` argument.
-const ref = filterStaffRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterStaffRef(dataConnect, filterStaffVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.staffs);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.staffs);
-});
-```
-
-## listTeamMemberInvite
-You can execute the `listTeamMemberInvite` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listTeamMemberInvite(): QueryPromise;
-
-interface ListTeamMemberInviteRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listTeamMemberInviteRef: ListTeamMemberInviteRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listTeamMemberInvite(dc: DataConnect): QueryPromise;
-
-interface ListTeamMemberInviteRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listTeamMemberInviteRef: ListTeamMemberInviteRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listTeamMemberInviteRef:
-```typescript
-const name = listTeamMemberInviteRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listTeamMemberInvite` query has no variables.
-### Return Type
-Recall that executing the `listTeamMemberInvite` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListTeamMemberInviteData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListTeamMemberInviteData {
- teamMemberInvites: ({
- id: UUIDString;
- teamId: UUIDString;
- inviteCode: string;
- email: string;
- inviteStatus: TeamMemberInviteStatus;
- } & TeamMemberInvite_Key)[];
-}
-```
-### Using `listTeamMemberInvite`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listTeamMemberInvite } from '@dataconnect/generated';
-
-
-// Call the `listTeamMemberInvite()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listTeamMemberInvite();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listTeamMemberInvite(dataConnect);
-
-console.log(data.teamMemberInvites);
-
-// Or, you can use the `Promise` API.
-listTeamMemberInvite().then((response) => {
- const data = response.data;
- console.log(data.teamMemberInvites);
-});
-```
-
-### Using `listTeamMemberInvite`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listTeamMemberInviteRef } from '@dataconnect/generated';
-
-
-// Call the `listTeamMemberInviteRef()` function to get a reference to the query.
-const ref = listTeamMemberInviteRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listTeamMemberInviteRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamMemberInvites);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamMemberInvites);
-});
-```
-
-## getTeamMemberInviteById
-You can execute the `getTeamMemberInviteById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getTeamMemberInviteById(vars: GetTeamMemberInviteByIdVariables): QueryPromise;
-
-interface GetTeamMemberInviteByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetTeamMemberInviteByIdVariables): QueryRef;
-}
-export const getTeamMemberInviteByIdRef: GetTeamMemberInviteByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getTeamMemberInviteById(dc: DataConnect, vars: GetTeamMemberInviteByIdVariables): QueryPromise;
-
-interface GetTeamMemberInviteByIdRef {
- ...
- (dc: DataConnect, vars: GetTeamMemberInviteByIdVariables): QueryRef;
-}
-export const getTeamMemberInviteByIdRef: GetTeamMemberInviteByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getTeamMemberInviteByIdRef:
-```typescript
-const name = getTeamMemberInviteByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getTeamMemberInviteById` query requires an argument of type `GetTeamMemberInviteByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetTeamMemberInviteByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getTeamMemberInviteById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetTeamMemberInviteByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetTeamMemberInviteByIdData {
- teamMemberInvite?: {
- id: UUIDString;
- teamId: UUIDString;
- inviteCode: string;
- email: string;
- inviteStatus: TeamMemberInviteStatus;
- } & TeamMemberInvite_Key;
-}
-```
-### Using `getTeamMemberInviteById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getTeamMemberInviteById, GetTeamMemberInviteByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamMemberInviteById` query requires an argument of type `GetTeamMemberInviteByIdVariables`:
-const getTeamMemberInviteByIdVars: GetTeamMemberInviteByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamMemberInviteById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getTeamMemberInviteById(getTeamMemberInviteByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getTeamMemberInviteById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getTeamMemberInviteById(dataConnect, getTeamMemberInviteByIdVars);
-
-console.log(data.teamMemberInvite);
-
-// Or, you can use the `Promise` API.
-getTeamMemberInviteById(getTeamMemberInviteByIdVars).then((response) => {
- const data = response.data;
- console.log(data.teamMemberInvite);
-});
-```
-
-### Using `getTeamMemberInviteById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getTeamMemberInviteByIdRef, GetTeamMemberInviteByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamMemberInviteById` query requires an argument of type `GetTeamMemberInviteByIdVariables`:
-const getTeamMemberInviteByIdVars: GetTeamMemberInviteByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamMemberInviteByIdRef()` function to get a reference to the query.
-const ref = getTeamMemberInviteByIdRef(getTeamMemberInviteByIdVars);
-// Variables can be defined inline as well.
-const ref = getTeamMemberInviteByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getTeamMemberInviteByIdRef(dataConnect, getTeamMemberInviteByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamMemberInvite);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamMemberInvite);
-});
-```
-
-## filterTeamMemberInvite
-You can execute the `filterTeamMemberInvite` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterTeamMemberInvite(vars?: FilterTeamMemberInviteVariables): QueryPromise;
-
-interface FilterTeamMemberInviteRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterTeamMemberInviteVariables): QueryRef;
-}
-export const filterTeamMemberInviteRef: FilterTeamMemberInviteRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterTeamMemberInvite(dc: DataConnect, vars?: FilterTeamMemberInviteVariables): QueryPromise;
-
-interface FilterTeamMemberInviteRef {
- ...
- (dc: DataConnect, vars?: FilterTeamMemberInviteVariables): QueryRef;
-}
-export const filterTeamMemberInviteRef: FilterTeamMemberInviteRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterTeamMemberInviteRef:
-```typescript
-const name = filterTeamMemberInviteRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterTeamMemberInvite` query has an optional argument of type `FilterTeamMemberInviteVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterTeamMemberInviteVariables {
- teamId?: UUIDString | null;
- email?: string | null;
- inviteStatus?: TeamMemberInviteStatus | null;
-}
-```
-### Return Type
-Recall that executing the `filterTeamMemberInvite` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterTeamMemberInviteData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterTeamMemberInviteData {
- teamMemberInvites: ({
- id: UUIDString;
- teamId: UUIDString;
- inviteCode: string;
- email: string;
- inviteStatus: TeamMemberInviteStatus;
- } & TeamMemberInvite_Key)[];
-}
-```
-### Using `filterTeamMemberInvite`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterTeamMemberInvite, FilterTeamMemberInviteVariables } from '@dataconnect/generated';
-
-// The `filterTeamMemberInvite` query has an optional argument of type `FilterTeamMemberInviteVariables`:
-const filterTeamMemberInviteVars: FilterTeamMemberInviteVariables = {
- teamId: ..., // optional
- email: ..., // optional
- inviteStatus: ..., // optional
-};
-
-// Call the `filterTeamMemberInvite()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterTeamMemberInvite(filterTeamMemberInviteVars);
-// Variables can be defined inline as well.
-const { data } = await filterTeamMemberInvite({ teamId: ..., email: ..., inviteStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamMemberInviteVariables` argument.
-const { data } = await filterTeamMemberInvite();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterTeamMemberInvite(dataConnect, filterTeamMemberInviteVars);
-
-console.log(data.teamMemberInvites);
-
-// Or, you can use the `Promise` API.
-filterTeamMemberInvite(filterTeamMemberInviteVars).then((response) => {
- const data = response.data;
- console.log(data.teamMemberInvites);
-});
-```
-
-### Using `filterTeamMemberInvite`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterTeamMemberInviteRef, FilterTeamMemberInviteVariables } from '@dataconnect/generated';
-
-// The `filterTeamMemberInvite` query has an optional argument of type `FilterTeamMemberInviteVariables`:
-const filterTeamMemberInviteVars: FilterTeamMemberInviteVariables = {
- teamId: ..., // optional
- email: ..., // optional
- inviteStatus: ..., // optional
-};
-
-// Call the `filterTeamMemberInviteRef()` function to get a reference to the query.
-const ref = filterTeamMemberInviteRef(filterTeamMemberInviteVars);
-// Variables can be defined inline as well.
-const ref = filterTeamMemberInviteRef({ teamId: ..., email: ..., inviteStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamMemberInviteVariables` argument.
-const ref = filterTeamMemberInviteRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterTeamMemberInviteRef(dataConnect, filterTeamMemberInviteVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamMemberInvites);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamMemberInvites);
-});
-```
-
-## listCertification
-You can execute the `listCertification` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listCertification(): QueryPromise;
-
-interface ListCertificationRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listCertificationRef: ListCertificationRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listCertification(dc: DataConnect): QueryPromise;
-
-interface ListCertificationRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listCertificationRef: ListCertificationRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listCertificationRef:
-```typescript
-const name = listCertificationRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listCertification` query has no variables.
-### Return Type
-Recall that executing the `listCertification` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListCertificationData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListCertificationData {
- certifications: ({
- id: UUIDString;
- employeeName: string;
- certificationName: string;
- certificationType?: CertificationType | null;
- status?: CertificationStatus | null;
- expiryDate: string;
- validationStatus?: CertificationValidationStatus | null;
- } & Certification_Key)[];
-}
-```
-### Using `listCertification`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listCertification } from '@dataconnect/generated';
-
-
-// Call the `listCertification()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listCertification();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listCertification(dataConnect);
-
-console.log(data.certifications);
-
-// Or, you can use the `Promise` API.
-listCertification().then((response) => {
- const data = response.data;
- console.log(data.certifications);
-});
-```
-
-### Using `listCertification`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listCertificationRef } from '@dataconnect/generated';
-
-
-// Call the `listCertificationRef()` function to get a reference to the query.
-const ref = listCertificationRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listCertificationRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.certifications);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.certifications);
-});
-```
-
-## getCertificationById
-You can execute the `getCertificationById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getCertificationById(vars: GetCertificationByIdVariables): QueryPromise;
-
-interface GetCertificationByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetCertificationByIdVariables): QueryRef;
-}
-export const getCertificationByIdRef: GetCertificationByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getCertificationById(dc: DataConnect, vars: GetCertificationByIdVariables): QueryPromise;
-
-interface GetCertificationByIdRef {
- ...
- (dc: DataConnect, vars: GetCertificationByIdVariables): QueryRef;
-}
-export const getCertificationByIdRef: GetCertificationByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getCertificationByIdRef:
-```typescript
-const name = getCertificationByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getCertificationById` query requires an argument of type `GetCertificationByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetCertificationByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getCertificationById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetCertificationByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetCertificationByIdData {
- certification?: {
- id: UUIDString;
- employeeName: string;
- certificationName: string;
- certificationType?: CertificationType | null;
- status?: CertificationStatus | null;
- expiryDate: string;
- validationStatus?: CertificationValidationStatus | null;
- createdDate?: TimestampString | null;
- updatedDate?: TimestampString | null;
- createdBy?: string | null;
- } & Certification_Key;
-}
-```
-### Using `getCertificationById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getCertificationById, GetCertificationByIdVariables } from '@dataconnect/generated';
-
-// The `getCertificationById` query requires an argument of type `GetCertificationByIdVariables`:
-const getCertificationByIdVars: GetCertificationByIdVariables = {
- id: ...,
-};
-
-// Call the `getCertificationById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getCertificationById(getCertificationByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getCertificationById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getCertificationById(dataConnect, getCertificationByIdVars);
-
-console.log(data.certification);
-
-// Or, you can use the `Promise` API.
-getCertificationById(getCertificationByIdVars).then((response) => {
- const data = response.data;
- console.log(data.certification);
-});
-```
-
-### Using `getCertificationById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getCertificationByIdRef, GetCertificationByIdVariables } from '@dataconnect/generated';
-
-// The `getCertificationById` query requires an argument of type `GetCertificationByIdVariables`:
-const getCertificationByIdVars: GetCertificationByIdVariables = {
- id: ...,
-};
-
-// Call the `getCertificationByIdRef()` function to get a reference to the query.
-const ref = getCertificationByIdRef(getCertificationByIdVars);
-// Variables can be defined inline as well.
-const ref = getCertificationByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getCertificationByIdRef(dataConnect, getCertificationByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.certification);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.certification);
-});
-```
-
-## filterCertification
-You can execute the `filterCertification` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterCertification(vars?: FilterCertificationVariables): QueryPromise;
-
-interface FilterCertificationRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterCertificationVariables): QueryRef;
-}
-export const filterCertificationRef: FilterCertificationRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterCertification(dc: DataConnect, vars?: FilterCertificationVariables): QueryPromise;
-
-interface FilterCertificationRef {
- ...
- (dc: DataConnect, vars?: FilterCertificationVariables): QueryRef;
-}
-export const filterCertificationRef: FilterCertificationRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterCertificationRef:
-```typescript
-const name = filterCertificationRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterCertification` query has an optional argument of type `FilterCertificationVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterCertificationVariables {
- employeeName?: string | null;
- certificationName?: string | null;
- certificationType?: CertificationType | null;
- status?: CertificationStatus | null;
- validationStatus?: CertificationValidationStatus | null;
-}
-```
-### Return Type
-Recall that executing the `filterCertification` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterCertificationData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterCertificationData {
- certifications: ({
- id: UUIDString;
- employeeName: string;
- certificationName: string;
- certificationType?: CertificationType | null;
- status?: CertificationStatus | null;
- expiryDate: string;
- validationStatus?: CertificationValidationStatus | null;
- } & Certification_Key)[];
-}
-```
-### Using `filterCertification`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterCertification, FilterCertificationVariables } from '@dataconnect/generated';
-
-// The `filterCertification` query has an optional argument of type `FilterCertificationVariables`:
-const filterCertificationVars: FilterCertificationVariables = {
- employeeName: ..., // optional
- certificationName: ..., // optional
- certificationType: ..., // optional
- status: ..., // optional
- validationStatus: ..., // optional
-};
-
-// Call the `filterCertification()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterCertification(filterCertificationVars);
-// Variables can be defined inline as well.
-const { data } = await filterCertification({ employeeName: ..., certificationName: ..., certificationType: ..., status: ..., validationStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterCertificationVariables` argument.
-const { data } = await filterCertification();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterCertification(dataConnect, filterCertificationVars);
-
-console.log(data.certifications);
-
-// Or, you can use the `Promise` API.
-filterCertification(filterCertificationVars).then((response) => {
- const data = response.data;
- console.log(data.certifications);
-});
-```
-
-### Using `filterCertification`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterCertificationRef, FilterCertificationVariables } from '@dataconnect/generated';
-
-// The `filterCertification` query has an optional argument of type `FilterCertificationVariables`:
-const filterCertificationVars: FilterCertificationVariables = {
- employeeName: ..., // optional
- certificationName: ..., // optional
- certificationType: ..., // optional
- status: ..., // optional
- validationStatus: ..., // optional
-};
-
-// Call the `filterCertificationRef()` function to get a reference to the query.
-const ref = filterCertificationRef(filterCertificationVars);
-// Variables can be defined inline as well.
-const ref = filterCertificationRef({ employeeName: ..., certificationName: ..., certificationType: ..., status: ..., validationStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterCertificationVariables` argument.
-const ref = filterCertificationRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterCertificationRef(dataConnect, filterCertificationVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.certifications);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.certifications);
-});
-```
-
-## listTeam
-You can execute the `listTeam` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listTeam(vars?: ListTeamVariables): QueryPromise;
-
-interface ListTeamRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: ListTeamVariables): QueryRef;
-}
-export const listTeamRef: ListTeamRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listTeam(dc: DataConnect, vars?: ListTeamVariables): QueryPromise;
-
-interface ListTeamRef {
- ...
- (dc: DataConnect, vars?: ListTeamVariables): QueryRef;
-}
-export const listTeamRef: ListTeamRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listTeamRef:
-```typescript
-const name = listTeamRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listTeam` query has an optional argument of type `ListTeamVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface ListTeamVariables {
- orderByCreatedDate?: OrderDirection | null;
- limit?: number | null;
-}
-```
-### Return Type
-Recall that executing the `listTeam` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListTeamData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListTeamData {
- teams: ({
- id: UUIDString;
- teamName: string;
- ownerId: string;
- ownerName: string;
- ownerRole: TeamOwnerRole;
- favoriteStaff?: string | null;
- blockedStaff?: string | null;
- } & Team_Key)[];
-}
-```
-### Using `listTeam`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listTeam, ListTeamVariables } from '@dataconnect/generated';
-
-// The `listTeam` query has an optional argument of type `ListTeamVariables`:
-const listTeamVars: ListTeamVariables = {
- orderByCreatedDate: ..., // optional
- limit: ..., // optional
-};
-
-// Call the `listTeam()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listTeam(listTeamVars);
-// Variables can be defined inline as well.
-const { data } = await listTeam({ orderByCreatedDate: ..., limit: ..., });
-// Since all variables are optional for this query, you can omit the `ListTeamVariables` argument.
-const { data } = await listTeam();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listTeam(dataConnect, listTeamVars);
-
-console.log(data.teams);
-
-// Or, you can use the `Promise` API.
-listTeam(listTeamVars).then((response) => {
- const data = response.data;
- console.log(data.teams);
-});
-```
-
-### Using `listTeam`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listTeamRef, ListTeamVariables } from '@dataconnect/generated';
-
-// The `listTeam` query has an optional argument of type `ListTeamVariables`:
-const listTeamVars: ListTeamVariables = {
- orderByCreatedDate: ..., // optional
- limit: ..., // optional
-};
-
-// Call the `listTeamRef()` function to get a reference to the query.
-const ref = listTeamRef(listTeamVars);
-// Variables can be defined inline as well.
-const ref = listTeamRef({ orderByCreatedDate: ..., limit: ..., });
-// Since all variables are optional for this query, you can omit the `ListTeamVariables` argument.
-const ref = listTeamRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listTeamRef(dataConnect, listTeamVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teams);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teams);
-});
-```
-
-## getTeamById
-You can execute the `getTeamById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getTeamById(vars: GetTeamByIdVariables): QueryPromise;
-
-interface GetTeamByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetTeamByIdVariables): QueryRef;
-}
-export const getTeamByIdRef: GetTeamByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getTeamById(dc: DataConnect, vars: GetTeamByIdVariables): QueryPromise;
-
-interface GetTeamByIdRef {
- ...
- (dc: DataConnect, vars: GetTeamByIdVariables): QueryRef;
-}
-export const getTeamByIdRef: GetTeamByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getTeamByIdRef:
-```typescript
-const name = getTeamByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getTeamById` query requires an argument of type `GetTeamByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetTeamByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getTeamById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetTeamByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetTeamByIdData {
- team?: {
- id: UUIDString;
- teamName: string;
- ownerId: string;
- ownerName: string;
- ownerRole: TeamOwnerRole;
- favoriteStaff?: string | null;
- blockedStaff?: string | null;
- } & Team_Key;
-}
-```
-### Using `getTeamById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getTeamById, GetTeamByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamById` query requires an argument of type `GetTeamByIdVariables`:
-const getTeamByIdVars: GetTeamByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getTeamById(getTeamByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getTeamById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getTeamById(dataConnect, getTeamByIdVars);
-
-console.log(data.team);
-
-// Or, you can use the `Promise` API.
-getTeamById(getTeamByIdVars).then((response) => {
- const data = response.data;
- console.log(data.team);
-});
-```
-
-### Using `getTeamById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getTeamByIdRef, GetTeamByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamById` query requires an argument of type `GetTeamByIdVariables`:
-const getTeamByIdVars: GetTeamByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamByIdRef()` function to get a reference to the query.
-const ref = getTeamByIdRef(getTeamByIdVars);
-// Variables can be defined inline as well.
-const ref = getTeamByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getTeamByIdRef(dataConnect, getTeamByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.team);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.team);
-});
-```
-
-## filterTeam
-You can execute the `filterTeam` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterTeam(vars?: FilterTeamVariables): QueryPromise;
-
-interface FilterTeamRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterTeamVariables): QueryRef;
-}
-export const filterTeamRef: FilterTeamRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterTeam(dc: DataConnect, vars?: FilterTeamVariables): QueryPromise;
-
-interface FilterTeamRef {
- ...
- (dc: DataConnect, vars?: FilterTeamVariables): QueryRef;
-}
-export const filterTeamRef: FilterTeamRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterTeamRef:
-```typescript
-const name = filterTeamRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterTeam` query has an optional argument of type `FilterTeamVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterTeamVariables {
- teamName?: string | null;
- ownerId?: string | null;
- ownerRole?: TeamOwnerRole | null;
-}
-```
-### Return Type
-Recall that executing the `filterTeam` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterTeamData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterTeamData {
- teams: ({
- id: UUIDString;
- teamName: string;
- ownerId: string;
- ownerName: string;
- ownerRole: TeamOwnerRole;
- favoriteStaff?: string | null;
- blockedStaff?: string | null;
- } & Team_Key)[];
-}
-```
-### Using `filterTeam`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterTeam, FilterTeamVariables } from '@dataconnect/generated';
-
-// The `filterTeam` query has an optional argument of type `FilterTeamVariables`:
-const filterTeamVars: FilterTeamVariables = {
- teamName: ..., // optional
- ownerId: ..., // optional
- ownerRole: ..., // optional
-};
-
-// Call the `filterTeam()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterTeam(filterTeamVars);
-// Variables can be defined inline as well.
-const { data } = await filterTeam({ teamName: ..., ownerId: ..., ownerRole: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamVariables` argument.
-const { data } = await filterTeam();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterTeam(dataConnect, filterTeamVars);
-
-console.log(data.teams);
-
-// Or, you can use the `Promise` API.
-filterTeam(filterTeamVars).then((response) => {
- const data = response.data;
- console.log(data.teams);
-});
-```
-
-### Using `filterTeam`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterTeamRef, FilterTeamVariables } from '@dataconnect/generated';
-
-// The `filterTeam` query has an optional argument of type `FilterTeamVariables`:
-const filterTeamVars: FilterTeamVariables = {
- teamName: ..., // optional
- ownerId: ..., // optional
- ownerRole: ..., // optional
-};
-
-// Call the `filterTeamRef()` function to get a reference to the query.
-const ref = filterTeamRef(filterTeamVars);
-// Variables can be defined inline as well.
-const ref = filterTeamRef({ teamName: ..., ownerId: ..., ownerRole: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamVariables` argument.
-const ref = filterTeamRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterTeamRef(dataConnect, filterTeamVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teams);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teams);
-});
-```
-
-## listTeamHub
-You can execute the `listTeamHub` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listTeamHub(): QueryPromise;
-
-interface ListTeamHubRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listTeamHubRef: ListTeamHubRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listTeamHub(dc: DataConnect): QueryPromise;
-
-interface ListTeamHubRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listTeamHubRef: ListTeamHubRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listTeamHubRef:
-```typescript
-const name = listTeamHubRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listTeamHub` query has no variables.
-### Return Type
-Recall that executing the `listTeamHub` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListTeamHubData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListTeamHubData {
- teamHubs: ({
- id: UUIDString;
- teamId: UUIDString;
- hubName: string;
- departments?: string | null;
- } & TeamHub_Key)[];
-}
-```
-### Using `listTeamHub`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listTeamHub } from '@dataconnect/generated';
-
-
-// Call the `listTeamHub()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listTeamHub();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listTeamHub(dataConnect);
-
-console.log(data.teamHubs);
-
-// Or, you can use the `Promise` API.
-listTeamHub().then((response) => {
- const data = response.data;
- console.log(data.teamHubs);
-});
-```
-
-### Using `listTeamHub`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listTeamHubRef } from '@dataconnect/generated';
-
-
-// Call the `listTeamHubRef()` function to get a reference to the query.
-const ref = listTeamHubRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listTeamHubRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamHubs);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamHubs);
-});
-```
-
-## getTeamHubById
-You can execute the `getTeamHubById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getTeamHubById(vars: GetTeamHubByIdVariables): QueryPromise;
-
-interface GetTeamHubByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetTeamHubByIdVariables): QueryRef;
-}
-export const getTeamHubByIdRef: GetTeamHubByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getTeamHubById(dc: DataConnect, vars: GetTeamHubByIdVariables): QueryPromise;
-
-interface GetTeamHubByIdRef {
- ...
- (dc: DataConnect, vars: GetTeamHubByIdVariables): QueryRef;
-}
-export const getTeamHubByIdRef: GetTeamHubByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getTeamHubByIdRef:
-```typescript
-const name = getTeamHubByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getTeamHubById` query requires an argument of type `GetTeamHubByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetTeamHubByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getTeamHubById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetTeamHubByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetTeamHubByIdData {
- teamHub?: {
- id: UUIDString;
- teamId: UUIDString;
- hubName: string;
- departments?: string | null;
- } & TeamHub_Key;
-}
-```
-### Using `getTeamHubById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getTeamHubById, GetTeamHubByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamHubById` query requires an argument of type `GetTeamHubByIdVariables`:
-const getTeamHubByIdVars: GetTeamHubByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamHubById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getTeamHubById(getTeamHubByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getTeamHubById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getTeamHubById(dataConnect, getTeamHubByIdVars);
-
-console.log(data.teamHub);
-
-// Or, you can use the `Promise` API.
-getTeamHubById(getTeamHubByIdVars).then((response) => {
- const data = response.data;
- console.log(data.teamHub);
-});
-```
-
-### Using `getTeamHubById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getTeamHubByIdRef, GetTeamHubByIdVariables } from '@dataconnect/generated';
-
-// The `getTeamHubById` query requires an argument of type `GetTeamHubByIdVariables`:
-const getTeamHubByIdVars: GetTeamHubByIdVariables = {
- id: ...,
-};
-
-// Call the `getTeamHubByIdRef()` function to get a reference to the query.
-const ref = getTeamHubByIdRef(getTeamHubByIdVars);
-// Variables can be defined inline as well.
-const ref = getTeamHubByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getTeamHubByIdRef(dataConnect, getTeamHubByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamHub);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamHub);
-});
-```
-
-## filterTeamHub
-You can execute the `filterTeamHub` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterTeamHub(vars?: FilterTeamHubVariables): QueryPromise;
-
-interface FilterTeamHubRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterTeamHubVariables): QueryRef;
-}
-export const filterTeamHubRef: FilterTeamHubRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterTeamHub(dc: DataConnect, vars?: FilterTeamHubVariables): QueryPromise;
-
-interface FilterTeamHubRef {
- ...
- (dc: DataConnect, vars?: FilterTeamHubVariables): QueryRef;
-}
-export const filterTeamHubRef: FilterTeamHubRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterTeamHubRef:
-```typescript
-const name = filterTeamHubRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterTeamHub` query has an optional argument of type `FilterTeamHubVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterTeamHubVariables {
- teamId?: UUIDString | null;
- hubName?: string | null;
-}
-```
-### Return Type
-Recall that executing the `filterTeamHub` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterTeamHubData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterTeamHubData {
- teamHubs: ({
- id: UUIDString;
- teamId: UUIDString;
- hubName: string;
- departments?: string | null;
- } & TeamHub_Key)[];
-}
-```
-### Using `filterTeamHub`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterTeamHub, FilterTeamHubVariables } from '@dataconnect/generated';
-
-// The `filterTeamHub` query has an optional argument of type `FilterTeamHubVariables`:
-const filterTeamHubVars: FilterTeamHubVariables = {
- teamId: ..., // optional
- hubName: ..., // optional
-};
-
-// Call the `filterTeamHub()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterTeamHub(filterTeamHubVars);
-// Variables can be defined inline as well.
-const { data } = await filterTeamHub({ teamId: ..., hubName: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamHubVariables` argument.
-const { data } = await filterTeamHub();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterTeamHub(dataConnect, filterTeamHubVars);
-
-console.log(data.teamHubs);
-
-// Or, you can use the `Promise` API.
-filterTeamHub(filterTeamHubVars).then((response) => {
- const data = response.data;
- console.log(data.teamHubs);
-});
-```
-
-### Using `filterTeamHub`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterTeamHubRef, FilterTeamHubVariables } from '@dataconnect/generated';
-
-// The `filterTeamHub` query has an optional argument of type `FilterTeamHubVariables`:
-const filterTeamHubVars: FilterTeamHubVariables = {
- teamId: ..., // optional
- hubName: ..., // optional
-};
-
-// Call the `filterTeamHubRef()` function to get a reference to the query.
-const ref = filterTeamHubRef(filterTeamHubVars);
-// Variables can be defined inline as well.
-const ref = filterTeamHubRef({ teamId: ..., hubName: ..., });
-// Since all variables are optional for this query, you can omit the `FilterTeamHubVariables` argument.
-const ref = filterTeamHubRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterTeamHubRef(dataConnect, filterTeamHubVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.teamHubs);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.teamHubs);
-});
-```
-
-## listVendor
-You can execute the `listVendor` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listVendor(): QueryPromise;
-
-interface ListVendorRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listVendorRef: ListVendorRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listVendor(dc: DataConnect): QueryPromise;
-
-interface ListVendorRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listVendorRef: ListVendorRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRef:
-```typescript
-const name = listVendorRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listVendor` query has no variables.
-### Return Type
-Recall that executing the `listVendor` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListVendorData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListVendorData {
- vendors: ({
- id: UUIDString;
- vendorNumber: string;
- legalName: string;
- region: VendorRegion;
- platformType: VendorPlatformType;
- primaryContactEmail: string;
- approvalStatus: VendorApprovalStatus;
- isActive?: boolean | null;
- } & Vendor_Key)[];
-}
-```
-### Using `listVendor`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listVendor } from '@dataconnect/generated';
-
-
-// Call the `listVendor()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listVendor();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listVendor(dataConnect);
-
-console.log(data.vendors);
-
-// Or, you can use the `Promise` API.
-listVendor().then((response) => {
- const data = response.data;
- console.log(data.vendors);
-});
-```
-
-### Using `listVendor`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listVendorRef } from '@dataconnect/generated';
-
-
-// Call the `listVendorRef()` function to get a reference to the query.
-const ref = listVendorRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listVendorRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendors);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendors);
-});
-```
-
-## getVendorById
-You can execute the `getVendorById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getVendorById(vars: GetVendorByIdVariables): QueryPromise;
-
-interface GetVendorByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetVendorByIdVariables): QueryRef;
-}
-export const getVendorByIdRef: GetVendorByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getVendorById(dc: DataConnect, vars: GetVendorByIdVariables): QueryPromise;
-
-interface GetVendorByIdRef {
- ...
- (dc: DataConnect, vars: GetVendorByIdVariables): QueryRef;
-}
-export const getVendorByIdRef: GetVendorByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorByIdRef:
-```typescript
-const name = getVendorByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getVendorById` query requires an argument of type `GetVendorByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetVendorByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getVendorById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetVendorByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetVendorByIdData {
- vendor?: {
- id: UUIDString;
- vendorNumber: string;
- legalName: string;
- region: VendorRegion;
- platformType: VendorPlatformType;
- primaryContactEmail: string;
- approvalStatus: VendorApprovalStatus;
- isActive?: boolean | null;
- } & Vendor_Key;
-}
-```
-### Using `getVendorById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getVendorById, GetVendorByIdVariables } from '@dataconnect/generated';
-
-// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`:
-const getVendorByIdVars: GetVendorByIdVariables = {
- id: ...,
-};
-
-// Call the `getVendorById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getVendorById(getVendorByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getVendorById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getVendorById(dataConnect, getVendorByIdVars);
-
-console.log(data.vendor);
-
-// Or, you can use the `Promise` API.
-getVendorById(getVendorByIdVars).then((response) => {
- const data = response.data;
- console.log(data.vendor);
-});
-```
-
-### Using `getVendorById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getVendorByIdRef, GetVendorByIdVariables } from '@dataconnect/generated';
-
-// The `getVendorById` query requires an argument of type `GetVendorByIdVariables`:
-const getVendorByIdVars: GetVendorByIdVariables = {
- id: ...,
-};
-
-// Call the `getVendorByIdRef()` function to get a reference to the query.
-const ref = getVendorByIdRef(getVendorByIdVars);
-// Variables can be defined inline as well.
-const ref = getVendorByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getVendorByIdRef(dataConnect, getVendorByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendor);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendor);
-});
-```
-
-## filterVendors
-You can execute the `filterVendors` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterVendors(vars?: FilterVendorsVariables): QueryPromise;
-
-interface FilterVendorsRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterVendorsVariables): QueryRef;
-}
-export const filterVendorsRef: FilterVendorsRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterVendors(dc: DataConnect, vars?: FilterVendorsVariables): QueryPromise;
-
-interface FilterVendorsRef {
- ...
- (dc: DataConnect, vars?: FilterVendorsVariables): QueryRef;
-}
-export const filterVendorsRef: FilterVendorsRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorsRef:
-```typescript
-const name = filterVendorsRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterVendors` query has an optional argument of type `FilterVendorsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterVendorsVariables {
- region?: VendorRegion | null;
- approvalStatus?: VendorApprovalStatus | null;
- isActive?: boolean | null;
- vendorNumber?: string | null;
- primaryContactEmail?: string | null;
- legalName?: string | null;
- platformType?: VendorPlatformType | null;
-}
-```
-### Return Type
-Recall that executing the `filterVendors` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterVendorsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterVendorsData {
- vendors: ({
- id: UUIDString;
- vendorNumber: string;
- legalName: string;
- region: VendorRegion;
- platformType: VendorPlatformType;
- primaryContactEmail: string;
- approvalStatus: VendorApprovalStatus;
- isActive?: boolean | null;
- } & Vendor_Key)[];
-}
-```
-### Using `filterVendors`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterVendors, FilterVendorsVariables } from '@dataconnect/generated';
-
-// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`:
-const filterVendorsVars: FilterVendorsVariables = {
- region: ..., // optional
- approvalStatus: ..., // optional
- isActive: ..., // optional
- vendorNumber: ..., // optional
- primaryContactEmail: ..., // optional
- legalName: ..., // optional
- platformType: ..., // optional
-};
-
-// Call the `filterVendors()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterVendors(filterVendorsVars);
-// Variables can be defined inline as well.
-const { data } = await filterVendors({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., });
-// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument.
-const { data } = await filterVendors();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterVendors(dataConnect, filterVendorsVars);
-
-console.log(data.vendors);
-
-// Or, you can use the `Promise` API.
-filterVendors(filterVendorsVars).then((response) => {
- const data = response.data;
- console.log(data.vendors);
-});
-```
-
-### Using `filterVendors`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterVendorsRef, FilterVendorsVariables } from '@dataconnect/generated';
-
-// The `filterVendors` query has an optional argument of type `FilterVendorsVariables`:
-const filterVendorsVars: FilterVendorsVariables = {
- region: ..., // optional
- approvalStatus: ..., // optional
- isActive: ..., // optional
- vendorNumber: ..., // optional
- primaryContactEmail: ..., // optional
- legalName: ..., // optional
- platformType: ..., // optional
-};
-
-// Call the `filterVendorsRef()` function to get a reference to the query.
-const ref = filterVendorsRef(filterVendorsVars);
-// Variables can be defined inline as well.
-const ref = filterVendorsRef({ region: ..., approvalStatus: ..., isActive: ..., vendorNumber: ..., primaryContactEmail: ..., legalName: ..., platformType: ..., });
-// Since all variables are optional for this query, you can omit the `FilterVendorsVariables` argument.
-const ref = filterVendorsRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterVendorsRef(dataConnect, filterVendorsVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendors);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendors);
-});
-```
-
-## listInvoice
-You can execute the `listInvoice` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listInvoice(): QueryPromise;
-
-interface ListInvoiceRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listInvoiceRef: ListInvoiceRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listInvoice(dc: DataConnect): QueryPromise;
-
-interface ListInvoiceRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listInvoiceRef: ListInvoiceRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listInvoiceRef:
-```typescript
-const name = listInvoiceRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listInvoice` query has no variables.
-### Return Type
-Recall that executing the `listInvoice` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListInvoiceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListInvoiceData {
- invoices: ({
- id: UUIDString;
- invoiceNumber: string;
- amount: number;
- status: InvoiceStatus;
- issueDate: TimestampString;
- dueDate: TimestampString;
- disputedItems?: string | null;
- isAutoGenerated?: boolean | null;
- } & Invoice_Key)[];
-}
-```
-### Using `listInvoice`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listInvoice } from '@dataconnect/generated';
-
-
-// Call the `listInvoice()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listInvoice();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listInvoice(dataConnect);
-
-console.log(data.invoices);
-
-// Or, you can use the `Promise` API.
-listInvoice().then((response) => {
- const data = response.data;
- console.log(data.invoices);
-});
-```
-
-### Using `listInvoice`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listInvoiceRef } from '@dataconnect/generated';
-
-
-// Call the `listInvoiceRef()` function to get a reference to the query.
-const ref = listInvoiceRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listInvoiceRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.invoices);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.invoices);
-});
-```
-
-## getInvoiceById
-You can execute the `getInvoiceById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getInvoiceById(vars: GetInvoiceByIdVariables): QueryPromise;
-
-interface GetInvoiceByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetInvoiceByIdVariables): QueryRef;
-}
-export const getInvoiceByIdRef: GetInvoiceByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getInvoiceById(dc: DataConnect, vars: GetInvoiceByIdVariables): QueryPromise;
-
-interface GetInvoiceByIdRef {
- ...
- (dc: DataConnect, vars: GetInvoiceByIdVariables): QueryRef;
-}
-export const getInvoiceByIdRef: GetInvoiceByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getInvoiceByIdRef:
-```typescript
-const name = getInvoiceByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetInvoiceByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getInvoiceById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetInvoiceByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetInvoiceByIdData {
- invoice?: {
- id: UUIDString;
- invoiceNumber: string;
- amount: number;
- status: InvoiceStatus;
- issueDate: TimestampString;
- dueDate: TimestampString;
- disputedItems?: string | null;
- isAutoGenerated?: boolean | null;
- } & Invoice_Key;
-}
-```
-### Using `getInvoiceById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getInvoiceById, GetInvoiceByIdVariables } from '@dataconnect/generated';
-
-// The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`:
-const getInvoiceByIdVars: GetInvoiceByIdVariables = {
- id: ...,
-};
-
-// Call the `getInvoiceById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getInvoiceById(getInvoiceByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getInvoiceById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getInvoiceById(dataConnect, getInvoiceByIdVars);
-
-console.log(data.invoice);
-
-// Or, you can use the `Promise` API.
-getInvoiceById(getInvoiceByIdVars).then((response) => {
- const data = response.data;
- console.log(data.invoice);
-});
-```
-
-### Using `getInvoiceById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getInvoiceByIdRef, GetInvoiceByIdVariables } from '@dataconnect/generated';
-
-// The `getInvoiceById` query requires an argument of type `GetInvoiceByIdVariables`:
-const getInvoiceByIdVars: GetInvoiceByIdVariables = {
- id: ...,
-};
-
-// Call the `getInvoiceByIdRef()` function to get a reference to the query.
-const ref = getInvoiceByIdRef(getInvoiceByIdVars);
-// Variables can be defined inline as well.
-const ref = getInvoiceByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getInvoiceByIdRef(dataConnect, getInvoiceByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.invoice);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.invoice);
-});
-```
-
-## filterInvoices
-You can execute the `filterInvoices` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterInvoices(vars?: FilterInvoicesVariables): QueryPromise;
-
-interface FilterInvoicesRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterInvoicesVariables): QueryRef;
-}
-export const filterInvoicesRef: FilterInvoicesRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterInvoices(dc: DataConnect, vars?: FilterInvoicesVariables): QueryPromise;
-
-interface FilterInvoicesRef {
- ...
- (dc: DataConnect, vars?: FilterInvoicesVariables): QueryRef;
-}
-export const filterInvoicesRef: FilterInvoicesRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterInvoicesRef:
-```typescript
-const name = filterInvoicesRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterInvoicesVariables {
- invoiceNumber?: string | null;
- status?: InvoiceStatus | null;
- isAutoGenerated?: boolean | null;
- amount?: number | null;
-}
-```
-### Return Type
-Recall that executing the `filterInvoices` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterInvoicesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterInvoicesData {
- invoices: ({
- id: UUIDString;
- invoiceNumber: string;
- amount: number;
- status: InvoiceStatus;
- issueDate: TimestampString;
- dueDate: TimestampString;
- isAutoGenerated?: boolean | null;
- } & Invoice_Key)[];
-}
-```
-### Using `filterInvoices`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterInvoices, FilterInvoicesVariables } from '@dataconnect/generated';
-
-// The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`:
-const filterInvoicesVars: FilterInvoicesVariables = {
- invoiceNumber: ..., // optional
- status: ..., // optional
- isAutoGenerated: ..., // optional
- amount: ..., // optional
-};
-
-// Call the `filterInvoices()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterInvoices(filterInvoicesVars);
-// Variables can be defined inline as well.
-const { data } = await filterInvoices({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., });
-// Since all variables are optional for this query, you can omit the `FilterInvoicesVariables` argument.
-const { data } = await filterInvoices();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterInvoices(dataConnect, filterInvoicesVars);
-
-console.log(data.invoices);
-
-// Or, you can use the `Promise` API.
-filterInvoices(filterInvoicesVars).then((response) => {
- const data = response.data;
- console.log(data.invoices);
-});
-```
-
-### Using `filterInvoices`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterInvoicesRef, FilterInvoicesVariables } from '@dataconnect/generated';
-
-// The `filterInvoices` query has an optional argument of type `FilterInvoicesVariables`:
-const filterInvoicesVars: FilterInvoicesVariables = {
- invoiceNumber: ..., // optional
- status: ..., // optional
- isAutoGenerated: ..., // optional
- amount: ..., // optional
-};
-
-// Call the `filterInvoicesRef()` function to get a reference to the query.
-const ref = filterInvoicesRef(filterInvoicesVars);
-// Variables can be defined inline as well.
-const ref = filterInvoicesRef({ invoiceNumber: ..., status: ..., isAutoGenerated: ..., amount: ..., });
-// Since all variables are optional for this query, you can omit the `FilterInvoicesVariables` argument.
-const ref = filterInvoicesRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterInvoicesRef(dataConnect, filterInvoicesVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.invoices);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.invoices);
-});
-```
-
-## listMessage
-You can execute the `listMessage` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listMessage(): QueryPromise;
-
-interface ListMessageRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listMessageRef: ListMessageRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listMessage(dc: DataConnect): QueryPromise;
-
-interface ListMessageRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listMessageRef: ListMessageRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listMessageRef:
-```typescript
-const name = listMessageRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listMessage` query has no variables.
-### Return Type
-Recall that executing the `listMessage` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListMessageData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListMessageData {
- messages: ({
- id: UUIDString;
- conversationId: UUIDString;
- senderName: string;
- content: string;
- readBy?: string | null;
- } & Message_Key)[];
-}
-```
-### Using `listMessage`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listMessage } from '@dataconnect/generated';
-
-
-// Call the `listMessage()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listMessage();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listMessage(dataConnect);
-
-console.log(data.messages);
-
-// Or, you can use the `Promise` API.
-listMessage().then((response) => {
- const data = response.data;
- console.log(data.messages);
-});
-```
-
-### Using `listMessage`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listMessageRef } from '@dataconnect/generated';
-
-
-// Call the `listMessageRef()` function to get a reference to the query.
-const ref = listMessageRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listMessageRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.messages);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.messages);
-});
-```
-
-## getMessageById
-You can execute the `getMessageById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getMessageById(vars: GetMessageByIdVariables): QueryPromise;
-
-interface GetMessageByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetMessageByIdVariables): QueryRef;
-}
-export const getMessageByIdRef: GetMessageByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getMessageById(dc: DataConnect, vars: GetMessageByIdVariables): QueryPromise;
-
-interface GetMessageByIdRef {
- ...
- (dc: DataConnect, vars: GetMessageByIdVariables): QueryRef;
-}
-export const getMessageByIdRef: GetMessageByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getMessageByIdRef:
-```typescript
-const name = getMessageByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getMessageById` query requires an argument of type `GetMessageByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetMessageByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getMessageById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetMessageByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetMessageByIdData {
- message?: {
- id: UUIDString;
- conversationId: UUIDString;
- senderName: string;
- content: string;
- readBy?: string | null;
- } & Message_Key;
-}
-```
-### Using `getMessageById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getMessageById, GetMessageByIdVariables } from '@dataconnect/generated';
-
-// The `getMessageById` query requires an argument of type `GetMessageByIdVariables`:
-const getMessageByIdVars: GetMessageByIdVariables = {
- id: ...,
-};
-
-// Call the `getMessageById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getMessageById(getMessageByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getMessageById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getMessageById(dataConnect, getMessageByIdVars);
-
-console.log(data.message);
-
-// Or, you can use the `Promise` API.
-getMessageById(getMessageByIdVars).then((response) => {
- const data = response.data;
- console.log(data.message);
-});
-```
-
-### Using `getMessageById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getMessageByIdRef, GetMessageByIdVariables } from '@dataconnect/generated';
-
-// The `getMessageById` query requires an argument of type `GetMessageByIdVariables`:
-const getMessageByIdVars: GetMessageByIdVariables = {
- id: ...,
-};
-
-// Call the `getMessageByIdRef()` function to get a reference to the query.
-const ref = getMessageByIdRef(getMessageByIdVars);
-// Variables can be defined inline as well.
-const ref = getMessageByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getMessageByIdRef(dataConnect, getMessageByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.message);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.message);
-});
-```
-
-## filterMessage
-You can execute the `filterMessage` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterMessage(vars?: FilterMessageVariables): QueryPromise;
-
-interface FilterMessageRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterMessageVariables): QueryRef;
-}
-export const filterMessageRef: FilterMessageRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterMessage(dc: DataConnect, vars?: FilterMessageVariables): QueryPromise;
-
-interface FilterMessageRef {
- ...
- (dc: DataConnect, vars?: FilterMessageVariables): QueryRef;
-}
-export const filterMessageRef: FilterMessageRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterMessageRef:
-```typescript
-const name = filterMessageRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterMessage` query has an optional argument of type `FilterMessageVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterMessageVariables {
- conversationId?: UUIDString | null;
- senderName?: string | null;
-}
-```
-### Return Type
-Recall that executing the `filterMessage` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterMessageData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterMessageData {
- messages: ({
- id: UUIDString;
- conversationId: UUIDString;
- senderName: string;
- content: string;
- readBy?: string | null;
- } & Message_Key)[];
-}
-```
-### Using `filterMessage`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterMessage, FilterMessageVariables } from '@dataconnect/generated';
-
-// The `filterMessage` query has an optional argument of type `FilterMessageVariables`:
-const filterMessageVars: FilterMessageVariables = {
- conversationId: ..., // optional
- senderName: ..., // optional
-};
-
-// Call the `filterMessage()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterMessage(filterMessageVars);
-// Variables can be defined inline as well.
-const { data } = await filterMessage({ conversationId: ..., senderName: ..., });
-// Since all variables are optional for this query, you can omit the `FilterMessageVariables` argument.
-const { data } = await filterMessage();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterMessage(dataConnect, filterMessageVars);
-
-console.log(data.messages);
-
-// Or, you can use the `Promise` API.
-filterMessage(filterMessageVars).then((response) => {
- const data = response.data;
- console.log(data.messages);
-});
-```
-
-### Using `filterMessage`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterMessageRef, FilterMessageVariables } from '@dataconnect/generated';
-
-// The `filterMessage` query has an optional argument of type `FilterMessageVariables`:
-const filterMessageVars: FilterMessageVariables = {
- conversationId: ..., // optional
- senderName: ..., // optional
-};
-
-// Call the `filterMessageRef()` function to get a reference to the query.
-const ref = filterMessageRef(filterMessageVars);
-// Variables can be defined inline as well.
-const ref = filterMessageRef({ conversationId: ..., senderName: ..., });
-// Since all variables are optional for this query, you can omit the `FilterMessageVariables` argument.
-const ref = filterMessageRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterMessageRef(dataConnect, filterMessageVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.messages);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.messages);
-});
-```
-
-## listPartner
-You can execute the `listPartner` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listPartner(): QueryPromise;
-
-interface ListPartnerRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listPartnerRef: ListPartnerRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listPartner(dc: DataConnect): QueryPromise;
-
-interface ListPartnerRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listPartnerRef: ListPartnerRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listPartnerRef:
-```typescript
-const name = listPartnerRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listPartner` query has no variables.
-### Return Type
-Recall that executing the `listPartner` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListPartnerData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListPartnerData {
- partners: ({
- id: UUIDString;
- partnerName: string;
- partnerNumber: string;
- partnerType?: PartnerType | null;
- } & Partner_Key)[];
-}
-```
-### Using `listPartner`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listPartner } from '@dataconnect/generated';
-
-
-// Call the `listPartner()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listPartner();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listPartner(dataConnect);
-
-console.log(data.partners);
-
-// Or, you can use the `Promise` API.
-listPartner().then((response) => {
- const data = response.data;
- console.log(data.partners);
-});
-```
-
-### Using `listPartner`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listPartnerRef } from '@dataconnect/generated';
-
-
-// Call the `listPartnerRef()` function to get a reference to the query.
-const ref = listPartnerRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listPartnerRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.partners);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.partners);
-});
-```
-
-## getPartnerById
-You can execute the `getPartnerById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getPartnerById(vars: GetPartnerByIdVariables): QueryPromise;
-
-interface GetPartnerByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetPartnerByIdVariables): QueryRef;
-}
-export const getPartnerByIdRef: GetPartnerByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getPartnerById(dc: DataConnect, vars: GetPartnerByIdVariables): QueryPromise;
-
-interface GetPartnerByIdRef {
- ...
- (dc: DataConnect, vars: GetPartnerByIdVariables): QueryRef;
-}
-export const getPartnerByIdRef: GetPartnerByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getPartnerByIdRef:
-```typescript
-const name = getPartnerByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getPartnerById` query requires an argument of type `GetPartnerByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetPartnerByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getPartnerById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetPartnerByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetPartnerByIdData {
- partner?: {
- id: UUIDString;
- partnerName: string;
- partnerNumber: string;
- partnerType?: PartnerType | null;
- } & Partner_Key;
-}
-```
-### Using `getPartnerById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getPartnerById, GetPartnerByIdVariables } from '@dataconnect/generated';
-
-// The `getPartnerById` query requires an argument of type `GetPartnerByIdVariables`:
-const getPartnerByIdVars: GetPartnerByIdVariables = {
- id: ...,
-};
-
-// Call the `getPartnerById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getPartnerById(getPartnerByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getPartnerById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getPartnerById(dataConnect, getPartnerByIdVars);
-
-console.log(data.partner);
-
-// Or, you can use the `Promise` API.
-getPartnerById(getPartnerByIdVars).then((response) => {
- const data = response.data;
- console.log(data.partner);
-});
-```
-
-### Using `getPartnerById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getPartnerByIdRef, GetPartnerByIdVariables } from '@dataconnect/generated';
-
-// The `getPartnerById` query requires an argument of type `GetPartnerByIdVariables`:
-const getPartnerByIdVars: GetPartnerByIdVariables = {
- id: ...,
-};
-
-// Call the `getPartnerByIdRef()` function to get a reference to the query.
-const ref = getPartnerByIdRef(getPartnerByIdVars);
-// Variables can be defined inline as well.
-const ref = getPartnerByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getPartnerByIdRef(dataConnect, getPartnerByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.partner);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.partner);
-});
-```
-
-## filterPartner
-You can execute the `filterPartner` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterPartner(vars?: FilterPartnerVariables): QueryPromise;
-
-interface FilterPartnerRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterPartnerVariables): QueryRef;
-}
-export const filterPartnerRef: FilterPartnerRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterPartner(dc: DataConnect, vars?: FilterPartnerVariables): QueryPromise;
-
-interface FilterPartnerRef {
- ...
- (dc: DataConnect, vars?: FilterPartnerVariables): QueryRef;
-}
-export const filterPartnerRef: FilterPartnerRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterPartnerRef:
-```typescript
-const name = filterPartnerRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterPartner` query has an optional argument of type `FilterPartnerVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterPartnerVariables {
- partnerName?: string | null;
- partnerNumber?: string | null;
- partnerType?: PartnerType | null;
-}
-```
-### Return Type
-Recall that executing the `filterPartner` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterPartnerData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterPartnerData {
- partners: ({
- id: UUIDString;
- partnerName: string;
- partnerNumber: string;
- partnerType?: PartnerType | null;
- } & Partner_Key)[];
-}
-```
-### Using `filterPartner`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterPartner, FilterPartnerVariables } from '@dataconnect/generated';
-
-// The `filterPartner` query has an optional argument of type `FilterPartnerVariables`:
-const filterPartnerVars: FilterPartnerVariables = {
- partnerName: ..., // optional
- partnerNumber: ..., // optional
- partnerType: ..., // optional
-};
-
-// Call the `filterPartner()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterPartner(filterPartnerVars);
-// Variables can be defined inline as well.
-const { data } = await filterPartner({ partnerName: ..., partnerNumber: ..., partnerType: ..., });
-// Since all variables are optional for this query, you can omit the `FilterPartnerVariables` argument.
-const { data } = await filterPartner();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterPartner(dataConnect, filterPartnerVars);
-
-console.log(data.partners);
-
-// Or, you can use the `Promise` API.
-filterPartner(filterPartnerVars).then((response) => {
- const data = response.data;
- console.log(data.partners);
-});
-```
-
-### Using `filterPartner`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterPartnerRef, FilterPartnerVariables } from '@dataconnect/generated';
-
-// The `filterPartner` query has an optional argument of type `FilterPartnerVariables`:
-const filterPartnerVars: FilterPartnerVariables = {
- partnerName: ..., // optional
- partnerNumber: ..., // optional
- partnerType: ..., // optional
-};
-
-// Call the `filterPartnerRef()` function to get a reference to the query.
-const ref = filterPartnerRef(filterPartnerVars);
-// Variables can be defined inline as well.
-const ref = filterPartnerRef({ partnerName: ..., partnerNumber: ..., partnerType: ..., });
-// Since all variables are optional for this query, you can omit the `FilterPartnerVariables` argument.
-const ref = filterPartnerRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterPartnerRef(dataConnect, filterPartnerVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.partners);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.partners);
-});
-```
-
-## listVendorRate
-You can execute the `listVendorRate` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listVendorRate(): QueryPromise;
-
-interface ListVendorRateRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listVendorRateRef: ListVendorRateRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listVendorRate(dc: DataConnect): QueryPromise;
-
-interface ListVendorRateRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listVendorRateRef: ListVendorRateRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listVendorRateRef:
-```typescript
-const name = listVendorRateRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listVendorRate` query has no variables.
-### Return Type
-Recall that executing the `listVendorRate` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListVendorRateData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListVendorRateData {
- vendorRates: ({
- id: UUIDString;
- vendorName: string;
- category: VendorRateCategory;
- roleName: string;
- employeeWage: number;
- markupPercentage?: number | null;
- vendorFeePercentage?: number | null;
- clientRate: number;
- } & VendorRate_Key)[];
-}
-```
-### Using `listVendorRate`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listVendorRate } from '@dataconnect/generated';
-
-
-// Call the `listVendorRate()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listVendorRate();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listVendorRate(dataConnect);
-
-console.log(data.vendorRates);
-
-// Or, you can use the `Promise` API.
-listVendorRate().then((response) => {
- const data = response.data;
- console.log(data.vendorRates);
-});
-```
-
-### Using `listVendorRate`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listVendorRateRef } from '@dataconnect/generated';
-
-
-// Call the `listVendorRateRef()` function to get a reference to the query.
-const ref = listVendorRateRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listVendorRateRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendorRates);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendorRates);
-});
-```
-
-## getVendorRateById
-You can execute the `getVendorRateById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getVendorRateById(vars: GetVendorRateByIdVariables): QueryPromise;
-
-interface GetVendorRateByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetVendorRateByIdVariables): QueryRef;
-}
-export const getVendorRateByIdRef: GetVendorRateByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getVendorRateById(dc: DataConnect, vars: GetVendorRateByIdVariables): QueryPromise;
-
-interface GetVendorRateByIdRef {
- ...
- (dc: DataConnect, vars: GetVendorRateByIdVariables): QueryRef;
-}
-export const getVendorRateByIdRef: GetVendorRateByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getVendorRateByIdRef:
-```typescript
-const name = getVendorRateByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetVendorRateByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getVendorRateById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetVendorRateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetVendorRateByIdData {
- vendorRate?: {
- id: UUIDString;
- vendorName: string;
- category: VendorRateCategory;
- roleName: string;
- employeeWage: number;
- markupPercentage?: number | null;
- vendorFeePercentage?: number | null;
- clientRate: number;
- createdDate?: TimestampString | null;
- updatedDate?: TimestampString | null;
- createdBy?: string | null;
- } & VendorRate_Key;
-}
-```
-### Using `getVendorRateById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getVendorRateById, GetVendorRateByIdVariables } from '@dataconnect/generated';
-
-// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`:
-const getVendorRateByIdVars: GetVendorRateByIdVariables = {
- id: ...,
-};
-
-// Call the `getVendorRateById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getVendorRateById(getVendorRateByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getVendorRateById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getVendorRateById(dataConnect, getVendorRateByIdVars);
-
-console.log(data.vendorRate);
-
-// Or, you can use the `Promise` API.
-getVendorRateById(getVendorRateByIdVars).then((response) => {
- const data = response.data;
- console.log(data.vendorRate);
-});
-```
-
-### Using `getVendorRateById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getVendorRateByIdRef, GetVendorRateByIdVariables } from '@dataconnect/generated';
-
-// The `getVendorRateById` query requires an argument of type `GetVendorRateByIdVariables`:
-const getVendorRateByIdVars: GetVendorRateByIdVariables = {
- id: ...,
-};
-
-// Call the `getVendorRateByIdRef()` function to get a reference to the query.
-const ref = getVendorRateByIdRef(getVendorRateByIdVars);
-// Variables can be defined inline as well.
-const ref = getVendorRateByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getVendorRateByIdRef(dataConnect, getVendorRateByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendorRate);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendorRate);
-});
-```
-
-## filterVendorRates
-You can execute the `filterVendorRates` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterVendorRates(vars?: FilterVendorRatesVariables): QueryPromise;
-
-interface FilterVendorRatesRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterVendorRatesVariables): QueryRef;
-}
-export const filterVendorRatesRef: FilterVendorRatesRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterVendorRates(dc: DataConnect, vars?: FilterVendorRatesVariables): QueryPromise;
-
-interface FilterVendorRatesRef {
- ...
- (dc: DataConnect, vars?: FilterVendorRatesVariables): QueryRef;
-}
-export const filterVendorRatesRef: FilterVendorRatesRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterVendorRatesRef:
-```typescript
-const name = filterVendorRatesRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterVendorRatesVariables {
- vendorName?: string | null;
- category?: VendorRateCategory | null;
- roleName?: string | null;
- minClientRate?: number | null;
- maxClientRate?: number | null;
-}
-```
-### Return Type
-Recall that executing the `filterVendorRates` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterVendorRatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterVendorRatesData {
- vendorRates: ({
- id: UUIDString;
- vendorName: string;
- category: VendorRateCategory;
- roleName: string;
- employeeWage: number;
- markupPercentage?: number | null;
- vendorFeePercentage?: number | null;
- clientRate: number;
- } & VendorRate_Key)[];
-}
-```
-### Using `filterVendorRates`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterVendorRates, FilterVendorRatesVariables } from '@dataconnect/generated';
-
-// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`:
-const filterVendorRatesVars: FilterVendorRatesVariables = {
- vendorName: ..., // optional
- category: ..., // optional
- roleName: ..., // optional
- minClientRate: ..., // optional
- maxClientRate: ..., // optional
-};
-
-// Call the `filterVendorRates()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterVendorRates(filterVendorRatesVars);
-// Variables can be defined inline as well.
-const { data } = await filterVendorRates({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., });
-// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument.
-const { data } = await filterVendorRates();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterVendorRates(dataConnect, filterVendorRatesVars);
-
-console.log(data.vendorRates);
-
-// Or, you can use the `Promise` API.
-filterVendorRates(filterVendorRatesVars).then((response) => {
- const data = response.data;
- console.log(data.vendorRates);
-});
-```
-
-### Using `filterVendorRates`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterVendorRatesRef, FilterVendorRatesVariables } from '@dataconnect/generated';
-
-// The `filterVendorRates` query has an optional argument of type `FilterVendorRatesVariables`:
-const filterVendorRatesVars: FilterVendorRatesVariables = {
- vendorName: ..., // optional
- category: ..., // optional
- roleName: ..., // optional
- minClientRate: ..., // optional
- maxClientRate: ..., // optional
-};
-
-// Call the `filterVendorRatesRef()` function to get a reference to the query.
-const ref = filterVendorRatesRef(filterVendorRatesVars);
-// Variables can be defined inline as well.
-const ref = filterVendorRatesRef({ vendorName: ..., category: ..., roleName: ..., minClientRate: ..., maxClientRate: ..., });
-// Since all variables are optional for this query, you can omit the `FilterVendorRatesVariables` argument.
-const ref = filterVendorRatesRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterVendorRatesRef(dataConnect, filterVendorRatesVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.vendorRates);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.vendorRates);
-});
-```
-
-## listAssignment
-You can execute the `listAssignment` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listAssignment(): QueryPromise;
-
-interface ListAssignmentRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listAssignmentRef: ListAssignmentRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listAssignment(dc: DataConnect): QueryPromise;
-
-interface ListAssignmentRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listAssignmentRef: ListAssignmentRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listAssignmentRef:
-```typescript
-const name = listAssignmentRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listAssignment` query has no variables.
-### Return Type
-Recall that executing the `listAssignment` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListAssignmentData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListAssignmentData {
- assignments: ({
- id: UUIDString;
- assignmentNumber?: string | null;
- orderId: UUIDString;
- workforceId: UUIDString;
- vendorId: UUIDString;
- role: string;
- assignmentStatus: AssignmentStatus;
- scheduledStart: TimestampString;
- } & Assignment_Key)[];
-}
-```
-### Using `listAssignment`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listAssignment } from '@dataconnect/generated';
-
-
-// Call the `listAssignment()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listAssignment();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listAssignment(dataConnect);
-
-console.log(data.assignments);
-
-// Or, you can use the `Promise` API.
-listAssignment().then((response) => {
- const data = response.data;
- console.log(data.assignments);
-});
-```
-
-### Using `listAssignment`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listAssignmentRef } from '@dataconnect/generated';
-
-
-// Call the `listAssignmentRef()` function to get a reference to the query.
-const ref = listAssignmentRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listAssignmentRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.assignments);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.assignments);
-});
-```
-
-## getAssignmentById
-You can execute the `getAssignmentById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getAssignmentById(vars: GetAssignmentByIdVariables): QueryPromise;
-
-interface GetAssignmentByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetAssignmentByIdVariables): QueryRef;
-}
-export const getAssignmentByIdRef: GetAssignmentByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getAssignmentById(dc: DataConnect, vars: GetAssignmentByIdVariables): QueryPromise;
-
-interface GetAssignmentByIdRef {
- ...
- (dc: DataConnect, vars: GetAssignmentByIdVariables): QueryRef;
-}
-export const getAssignmentByIdRef: GetAssignmentByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getAssignmentByIdRef:
-```typescript
-const name = getAssignmentByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getAssignmentById` query requires an argument of type `GetAssignmentByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetAssignmentByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getAssignmentById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetAssignmentByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetAssignmentByIdData {
- assignment?: {
- id: UUIDString;
- assignmentNumber?: string | null;
- orderId: UUIDString;
- workforceId: UUIDString;
- vendorId: UUIDString;
- role: string;
- assignmentStatus: AssignmentStatus;
- scheduledStart: TimestampString;
- } & Assignment_Key;
-}
-```
-### Using `getAssignmentById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getAssignmentById, GetAssignmentByIdVariables } from '@dataconnect/generated';
-
-// The `getAssignmentById` query requires an argument of type `GetAssignmentByIdVariables`:
-const getAssignmentByIdVars: GetAssignmentByIdVariables = {
- id: ...,
-};
-
-// Call the `getAssignmentById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getAssignmentById(getAssignmentByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getAssignmentById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getAssignmentById(dataConnect, getAssignmentByIdVars);
-
-console.log(data.assignment);
-
-// Or, you can use the `Promise` API.
-getAssignmentById(getAssignmentByIdVars).then((response) => {
- const data = response.data;
- console.log(data.assignment);
-});
-```
-
-### Using `getAssignmentById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getAssignmentByIdRef, GetAssignmentByIdVariables } from '@dataconnect/generated';
-
-// The `getAssignmentById` query requires an argument of type `GetAssignmentByIdVariables`:
-const getAssignmentByIdVars: GetAssignmentByIdVariables = {
- id: ...,
-};
-
-// Call the `getAssignmentByIdRef()` function to get a reference to the query.
-const ref = getAssignmentByIdRef(getAssignmentByIdVars);
-// Variables can be defined inline as well.
-const ref = getAssignmentByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getAssignmentByIdRef(dataConnect, getAssignmentByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.assignment);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.assignment);
-});
-```
-
-## filterAssignment
-You can execute the `filterAssignment` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterAssignment(vars?: FilterAssignmentVariables): QueryPromise;
-
-interface FilterAssignmentRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterAssignmentVariables): QueryRef;
-}
-export const filterAssignmentRef: FilterAssignmentRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterAssignment(dc: DataConnect, vars?: FilterAssignmentVariables): QueryPromise;
-
-interface FilterAssignmentRef {
- ...
- (dc: DataConnect, vars?: FilterAssignmentVariables): QueryRef;
-}
-export const filterAssignmentRef: FilterAssignmentRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterAssignmentRef:
-```typescript
-const name = filterAssignmentRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterAssignment` query has an optional argument of type `FilterAssignmentVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterAssignmentVariables {
- assignmentNumber?: string | null;
- orderId?: UUIDString | null;
- workforceId?: UUIDString | null;
- vendorId?: UUIDString | null;
- assignmentStatus?: AssignmentStatus | null;
-}
-```
-### Return Type
-Recall that executing the `filterAssignment` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterAssignmentData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterAssignmentData {
- assignments: ({
- id: UUIDString;
- assignmentNumber?: string | null;
- orderId: UUIDString;
- workforceId: UUIDString;
- vendorId: UUIDString;
- role: string;
- assignmentStatus: AssignmentStatus;
- scheduledStart: TimestampString;
- } & Assignment_Key)[];
-}
-```
-### Using `filterAssignment`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterAssignment, FilterAssignmentVariables } from '@dataconnect/generated';
-
-// The `filterAssignment` query has an optional argument of type `FilterAssignmentVariables`:
-const filterAssignmentVars: FilterAssignmentVariables = {
- assignmentNumber: ..., // optional
- orderId: ..., // optional
- workforceId: ..., // optional
- vendorId: ..., // optional
- assignmentStatus: ..., // optional
-};
-
-// Call the `filterAssignment()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterAssignment(filterAssignmentVars);
-// Variables can be defined inline as well.
-const { data } = await filterAssignment({ assignmentNumber: ..., orderId: ..., workforceId: ..., vendorId: ..., assignmentStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterAssignmentVariables` argument.
-const { data } = await filterAssignment();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterAssignment(dataConnect, filterAssignmentVars);
-
-console.log(data.assignments);
-
-// Or, you can use the `Promise` API.
-filterAssignment(filterAssignmentVars).then((response) => {
- const data = response.data;
- console.log(data.assignments);
-});
-```
-
-### Using `filterAssignment`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterAssignmentRef, FilterAssignmentVariables } from '@dataconnect/generated';
-
-// The `filterAssignment` query has an optional argument of type `FilterAssignmentVariables`:
-const filterAssignmentVars: FilterAssignmentVariables = {
- assignmentNumber: ..., // optional
- orderId: ..., // optional
- workforceId: ..., // optional
- vendorId: ..., // optional
- assignmentStatus: ..., // optional
-};
-
-// Call the `filterAssignmentRef()` function to get a reference to the query.
-const ref = filterAssignmentRef(filterAssignmentVars);
-// Variables can be defined inline as well.
-const ref = filterAssignmentRef({ assignmentNumber: ..., orderId: ..., workforceId: ..., vendorId: ..., assignmentStatus: ..., });
-// Since all variables are optional for this query, you can omit the `FilterAssignmentVariables` argument.
-const ref = filterAssignmentRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterAssignmentRef(dataConnect, filterAssignmentVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.assignments);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.assignments);
-});
-```
-
-## listWorkforce
-You can execute the `listWorkforce` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listWorkforce(): QueryPromise;
-
-interface ListWorkforceRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listWorkforceRef: ListWorkforceRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listWorkforce(dc: DataConnect): QueryPromise;
-
-interface ListWorkforceRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listWorkforceRef: ListWorkforceRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listWorkforceRef:
-```typescript
-const name = listWorkforceRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listWorkforce` query has no variables.
-### Return Type
-Recall that executing the `listWorkforce` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListWorkforceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListWorkforceData {
- workforces: ({
- id: UUIDString;
- workforceNumber: string;
- vendorId: UUIDString;
- firstName: string;
- lastName: string;
- employmentType?: WorkforceEmploymentType | null;
- } & Workforce_Key)[];
-}
-```
-### Using `listWorkforce`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listWorkforce } from '@dataconnect/generated';
-
-
-// Call the `listWorkforce()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listWorkforce();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listWorkforce(dataConnect);
-
-console.log(data.workforces);
-
-// Or, you can use the `Promise` API.
-listWorkforce().then((response) => {
- const data = response.data;
- console.log(data.workforces);
-});
-```
-
-### Using `listWorkforce`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listWorkforceRef } from '@dataconnect/generated';
-
-
-// Call the `listWorkforceRef()` function to get a reference to the query.
-const ref = listWorkforceRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listWorkforceRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.workforces);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.workforces);
-});
-```
-
-## getWorkforceById
-You can execute the `getWorkforceById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getWorkforceById(vars: GetWorkforceByIdVariables): QueryPromise;
-
-interface GetWorkforceByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetWorkforceByIdVariables): QueryRef;
-}
-export const getWorkforceByIdRef: GetWorkforceByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getWorkforceById(dc: DataConnect, vars: GetWorkforceByIdVariables): QueryPromise;
-
-interface GetWorkforceByIdRef {
- ...
- (dc: DataConnect, vars: GetWorkforceByIdVariables): QueryRef;
-}
-export const getWorkforceByIdRef: GetWorkforceByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getWorkforceByIdRef:
-```typescript
-const name = getWorkforceByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getWorkforceById` query requires an argument of type `GetWorkforceByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetWorkforceByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getWorkforceById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetWorkforceByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetWorkforceByIdData {
- workforce?: {
- id: UUIDString;
- workforceNumber: string;
- vendorId: UUIDString;
- firstName: string;
- lastName: string;
- employmentType?: WorkforceEmploymentType | null;
- } & Workforce_Key;
-}
-```
-### Using `getWorkforceById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getWorkforceById, GetWorkforceByIdVariables } from '@dataconnect/generated';
-
-// The `getWorkforceById` query requires an argument of type `GetWorkforceByIdVariables`:
-const getWorkforceByIdVars: GetWorkforceByIdVariables = {
- id: ...,
-};
-
-// Call the `getWorkforceById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getWorkforceById(getWorkforceByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getWorkforceById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getWorkforceById(dataConnect, getWorkforceByIdVars);
-
-console.log(data.workforce);
-
-// Or, you can use the `Promise` API.
-getWorkforceById(getWorkforceByIdVars).then((response) => {
- const data = response.data;
- console.log(data.workforce);
-});
-```
-
-### Using `getWorkforceById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getWorkforceByIdRef, GetWorkforceByIdVariables } from '@dataconnect/generated';
-
-// The `getWorkforceById` query requires an argument of type `GetWorkforceByIdVariables`:
-const getWorkforceByIdVars: GetWorkforceByIdVariables = {
- id: ...,
-};
-
-// Call the `getWorkforceByIdRef()` function to get a reference to the query.
-const ref = getWorkforceByIdRef(getWorkforceByIdVars);
-// Variables can be defined inline as well.
-const ref = getWorkforceByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getWorkforceByIdRef(dataConnect, getWorkforceByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.workforce);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.workforce);
-});
-```
-
-## filterWorkforce
-You can execute the `filterWorkforce` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterWorkforce(vars?: FilterWorkforceVariables): QueryPromise;
-
-interface FilterWorkforceRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterWorkforceVariables): QueryRef;
-}
-export const filterWorkforceRef: FilterWorkforceRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterWorkforce(dc: DataConnect, vars?: FilterWorkforceVariables): QueryPromise;
-
-interface FilterWorkforceRef {
- ...
- (dc: DataConnect, vars?: FilterWorkforceVariables): QueryRef;
-}
-export const filterWorkforceRef: FilterWorkforceRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterWorkforceRef:
-```typescript
-const name = filterWorkforceRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterWorkforce` query has an optional argument of type `FilterWorkforceVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterWorkforceVariables {
- workforceNumber?: string | null;
- vendorId?: UUIDString | null;
- firstName?: string | null;
- lastName?: string | null;
- employmentType?: WorkforceEmploymentType | null;
-}
-```
-### Return Type
-Recall that executing the `filterWorkforce` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterWorkforceData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterWorkforceData {
- workforces: ({
- id: UUIDString;
- workforceNumber: string;
- vendorId: UUIDString;
- firstName: string;
- lastName: string;
- employmentType?: WorkforceEmploymentType | null;
- } & Workforce_Key)[];
-}
-```
-### Using `filterWorkforce`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterWorkforce, FilterWorkforceVariables } from '@dataconnect/generated';
-
-// The `filterWorkforce` query has an optional argument of type `FilterWorkforceVariables`:
-const filterWorkforceVars: FilterWorkforceVariables = {
- workforceNumber: ..., // optional
- vendorId: ..., // optional
- firstName: ..., // optional
- lastName: ..., // optional
- employmentType: ..., // optional
-};
-
-// Call the `filterWorkforce()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterWorkforce(filterWorkforceVars);
-// Variables can be defined inline as well.
-const { data } = await filterWorkforce({ workforceNumber: ..., vendorId: ..., firstName: ..., lastName: ..., employmentType: ..., });
-// Since all variables are optional for this query, you can omit the `FilterWorkforceVariables` argument.
-const { data } = await filterWorkforce();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterWorkforce(dataConnect, filterWorkforceVars);
-
-console.log(data.workforces);
-
-// Or, you can use the `Promise` API.
-filterWorkforce(filterWorkforceVars).then((response) => {
- const data = response.data;
- console.log(data.workforces);
-});
-```
-
-### Using `filterWorkforce`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterWorkforceRef, FilterWorkforceVariables } from '@dataconnect/generated';
-
-// The `filterWorkforce` query has an optional argument of type `FilterWorkforceVariables`:
-const filterWorkforceVars: FilterWorkforceVariables = {
- workforceNumber: ..., // optional
- vendorId: ..., // optional
- firstName: ..., // optional
- lastName: ..., // optional
- employmentType: ..., // optional
-};
-
-// Call the `filterWorkforceRef()` function to get a reference to the query.
-const ref = filterWorkforceRef(filterWorkforceVars);
-// Variables can be defined inline as well.
-const ref = filterWorkforceRef({ workforceNumber: ..., vendorId: ..., firstName: ..., lastName: ..., employmentType: ..., });
-// Since all variables are optional for this query, you can omit the `FilterWorkforceVariables` argument.
-const ref = filterWorkforceRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterWorkforceRef(dataConnect, filterWorkforceVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.workforces);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.workforces);
-});
-```
-
-## listEnterprise
-You can execute the `listEnterprise` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listEnterprise(): QueryPromise;
-
-interface ListEnterpriseRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (): QueryRef;
-}
-export const listEnterpriseRef: ListEnterpriseRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listEnterprise(dc: DataConnect): QueryPromise;
-
-interface ListEnterpriseRef {
- ...
- (dc: DataConnect): QueryRef;
-}
-export const listEnterpriseRef: ListEnterpriseRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listEnterpriseRef:
-```typescript
-const name = listEnterpriseRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listEnterprise` query has no variables.
-### Return Type
-Recall that executing the `listEnterprise` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListEnterpriseData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListEnterpriseData {
- enterprises: ({
- id: UUIDString;
- enterpriseNumber: string;
- enterpriseName: string;
- enterpriseCode: string;
- } & Enterprise_Key)[];
-}
-```
-### Using `listEnterprise`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listEnterprise } from '@dataconnect/generated';
-
-
-// Call the `listEnterprise()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listEnterprise();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listEnterprise(dataConnect);
-
-console.log(data.enterprises);
-
-// Or, you can use the `Promise` API.
-listEnterprise().then((response) => {
- const data = response.data;
- console.log(data.enterprises);
-});
-```
-
-### Using `listEnterprise`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listEnterpriseRef } from '@dataconnect/generated';
-
-
-// Call the `listEnterpriseRef()` function to get a reference to the query.
-const ref = listEnterpriseRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listEnterpriseRef(dataConnect);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.enterprises);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.enterprises);
-});
-```
-
-## getEnterpriseById
-You can execute the `getEnterpriseById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getEnterpriseById(vars: GetEnterpriseByIdVariables): QueryPromise;
-
-interface GetEnterpriseByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetEnterpriseByIdVariables): QueryRef;
-}
-export const getEnterpriseByIdRef: GetEnterpriseByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getEnterpriseById(dc: DataConnect, vars: GetEnterpriseByIdVariables): QueryPromise;
-
-interface GetEnterpriseByIdRef {
- ...
- (dc: DataConnect, vars: GetEnterpriseByIdVariables): QueryRef;
-}
-export const getEnterpriseByIdRef: GetEnterpriseByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getEnterpriseByIdRef:
-```typescript
-const name = getEnterpriseByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getEnterpriseById` query requires an argument of type `GetEnterpriseByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetEnterpriseByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getEnterpriseById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetEnterpriseByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetEnterpriseByIdData {
- enterprise?: {
- id: UUIDString;
- enterpriseNumber: string;
- enterpriseName: string;
- enterpriseCode: string;
- } & Enterprise_Key;
-}
-```
-### Using `getEnterpriseById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getEnterpriseById, GetEnterpriseByIdVariables } from '@dataconnect/generated';
-
-// The `getEnterpriseById` query requires an argument of type `GetEnterpriseByIdVariables`:
-const getEnterpriseByIdVars: GetEnterpriseByIdVariables = {
- id: ...,
-};
-
-// Call the `getEnterpriseById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getEnterpriseById(getEnterpriseByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getEnterpriseById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getEnterpriseById(dataConnect, getEnterpriseByIdVars);
-
-console.log(data.enterprise);
-
-// Or, you can use the `Promise` API.
-getEnterpriseById(getEnterpriseByIdVars).then((response) => {
- const data = response.data;
- console.log(data.enterprise);
-});
-```
-
-### Using `getEnterpriseById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getEnterpriseByIdRef, GetEnterpriseByIdVariables } from '@dataconnect/generated';
-
-// The `getEnterpriseById` query requires an argument of type `GetEnterpriseByIdVariables`:
-const getEnterpriseByIdVars: GetEnterpriseByIdVariables = {
- id: ...,
-};
-
-// Call the `getEnterpriseByIdRef()` function to get a reference to the query.
-const ref = getEnterpriseByIdRef(getEnterpriseByIdVars);
-// Variables can be defined inline as well.
-const ref = getEnterpriseByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getEnterpriseByIdRef(dataConnect, getEnterpriseByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.enterprise);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.enterprise);
-});
-```
-
-## filterEnterprise
-You can execute the `filterEnterprise` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterEnterprise(vars?: FilterEnterpriseVariables): QueryPromise;
-
-interface FilterEnterpriseRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterEnterpriseVariables): QueryRef;
-}
-export const filterEnterpriseRef: FilterEnterpriseRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterEnterprise(dc: DataConnect, vars?: FilterEnterpriseVariables): QueryPromise;
-
-interface FilterEnterpriseRef {
- ...
- (dc: DataConnect, vars?: FilterEnterpriseVariables): QueryRef;
-}
-export const filterEnterpriseRef: FilterEnterpriseRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterEnterpriseRef:
-```typescript
-const name = filterEnterpriseRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterEnterprise` query has an optional argument of type `FilterEnterpriseVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterEnterpriseVariables {
- enterpriseNumber?: string | null;
- enterpriseName?: string | null;
- enterpriseCode?: string | null;
-}
-```
-### Return Type
-Recall that executing the `filterEnterprise` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterEnterpriseData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterEnterpriseData {
- enterprises: ({
- id: UUIDString;
- enterpriseNumber: string;
- enterpriseName: string;
- enterpriseCode: string;
- } & Enterprise_Key)[];
-}
-```
-### Using `filterEnterprise`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterEnterprise, FilterEnterpriseVariables } from '@dataconnect/generated';
-
-// The `filterEnterprise` query has an optional argument of type `FilterEnterpriseVariables`:
-const filterEnterpriseVars: FilterEnterpriseVariables = {
- enterpriseNumber: ..., // optional
- enterpriseName: ..., // optional
- enterpriseCode: ..., // optional
-};
-
-// Call the `filterEnterprise()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterEnterprise(filterEnterpriseVars);
-// Variables can be defined inline as well.
-const { data } = await filterEnterprise({ enterpriseNumber: ..., enterpriseName: ..., enterpriseCode: ..., });
-// Since all variables are optional for this query, you can omit the `FilterEnterpriseVariables` argument.
-const { data } = await filterEnterprise();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterEnterprise(dataConnect, filterEnterpriseVars);
-
-console.log(data.enterprises);
-
-// Or, you can use the `Promise` API.
-filterEnterprise(filterEnterpriseVars).then((response) => {
- const data = response.data;
- console.log(data.enterprises);
-});
-```
-
-### Using `filterEnterprise`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterEnterpriseRef, FilterEnterpriseVariables } from '@dataconnect/generated';
-
-// The `filterEnterprise` query has an optional argument of type `FilterEnterpriseVariables`:
-const filterEnterpriseVars: FilterEnterpriseVariables = {
- enterpriseNumber: ..., // optional
- enterpriseName: ..., // optional
- enterpriseCode: ..., // optional
-};
-
-// Call the `filterEnterpriseRef()` function to get a reference to the query.
-const ref = filterEnterpriseRef(filterEnterpriseVars);
-// Variables can be defined inline as well.
-const ref = filterEnterpriseRef({ enterpriseNumber: ..., enterpriseName: ..., enterpriseCode: ..., });
-// Since all variables are optional for this query, you can omit the `FilterEnterpriseVariables` argument.
-const ref = filterEnterpriseRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterEnterpriseRef(dataConnect, filterEnterpriseVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.enterprises);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.enterprises);
-});
-```
-
-## listEvents
-You can execute the `listEvents` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listEvents(vars?: ListEventsVariables): QueryPromise;
-
-interface ListEventsRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: ListEventsVariables): QueryRef;
-}
-export const listEventsRef: ListEventsRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-listEvents(dc: DataConnect, vars?: ListEventsVariables): QueryPromise;
-
-interface ListEventsRef {
- ...
- (dc: DataConnect, vars?: ListEventsVariables): QueryRef;
-}
-export const listEventsRef: ListEventsRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the listEventsRef:
-```typescript
-const name = listEventsRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `listEvents` query has an optional argument of type `ListEventsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface ListEventsVariables {
- orderByDate?: OrderDirection | null;
- limit?: number | null;
-}
-```
-### Return Type
-Recall that executing the `listEvents` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `ListEventsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface ListEventsData {
- events: ({
- id: UUIDString;
- eventName: string;
- status: EventStatus;
- date: TimestampString;
- isRapid?: boolean | null;
- isRecurring?: boolean | null;
- isMultiDay?: boolean | null;
- recurrenceType?: RecurrenceType | null;
- recurrenceStartDate?: TimestampString | null;
- recurrenceEndDate?: TimestampString | null;
- scatterDates?: unknown | null;
- multiDayStartDate?: TimestampString | null;
- multiDayEndDate?: TimestampString | null;
- bufferTimeBefore?: number | null;
- bufferTimeAfter?: number | null;
- conflictDetectionEnabled?: boolean | null;
- detectedConflicts?: unknown | null;
- businessId: UUIDString;
- businessName?: string | null;
- vendorId?: string | null;
- vendorName?: string | null;
- hub?: string | null;
- eventLocation?: string | null;
- contractType?: ContractType | null;
- poReference?: string | null;
- shifts?: unknown | null;
- addons?: unknown | null;
- total?: number | null;
- clientName?: string | null;
- clientEmail?: string | null;
- clientPhone?: string | null;
- invoiceId?: UUIDString | null;
- notes?: string | null;
- requested?: number | null;
- assignedStaff?: unknown | null;
- createdBy?: string | null;
- } & Event_Key)[];
-}
-```
-### Using `listEvents`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, listEvents, ListEventsVariables } from '@dataconnect/generated';
-
-// The `listEvents` query has an optional argument of type `ListEventsVariables`:
-const listEventsVars: ListEventsVariables = {
- orderByDate: ..., // optional
- limit: ..., // optional
-};
-
-// Call the `listEvents()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await listEvents(listEventsVars);
-// Variables can be defined inline as well.
-const { data } = await listEvents({ orderByDate: ..., limit: ..., });
-// Since all variables are optional for this query, you can omit the `ListEventsVariables` argument.
-const { data } = await listEvents();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await listEvents(dataConnect, listEventsVars);
-
-console.log(data.events);
-
-// Or, you can use the `Promise` API.
-listEvents(listEventsVars).then((response) => {
- const data = response.data;
- console.log(data.events);
-});
-```
-
-### Using `listEvents`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, listEventsRef, ListEventsVariables } from '@dataconnect/generated';
-
-// The `listEvents` query has an optional argument of type `ListEventsVariables`:
-const listEventsVars: ListEventsVariables = {
- orderByDate: ..., // optional
- limit: ..., // optional
-};
-
-// Call the `listEventsRef()` function to get a reference to the query.
-const ref = listEventsRef(listEventsVars);
-// Variables can be defined inline as well.
-const ref = listEventsRef({ orderByDate: ..., limit: ..., });
-// Since all variables are optional for this query, you can omit the `ListEventsVariables` argument.
-const ref = listEventsRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = listEventsRef(dataConnect, listEventsVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.events);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.events);
-});
-```
-
-## getEventById
-You can execute the `getEventById` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-getEventById(vars: GetEventByIdVariables): QueryPromise;
-
-interface GetEventByIdRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars: GetEventByIdVariables): QueryRef;
-}
-export const getEventByIdRef: GetEventByIdRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-getEventById(dc: DataConnect, vars: GetEventByIdVariables): QueryPromise;
-
-interface GetEventByIdRef {
- ...
- (dc: DataConnect, vars: GetEventByIdVariables): QueryRef;
-}
-export const getEventByIdRef: GetEventByIdRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the getEventByIdRef:
-```typescript
-const name = getEventByIdRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `getEventById` query requires an argument of type `GetEventByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface GetEventByIdVariables {
- id: UUIDString;
-}
-```
-### Return Type
-Recall that executing the `getEventById` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `GetEventByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface GetEventByIdData {
- event?: {
- id: UUIDString;
- eventName: string;
- status: EventStatus;
- date: TimestampString;
- isRapid?: boolean | null;
- isRecurring?: boolean | null;
- isMultiDay?: boolean | null;
- recurrenceType?: RecurrenceType | null;
- recurrenceStartDate?: TimestampString | null;
- recurrenceEndDate?: TimestampString | null;
- scatterDates?: unknown | null;
- multiDayStartDate?: TimestampString | null;
- multiDayEndDate?: TimestampString | null;
- bufferTimeBefore?: number | null;
- bufferTimeAfter?: number | null;
- conflictDetectionEnabled?: boolean | null;
- detectedConflicts?: unknown | null;
- businessId: UUIDString;
- businessName?: string | null;
- vendorId?: string | null;
- vendorName?: string | null;
- hub?: string | null;
- eventLocation?: string | null;
- contractType?: ContractType | null;
- poReference?: string | null;
- shifts?: unknown | null;
- addons?: unknown | null;
- total?: number | null;
- clientName?: string | null;
- clientEmail?: string | null;
- clientPhone?: string | null;
- invoiceId?: UUIDString | null;
- notes?: string | null;
- requested?: number | null;
- assignedStaff?: unknown | null;
- } & Event_Key;
-}
-```
-### Using `getEventById`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, getEventById, GetEventByIdVariables } from '@dataconnect/generated';
-
-// The `getEventById` query requires an argument of type `GetEventByIdVariables`:
-const getEventByIdVars: GetEventByIdVariables = {
- id: ...,
-};
-
-// Call the `getEventById()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await getEventById(getEventByIdVars);
-// Variables can be defined inline as well.
-const { data } = await getEventById({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await getEventById(dataConnect, getEventByIdVars);
-
-console.log(data.event);
-
-// Or, you can use the `Promise` API.
-getEventById(getEventByIdVars).then((response) => {
- const data = response.data;
- console.log(data.event);
-});
-```
-
-### Using `getEventById`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, getEventByIdRef, GetEventByIdVariables } from '@dataconnect/generated';
-
-// The `getEventById` query requires an argument of type `GetEventByIdVariables`:
-const getEventByIdVars: GetEventByIdVariables = {
- id: ...,
-};
-
-// Call the `getEventByIdRef()` function to get a reference to the query.
-const ref = getEventByIdRef(getEventByIdVars);
-// Variables can be defined inline as well.
-const ref = getEventByIdRef({ id: ..., });
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = getEventByIdRef(dataConnect, getEventByIdVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.event);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.event);
-});
-```
-
-## filterEvents
-You can execute the `filterEvents` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-filterEvents(vars?: FilterEventsVariables): QueryPromise;
-
-interface FilterEventsRef {
- ...
- /* Allow users to create refs without passing in DataConnect */
- (vars?: FilterEventsVariables): QueryRef;
-}
-export const filterEventsRef: FilterEventsRef;
-```
-You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
-```typescript
-filterEvents(dc: DataConnect, vars?: FilterEventsVariables): QueryPromise;
-
-interface FilterEventsRef {
- ...
- (dc: DataConnect, vars?: FilterEventsVariables): QueryRef;
-}
-export const filterEventsRef: FilterEventsRef;
-```
-
-If you need the name of the operation without creating a ref, you can retrieve the operation name by calling the `operationName` property on the filterEventsRef:
-```typescript
-const name = filterEventsRef.operationName;
-console.log(name);
-```
-
-### Variables
-The `filterEvents` query has an optional argument of type `FilterEventsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-
-```typescript
-export interface FilterEventsVariables {
- status?: EventStatus | null;
- businessId?: UUIDString | null;
- vendorId?: string | null;
- isRecurring?: boolean | null;
- isRapid?: boolean | null;
- isMultiDay?: boolean | null;
- recurrenceType?: RecurrenceType | null;
- date?: TimestampString | null;
- hub?: string | null;
- eventLocation?: string | null;
- contractType?: ContractType | null;
- clientEmail?: string | null;
-}
-```
-### Return Type
-Recall that executing the `filterEvents` query returns a `QueryPromise` that resolves to an object with a `data` property.
-
-The `data` property is an object of type `FilterEventsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
-```typescript
-export interface FilterEventsData {
- events: ({
- id: UUIDString;
- eventName: string;
- status: EventStatus;
- date: TimestampString;
- isRapid?: boolean | null;
- isRecurring?: boolean | null;
- isMultiDay?: boolean | null;
- recurrenceType?: RecurrenceType | null;
- recurrenceStartDate?: TimestampString | null;
- recurrenceEndDate?: TimestampString | null;
- scatterDates?: unknown | null;
- multiDayStartDate?: TimestampString | null;
- multiDayEndDate?: TimestampString | null;
- bufferTimeBefore?: number | null;
- bufferTimeAfter?: number | null;
- conflictDetectionEnabled?: boolean | null;
- detectedConflicts?: unknown | null;
- businessId: UUIDString;
- businessName?: string | null;
- vendorId?: string | null;
- vendorName?: string | null;
- hub?: string | null;
- eventLocation?: string | null;
- contractType?: ContractType | null;
- poReference?: string | null;
- shifts?: unknown | null;
- addons?: unknown | null;
- total?: number | null;
- clientName?: string | null;
- clientEmail?: string | null;
- clientPhone?: string | null;
- invoiceId?: UUIDString | null;
- notes?: string | null;
- requested?: number | null;
- assignedStaff?: unknown | null;
- createdBy?: string | null;
- } & Event_Key)[];
-}
-```
-### Using `filterEvents`'s action shortcut function
-
-```typescript
-import { getDataConnect } from 'firebase/data-connect';
-import { connectorConfig, filterEvents, FilterEventsVariables } from '@dataconnect/generated';
-
-// The `filterEvents` query has an optional argument of type `FilterEventsVariables`:
-const filterEventsVars: FilterEventsVariables = {
- status: ..., // optional
- businessId: ..., // optional
- vendorId: ..., // optional
- isRecurring: ..., // optional
- isRapid: ..., // optional
- isMultiDay: ..., // optional
- recurrenceType: ..., // optional
- date: ..., // optional
- hub: ..., // optional
- eventLocation: ..., // optional
- contractType: ..., // optional
- clientEmail: ..., // optional
-};
-
-// Call the `filterEvents()` function to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await filterEvents(filterEventsVars);
-// Variables can be defined inline as well.
-const { data } = await filterEvents({ status: ..., businessId: ..., vendorId: ..., isRecurring: ..., isRapid: ..., isMultiDay: ..., recurrenceType: ..., date: ..., hub: ..., eventLocation: ..., contractType: ..., clientEmail: ..., });
-// Since all variables are optional for this query, you can omit the `FilterEventsVariables` argument.
-const { data } = await filterEvents();
-
-// You can also pass in a `DataConnect` instance to the action shortcut function.
-const dataConnect = getDataConnect(connectorConfig);
-const { data } = await filterEvents(dataConnect, filterEventsVars);
-
-console.log(data.events);
-
-// Or, you can use the `Promise` API.
-filterEvents(filterEventsVars).then((response) => {
- const data = response.data;
- console.log(data.events);
-});
-```
-
-### Using `filterEvents`'s `QueryRef` function
-
-```typescript
-import { getDataConnect, executeQuery } from 'firebase/data-connect';
-import { connectorConfig, filterEventsRef, FilterEventsVariables } from '@dataconnect/generated';
-
-// The `filterEvents` query has an optional argument of type `FilterEventsVariables`:
-const filterEventsVars: FilterEventsVariables = {
- status: ..., // optional
- businessId: ..., // optional
- vendorId: ..., // optional
- isRecurring: ..., // optional
- isRapid: ..., // optional
- isMultiDay: ..., // optional
- recurrenceType: ..., // optional
- date: ..., // optional
- hub: ..., // optional
- eventLocation: ..., // optional
- contractType: ..., // optional
- clientEmail: ..., // optional
-};
-
-// Call the `filterEventsRef()` function to get a reference to the query.
-const ref = filterEventsRef(filterEventsVars);
-// Variables can be defined inline as well.
-const ref = filterEventsRef({ status: ..., businessId: ..., vendorId: ..., isRecurring: ..., isRapid: ..., isMultiDay: ..., recurrenceType: ..., date: ..., hub: ..., eventLocation: ..., contractType: ..., clientEmail: ..., });
-// Since all variables are optional for this query, you can omit the `FilterEventsVariables` argument.
-const ref = filterEventsRef();
-
-// You can also pass in a `DataConnect` instance to the `QueryRef` function.
-const dataConnect = getDataConnect(connectorConfig);
-const ref = filterEventsRef(dataConnect, filterEventsVars);
-
-// Call `executeQuery()` on the reference to execute the query.
-// You can use the `await` keyword to wait for the promise to resolve.
-const { data } = await executeQuery(ref);
-
-console.log(data.events);
-
-// Or, you can use the `Promise` API.
-executeQuery(ref).then((response) => {
- const data = response.data;
- console.log(data.events);
-});
-```
-
-## listSector
-You can execute the `listSector` query using the following action shortcut function, or by calling `executeQuery()` after calling the following `QueryRef` function, both of which are defined in [dataconnect-generated/index.d.ts](./index.d.ts):
-```typescript
-listSector(): QueryPromise