diff --git a/.gitignore b/.gitignore
index 9dd0e50a..ccbe6030 100644
--- a/.gitignore
+++ b/.gitignore
@@ -184,3 +184,7 @@ krow-workforce-export-latest/
# Data Connect Generated SDKs (Explicit)
apps/mobile/packages/data_connect/lib/src/dataconnect_generated/
apps/web/src/dataconnect-generated/
+
+# Keep web Data Connect SDK in repo so web CI builds don't depend on runtime generation
+!apps/web/src/dataconnect-generated/
+!apps/web/src/dataconnect-generated/**
diff --git a/apps/web/src/dataconnect-generated/.guides/config.json b/apps/web/src/dataconnect-generated/.guides/config.json
new file mode 100644
index 00000000..e37ed06f
--- /dev/null
+++ b/apps/web/src/dataconnect-generated/.guides/config.json
@@ -0,0 +1,9 @@
+{
+ "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/apps/web/src/dataconnect-generated/.guides/setup.md b/apps/web/src/dataconnect-generated/.guides/setup.md
new file mode 100644
index 00000000..64a49286
--- /dev/null
+++ b/apps/web/src/dataconnect-generated/.guides/setup.md
@@ -0,0 +1,62 @@
+# 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/apps/web/src/dataconnect-generated/.guides/usage.md b/apps/web/src/dataconnect-generated/.guides/usage.md
new file mode 100644
index 00000000..04d920af
--- /dev/null
+++ b/apps/web/src/dataconnect-generated/.guides/usage.md
@@ -0,0 +1,109 @@
+# 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 { useCreateBenefitsData, useUpdateBenefitsData, useDeleteBenefitsData, useListShifts, useGetShiftById, useFilterShifts, useGetShiftsByBusinessId, useGetShiftsByVendorId, useCreateStaffDocument, useUpdateStaffDocument } from '@dataconnect/generated/react';
+// The types of these hooks are available in react/index.d.ts
+
+const { data, isPending, isSuccess, isError, error } = useCreateBenefitsData(createBenefitsDataVars);
+
+const { data, isPending, isSuccess, isError, error } = useUpdateBenefitsData(updateBenefitsDataVars);
+
+const { data, isPending, isSuccess, isError, error } = useDeleteBenefitsData(deleteBenefitsDataVars);
+
+const { data, isPending, isSuccess, isError, error } = useListShifts(listShiftsVars);
+
+const { data, isPending, isSuccess, isError, error } = useGetShiftById(getShiftByIdVars);
+
+const { data, isPending, isSuccess, isError, error } = useFilterShifts(filterShiftsVars);
+
+const { data, isPending, isSuccess, isError, error } = useGetShiftsByBusinessId(getShiftsByBusinessIdVars);
+
+const { data, isPending, isSuccess, isError, error } = useGetShiftsByVendorId(getShiftsByVendorIdVars);
+
+const { data, isPending, isSuccess, isError, error } = useCreateStaffDocument(createStaffDocumentVars);
+
+const { data, isPending, isSuccess, isError, error } = useUpdateStaffDocument(updateStaffDocumentVars);
+
+```
+
+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 { createBenefitsData, updateBenefitsData, deleteBenefitsData, listShifts, getShiftById, filterShifts, getShiftsByBusinessId, getShiftsByVendorId, createStaffDocument, updateStaffDocument } from '@dataconnect/generated';
+
+
+// Operation createBenefitsData: For variables, look at type CreateBenefitsDataVars in ../index.d.ts
+const { data } = await CreateBenefitsData(dataConnect, createBenefitsDataVars);
+
+// Operation updateBenefitsData: For variables, look at type UpdateBenefitsDataVars in ../index.d.ts
+const { data } = await UpdateBenefitsData(dataConnect, updateBenefitsDataVars);
+
+// Operation deleteBenefitsData: For variables, look at type DeleteBenefitsDataVars in ../index.d.ts
+const { data } = await DeleteBenefitsData(dataConnect, deleteBenefitsDataVars);
+
+// Operation listShifts: For variables, look at type ListShiftsVars in ../index.d.ts
+const { data } = await ListShifts(dataConnect, listShiftsVars);
+
+// Operation getShiftById: For variables, look at type GetShiftByIdVars in ../index.d.ts
+const { data } = await GetShiftById(dataConnect, getShiftByIdVars);
+
+// Operation filterShifts: For variables, look at type FilterShiftsVars in ../index.d.ts
+const { data } = await FilterShifts(dataConnect, filterShiftsVars);
+
+// Operation getShiftsByBusinessId: For variables, look at type GetShiftsByBusinessIdVars in ../index.d.ts
+const { data } = await GetShiftsByBusinessId(dataConnect, getShiftsByBusinessIdVars);
+
+// Operation getShiftsByVendorId: For variables, look at type GetShiftsByVendorIdVars in ../index.d.ts
+const { data } = await GetShiftsByVendorId(dataConnect, getShiftsByVendorIdVars);
+
+// Operation createStaffDocument: For variables, look at type CreateStaffDocumentVars in ../index.d.ts
+const { data } = await CreateStaffDocument(dataConnect, createStaffDocumentVars);
+
+// Operation updateStaffDocument: For variables, look at type UpdateStaffDocumentVars in ../index.d.ts
+const { data } = await UpdateStaffDocument(dataConnect, updateStaffDocumentVars);
+
+
+```
\ No newline at end of file
diff --git a/apps/web/src/dataconnect-generated/README.md b/apps/web/src/dataconnect-generated/README.md
new file mode 100644
index 00000000..55abf250
--- /dev/null
+++ b/apps/web/src/dataconnect-generated/README.md
@@ -0,0 +1,49269 @@
+# Generated TypeScript README
+This README will guide you through the process of using the generated JavaScript SDK package for the connector `example`. 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)
+ - [*listShifts*](#listshifts)
+ - [*getShiftById*](#getshiftbyid)
+ - [*filterShifts*](#filtershifts)
+ - [*getShiftsByBusinessId*](#getshiftsbybusinessid)
+ - [*getShiftsByVendorId*](#getshiftsbyvendorid)
+ - [*listEmergencyContacts*](#listemergencycontacts)
+ - [*getEmergencyContactById*](#getemergencycontactbyid)
+ - [*getEmergencyContactsByStaffId*](#getemergencycontactsbystaffid)
+ - [*getMyTasks*](#getmytasks)
+ - [*getMemberTaskByIdKey*](#getmembertaskbyidkey)
+ - [*getMemberTasksByTaskId*](#getmembertasksbytaskid)
+ - [*listCertificates*](#listcertificates)
+ - [*getCertificateById*](#getcertificatebyid)
+ - [*listCertificatesByStaffId*](#listcertificatesbystaffid)
+ - [*listAssignments*](#listassignments)
+ - [*getAssignmentById*](#getassignmentbyid)
+ - [*listAssignmentsByWorkforceId*](#listassignmentsbyworkforceid)
+ - [*listAssignmentsByWorkforceIds*](#listassignmentsbyworkforceids)
+ - [*listAssignmentsByShiftRole*](#listassignmentsbyshiftrole)
+ - [*filterAssignments*](#filterassignments)
+ - [*listInvoiceTemplates*](#listinvoicetemplates)
+ - [*getInvoiceTemplateById*](#getinvoicetemplatebyid)
+ - [*listInvoiceTemplatesByOwnerId*](#listinvoicetemplatesbyownerid)
+ - [*listInvoiceTemplatesByVendorId*](#listinvoicetemplatesbyvendorid)
+ - [*listInvoiceTemplatesByBusinessId*](#listinvoicetemplatesbybusinessid)
+ - [*listInvoiceTemplatesByOrderId*](#listinvoicetemplatesbyorderid)
+ - [*searchInvoiceTemplatesByOwnerAndName*](#searchinvoicetemplatesbyownerandname)
+ - [*getStaffDocumentByKey*](#getstaffdocumentbykey)
+ - [*listStaffDocumentsByStaffId*](#liststaffdocumentsbystaffid)
+ - [*listStaffDocumentsByDocumentType*](#liststaffdocumentsbydocumenttype)
+ - [*listStaffDocumentsByStatus*](#liststaffdocumentsbystatus)
+ - [*listAccounts*](#listaccounts)
+ - [*getAccountById*](#getaccountbyid)
+ - [*getAccountsByOwnerId*](#getaccountsbyownerid)
+ - [*filterAccounts*](#filteraccounts)
+ - [*listApplications*](#listapplications)
+ - [*getApplicationById*](#getapplicationbyid)
+ - [*getApplicationsByShiftId*](#getapplicationsbyshiftid)
+ - [*getApplicationsByShiftIdAndStatus*](#getapplicationsbyshiftidandstatus)
+ - [*getApplicationsByStaffId*](#getapplicationsbystaffid)
+ - [*vaidateDayStaffApplication*](#vaidatedaystaffapplication)
+ - [*getApplicationByStaffShiftAndRole*](#getapplicationbystaffshiftandrole)
+ - [*listAcceptedApplicationsByShiftRoleKey*](#listacceptedapplicationsbyshiftrolekey)
+ - [*listAcceptedApplicationsByBusinessForDay*](#listacceptedapplicationsbybusinessforday)
+ - [*listStaffsApplicationsByBusinessForDay*](#liststaffsapplicationsbybusinessforday)
+ - [*listCompletedApplicationsByStaffId*](#listcompletedapplicationsbystaffid)
+ - [*listAttireOptions*](#listattireoptions)
+ - [*getAttireOptionById*](#getattireoptionbyid)
+ - [*filterAttireOptions*](#filterattireoptions)
+ - [*listCustomRateCards*](#listcustomratecards)
+ - [*getCustomRateCardById*](#getcustomratecardbyid)
+ - [*listRoleCategories*](#listrolecategories)
+ - [*getRoleCategoryById*](#getrolecategorybyid)
+ - [*getRoleCategoriesByCategory*](#getrolecategoriesbycategory)
+ - [*listStaffAvailabilities*](#liststaffavailabilities)
+ - [*listStaffAvailabilitiesByStaffId*](#liststaffavailabilitiesbystaffid)
+ - [*getStaffAvailabilityByKey*](#getstaffavailabilitybykey)
+ - [*listStaffAvailabilitiesByDay*](#liststaffavailabilitiesbyday)
+ - [*listRecentPayments*](#listrecentpayments)
+ - [*getRecentPaymentById*](#getrecentpaymentbyid)
+ - [*listRecentPaymentsByStaffId*](#listrecentpaymentsbystaffid)
+ - [*listRecentPaymentsByApplicationId*](#listrecentpaymentsbyapplicationid)
+ - [*listRecentPaymentsByInvoiceId*](#listrecentpaymentsbyinvoiceid)
+ - [*listRecentPaymentsByStatus*](#listrecentpaymentsbystatus)
+ - [*listRecentPaymentsByInvoiceIds*](#listrecentpaymentsbyinvoiceids)
+ - [*listRecentPaymentsByBusinessId*](#listrecentpaymentsbybusinessid)
+ - [*listBusinesses*](#listbusinesses)
+ - [*getBusinessesByUserId*](#getbusinessesbyuserid)
+ - [*getBusinessById*](#getbusinessbyid)
+ - [*listConversations*](#listconversations)
+ - [*getConversationById*](#getconversationbyid)
+ - [*listConversationsByType*](#listconversationsbytype)
+ - [*listConversationsByStatus*](#listconversationsbystatus)
+ - [*filterConversations*](#filterconversations)
+ - [*listOrders*](#listorders)
+ - [*getOrderById*](#getorderbyid)
+ - [*getOrdersByBusinessId*](#getordersbybusinessid)
+ - [*getOrdersByVendorId*](#getordersbyvendorid)
+ - [*getOrdersByStatus*](#getordersbystatus)
+ - [*getOrdersByDateRange*](#getordersbydaterange)
+ - [*getRapidOrders*](#getrapidorders)
+ - [*listOrdersByBusinessAndTeamHub*](#listordersbybusinessandteamhub)
+ - [*listStaffRoles*](#liststaffroles)
+ - [*getStaffRoleByKey*](#getstaffrolebykey)
+ - [*listStaffRolesByStaffId*](#liststaffrolesbystaffid)
+ - [*listStaffRolesByRoleId*](#liststaffrolesbyroleid)
+ - [*filterStaffRoles*](#filterstaffroles)
+ - [*listTaskComments*](#listtaskcomments)
+ - [*getTaskCommentById*](#gettaskcommentbyid)
+ - [*getTaskCommentsByTaskId*](#gettaskcommentsbytaskid)
+ - [*listDocuments*](#listdocuments)
+ - [*getDocumentById*](#getdocumentbyid)
+ - [*filterDocuments*](#filterdocuments)
+ - [*listShiftsForCoverage*](#listshiftsforcoverage)
+ - [*listApplicationsForCoverage*](#listapplicationsforcoverage)
+ - [*listShiftsForDailyOpsByBusiness*](#listshiftsfordailyopsbybusiness)
+ - [*listShiftsForDailyOpsByVendor*](#listshiftsfordailyopsbyvendor)
+ - [*listApplicationsForDailyOps*](#listapplicationsfordailyops)
+ - [*listShiftsForForecastByBusiness*](#listshiftsforforecastbybusiness)
+ - [*listShiftsForForecastByVendor*](#listshiftsforforecastbyvendor)
+ - [*listShiftsForNoShowRangeByBusiness*](#listshiftsfornoshowrangebybusiness)
+ - [*listShiftsForNoShowRangeByVendor*](#listshiftsfornoshowrangebyvendor)
+ - [*listApplicationsForNoShowRange*](#listapplicationsfornoshowrange)
+ - [*listStaffForNoShowReport*](#liststafffornoshowreport)
+ - [*listInvoicesForSpendByBusiness*](#listinvoicesforspendbybusiness)
+ - [*listInvoicesForSpendByVendor*](#listinvoicesforspendbyvendor)
+ - [*listInvoicesForSpendByOrder*](#listinvoicesforspendbyorder)
+ - [*listTimesheetsForSpend*](#listtimesheetsforspend)
+ - [*listShiftsForPerformanceByBusiness*](#listshiftsforperformancebybusiness)
+ - [*listShiftsForPerformanceByVendor*](#listshiftsforperformancebyvendor)
+ - [*listApplicationsForPerformance*](#listapplicationsforperformance)
+ - [*listStaffForPerformance*](#liststaffforperformance)
+ - [*listRoles*](#listroles)
+ - [*getRoleById*](#getrolebyid)
+ - [*listRolesByVendorId*](#listrolesbyvendorid)
+ - [*listRolesByroleCategoryId*](#listrolesbyrolecategoryid)
+ - [*getShiftRoleById*](#getshiftrolebyid)
+ - [*listShiftRolesByShiftId*](#listshiftrolesbyshiftid)
+ - [*listShiftRolesByRoleId*](#listshiftrolesbyroleid)
+ - [*listShiftRolesByShiftIdAndTimeRange*](#listshiftrolesbyshiftidandtimerange)
+ - [*listShiftRolesByVendorId*](#listshiftrolesbyvendorid)
+ - [*listShiftRolesByBusinessAndDateRange*](#listshiftrolesbybusinessanddaterange)
+ - [*listShiftRolesByBusinessAndOrder*](#listshiftrolesbybusinessandorder)
+ - [*listShiftRolesByBusinessDateRangeCompletedOrders*](#listshiftrolesbybusinessdaterangecompletedorders)
+ - [*listShiftRolesByBusinessAndDatesSummary*](#listshiftrolesbybusinessanddatessummary)
+ - [*getCompletedShiftsByBusinessId*](#getcompletedshiftsbybusinessid)
+ - [*listTaxForms*](#listtaxforms)
+ - [*getTaxFormById*](#gettaxformbyid)
+ - [*getTaxFormsByStaffId*](#gettaxformsbystaffid)
+ - [*listTaxFormsWhere*](#listtaxformswhere)
+ - [*listFaqDatas*](#listfaqdatas)
+ - [*getFaqDataById*](#getfaqdatabyid)
+ - [*filterFaqDatas*](#filterfaqdatas)
+ - [*getStaffCourseById*](#getstaffcoursebyid)
+ - [*listStaffCoursesByStaffId*](#liststaffcoursesbystaffid)
+ - [*listStaffCoursesByCourseId*](#liststaffcoursesbycourseid)
+ - [*getStaffCourseByStaffAndCourse*](#getstaffcoursebystaffandcourse)
+ - [*listActivityLogs*](#listactivitylogs)
+ - [*getActivityLogById*](#getactivitylogbyid)
+ - [*listActivityLogsByUserId*](#listactivitylogsbyuserid)
+ - [*listUnreadActivityLogsByUserId*](#listunreadactivitylogsbyuserid)
+ - [*filterActivityLogs*](#filteractivitylogs)
+ - [*listBenefitsData*](#listbenefitsdata)
+ - [*getBenefitsDataByKey*](#getbenefitsdatabykey)
+ - [*listBenefitsDataByStaffId*](#listbenefitsdatabystaffid)
+ - [*listBenefitsDataByVendorBenefitPlanId*](#listbenefitsdatabyvendorbenefitplanid)
+ - [*listBenefitsDataByVendorBenefitPlanIds*](#listbenefitsdatabyvendorbenefitplanids)
+ - [*listStaff*](#liststaff)
+ - [*getStaffById*](#getstaffbyid)
+ - [*getStaffByUserId*](#getstaffbyuserid)
+ - [*filterStaff*](#filterstaff)
+ - [*listTasks*](#listtasks)
+ - [*getTaskById*](#gettaskbyid)
+ - [*getTasksByOwnerId*](#gettasksbyownerid)
+ - [*filterTasks*](#filtertasks)
+ - [*listTeamHubs*](#listteamhubs)
+ - [*getTeamHubById*](#getteamhubbyid)
+ - [*getTeamHubsByTeamId*](#getteamhubsbyteamid)
+ - [*listTeamHubsByOwnerId*](#listteamhubsbyownerid)
+ - [*listClientFeedbacks*](#listclientfeedbacks)
+ - [*getClientFeedbackById*](#getclientfeedbackbyid)
+ - [*listClientFeedbacksByBusinessId*](#listclientfeedbacksbybusinessid)
+ - [*listClientFeedbacksByVendorId*](#listclientfeedbacksbyvendorid)
+ - [*listClientFeedbacksByBusinessAndVendor*](#listclientfeedbacksbybusinessandvendor)
+ - [*filterClientFeedbacks*](#filterclientfeedbacks)
+ - [*listClientFeedbackRatingsByVendorId*](#listclientfeedbackratingsbyvendorid)
+ - [*listUsers*](#listusers)
+ - [*getUserById*](#getuserbyid)
+ - [*filterUsers*](#filterusers)
+ - [*getVendorById*](#getvendorbyid)
+ - [*getVendorByUserId*](#getvendorbyuserid)
+ - [*listVendors*](#listvendors)
+ - [*listCategories*](#listcategories)
+ - [*getCategoryById*](#getcategorybyid)
+ - [*filterCategories*](#filtercategories)
+ - [*listMessages*](#listmessages)
+ - [*getMessageById*](#getmessagebyid)
+ - [*getMessagesByConversationId*](#getmessagesbyconversationid)
+ - [*listUserConversations*](#listuserconversations)
+ - [*getUserConversationByKey*](#getuserconversationbykey)
+ - [*listUserConversationsByUserId*](#listuserconversationsbyuserid)
+ - [*listUnreadUserConversationsByUserId*](#listunreaduserconversationsbyuserid)
+ - [*listUserConversationsByConversationId*](#listuserconversationsbyconversationid)
+ - [*filterUserConversations*](#filteruserconversations)
+ - [*listHubs*](#listhubs)
+ - [*getHubById*](#gethubbyid)
+ - [*getHubsByOwnerId*](#gethubsbyownerid)
+ - [*filterHubs*](#filterhubs)
+ - [*listInvoices*](#listinvoices)
+ - [*getInvoiceById*](#getinvoicebyid)
+ - [*listInvoicesByVendorId*](#listinvoicesbyvendorid)
+ - [*listInvoicesByBusinessId*](#listinvoicesbybusinessid)
+ - [*listInvoicesByOrderId*](#listinvoicesbyorderid)
+ - [*listInvoicesByStatus*](#listinvoicesbystatus)
+ - [*filterInvoices*](#filterinvoices)
+ - [*listOverdueInvoices*](#listoverdueinvoices)
+ - [*listCourses*](#listcourses)
+ - [*getCourseById*](#getcoursebyid)
+ - [*filterCourses*](#filtercourses)
+ - [*listVendorRates*](#listvendorrates)
+ - [*getVendorRateById*](#getvendorratebyid)
+ - [*getWorkforceById*](#getworkforcebyid)
+ - [*getWorkforceByVendorAndStaff*](#getworkforcebyvendorandstaff)
+ - [*listWorkforceByVendorId*](#listworkforcebyvendorid)
+ - [*listWorkforceByStaffId*](#listworkforcebystaffid)
+ - [*getWorkforceByVendorAndNumber*](#getworkforcebyvendorandnumber)
+ - [*listStaffAvailabilityStats*](#liststaffavailabilitystats)
+ - [*getStaffAvailabilityStatsByStaffId*](#getstaffavailabilitystatsbystaffid)
+ - [*filterStaffAvailabilityStats*](#filterstaffavailabilitystats)
+ - [*listTeamHudDepartments*](#listteamhuddepartments)
+ - [*getTeamHudDepartmentById*](#getteamhuddepartmentbyid)
+ - [*listTeamHudDepartmentsByTeamHubId*](#listteamhuddepartmentsbyteamhubid)
+ - [*listLevels*](#listlevels)
+ - [*getLevelById*](#getlevelbyid)
+ - [*filterLevels*](#filterlevels)
+ - [*listTeams*](#listteams)
+ - [*getTeamById*](#getteambyid)
+ - [*getTeamsByOwnerId*](#getteamsbyownerid)
+ - [*listTeamMembers*](#listteammembers)
+ - [*getTeamMemberById*](#getteammemberbyid)
+ - [*getTeamMembersByTeamId*](#getteammembersbyteamid)
+ - [*listVendorBenefitPlans*](#listvendorbenefitplans)
+ - [*getVendorBenefitPlanById*](#getvendorbenefitplanbyid)
+ - [*listVendorBenefitPlansByVendorId*](#listvendorbenefitplansbyvendorid)
+ - [*listActiveVendorBenefitPlansByVendorId*](#listactivevendorbenefitplansbyvendorid)
+ - [*filterVendorBenefitPlans*](#filtervendorbenefitplans)
+- [**Mutations**](#mutations)
+ - [*createBenefitsData*](#createbenefitsdata)
+ - [*updateBenefitsData*](#updatebenefitsdata)
+ - [*deleteBenefitsData*](#deletebenefitsdata)
+ - [*createStaffDocument*](#createstaffdocument)
+ - [*updateStaffDocument*](#updatestaffdocument)
+ - [*deleteStaffDocument*](#deletestaffdocument)
+ - [*createTeamHudDepartment*](#createteamhuddepartment)
+ - [*updateTeamHudDepartment*](#updateteamhuddepartment)
+ - [*deleteTeamHudDepartment*](#deleteteamhuddepartment)
+ - [*createMemberTask*](#createmembertask)
+ - [*deleteMemberTask*](#deletemembertask)
+ - [*createTeam*](#createteam)
+ - [*updateTeam*](#updateteam)
+ - [*deleteTeam*](#deleteteam)
+ - [*createUserConversation*](#createuserconversation)
+ - [*updateUserConversation*](#updateuserconversation)
+ - [*markConversationAsRead*](#markconversationasread)
+ - [*incrementUnreadForUser*](#incrementunreadforuser)
+ - [*deleteUserConversation*](#deleteuserconversation)
+ - [*createAttireOption*](#createattireoption)
+ - [*updateAttireOption*](#updateattireoption)
+ - [*deleteAttireOption*](#deleteattireoption)
+ - [*createCourse*](#createcourse)
+ - [*updateCourse*](#updatecourse)
+ - [*deleteCourse*](#deletecourse)
+ - [*createEmergencyContact*](#createemergencycontact)
+ - [*updateEmergencyContact*](#updateemergencycontact)
+ - [*deleteEmergencyContact*](#deleteemergencycontact)
+ - [*createStaffCourse*](#createstaffcourse)
+ - [*updateStaffCourse*](#updatestaffcourse)
+ - [*deleteStaffCourse*](#deletestaffcourse)
+ - [*createTask*](#createtask)
+ - [*updateTask*](#updatetask)
+ - [*deleteTask*](#deletetask)
+ - [*CreateCertificate*](#createcertificate)
+ - [*UpdateCertificate*](#updatecertificate)
+ - [*DeleteCertificate*](#deletecertificate)
+ - [*createRole*](#createrole)
+ - [*updateRole*](#updaterole)
+ - [*deleteRole*](#deleterole)
+ - [*createClientFeedback*](#createclientfeedback)
+ - [*updateClientFeedback*](#updateclientfeedback)
+ - [*deleteClientFeedback*](#deleteclientfeedback)
+ - [*createBusiness*](#createbusiness)
+ - [*updateBusiness*](#updatebusiness)
+ - [*deleteBusiness*](#deletebusiness)
+ - [*createConversation*](#createconversation)
+ - [*updateConversation*](#updateconversation)
+ - [*updateConversationLastMessage*](#updateconversationlastmessage)
+ - [*deleteConversation*](#deleteconversation)
+ - [*createCustomRateCard*](#createcustomratecard)
+ - [*updateCustomRateCard*](#updatecustomratecard)
+ - [*deleteCustomRateCard*](#deletecustomratecard)
+ - [*createRecentPayment*](#createrecentpayment)
+ - [*updateRecentPayment*](#updaterecentpayment)
+ - [*deleteRecentPayment*](#deleterecentpayment)
+ - [*CreateUser*](#createuser)
+ - [*UpdateUser*](#updateuser)
+ - [*DeleteUser*](#deleteuser)
+ - [*createVendor*](#createvendor)
+ - [*updateVendor*](#updatevendor)
+ - [*deleteVendor*](#deletevendor)
+ - [*createDocument*](#createdocument)
+ - [*updateDocument*](#updatedocument)
+ - [*deleteDocument*](#deletedocument)
+ - [*createTaskComment*](#createtaskcomment)
+ - [*updateTaskComment*](#updatetaskcomment)
+ - [*deleteTaskComment*](#deletetaskcomment)
+ - [*createVendorBenefitPlan*](#createvendorbenefitplan)
+ - [*updateVendorBenefitPlan*](#updatevendorbenefitplan)
+ - [*deleteVendorBenefitPlan*](#deletevendorbenefitplan)
+ - [*createMessage*](#createmessage)
+ - [*updateMessage*](#updatemessage)
+ - [*deleteMessage*](#deletemessage)
+ - [*createWorkforce*](#createworkforce)
+ - [*updateWorkforce*](#updateworkforce)
+ - [*deactivateWorkforce*](#deactivateworkforce)
+ - [*createFaqData*](#createfaqdata)
+ - [*updateFaqData*](#updatefaqdata)
+ - [*deleteFaqData*](#deletefaqdata)
+ - [*createInvoice*](#createinvoice)
+ - [*updateInvoice*](#updateinvoice)
+ - [*deleteInvoice*](#deleteinvoice)
+ - [*createTeamHub*](#createteamhub)
+ - [*updateTeamHub*](#updateteamhub)
+ - [*deleteTeamHub*](#deleteteamhub)
+ - [*createHub*](#createhub)
+ - [*updateHub*](#updatehub)
+ - [*deleteHub*](#deletehub)
+ - [*createRoleCategory*](#createrolecategory)
+ - [*updateRoleCategory*](#updaterolecategory)
+ - [*deleteRoleCategory*](#deleterolecategory)
+ - [*createStaffAvailabilityStats*](#createstaffavailabilitystats)
+ - [*updateStaffAvailabilityStats*](#updatestaffavailabilitystats)
+ - [*deleteStaffAvailabilityStats*](#deletestaffavailabilitystats)
+ - [*createShiftRole*](#createshiftrole)
+ - [*updateShiftRole*](#updateshiftrole)
+ - [*deleteShiftRole*](#deleteshiftrole)
+ - [*createStaffRole*](#createstaffrole)
+ - [*deleteStaffRole*](#deletestaffrole)
+ - [*createAccount*](#createaccount)
+ - [*updateAccount*](#updateaccount)
+ - [*deleteAccount*](#deleteaccount)
+ - [*createApplication*](#createapplication)
+ - [*updateApplicationStatus*](#updateapplicationstatus)
+ - [*deleteApplication*](#deleteapplication)
+ - [*CreateAssignment*](#createassignment)
+ - [*UpdateAssignment*](#updateassignment)
+ - [*DeleteAssignment*](#deleteassignment)
+ - [*createInvoiceTemplate*](#createinvoicetemplate)
+ - [*updateInvoiceTemplate*](#updateinvoicetemplate)
+ - [*deleteInvoiceTemplate*](#deleteinvoicetemplate)
+ - [*createStaffAvailability*](#createstaffavailability)
+ - [*updateStaffAvailability*](#updatestaffavailability)
+ - [*deleteStaffAvailability*](#deletestaffavailability)
+ - [*createTeamMember*](#createteammember)
+ - [*updateTeamMember*](#updateteammember)
+ - [*updateTeamMemberInviteStatus*](#updateteammemberinvitestatus)
+ - [*acceptInviteByCode*](#acceptinvitebycode)
+ - [*cancelInviteByCode*](#cancelinvitebycode)
+ - [*deleteTeamMember*](#deleteteammember)
+ - [*createLevel*](#createlevel)
+ - [*updateLevel*](#updatelevel)
+ - [*deleteLevel*](#deletelevel)
+ - [*createOrder*](#createorder)
+ - [*updateOrder*](#updateorder)
+ - [*deleteOrder*](#deleteorder)
+ - [*createCategory*](#createcategory)
+ - [*updateCategory*](#updatecategory)
+ - [*deleteCategory*](#deletecategory)
+ - [*createTaxForm*](#createtaxform)
+ - [*updateTaxForm*](#updatetaxform)
+ - [*deleteTaxForm*](#deletetaxform)
+ - [*createVendorRate*](#createvendorrate)
+ - [*updateVendorRate*](#updatevendorrate)
+ - [*deleteVendorRate*](#deletevendorrate)
+ - [*createActivityLog*](#createactivitylog)
+ - [*updateActivityLog*](#updateactivitylog)
+ - [*markActivityLogAsRead*](#markactivitylogasread)
+ - [*markActivityLogsAsRead*](#markactivitylogsasread)
+ - [*deleteActivityLog*](#deleteactivitylog)
+ - [*createShift*](#createshift)
+ - [*updateShift*](#updateshift)
+ - [*deleteShift*](#deleteshift)
+ - [*CreateStaff*](#createstaff)
+ - [*UpdateStaff*](#updatestaff)
+ - [*DeleteStaff*](#deletestaff)
+
+# 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 `example`. 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 `example` 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).
+
+## listShifts
+You can execute the `listShifts` 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
+listShifts(vars?: ListShiftsVariables): QueryPromise;
+
+interface ListShiftsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: ListShiftsVariables): QueryRef;
+}
+export const listShiftsRef: ListShiftsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listShifts(dc: DataConnect, vars?: ListShiftsVariables): QueryPromise;
+
+interface ListShiftsRef {
+ ...
+ (dc: DataConnect, vars?: ListShiftsVariables): QueryRef;
+}
+export const listShiftsRef: ListShiftsRef;
+```
+
+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 listShiftsRef:
+```typescript
+const name = listShiftsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listShifts` query has an optional argument of type `ListShiftsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListShiftsVariables {
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listShifts` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListShiftsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListShiftsData {
+ shifts: ({
+ id: UUIDString;
+ title: string;
+ orderId: UUIDString;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ cost?: number | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ placeId?: string | null;
+ city?: string | null;
+ state?: string | null;
+ street?: string | null;
+ country?: string | null;
+ description?: string | null;
+ status?: ShiftStatus | null;
+ workersNeeded?: number | null;
+ filled?: number | null;
+ filledAt?: TimestampString | null;
+ managers?: unknown[] | null;
+ durationDays?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ businessId: UUIDString;
+ vendorId?: UUIDString | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key)[];
+}
+```
+### Using `listShifts`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listShifts, ListShiftsVariables } from '@dataconnect/generated';
+
+// The `listShifts` query has an optional argument of type `ListShiftsVariables`:
+const listShiftsVars: ListShiftsVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listShifts()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listShifts(listShiftsVars);
+// Variables can be defined inline as well.
+const { data } = await listShifts({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListShiftsVariables` argument.
+const { data } = await listShifts();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listShifts(dataConnect, listShiftsVars);
+
+console.log(data.shifts);
+
+// Or, you can use the `Promise` API.
+listShifts(listShiftsVars).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+### Using `listShifts`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listShiftsRef, ListShiftsVariables } from '@dataconnect/generated';
+
+// The `listShifts` query has an optional argument of type `ListShiftsVariables`:
+const listShiftsVars: ListShiftsVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listShiftsRef()` function to get a reference to the query.
+const ref = listShiftsRef(listShiftsVars);
+// Variables can be defined inline as well.
+const ref = listShiftsRef({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListShiftsVariables` argument.
+const ref = listShiftsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listShiftsRef(dataConnect, listShiftsVars);
+
+// 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.shifts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+## getShiftById
+You can execute the `getShiftById` 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
+getShiftById(vars: GetShiftByIdVariables): QueryPromise;
+
+interface GetShiftByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetShiftByIdVariables): QueryRef;
+}
+export const getShiftByIdRef: GetShiftByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getShiftById(dc: DataConnect, vars: GetShiftByIdVariables): QueryPromise;
+
+interface GetShiftByIdRef {
+ ...
+ (dc: DataConnect, vars: GetShiftByIdVariables): QueryRef;
+}
+export const getShiftByIdRef: GetShiftByIdRef;
+```
+
+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 getShiftByIdRef:
+```typescript
+const name = getShiftByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getShiftById` query requires an argument of type `GetShiftByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetShiftByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getShiftById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetShiftByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetShiftByIdData {
+ shift?: {
+ id: UUIDString;
+ title: string;
+ orderId: UUIDString;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ cost?: number | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ placeId?: string | null;
+ city?: string | null;
+ state?: string | null;
+ street?: string | null;
+ country?: string | null;
+ description?: string | null;
+ status?: ShiftStatus | null;
+ workersNeeded?: number | null;
+ filled?: number | null;
+ filledAt?: TimestampString | null;
+ managers?: unknown[] | null;
+ durationDays?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ businessId: UUIDString;
+ vendorId?: UUIDString | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+}
+```
+### Using `getShiftById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getShiftById, GetShiftByIdVariables } from '@dataconnect/generated';
+
+// The `getShiftById` query requires an argument of type `GetShiftByIdVariables`:
+const getShiftByIdVars: GetShiftByIdVariables = {
+ id: ...,
+};
+
+// Call the `getShiftById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getShiftById(getShiftByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getShiftById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getShiftById(dataConnect, getShiftByIdVars);
+
+console.log(data.shift);
+
+// Or, you can use the `Promise` API.
+getShiftById(getShiftByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.shift);
+});
+```
+
+### Using `getShiftById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getShiftByIdRef, GetShiftByIdVariables } from '@dataconnect/generated';
+
+// The `getShiftById` query requires an argument of type `GetShiftByIdVariables`:
+const getShiftByIdVars: GetShiftByIdVariables = {
+ id: ...,
+};
+
+// Call the `getShiftByIdRef()` function to get a reference to the query.
+const ref = getShiftByIdRef(getShiftByIdVars);
+// Variables can be defined inline as well.
+const ref = getShiftByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getShiftByIdRef(dataConnect, getShiftByIdVars);
+
+// 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.shift);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.shift);
+});
+```
+
+## filterShifts
+You can execute the `filterShifts` 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
+filterShifts(vars?: FilterShiftsVariables): QueryPromise;
+
+interface FilterShiftsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: FilterShiftsVariables): QueryRef;
+}
+export const filterShiftsRef: FilterShiftsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+filterShifts(dc: DataConnect, vars?: FilterShiftsVariables): QueryPromise;
+
+interface FilterShiftsRef {
+ ...
+ (dc: DataConnect, vars?: FilterShiftsVariables): QueryRef;
+}
+export const filterShiftsRef: FilterShiftsRef;
+```
+
+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 filterShiftsRef:
+```typescript
+const name = filterShiftsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `filterShifts` query has an optional argument of type `FilterShiftsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface FilterShiftsVariables {
+ status?: ShiftStatus | null;
+ orderId?: UUIDString | null;
+ dateFrom?: TimestampString | null;
+ dateTo?: TimestampString | null;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `filterShifts` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `FilterShiftsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface FilterShiftsData {
+ shifts: ({
+ id: UUIDString;
+ title: string;
+ orderId: UUIDString;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ cost?: number | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ placeId?: string | null;
+ city?: string | null;
+ state?: string | null;
+ street?: string | null;
+ country?: string | null;
+ description?: string | null;
+ status?: ShiftStatus | null;
+ workersNeeded?: number | null;
+ filled?: number | null;
+ filledAt?: TimestampString | null;
+ managers?: unknown[] | null;
+ durationDays?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ businessId: UUIDString;
+ vendorId?: UUIDString | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key)[];
+}
+```
+### Using `filterShifts`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, filterShifts, FilterShiftsVariables } from '@dataconnect/generated';
+
+// The `filterShifts` query has an optional argument of type `FilterShiftsVariables`:
+const filterShiftsVars: FilterShiftsVariables = {
+ status: ..., // optional
+ orderId: ..., // optional
+ dateFrom: ..., // optional
+ dateTo: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `filterShifts()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await filterShifts(filterShiftsVars);
+// Variables can be defined inline as well.
+const { data } = await filterShifts({ status: ..., orderId: ..., dateFrom: ..., dateTo: ..., offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `FilterShiftsVariables` argument.
+const { data } = await filterShifts();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await filterShifts(dataConnect, filterShiftsVars);
+
+console.log(data.shifts);
+
+// Or, you can use the `Promise` API.
+filterShifts(filterShiftsVars).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+### Using `filterShifts`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, filterShiftsRef, FilterShiftsVariables } from '@dataconnect/generated';
+
+// The `filterShifts` query has an optional argument of type `FilterShiftsVariables`:
+const filterShiftsVars: FilterShiftsVariables = {
+ status: ..., // optional
+ orderId: ..., // optional
+ dateFrom: ..., // optional
+ dateTo: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `filterShiftsRef()` function to get a reference to the query.
+const ref = filterShiftsRef(filterShiftsVars);
+// Variables can be defined inline as well.
+const ref = filterShiftsRef({ status: ..., orderId: ..., dateFrom: ..., dateTo: ..., offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `FilterShiftsVariables` argument.
+const ref = filterShiftsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = filterShiftsRef(dataConnect, filterShiftsVars);
+
+// 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.shifts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+## getShiftsByBusinessId
+You can execute the `getShiftsByBusinessId` 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
+getShiftsByBusinessId(vars: GetShiftsByBusinessIdVariables): QueryPromise;
+
+interface GetShiftsByBusinessIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetShiftsByBusinessIdVariables): QueryRef;
+}
+export const getShiftsByBusinessIdRef: GetShiftsByBusinessIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getShiftsByBusinessId(dc: DataConnect, vars: GetShiftsByBusinessIdVariables): QueryPromise;
+
+interface GetShiftsByBusinessIdRef {
+ ...
+ (dc: DataConnect, vars: GetShiftsByBusinessIdVariables): QueryRef;
+}
+export const getShiftsByBusinessIdRef: GetShiftsByBusinessIdRef;
+```
+
+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 getShiftsByBusinessIdRef:
+```typescript
+const name = getShiftsByBusinessIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getShiftsByBusinessId` query requires an argument of type `GetShiftsByBusinessIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetShiftsByBusinessIdVariables {
+ businessId: UUIDString;
+ dateFrom?: TimestampString | null;
+ dateTo?: TimestampString | null;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `getShiftsByBusinessId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetShiftsByBusinessIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetShiftsByBusinessIdData {
+ shifts: ({
+ id: UUIDString;
+ title: string;
+ orderId: UUIDString;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ cost?: number | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ placeId?: string | null;
+ city?: string | null;
+ state?: string | null;
+ street?: string | null;
+ country?: string | null;
+ description?: string | null;
+ status?: ShiftStatus | null;
+ workersNeeded?: number | null;
+ filled?: number | null;
+ filledAt?: TimestampString | null;
+ managers?: unknown[] | null;
+ durationDays?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ businessId: UUIDString;
+ vendorId?: UUIDString | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key)[];
+}
+```
+### Using `getShiftsByBusinessId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getShiftsByBusinessId, GetShiftsByBusinessIdVariables } from '@dataconnect/generated';
+
+// The `getShiftsByBusinessId` query requires an argument of type `GetShiftsByBusinessIdVariables`:
+const getShiftsByBusinessIdVars: GetShiftsByBusinessIdVariables = {
+ businessId: ...,
+ dateFrom: ..., // optional
+ dateTo: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getShiftsByBusinessId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getShiftsByBusinessId(getShiftsByBusinessIdVars);
+// Variables can be defined inline as well.
+const { data } = await getShiftsByBusinessId({ businessId: ..., dateFrom: ..., dateTo: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getShiftsByBusinessId(dataConnect, getShiftsByBusinessIdVars);
+
+console.log(data.shifts);
+
+// Or, you can use the `Promise` API.
+getShiftsByBusinessId(getShiftsByBusinessIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+### Using `getShiftsByBusinessId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getShiftsByBusinessIdRef, GetShiftsByBusinessIdVariables } from '@dataconnect/generated';
+
+// The `getShiftsByBusinessId` query requires an argument of type `GetShiftsByBusinessIdVariables`:
+const getShiftsByBusinessIdVars: GetShiftsByBusinessIdVariables = {
+ businessId: ...,
+ dateFrom: ..., // optional
+ dateTo: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getShiftsByBusinessIdRef()` function to get a reference to the query.
+const ref = getShiftsByBusinessIdRef(getShiftsByBusinessIdVars);
+// Variables can be defined inline as well.
+const ref = getShiftsByBusinessIdRef({ businessId: ..., dateFrom: ..., dateTo: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getShiftsByBusinessIdRef(dataConnect, getShiftsByBusinessIdVars);
+
+// 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.shifts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+## getShiftsByVendorId
+You can execute the `getShiftsByVendorId` 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
+getShiftsByVendorId(vars: GetShiftsByVendorIdVariables): QueryPromise;
+
+interface GetShiftsByVendorIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetShiftsByVendorIdVariables): QueryRef;
+}
+export const getShiftsByVendorIdRef: GetShiftsByVendorIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getShiftsByVendorId(dc: DataConnect, vars: GetShiftsByVendorIdVariables): QueryPromise;
+
+interface GetShiftsByVendorIdRef {
+ ...
+ (dc: DataConnect, vars: GetShiftsByVendorIdVariables): QueryRef;
+}
+export const getShiftsByVendorIdRef: GetShiftsByVendorIdRef;
+```
+
+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 getShiftsByVendorIdRef:
+```typescript
+const name = getShiftsByVendorIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getShiftsByVendorId` query requires an argument of type `GetShiftsByVendorIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetShiftsByVendorIdVariables {
+ vendorId: UUIDString;
+ dateFrom?: TimestampString | null;
+ dateTo?: TimestampString | null;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `getShiftsByVendorId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetShiftsByVendorIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetShiftsByVendorIdData {
+ shifts: ({
+ id: UUIDString;
+ title: string;
+ orderId: UUIDString;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ cost?: number | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ placeId?: string | null;
+ city?: string | null;
+ state?: string | null;
+ street?: string | null;
+ country?: string | null;
+ description?: string | null;
+ status?: ShiftStatus | null;
+ workersNeeded?: number | null;
+ filled?: number | null;
+ filledAt?: TimestampString | null;
+ managers?: unknown[] | null;
+ durationDays?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ businessId: UUIDString;
+ vendorId?: UUIDString | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key)[];
+}
+```
+### Using `getShiftsByVendorId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getShiftsByVendorId, GetShiftsByVendorIdVariables } from '@dataconnect/generated';
+
+// The `getShiftsByVendorId` query requires an argument of type `GetShiftsByVendorIdVariables`:
+const getShiftsByVendorIdVars: GetShiftsByVendorIdVariables = {
+ vendorId: ...,
+ dateFrom: ..., // optional
+ dateTo: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getShiftsByVendorId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getShiftsByVendorId(getShiftsByVendorIdVars);
+// Variables can be defined inline as well.
+const { data } = await getShiftsByVendorId({ vendorId: ..., dateFrom: ..., dateTo: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getShiftsByVendorId(dataConnect, getShiftsByVendorIdVars);
+
+console.log(data.shifts);
+
+// Or, you can use the `Promise` API.
+getShiftsByVendorId(getShiftsByVendorIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+### Using `getShiftsByVendorId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getShiftsByVendorIdRef, GetShiftsByVendorIdVariables } from '@dataconnect/generated';
+
+// The `getShiftsByVendorId` query requires an argument of type `GetShiftsByVendorIdVariables`:
+const getShiftsByVendorIdVars: GetShiftsByVendorIdVariables = {
+ vendorId: ...,
+ dateFrom: ..., // optional
+ dateTo: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getShiftsByVendorIdRef()` function to get a reference to the query.
+const ref = getShiftsByVendorIdRef(getShiftsByVendorIdVars);
+// Variables can be defined inline as well.
+const ref = getShiftsByVendorIdRef({ vendorId: ..., dateFrom: ..., dateTo: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getShiftsByVendorIdRef(dataConnect, getShiftsByVendorIdVars);
+
+// 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.shifts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.shifts);
+});
+```
+
+## listEmergencyContacts
+You can execute the `listEmergencyContacts` 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
+listEmergencyContacts(): QueryPromise;
+
+interface ListEmergencyContactsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listEmergencyContactsRef: ListEmergencyContactsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listEmergencyContacts(dc: DataConnect): QueryPromise;
+
+interface ListEmergencyContactsRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listEmergencyContactsRef: ListEmergencyContactsRef;
+```
+
+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 listEmergencyContactsRef:
+```typescript
+const name = listEmergencyContactsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listEmergencyContacts` query has no variables.
+### Return Type
+Recall that executing the `listEmergencyContacts` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListEmergencyContactsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListEmergencyContactsData {
+ emergencyContacts: ({
+ id: UUIDString;
+ name: string;
+ phone: string;
+ relationship: RelationshipType;
+ staffId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ } & EmergencyContact_Key)[];
+}
+```
+### Using `listEmergencyContacts`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listEmergencyContacts } from '@dataconnect/generated';
+
+
+// Call the `listEmergencyContacts()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listEmergencyContacts();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listEmergencyContacts(dataConnect);
+
+console.log(data.emergencyContacts);
+
+// Or, you can use the `Promise` API.
+listEmergencyContacts().then((response) => {
+ const data = response.data;
+ console.log(data.emergencyContacts);
+});
+```
+
+### Using `listEmergencyContacts`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listEmergencyContactsRef } from '@dataconnect/generated';
+
+
+// Call the `listEmergencyContactsRef()` function to get a reference to the query.
+const ref = listEmergencyContactsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listEmergencyContactsRef(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.emergencyContacts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.emergencyContacts);
+});
+```
+
+## getEmergencyContactById
+You can execute the `getEmergencyContactById` 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
+getEmergencyContactById(vars: GetEmergencyContactByIdVariables): QueryPromise;
+
+interface GetEmergencyContactByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetEmergencyContactByIdVariables): QueryRef;
+}
+export const getEmergencyContactByIdRef: GetEmergencyContactByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getEmergencyContactById(dc: DataConnect, vars: GetEmergencyContactByIdVariables): QueryPromise;
+
+interface GetEmergencyContactByIdRef {
+ ...
+ (dc: DataConnect, vars: GetEmergencyContactByIdVariables): QueryRef;
+}
+export const getEmergencyContactByIdRef: GetEmergencyContactByIdRef;
+```
+
+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 getEmergencyContactByIdRef:
+```typescript
+const name = getEmergencyContactByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getEmergencyContactById` query requires an argument of type `GetEmergencyContactByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetEmergencyContactByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getEmergencyContactById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetEmergencyContactByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetEmergencyContactByIdData {
+ emergencyContact?: {
+ id: UUIDString;
+ name: string;
+ phone: string;
+ relationship: RelationshipType;
+ staffId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ } & EmergencyContact_Key;
+}
+```
+### Using `getEmergencyContactById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getEmergencyContactById, GetEmergencyContactByIdVariables } from '@dataconnect/generated';
+
+// The `getEmergencyContactById` query requires an argument of type `GetEmergencyContactByIdVariables`:
+const getEmergencyContactByIdVars: GetEmergencyContactByIdVariables = {
+ id: ...,
+};
+
+// Call the `getEmergencyContactById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getEmergencyContactById(getEmergencyContactByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getEmergencyContactById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getEmergencyContactById(dataConnect, getEmergencyContactByIdVars);
+
+console.log(data.emergencyContact);
+
+// Or, you can use the `Promise` API.
+getEmergencyContactById(getEmergencyContactByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.emergencyContact);
+});
+```
+
+### Using `getEmergencyContactById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getEmergencyContactByIdRef, GetEmergencyContactByIdVariables } from '@dataconnect/generated';
+
+// The `getEmergencyContactById` query requires an argument of type `GetEmergencyContactByIdVariables`:
+const getEmergencyContactByIdVars: GetEmergencyContactByIdVariables = {
+ id: ...,
+};
+
+// Call the `getEmergencyContactByIdRef()` function to get a reference to the query.
+const ref = getEmergencyContactByIdRef(getEmergencyContactByIdVars);
+// Variables can be defined inline as well.
+const ref = getEmergencyContactByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getEmergencyContactByIdRef(dataConnect, getEmergencyContactByIdVars);
+
+// 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.emergencyContact);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.emergencyContact);
+});
+```
+
+## getEmergencyContactsByStaffId
+You can execute the `getEmergencyContactsByStaffId` 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
+getEmergencyContactsByStaffId(vars: GetEmergencyContactsByStaffIdVariables): QueryPromise;
+
+interface GetEmergencyContactsByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetEmergencyContactsByStaffIdVariables): QueryRef;
+}
+export const getEmergencyContactsByStaffIdRef: GetEmergencyContactsByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getEmergencyContactsByStaffId(dc: DataConnect, vars: GetEmergencyContactsByStaffIdVariables): QueryPromise;
+
+interface GetEmergencyContactsByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: GetEmergencyContactsByStaffIdVariables): QueryRef;
+}
+export const getEmergencyContactsByStaffIdRef: GetEmergencyContactsByStaffIdRef;
+```
+
+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 getEmergencyContactsByStaffIdRef:
+```typescript
+const name = getEmergencyContactsByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getEmergencyContactsByStaffId` query requires an argument of type `GetEmergencyContactsByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetEmergencyContactsByStaffIdVariables {
+ staffId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getEmergencyContactsByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetEmergencyContactsByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetEmergencyContactsByStaffIdData {
+ emergencyContacts: ({
+ id: UUIDString;
+ name: string;
+ phone: string;
+ relationship: RelationshipType;
+ staffId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ } & EmergencyContact_Key)[];
+}
+```
+### Using `getEmergencyContactsByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getEmergencyContactsByStaffId, GetEmergencyContactsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `getEmergencyContactsByStaffId` query requires an argument of type `GetEmergencyContactsByStaffIdVariables`:
+const getEmergencyContactsByStaffIdVars: GetEmergencyContactsByStaffIdVariables = {
+ staffId: ...,
+};
+
+// Call the `getEmergencyContactsByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getEmergencyContactsByStaffId(getEmergencyContactsByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await getEmergencyContactsByStaffId({ staffId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getEmergencyContactsByStaffId(dataConnect, getEmergencyContactsByStaffIdVars);
+
+console.log(data.emergencyContacts);
+
+// Or, you can use the `Promise` API.
+getEmergencyContactsByStaffId(getEmergencyContactsByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.emergencyContacts);
+});
+```
+
+### Using `getEmergencyContactsByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getEmergencyContactsByStaffIdRef, GetEmergencyContactsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `getEmergencyContactsByStaffId` query requires an argument of type `GetEmergencyContactsByStaffIdVariables`:
+const getEmergencyContactsByStaffIdVars: GetEmergencyContactsByStaffIdVariables = {
+ staffId: ...,
+};
+
+// Call the `getEmergencyContactsByStaffIdRef()` function to get a reference to the query.
+const ref = getEmergencyContactsByStaffIdRef(getEmergencyContactsByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = getEmergencyContactsByStaffIdRef({ staffId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getEmergencyContactsByStaffIdRef(dataConnect, getEmergencyContactsByStaffIdVars);
+
+// 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.emergencyContacts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.emergencyContacts);
+});
+```
+
+## getMyTasks
+You can execute the `getMyTasks` 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
+getMyTasks(vars: GetMyTasksVariables): QueryPromise;
+
+interface GetMyTasksRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetMyTasksVariables): QueryRef;
+}
+export const getMyTasksRef: GetMyTasksRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getMyTasks(dc: DataConnect, vars: GetMyTasksVariables): QueryPromise;
+
+interface GetMyTasksRef {
+ ...
+ (dc: DataConnect, vars: GetMyTasksVariables): QueryRef;
+}
+export const getMyTasksRef: GetMyTasksRef;
+```
+
+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 getMyTasksRef:
+```typescript
+const name = getMyTasksRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getMyTasks` query requires an argument of type `GetMyTasksVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetMyTasksVariables {
+ teamMemberId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getMyTasks` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetMyTasksData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetMyTasksData {
+ memberTasks: ({
+ id: UUIDString;
+ task: {
+ id: UUIDString;
+ taskName: string;
+ description?: string | null;
+ status: TaskStatus;
+ dueDate?: TimestampString | null;
+ progress?: number | null;
+ priority: TaskPriority;
+ } & Task_Key;
+ teamMember: {
+ user: {
+ fullName?: string | null;
+ email?: string | null;
+ };
+ };
+ })[];
+}
+```
+### Using `getMyTasks`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getMyTasks, GetMyTasksVariables } from '@dataconnect/generated';
+
+// The `getMyTasks` query requires an argument of type `GetMyTasksVariables`:
+const getMyTasksVars: GetMyTasksVariables = {
+ teamMemberId: ...,
+};
+
+// Call the `getMyTasks()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getMyTasks(getMyTasksVars);
+// Variables can be defined inline as well.
+const { data } = await getMyTasks({ teamMemberId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getMyTasks(dataConnect, getMyTasksVars);
+
+console.log(data.memberTasks);
+
+// Or, you can use the `Promise` API.
+getMyTasks(getMyTasksVars).then((response) => {
+ const data = response.data;
+ console.log(data.memberTasks);
+});
+```
+
+### Using `getMyTasks`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getMyTasksRef, GetMyTasksVariables } from '@dataconnect/generated';
+
+// The `getMyTasks` query requires an argument of type `GetMyTasksVariables`:
+const getMyTasksVars: GetMyTasksVariables = {
+ teamMemberId: ...,
+};
+
+// Call the `getMyTasksRef()` function to get a reference to the query.
+const ref = getMyTasksRef(getMyTasksVars);
+// Variables can be defined inline as well.
+const ref = getMyTasksRef({ teamMemberId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getMyTasksRef(dataConnect, getMyTasksVars);
+
+// 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.memberTasks);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.memberTasks);
+});
+```
+
+## getMemberTaskByIdKey
+You can execute the `getMemberTaskByIdKey` 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
+getMemberTaskByIdKey(vars: GetMemberTaskByIdKeyVariables): QueryPromise;
+
+interface GetMemberTaskByIdKeyRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetMemberTaskByIdKeyVariables): QueryRef;
+}
+export const getMemberTaskByIdKeyRef: GetMemberTaskByIdKeyRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getMemberTaskByIdKey(dc: DataConnect, vars: GetMemberTaskByIdKeyVariables): QueryPromise;
+
+interface GetMemberTaskByIdKeyRef {
+ ...
+ (dc: DataConnect, vars: GetMemberTaskByIdKeyVariables): QueryRef;
+}
+export const getMemberTaskByIdKeyRef: GetMemberTaskByIdKeyRef;
+```
+
+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 getMemberTaskByIdKeyRef:
+```typescript
+const name = getMemberTaskByIdKeyRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getMemberTaskByIdKey` query requires an argument of type `GetMemberTaskByIdKeyVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetMemberTaskByIdKeyVariables {
+ teamMemberId: UUIDString;
+ taskId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getMemberTaskByIdKey` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetMemberTaskByIdKeyData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetMemberTaskByIdKeyData {
+ memberTask?: {
+ id: UUIDString;
+ task: {
+ id: UUIDString;
+ taskName: string;
+ description?: string | null;
+ status: TaskStatus;
+ dueDate?: TimestampString | null;
+ progress?: number | null;
+ priority: TaskPriority;
+ } & Task_Key;
+ teamMember: {
+ user: {
+ fullName?: string | null;
+ email?: string | null;
+ };
+ };
+ };
+}
+```
+### Using `getMemberTaskByIdKey`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getMemberTaskByIdKey, GetMemberTaskByIdKeyVariables } from '@dataconnect/generated';
+
+// The `getMemberTaskByIdKey` query requires an argument of type `GetMemberTaskByIdKeyVariables`:
+const getMemberTaskByIdKeyVars: GetMemberTaskByIdKeyVariables = {
+ teamMemberId: ...,
+ taskId: ...,
+};
+
+// Call the `getMemberTaskByIdKey()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getMemberTaskByIdKey(getMemberTaskByIdKeyVars);
+// Variables can be defined inline as well.
+const { data } = await getMemberTaskByIdKey({ teamMemberId: ..., taskId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getMemberTaskByIdKey(dataConnect, getMemberTaskByIdKeyVars);
+
+console.log(data.memberTask);
+
+// Or, you can use the `Promise` API.
+getMemberTaskByIdKey(getMemberTaskByIdKeyVars).then((response) => {
+ const data = response.data;
+ console.log(data.memberTask);
+});
+```
+
+### Using `getMemberTaskByIdKey`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getMemberTaskByIdKeyRef, GetMemberTaskByIdKeyVariables } from '@dataconnect/generated';
+
+// The `getMemberTaskByIdKey` query requires an argument of type `GetMemberTaskByIdKeyVariables`:
+const getMemberTaskByIdKeyVars: GetMemberTaskByIdKeyVariables = {
+ teamMemberId: ...,
+ taskId: ...,
+};
+
+// Call the `getMemberTaskByIdKeyRef()` function to get a reference to the query.
+const ref = getMemberTaskByIdKeyRef(getMemberTaskByIdKeyVars);
+// Variables can be defined inline as well.
+const ref = getMemberTaskByIdKeyRef({ teamMemberId: ..., taskId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getMemberTaskByIdKeyRef(dataConnect, getMemberTaskByIdKeyVars);
+
+// 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.memberTask);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.memberTask);
+});
+```
+
+## getMemberTasksByTaskId
+You can execute the `getMemberTasksByTaskId` 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
+getMemberTasksByTaskId(vars: GetMemberTasksByTaskIdVariables): QueryPromise;
+
+interface GetMemberTasksByTaskIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetMemberTasksByTaskIdVariables): QueryRef;
+}
+export const getMemberTasksByTaskIdRef: GetMemberTasksByTaskIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getMemberTasksByTaskId(dc: DataConnect, vars: GetMemberTasksByTaskIdVariables): QueryPromise;
+
+interface GetMemberTasksByTaskIdRef {
+ ...
+ (dc: DataConnect, vars: GetMemberTasksByTaskIdVariables): QueryRef;
+}
+export const getMemberTasksByTaskIdRef: GetMemberTasksByTaskIdRef;
+```
+
+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 getMemberTasksByTaskIdRef:
+```typescript
+const name = getMemberTasksByTaskIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getMemberTasksByTaskId` query requires an argument of type `GetMemberTasksByTaskIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetMemberTasksByTaskIdVariables {
+ taskId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getMemberTasksByTaskId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetMemberTasksByTaskIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetMemberTasksByTaskIdData {
+ memberTasks: ({
+ id: UUIDString;
+ task: {
+ id: UUIDString;
+ taskName: string;
+ description?: string | null;
+ status: TaskStatus;
+ dueDate?: TimestampString | null;
+ progress?: number | null;
+ priority: TaskPriority;
+ } & Task_Key;
+ teamMember: {
+ user: {
+ fullName?: string | null;
+ email?: string | null;
+ };
+ };
+ })[];
+}
+```
+### Using `getMemberTasksByTaskId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getMemberTasksByTaskId, GetMemberTasksByTaskIdVariables } from '@dataconnect/generated';
+
+// The `getMemberTasksByTaskId` query requires an argument of type `GetMemberTasksByTaskIdVariables`:
+const getMemberTasksByTaskIdVars: GetMemberTasksByTaskIdVariables = {
+ taskId: ...,
+};
+
+// Call the `getMemberTasksByTaskId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getMemberTasksByTaskId(getMemberTasksByTaskIdVars);
+// Variables can be defined inline as well.
+const { data } = await getMemberTasksByTaskId({ taskId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getMemberTasksByTaskId(dataConnect, getMemberTasksByTaskIdVars);
+
+console.log(data.memberTasks);
+
+// Or, you can use the `Promise` API.
+getMemberTasksByTaskId(getMemberTasksByTaskIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.memberTasks);
+});
+```
+
+### Using `getMemberTasksByTaskId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getMemberTasksByTaskIdRef, GetMemberTasksByTaskIdVariables } from '@dataconnect/generated';
+
+// The `getMemberTasksByTaskId` query requires an argument of type `GetMemberTasksByTaskIdVariables`:
+const getMemberTasksByTaskIdVars: GetMemberTasksByTaskIdVariables = {
+ taskId: ...,
+};
+
+// Call the `getMemberTasksByTaskIdRef()` function to get a reference to the query.
+const ref = getMemberTasksByTaskIdRef(getMemberTasksByTaskIdVars);
+// Variables can be defined inline as well.
+const ref = getMemberTasksByTaskIdRef({ taskId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getMemberTasksByTaskIdRef(dataConnect, getMemberTasksByTaskIdVars);
+
+// 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.memberTasks);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.memberTasks);
+});
+```
+
+## listCertificates
+You can execute the `listCertificates` 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
+listCertificates(): QueryPromise;
+
+interface ListCertificatesRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listCertificatesRef: ListCertificatesRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listCertificates(dc: DataConnect): QueryPromise;
+
+interface ListCertificatesRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listCertificatesRef: ListCertificatesRef;
+```
+
+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 listCertificatesRef:
+```typescript
+const name = listCertificatesRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listCertificates` query has no variables.
+### Return Type
+Recall that executing the `listCertificates` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListCertificatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListCertificatesData {
+ certificates: ({
+ id: UUIDString;
+ name: string;
+ description?: string | null;
+ expiry?: TimestampString | null;
+ status: CertificateStatus;
+ fileUrl?: string | null;
+ icon?: string | null;
+ staffId: UUIDString;
+ certificationType?: ComplianceType | null;
+ issuer?: string | null;
+ validationStatus?: ValidationStatus | null;
+ certificateNumber?: string | null;
+ createdAt?: TimestampString | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Certificate_Key)[];
+}
+```
+### Using `listCertificates`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listCertificates } from '@dataconnect/generated';
+
+
+// Call the `listCertificates()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listCertificates();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listCertificates(dataConnect);
+
+console.log(data.certificates);
+
+// Or, you can use the `Promise` API.
+listCertificates().then((response) => {
+ const data = response.data;
+ console.log(data.certificates);
+});
+```
+
+### Using `listCertificates`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listCertificatesRef } from '@dataconnect/generated';
+
+
+// Call the `listCertificatesRef()` function to get a reference to the query.
+const ref = listCertificatesRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listCertificatesRef(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.certificates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.certificates);
+});
+```
+
+## getCertificateById
+You can execute the `getCertificateById` 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
+getCertificateById(vars: GetCertificateByIdVariables): QueryPromise;
+
+interface GetCertificateByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetCertificateByIdVariables): QueryRef;
+}
+export const getCertificateByIdRef: GetCertificateByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getCertificateById(dc: DataConnect, vars: GetCertificateByIdVariables): QueryPromise;
+
+interface GetCertificateByIdRef {
+ ...
+ (dc: DataConnect, vars: GetCertificateByIdVariables): QueryRef;
+}
+export const getCertificateByIdRef: GetCertificateByIdRef;
+```
+
+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 getCertificateByIdRef:
+```typescript
+const name = getCertificateByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getCertificateById` query requires an argument of type `GetCertificateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetCertificateByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getCertificateById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetCertificateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetCertificateByIdData {
+ certificate?: {
+ id: UUIDString;
+ name: string;
+ description?: string | null;
+ expiry?: TimestampString | null;
+ status: CertificateStatus;
+ fileUrl?: string | null;
+ icon?: string | null;
+ certificationType?: ComplianceType | null;
+ issuer?: string | null;
+ staffId: UUIDString;
+ validationStatus?: ValidationStatus | null;
+ certificateNumber?: string | null;
+ updatedAt?: TimestampString | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Certificate_Key;
+}
+```
+### Using `getCertificateById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getCertificateById, GetCertificateByIdVariables } from '@dataconnect/generated';
+
+// The `getCertificateById` query requires an argument of type `GetCertificateByIdVariables`:
+const getCertificateByIdVars: GetCertificateByIdVariables = {
+ id: ...,
+};
+
+// Call the `getCertificateById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getCertificateById(getCertificateByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getCertificateById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getCertificateById(dataConnect, getCertificateByIdVars);
+
+console.log(data.certificate);
+
+// Or, you can use the `Promise` API.
+getCertificateById(getCertificateByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.certificate);
+});
+```
+
+### Using `getCertificateById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getCertificateByIdRef, GetCertificateByIdVariables } from '@dataconnect/generated';
+
+// The `getCertificateById` query requires an argument of type `GetCertificateByIdVariables`:
+const getCertificateByIdVars: GetCertificateByIdVariables = {
+ id: ...,
+};
+
+// Call the `getCertificateByIdRef()` function to get a reference to the query.
+const ref = getCertificateByIdRef(getCertificateByIdVars);
+// Variables can be defined inline as well.
+const ref = getCertificateByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getCertificateByIdRef(dataConnect, getCertificateByIdVars);
+
+// 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.certificate);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.certificate);
+});
+```
+
+## listCertificatesByStaffId
+You can execute the `listCertificatesByStaffId` 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
+listCertificatesByStaffId(vars: ListCertificatesByStaffIdVariables): QueryPromise;
+
+interface ListCertificatesByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListCertificatesByStaffIdVariables): QueryRef;
+}
+export const listCertificatesByStaffIdRef: ListCertificatesByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listCertificatesByStaffId(dc: DataConnect, vars: ListCertificatesByStaffIdVariables): QueryPromise;
+
+interface ListCertificatesByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: ListCertificatesByStaffIdVariables): QueryRef;
+}
+export const listCertificatesByStaffIdRef: ListCertificatesByStaffIdRef;
+```
+
+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 listCertificatesByStaffIdRef:
+```typescript
+const name = listCertificatesByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listCertificatesByStaffId` query requires an argument of type `ListCertificatesByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListCertificatesByStaffIdVariables {
+ staffId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `listCertificatesByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListCertificatesByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListCertificatesByStaffIdData {
+ certificates: ({
+ id: UUIDString;
+ name: string;
+ description?: string | null;
+ expiry?: TimestampString | null;
+ status: CertificateStatus;
+ fileUrl?: string | null;
+ icon?: string | null;
+ staffId: UUIDString;
+ certificationType?: ComplianceType | null;
+ issuer?: string | null;
+ validationStatus?: ValidationStatus | null;
+ certificateNumber?: string | null;
+ createdAt?: TimestampString | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Certificate_Key)[];
+}
+```
+### Using `listCertificatesByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listCertificatesByStaffId, ListCertificatesByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listCertificatesByStaffId` query requires an argument of type `ListCertificatesByStaffIdVariables`:
+const listCertificatesByStaffIdVars: ListCertificatesByStaffIdVariables = {
+ staffId: ...,
+};
+
+// Call the `listCertificatesByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listCertificatesByStaffId(listCertificatesByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await listCertificatesByStaffId({ staffId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listCertificatesByStaffId(dataConnect, listCertificatesByStaffIdVars);
+
+console.log(data.certificates);
+
+// Or, you can use the `Promise` API.
+listCertificatesByStaffId(listCertificatesByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.certificates);
+});
+```
+
+### Using `listCertificatesByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listCertificatesByStaffIdRef, ListCertificatesByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listCertificatesByStaffId` query requires an argument of type `ListCertificatesByStaffIdVariables`:
+const listCertificatesByStaffIdVars: ListCertificatesByStaffIdVariables = {
+ staffId: ...,
+};
+
+// Call the `listCertificatesByStaffIdRef()` function to get a reference to the query.
+const ref = listCertificatesByStaffIdRef(listCertificatesByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = listCertificatesByStaffIdRef({ staffId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listCertificatesByStaffIdRef(dataConnect, listCertificatesByStaffIdVars);
+
+// 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.certificates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.certificates);
+});
+```
+
+## listAssignments
+You can execute the `listAssignments` 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
+listAssignments(vars?: ListAssignmentsVariables): QueryPromise;
+
+interface ListAssignmentsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: ListAssignmentsVariables): QueryRef;
+}
+export const listAssignmentsRef: ListAssignmentsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAssignments(dc: DataConnect, vars?: ListAssignmentsVariables): QueryPromise;
+
+interface ListAssignmentsRef {
+ ...
+ (dc: DataConnect, vars?: ListAssignmentsVariables): QueryRef;
+}
+export const listAssignmentsRef: ListAssignmentsRef;
+```
+
+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 listAssignmentsRef:
+```typescript
+const name = listAssignmentsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAssignments` query has an optional argument of type `ListAssignmentsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListAssignmentsVariables {
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listAssignments` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAssignmentsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAssignmentsData {
+ assignments: ({
+ id: UUIDString;
+ title?: string | null;
+ status?: AssignmentStatus | null;
+ createdAt?: TimestampString | null;
+ workforce: {
+ id: UUIDString;
+ workforceNumber: string;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Workforce_Key;
+ shiftRole: {
+ id: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ };
+ } & Assignment_Key)[];
+}
+```
+### Using `listAssignments`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAssignments, ListAssignmentsVariables } from '@dataconnect/generated';
+
+// The `listAssignments` query has an optional argument of type `ListAssignmentsVariables`:
+const listAssignmentsVars: ListAssignmentsVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignments()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAssignments(listAssignmentsVars);
+// Variables can be defined inline as well.
+const { data } = await listAssignments({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListAssignmentsVariables` argument.
+const { data } = await listAssignments();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAssignments(dataConnect, listAssignmentsVars);
+
+console.log(data.assignments);
+
+// Or, you can use the `Promise` API.
+listAssignments(listAssignmentsVars).then((response) => {
+ const data = response.data;
+ console.log(data.assignments);
+});
+```
+
+### Using `listAssignments`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsRef, ListAssignmentsVariables } from '@dataconnect/generated';
+
+// The `listAssignments` query has an optional argument of type `ListAssignmentsVariables`:
+const listAssignmentsVars: ListAssignmentsVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsRef()` function to get a reference to the query.
+const ref = listAssignmentsRef(listAssignmentsVars);
+// Variables can be defined inline as well.
+const ref = listAssignmentsRef({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListAssignmentsVariables` argument.
+const ref = listAssignmentsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAssignmentsRef(dataConnect, listAssignmentsVars);
+
+// 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;
+ title?: string | null;
+ description?: string | null;
+ instructions?: string | null;
+ status?: AssignmentStatus | null;
+ tipsAvailable?: boolean | null;
+ travelTime?: boolean | null;
+ mealProvided?: boolean | null;
+ parkingAvailable?: boolean | null;
+ gasCompensation?: boolean | null;
+ managers?: unknown[] | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ workforce: {
+ id: UUIDString;
+ workforceNumber: string;
+ status?: WorkforceStatus | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Workforce_Key;
+ shiftRole: {
+ id: UUIDString;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ breakType?: BreakDuration | null;
+ uniform?: string | null;
+ department?: string | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ status?: ShiftStatus | null;
+ managers?: unknown[] | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ orderType: OrderType;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ };
+ } & 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);
+});
+```
+
+## listAssignmentsByWorkforceId
+You can execute the `listAssignmentsByWorkforceId` 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
+listAssignmentsByWorkforceId(vars: ListAssignmentsByWorkforceIdVariables): QueryPromise;
+
+interface ListAssignmentsByWorkforceIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListAssignmentsByWorkforceIdVariables): QueryRef;
+}
+export const listAssignmentsByWorkforceIdRef: ListAssignmentsByWorkforceIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAssignmentsByWorkforceId(dc: DataConnect, vars: ListAssignmentsByWorkforceIdVariables): QueryPromise;
+
+interface ListAssignmentsByWorkforceIdRef {
+ ...
+ (dc: DataConnect, vars: ListAssignmentsByWorkforceIdVariables): QueryRef;
+}
+export const listAssignmentsByWorkforceIdRef: ListAssignmentsByWorkforceIdRef;
+```
+
+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 listAssignmentsByWorkforceIdRef:
+```typescript
+const name = listAssignmentsByWorkforceIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAssignmentsByWorkforceId` query requires an argument of type `ListAssignmentsByWorkforceIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListAssignmentsByWorkforceIdVariables {
+ workforceId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listAssignmentsByWorkforceId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAssignmentsByWorkforceIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAssignmentsByWorkforceIdData {
+ assignments: ({
+ id: UUIDString;
+ title?: string | null;
+ status?: AssignmentStatus | null;
+ createdAt?: TimestampString | null;
+ workforce: {
+ id: UUIDString;
+ workforceNumber: string;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Workforce_Key;
+ shiftRole: {
+ id: UUIDString;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ };
+ } & Assignment_Key)[];
+}
+```
+### Using `listAssignmentsByWorkforceId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsByWorkforceId, ListAssignmentsByWorkforceIdVariables } from '@dataconnect/generated';
+
+// The `listAssignmentsByWorkforceId` query requires an argument of type `ListAssignmentsByWorkforceIdVariables`:
+const listAssignmentsByWorkforceIdVars: ListAssignmentsByWorkforceIdVariables = {
+ workforceId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsByWorkforceId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAssignmentsByWorkforceId(listAssignmentsByWorkforceIdVars);
+// Variables can be defined inline as well.
+const { data } = await listAssignmentsByWorkforceId({ workforceId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAssignmentsByWorkforceId(dataConnect, listAssignmentsByWorkforceIdVars);
+
+console.log(data.assignments);
+
+// Or, you can use the `Promise` API.
+listAssignmentsByWorkforceId(listAssignmentsByWorkforceIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.assignments);
+});
+```
+
+### Using `listAssignmentsByWorkforceId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsByWorkforceIdRef, ListAssignmentsByWorkforceIdVariables } from '@dataconnect/generated';
+
+// The `listAssignmentsByWorkforceId` query requires an argument of type `ListAssignmentsByWorkforceIdVariables`:
+const listAssignmentsByWorkforceIdVars: ListAssignmentsByWorkforceIdVariables = {
+ workforceId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsByWorkforceIdRef()` function to get a reference to the query.
+const ref = listAssignmentsByWorkforceIdRef(listAssignmentsByWorkforceIdVars);
+// Variables can be defined inline as well.
+const ref = listAssignmentsByWorkforceIdRef({ workforceId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAssignmentsByWorkforceIdRef(dataConnect, listAssignmentsByWorkforceIdVars);
+
+// 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);
+});
+```
+
+## listAssignmentsByWorkforceIds
+You can execute the `listAssignmentsByWorkforceIds` 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
+listAssignmentsByWorkforceIds(vars: ListAssignmentsByWorkforceIdsVariables): QueryPromise;
+
+interface ListAssignmentsByWorkforceIdsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListAssignmentsByWorkforceIdsVariables): QueryRef;
+}
+export const listAssignmentsByWorkforceIdsRef: ListAssignmentsByWorkforceIdsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAssignmentsByWorkforceIds(dc: DataConnect, vars: ListAssignmentsByWorkforceIdsVariables): QueryPromise;
+
+interface ListAssignmentsByWorkforceIdsRef {
+ ...
+ (dc: DataConnect, vars: ListAssignmentsByWorkforceIdsVariables): QueryRef;
+}
+export const listAssignmentsByWorkforceIdsRef: ListAssignmentsByWorkforceIdsRef;
+```
+
+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 listAssignmentsByWorkforceIdsRef:
+```typescript
+const name = listAssignmentsByWorkforceIdsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAssignmentsByWorkforceIds` query requires an argument of type `ListAssignmentsByWorkforceIdsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListAssignmentsByWorkforceIdsVariables {
+ workforceIds: UUIDString[];
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listAssignmentsByWorkforceIds` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAssignmentsByWorkforceIdsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAssignmentsByWorkforceIdsData {
+ assignments: ({
+ id: UUIDString;
+ title?: string | null;
+ status?: AssignmentStatus | null;
+ createdAt?: TimestampString | null;
+ workforce: {
+ id: UUIDString;
+ workforceNumber: string;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Workforce_Key;
+ shiftRole: {
+ id: UUIDString;
+ role: {
+ id: UUIDString;
+ name: string;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ };
+ } & Assignment_Key)[];
+}
+```
+### Using `listAssignmentsByWorkforceIds`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsByWorkforceIds, ListAssignmentsByWorkforceIdsVariables } from '@dataconnect/generated';
+
+// The `listAssignmentsByWorkforceIds` query requires an argument of type `ListAssignmentsByWorkforceIdsVariables`:
+const listAssignmentsByWorkforceIdsVars: ListAssignmentsByWorkforceIdsVariables = {
+ workforceIds: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsByWorkforceIds()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAssignmentsByWorkforceIds(listAssignmentsByWorkforceIdsVars);
+// Variables can be defined inline as well.
+const { data } = await listAssignmentsByWorkforceIds({ workforceIds: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAssignmentsByWorkforceIds(dataConnect, listAssignmentsByWorkforceIdsVars);
+
+console.log(data.assignments);
+
+// Or, you can use the `Promise` API.
+listAssignmentsByWorkforceIds(listAssignmentsByWorkforceIdsVars).then((response) => {
+ const data = response.data;
+ console.log(data.assignments);
+});
+```
+
+### Using `listAssignmentsByWorkforceIds`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsByWorkforceIdsRef, ListAssignmentsByWorkforceIdsVariables } from '@dataconnect/generated';
+
+// The `listAssignmentsByWorkforceIds` query requires an argument of type `ListAssignmentsByWorkforceIdsVariables`:
+const listAssignmentsByWorkforceIdsVars: ListAssignmentsByWorkforceIdsVariables = {
+ workforceIds: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsByWorkforceIdsRef()` function to get a reference to the query.
+const ref = listAssignmentsByWorkforceIdsRef(listAssignmentsByWorkforceIdsVars);
+// Variables can be defined inline as well.
+const ref = listAssignmentsByWorkforceIdsRef({ workforceIds: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAssignmentsByWorkforceIdsRef(dataConnect, listAssignmentsByWorkforceIdsVars);
+
+// 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);
+});
+```
+
+## listAssignmentsByShiftRole
+You can execute the `listAssignmentsByShiftRole` 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
+listAssignmentsByShiftRole(vars: ListAssignmentsByShiftRoleVariables): QueryPromise;
+
+interface ListAssignmentsByShiftRoleRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListAssignmentsByShiftRoleVariables): QueryRef;
+}
+export const listAssignmentsByShiftRoleRef: ListAssignmentsByShiftRoleRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAssignmentsByShiftRole(dc: DataConnect, vars: ListAssignmentsByShiftRoleVariables): QueryPromise;
+
+interface ListAssignmentsByShiftRoleRef {
+ ...
+ (dc: DataConnect, vars: ListAssignmentsByShiftRoleVariables): QueryRef;
+}
+export const listAssignmentsByShiftRoleRef: ListAssignmentsByShiftRoleRef;
+```
+
+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 listAssignmentsByShiftRoleRef:
+```typescript
+const name = listAssignmentsByShiftRoleRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAssignmentsByShiftRole` query requires an argument of type `ListAssignmentsByShiftRoleVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListAssignmentsByShiftRoleVariables {
+ shiftId: UUIDString;
+ roleId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listAssignmentsByShiftRole` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAssignmentsByShiftRoleData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAssignmentsByShiftRoleData {
+ assignments: ({
+ id: UUIDString;
+ title?: string | null;
+ status?: AssignmentStatus | null;
+ createdAt?: TimestampString | null;
+ workforce: {
+ id: UUIDString;
+ workforceNumber: string;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Workforce_Key;
+ } & Assignment_Key)[];
+}
+```
+### Using `listAssignmentsByShiftRole`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsByShiftRole, ListAssignmentsByShiftRoleVariables } from '@dataconnect/generated';
+
+// The `listAssignmentsByShiftRole` query requires an argument of type `ListAssignmentsByShiftRoleVariables`:
+const listAssignmentsByShiftRoleVars: ListAssignmentsByShiftRoleVariables = {
+ shiftId: ...,
+ roleId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsByShiftRole()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAssignmentsByShiftRole(listAssignmentsByShiftRoleVars);
+// Variables can be defined inline as well.
+const { data } = await listAssignmentsByShiftRole({ shiftId: ..., roleId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAssignmentsByShiftRole(dataConnect, listAssignmentsByShiftRoleVars);
+
+console.log(data.assignments);
+
+// Or, you can use the `Promise` API.
+listAssignmentsByShiftRole(listAssignmentsByShiftRoleVars).then((response) => {
+ const data = response.data;
+ console.log(data.assignments);
+});
+```
+
+### Using `listAssignmentsByShiftRole`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAssignmentsByShiftRoleRef, ListAssignmentsByShiftRoleVariables } from '@dataconnect/generated';
+
+// The `listAssignmentsByShiftRole` query requires an argument of type `ListAssignmentsByShiftRoleVariables`:
+const listAssignmentsByShiftRoleVars: ListAssignmentsByShiftRoleVariables = {
+ shiftId: ...,
+ roleId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAssignmentsByShiftRoleRef()` function to get a reference to the query.
+const ref = listAssignmentsByShiftRoleRef(listAssignmentsByShiftRoleVars);
+// Variables can be defined inline as well.
+const ref = listAssignmentsByShiftRoleRef({ shiftId: ..., roleId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAssignmentsByShiftRoleRef(dataConnect, listAssignmentsByShiftRoleVars);
+
+// 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);
+});
+```
+
+## filterAssignments
+You can execute the `filterAssignments` 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
+filterAssignments(vars: FilterAssignmentsVariables): QueryPromise;
+
+interface FilterAssignmentsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: FilterAssignmentsVariables): QueryRef;
+}
+export const filterAssignmentsRef: FilterAssignmentsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+filterAssignments(dc: DataConnect, vars: FilterAssignmentsVariables): QueryPromise;
+
+interface FilterAssignmentsRef {
+ ...
+ (dc: DataConnect, vars: FilterAssignmentsVariables): QueryRef;
+}
+export const filterAssignmentsRef: FilterAssignmentsRef;
+```
+
+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 filterAssignmentsRef:
+```typescript
+const name = filterAssignmentsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `filterAssignments` query requires an argument of type `FilterAssignmentsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface FilterAssignmentsVariables {
+ shiftIds: UUIDString[];
+ roleIds: UUIDString[];
+ status?: AssignmentStatus | null;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `filterAssignments` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `FilterAssignmentsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface FilterAssignmentsData {
+ assignments: ({
+ id: UUIDString;
+ title?: string | null;
+ status?: AssignmentStatus | null;
+ createdAt?: TimestampString | null;
+ workforce: {
+ id: UUIDString;
+ workforceNumber: string;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & Workforce_Key;
+ shiftRole: {
+ id: UUIDString;
+ role: {
+ id: UUIDString;
+ name: string;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ } & Shift_Key;
+ };
+ } & Assignment_Key)[];
+}
+```
+### Using `filterAssignments`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, filterAssignments, FilterAssignmentsVariables } from '@dataconnect/generated';
+
+// The `filterAssignments` query requires an argument of type `FilterAssignmentsVariables`:
+const filterAssignmentsVars: FilterAssignmentsVariables = {
+ shiftIds: ...,
+ roleIds: ...,
+ status: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `filterAssignments()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await filterAssignments(filterAssignmentsVars);
+// Variables can be defined inline as well.
+const { data } = await filterAssignments({ shiftIds: ..., roleIds: ..., status: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await filterAssignments(dataConnect, filterAssignmentsVars);
+
+console.log(data.assignments);
+
+// Or, you can use the `Promise` API.
+filterAssignments(filterAssignmentsVars).then((response) => {
+ const data = response.data;
+ console.log(data.assignments);
+});
+```
+
+### Using `filterAssignments`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, filterAssignmentsRef, FilterAssignmentsVariables } from '@dataconnect/generated';
+
+// The `filterAssignments` query requires an argument of type `FilterAssignmentsVariables`:
+const filterAssignmentsVars: FilterAssignmentsVariables = {
+ shiftIds: ...,
+ roleIds: ...,
+ status: ..., // optional
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `filterAssignmentsRef()` function to get a reference to the query.
+const ref = filterAssignmentsRef(filterAssignmentsVars);
+// Variables can be defined inline as well.
+const ref = filterAssignmentsRef({ shiftIds: ..., roleIds: ..., status: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = filterAssignmentsRef(dataConnect, filterAssignmentsVars);
+
+// 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);
+});
+```
+
+## listInvoiceTemplates
+You can execute the `listInvoiceTemplates` 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
+listInvoiceTemplates(vars?: ListInvoiceTemplatesVariables): QueryPromise;
+
+interface ListInvoiceTemplatesRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: ListInvoiceTemplatesVariables): QueryRef;
+}
+export const listInvoiceTemplatesRef: ListInvoiceTemplatesRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listInvoiceTemplates(dc: DataConnect, vars?: ListInvoiceTemplatesVariables): QueryPromise;
+
+interface ListInvoiceTemplatesRef {
+ ...
+ (dc: DataConnect, vars?: ListInvoiceTemplatesVariables): QueryRef;
+}
+export const listInvoiceTemplatesRef: ListInvoiceTemplatesRef;
+```
+
+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 listInvoiceTemplatesRef:
+```typescript
+const name = listInvoiceTemplatesRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listInvoiceTemplates` query has an optional argument of type `ListInvoiceTemplatesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListInvoiceTemplatesVariables {
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listInvoiceTemplates` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListInvoiceTemplatesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListInvoiceTemplatesData {
+ invoiceTemplates: ({
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key)[];
+}
+```
+### Using `listInvoiceTemplates`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplates, ListInvoiceTemplatesVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplates` query has an optional argument of type `ListInvoiceTemplatesVariables`:
+const listInvoiceTemplatesVars: ListInvoiceTemplatesVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplates()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listInvoiceTemplates(listInvoiceTemplatesVars);
+// Variables can be defined inline as well.
+const { data } = await listInvoiceTemplates({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListInvoiceTemplatesVariables` argument.
+const { data } = await listInvoiceTemplates();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listInvoiceTemplates(dataConnect, listInvoiceTemplatesVars);
+
+console.log(data.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+listInvoiceTemplates(listInvoiceTemplatesVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+### Using `listInvoiceTemplates`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesRef, ListInvoiceTemplatesVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplates` query has an optional argument of type `ListInvoiceTemplatesVariables`:
+const listInvoiceTemplatesVars: ListInvoiceTemplatesVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesRef()` function to get a reference to the query.
+const ref = listInvoiceTemplatesRef(listInvoiceTemplatesVars);
+// Variables can be defined inline as well.
+const ref = listInvoiceTemplatesRef({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListInvoiceTemplatesVariables` argument.
+const ref = listInvoiceTemplatesRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listInvoiceTemplatesRef(dataConnect, listInvoiceTemplatesVars);
+
+// 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.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+## getInvoiceTemplateById
+You can execute the `getInvoiceTemplateById` 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
+getInvoiceTemplateById(vars: GetInvoiceTemplateByIdVariables): QueryPromise;
+
+interface GetInvoiceTemplateByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetInvoiceTemplateByIdVariables): QueryRef;
+}
+export const getInvoiceTemplateByIdRef: GetInvoiceTemplateByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getInvoiceTemplateById(dc: DataConnect, vars: GetInvoiceTemplateByIdVariables): QueryPromise;
+
+interface GetInvoiceTemplateByIdRef {
+ ...
+ (dc: DataConnect, vars: GetInvoiceTemplateByIdVariables): QueryRef;
+}
+export const getInvoiceTemplateByIdRef: GetInvoiceTemplateByIdRef;
+```
+
+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 getInvoiceTemplateByIdRef:
+```typescript
+const name = getInvoiceTemplateByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getInvoiceTemplateById` query requires an argument of type `GetInvoiceTemplateByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetInvoiceTemplateByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getInvoiceTemplateById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetInvoiceTemplateByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetInvoiceTemplateByIdData {
+ invoiceTemplate?: {
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key;
+}
+```
+### Using `getInvoiceTemplateById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getInvoiceTemplateById, GetInvoiceTemplateByIdVariables } from '@dataconnect/generated';
+
+// The `getInvoiceTemplateById` query requires an argument of type `GetInvoiceTemplateByIdVariables`:
+const getInvoiceTemplateByIdVars: GetInvoiceTemplateByIdVariables = {
+ id: ...,
+};
+
+// Call the `getInvoiceTemplateById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getInvoiceTemplateById(getInvoiceTemplateByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getInvoiceTemplateById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getInvoiceTemplateById(dataConnect, getInvoiceTemplateByIdVars);
+
+console.log(data.invoiceTemplate);
+
+// Or, you can use the `Promise` API.
+getInvoiceTemplateById(getInvoiceTemplateByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplate);
+});
+```
+
+### Using `getInvoiceTemplateById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getInvoiceTemplateByIdRef, GetInvoiceTemplateByIdVariables } from '@dataconnect/generated';
+
+// The `getInvoiceTemplateById` query requires an argument of type `GetInvoiceTemplateByIdVariables`:
+const getInvoiceTemplateByIdVars: GetInvoiceTemplateByIdVariables = {
+ id: ...,
+};
+
+// Call the `getInvoiceTemplateByIdRef()` function to get a reference to the query.
+const ref = getInvoiceTemplateByIdRef(getInvoiceTemplateByIdVars);
+// Variables can be defined inline as well.
+const ref = getInvoiceTemplateByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getInvoiceTemplateByIdRef(dataConnect, getInvoiceTemplateByIdVars);
+
+// 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.invoiceTemplate);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplate);
+});
+```
+
+## listInvoiceTemplatesByOwnerId
+You can execute the `listInvoiceTemplatesByOwnerId` 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
+listInvoiceTemplatesByOwnerId(vars: ListInvoiceTemplatesByOwnerIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByOwnerIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListInvoiceTemplatesByOwnerIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByOwnerIdRef: ListInvoiceTemplatesByOwnerIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listInvoiceTemplatesByOwnerId(dc: DataConnect, vars: ListInvoiceTemplatesByOwnerIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByOwnerIdRef {
+ ...
+ (dc: DataConnect, vars: ListInvoiceTemplatesByOwnerIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByOwnerIdRef: ListInvoiceTemplatesByOwnerIdRef;
+```
+
+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 listInvoiceTemplatesByOwnerIdRef:
+```typescript
+const name = listInvoiceTemplatesByOwnerIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listInvoiceTemplatesByOwnerId` query requires an argument of type `ListInvoiceTemplatesByOwnerIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListInvoiceTemplatesByOwnerIdVariables {
+ ownerId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listInvoiceTemplatesByOwnerId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListInvoiceTemplatesByOwnerIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListInvoiceTemplatesByOwnerIdData {
+ invoiceTemplates: ({
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key)[];
+}
+```
+### Using `listInvoiceTemplatesByOwnerId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByOwnerId, ListInvoiceTemplatesByOwnerIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByOwnerId` query requires an argument of type `ListInvoiceTemplatesByOwnerIdVariables`:
+const listInvoiceTemplatesByOwnerIdVars: ListInvoiceTemplatesByOwnerIdVariables = {
+ ownerId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByOwnerId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listInvoiceTemplatesByOwnerId(listInvoiceTemplatesByOwnerIdVars);
+// Variables can be defined inline as well.
+const { data } = await listInvoiceTemplatesByOwnerId({ ownerId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listInvoiceTemplatesByOwnerId(dataConnect, listInvoiceTemplatesByOwnerIdVars);
+
+console.log(data.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+listInvoiceTemplatesByOwnerId(listInvoiceTemplatesByOwnerIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+### Using `listInvoiceTemplatesByOwnerId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByOwnerIdRef, ListInvoiceTemplatesByOwnerIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByOwnerId` query requires an argument of type `ListInvoiceTemplatesByOwnerIdVariables`:
+const listInvoiceTemplatesByOwnerIdVars: ListInvoiceTemplatesByOwnerIdVariables = {
+ ownerId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByOwnerIdRef()` function to get a reference to the query.
+const ref = listInvoiceTemplatesByOwnerIdRef(listInvoiceTemplatesByOwnerIdVars);
+// Variables can be defined inline as well.
+const ref = listInvoiceTemplatesByOwnerIdRef({ ownerId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listInvoiceTemplatesByOwnerIdRef(dataConnect, listInvoiceTemplatesByOwnerIdVars);
+
+// 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.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+## listInvoiceTemplatesByVendorId
+You can execute the `listInvoiceTemplatesByVendorId` 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
+listInvoiceTemplatesByVendorId(vars: ListInvoiceTemplatesByVendorIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByVendorIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListInvoiceTemplatesByVendorIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByVendorIdRef: ListInvoiceTemplatesByVendorIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listInvoiceTemplatesByVendorId(dc: DataConnect, vars: ListInvoiceTemplatesByVendorIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByVendorIdRef {
+ ...
+ (dc: DataConnect, vars: ListInvoiceTemplatesByVendorIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByVendorIdRef: ListInvoiceTemplatesByVendorIdRef;
+```
+
+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 listInvoiceTemplatesByVendorIdRef:
+```typescript
+const name = listInvoiceTemplatesByVendorIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listInvoiceTemplatesByVendorId` query requires an argument of type `ListInvoiceTemplatesByVendorIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListInvoiceTemplatesByVendorIdVariables {
+ vendorId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listInvoiceTemplatesByVendorId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListInvoiceTemplatesByVendorIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListInvoiceTemplatesByVendorIdData {
+ invoiceTemplates: ({
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key)[];
+}
+```
+### Using `listInvoiceTemplatesByVendorId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByVendorId, ListInvoiceTemplatesByVendorIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByVendorId` query requires an argument of type `ListInvoiceTemplatesByVendorIdVariables`:
+const listInvoiceTemplatesByVendorIdVars: ListInvoiceTemplatesByVendorIdVariables = {
+ vendorId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByVendorId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listInvoiceTemplatesByVendorId(listInvoiceTemplatesByVendorIdVars);
+// Variables can be defined inline as well.
+const { data } = await listInvoiceTemplatesByVendorId({ vendorId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listInvoiceTemplatesByVendorId(dataConnect, listInvoiceTemplatesByVendorIdVars);
+
+console.log(data.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+listInvoiceTemplatesByVendorId(listInvoiceTemplatesByVendorIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+### Using `listInvoiceTemplatesByVendorId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByVendorIdRef, ListInvoiceTemplatesByVendorIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByVendorId` query requires an argument of type `ListInvoiceTemplatesByVendorIdVariables`:
+const listInvoiceTemplatesByVendorIdVars: ListInvoiceTemplatesByVendorIdVariables = {
+ vendorId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByVendorIdRef()` function to get a reference to the query.
+const ref = listInvoiceTemplatesByVendorIdRef(listInvoiceTemplatesByVendorIdVars);
+// Variables can be defined inline as well.
+const ref = listInvoiceTemplatesByVendorIdRef({ vendorId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listInvoiceTemplatesByVendorIdRef(dataConnect, listInvoiceTemplatesByVendorIdVars);
+
+// 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.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+## listInvoiceTemplatesByBusinessId
+You can execute the `listInvoiceTemplatesByBusinessId` 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
+listInvoiceTemplatesByBusinessId(vars: ListInvoiceTemplatesByBusinessIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByBusinessIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListInvoiceTemplatesByBusinessIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByBusinessIdRef: ListInvoiceTemplatesByBusinessIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listInvoiceTemplatesByBusinessId(dc: DataConnect, vars: ListInvoiceTemplatesByBusinessIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByBusinessIdRef {
+ ...
+ (dc: DataConnect, vars: ListInvoiceTemplatesByBusinessIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByBusinessIdRef: ListInvoiceTemplatesByBusinessIdRef;
+```
+
+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 listInvoiceTemplatesByBusinessIdRef:
+```typescript
+const name = listInvoiceTemplatesByBusinessIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listInvoiceTemplatesByBusinessId` query requires an argument of type `ListInvoiceTemplatesByBusinessIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListInvoiceTemplatesByBusinessIdVariables {
+ businessId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listInvoiceTemplatesByBusinessId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListInvoiceTemplatesByBusinessIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListInvoiceTemplatesByBusinessIdData {
+ invoiceTemplates: ({
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key)[];
+}
+```
+### Using `listInvoiceTemplatesByBusinessId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByBusinessId, ListInvoiceTemplatesByBusinessIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByBusinessId` query requires an argument of type `ListInvoiceTemplatesByBusinessIdVariables`:
+const listInvoiceTemplatesByBusinessIdVars: ListInvoiceTemplatesByBusinessIdVariables = {
+ businessId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByBusinessId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listInvoiceTemplatesByBusinessId(listInvoiceTemplatesByBusinessIdVars);
+// Variables can be defined inline as well.
+const { data } = await listInvoiceTemplatesByBusinessId({ businessId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listInvoiceTemplatesByBusinessId(dataConnect, listInvoiceTemplatesByBusinessIdVars);
+
+console.log(data.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+listInvoiceTemplatesByBusinessId(listInvoiceTemplatesByBusinessIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+### Using `listInvoiceTemplatesByBusinessId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByBusinessIdRef, ListInvoiceTemplatesByBusinessIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByBusinessId` query requires an argument of type `ListInvoiceTemplatesByBusinessIdVariables`:
+const listInvoiceTemplatesByBusinessIdVars: ListInvoiceTemplatesByBusinessIdVariables = {
+ businessId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByBusinessIdRef()` function to get a reference to the query.
+const ref = listInvoiceTemplatesByBusinessIdRef(listInvoiceTemplatesByBusinessIdVars);
+// Variables can be defined inline as well.
+const ref = listInvoiceTemplatesByBusinessIdRef({ businessId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listInvoiceTemplatesByBusinessIdRef(dataConnect, listInvoiceTemplatesByBusinessIdVars);
+
+// 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.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+## listInvoiceTemplatesByOrderId
+You can execute the `listInvoiceTemplatesByOrderId` 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
+listInvoiceTemplatesByOrderId(vars: ListInvoiceTemplatesByOrderIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByOrderIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListInvoiceTemplatesByOrderIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByOrderIdRef: ListInvoiceTemplatesByOrderIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listInvoiceTemplatesByOrderId(dc: DataConnect, vars: ListInvoiceTemplatesByOrderIdVariables): QueryPromise;
+
+interface ListInvoiceTemplatesByOrderIdRef {
+ ...
+ (dc: DataConnect, vars: ListInvoiceTemplatesByOrderIdVariables): QueryRef;
+}
+export const listInvoiceTemplatesByOrderIdRef: ListInvoiceTemplatesByOrderIdRef;
+```
+
+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 listInvoiceTemplatesByOrderIdRef:
+```typescript
+const name = listInvoiceTemplatesByOrderIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listInvoiceTemplatesByOrderId` query requires an argument of type `ListInvoiceTemplatesByOrderIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListInvoiceTemplatesByOrderIdVariables {
+ orderId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listInvoiceTemplatesByOrderId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListInvoiceTemplatesByOrderIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListInvoiceTemplatesByOrderIdData {
+ invoiceTemplates: ({
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key)[];
+}
+```
+### Using `listInvoiceTemplatesByOrderId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByOrderId, ListInvoiceTemplatesByOrderIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByOrderId` query requires an argument of type `ListInvoiceTemplatesByOrderIdVariables`:
+const listInvoiceTemplatesByOrderIdVars: ListInvoiceTemplatesByOrderIdVariables = {
+ orderId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByOrderId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listInvoiceTemplatesByOrderId(listInvoiceTemplatesByOrderIdVars);
+// Variables can be defined inline as well.
+const { data } = await listInvoiceTemplatesByOrderId({ orderId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listInvoiceTemplatesByOrderId(dataConnect, listInvoiceTemplatesByOrderIdVars);
+
+console.log(data.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+listInvoiceTemplatesByOrderId(listInvoiceTemplatesByOrderIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+### Using `listInvoiceTemplatesByOrderId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listInvoiceTemplatesByOrderIdRef, ListInvoiceTemplatesByOrderIdVariables } from '@dataconnect/generated';
+
+// The `listInvoiceTemplatesByOrderId` query requires an argument of type `ListInvoiceTemplatesByOrderIdVariables`:
+const listInvoiceTemplatesByOrderIdVars: ListInvoiceTemplatesByOrderIdVariables = {
+ orderId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listInvoiceTemplatesByOrderIdRef()` function to get a reference to the query.
+const ref = listInvoiceTemplatesByOrderIdRef(listInvoiceTemplatesByOrderIdVars);
+// Variables can be defined inline as well.
+const ref = listInvoiceTemplatesByOrderIdRef({ orderId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listInvoiceTemplatesByOrderIdRef(dataConnect, listInvoiceTemplatesByOrderIdVars);
+
+// 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.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+## searchInvoiceTemplatesByOwnerAndName
+You can execute the `searchInvoiceTemplatesByOwnerAndName` 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
+searchInvoiceTemplatesByOwnerAndName(vars: SearchInvoiceTemplatesByOwnerAndNameVariables): QueryPromise;
+
+interface SearchInvoiceTemplatesByOwnerAndNameRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: SearchInvoiceTemplatesByOwnerAndNameVariables): QueryRef;
+}
+export const searchInvoiceTemplatesByOwnerAndNameRef: SearchInvoiceTemplatesByOwnerAndNameRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+searchInvoiceTemplatesByOwnerAndName(dc: DataConnect, vars: SearchInvoiceTemplatesByOwnerAndNameVariables): QueryPromise;
+
+interface SearchInvoiceTemplatesByOwnerAndNameRef {
+ ...
+ (dc: DataConnect, vars: SearchInvoiceTemplatesByOwnerAndNameVariables): QueryRef;
+}
+export const searchInvoiceTemplatesByOwnerAndNameRef: SearchInvoiceTemplatesByOwnerAndNameRef;
+```
+
+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 searchInvoiceTemplatesByOwnerAndNameRef:
+```typescript
+const name = searchInvoiceTemplatesByOwnerAndNameRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `searchInvoiceTemplatesByOwnerAndName` query requires an argument of type `SearchInvoiceTemplatesByOwnerAndNameVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface SearchInvoiceTemplatesByOwnerAndNameVariables {
+ ownerId: UUIDString;
+ name: string;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `searchInvoiceTemplatesByOwnerAndName` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `SearchInvoiceTemplatesByOwnerAndNameData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface SearchInvoiceTemplatesByOwnerAndNameData {
+ invoiceTemplates: ({
+ id: UUIDString;
+ name: string;
+ ownerId: UUIDString;
+ vendorId?: UUIDString | null;
+ businessId?: UUIDString | null;
+ orderId?: UUIDString | null;
+ paymentTerms?: InovicePaymentTermsTemp | null;
+ invoiceNumber?: string | null;
+ issueDate?: TimestampString | null;
+ dueDate?: TimestampString | null;
+ hub?: string | null;
+ managerName?: string | null;
+ vendorNumber?: string | null;
+ roles?: unknown | null;
+ charges?: unknown | null;
+ otherCharges?: number | null;
+ subtotal?: number | null;
+ amount?: number | null;
+ notes?: string | null;
+ staffCount?: number | null;
+ chargesCount?: number | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ business?: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ order?: {
+ id: UUIDString;
+ eventName?: string | null;
+ status: OrderStatus;
+ orderType: OrderType;
+ } & Order_Key;
+ } & InvoiceTemplate_Key)[];
+}
+```
+### Using `searchInvoiceTemplatesByOwnerAndName`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, searchInvoiceTemplatesByOwnerAndName, SearchInvoiceTemplatesByOwnerAndNameVariables } from '@dataconnect/generated';
+
+// The `searchInvoiceTemplatesByOwnerAndName` query requires an argument of type `SearchInvoiceTemplatesByOwnerAndNameVariables`:
+const searchInvoiceTemplatesByOwnerAndNameVars: SearchInvoiceTemplatesByOwnerAndNameVariables = {
+ ownerId: ...,
+ name: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `searchInvoiceTemplatesByOwnerAndName()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await searchInvoiceTemplatesByOwnerAndName(searchInvoiceTemplatesByOwnerAndNameVars);
+// Variables can be defined inline as well.
+const { data } = await searchInvoiceTemplatesByOwnerAndName({ ownerId: ..., name: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await searchInvoiceTemplatesByOwnerAndName(dataConnect, searchInvoiceTemplatesByOwnerAndNameVars);
+
+console.log(data.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+searchInvoiceTemplatesByOwnerAndName(searchInvoiceTemplatesByOwnerAndNameVars).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+### Using `searchInvoiceTemplatesByOwnerAndName`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, searchInvoiceTemplatesByOwnerAndNameRef, SearchInvoiceTemplatesByOwnerAndNameVariables } from '@dataconnect/generated';
+
+// The `searchInvoiceTemplatesByOwnerAndName` query requires an argument of type `SearchInvoiceTemplatesByOwnerAndNameVariables`:
+const searchInvoiceTemplatesByOwnerAndNameVars: SearchInvoiceTemplatesByOwnerAndNameVariables = {
+ ownerId: ...,
+ name: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `searchInvoiceTemplatesByOwnerAndNameRef()` function to get a reference to the query.
+const ref = searchInvoiceTemplatesByOwnerAndNameRef(searchInvoiceTemplatesByOwnerAndNameVars);
+// Variables can be defined inline as well.
+const ref = searchInvoiceTemplatesByOwnerAndNameRef({ ownerId: ..., name: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = searchInvoiceTemplatesByOwnerAndNameRef(dataConnect, searchInvoiceTemplatesByOwnerAndNameVars);
+
+// 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.invoiceTemplates);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.invoiceTemplates);
+});
+```
+
+## getStaffDocumentByKey
+You can execute the `getStaffDocumentByKey` 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
+getStaffDocumentByKey(vars: GetStaffDocumentByKeyVariables): QueryPromise;
+
+interface GetStaffDocumentByKeyRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetStaffDocumentByKeyVariables): QueryRef;
+}
+export const getStaffDocumentByKeyRef: GetStaffDocumentByKeyRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getStaffDocumentByKey(dc: DataConnect, vars: GetStaffDocumentByKeyVariables): QueryPromise;
+
+interface GetStaffDocumentByKeyRef {
+ ...
+ (dc: DataConnect, vars: GetStaffDocumentByKeyVariables): QueryRef;
+}
+export const getStaffDocumentByKeyRef: GetStaffDocumentByKeyRef;
+```
+
+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 getStaffDocumentByKeyRef:
+```typescript
+const name = getStaffDocumentByKeyRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getStaffDocumentByKey` query requires an argument of type `GetStaffDocumentByKeyVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetStaffDocumentByKeyVariables {
+ staffId: UUIDString;
+ documentId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getStaffDocumentByKey` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetStaffDocumentByKeyData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetStaffDocumentByKeyData {
+ staffDocument?: {
+ id: UUIDString;
+ staffId: UUIDString;
+ staffName: string;
+ documentId: UUIDString;
+ status: DocumentStatus;
+ documentUrl?: string | null;
+ expiryDate?: TimestampString | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ document: {
+ id: UUIDString;
+ name: string;
+ documentType: DocumentType;
+ description?: string | null;
+ } & Document_Key;
+ } & StaffDocument_Key;
+}
+```
+### Using `getStaffDocumentByKey`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getStaffDocumentByKey, GetStaffDocumentByKeyVariables } from '@dataconnect/generated';
+
+// The `getStaffDocumentByKey` query requires an argument of type `GetStaffDocumentByKeyVariables`:
+const getStaffDocumentByKeyVars: GetStaffDocumentByKeyVariables = {
+ staffId: ...,
+ documentId: ...,
+};
+
+// Call the `getStaffDocumentByKey()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getStaffDocumentByKey(getStaffDocumentByKeyVars);
+// Variables can be defined inline as well.
+const { data } = await getStaffDocumentByKey({ staffId: ..., documentId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getStaffDocumentByKey(dataConnect, getStaffDocumentByKeyVars);
+
+console.log(data.staffDocument);
+
+// Or, you can use the `Promise` API.
+getStaffDocumentByKey(getStaffDocumentByKeyVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocument);
+});
+```
+
+### Using `getStaffDocumentByKey`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getStaffDocumentByKeyRef, GetStaffDocumentByKeyVariables } from '@dataconnect/generated';
+
+// The `getStaffDocumentByKey` query requires an argument of type `GetStaffDocumentByKeyVariables`:
+const getStaffDocumentByKeyVars: GetStaffDocumentByKeyVariables = {
+ staffId: ...,
+ documentId: ...,
+};
+
+// Call the `getStaffDocumentByKeyRef()` function to get a reference to the query.
+const ref = getStaffDocumentByKeyRef(getStaffDocumentByKeyVars);
+// Variables can be defined inline as well.
+const ref = getStaffDocumentByKeyRef({ staffId: ..., documentId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getStaffDocumentByKeyRef(dataConnect, getStaffDocumentByKeyVars);
+
+// 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.staffDocument);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocument);
+});
+```
+
+## listStaffDocumentsByStaffId
+You can execute the `listStaffDocumentsByStaffId` 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
+listStaffDocumentsByStaffId(vars: ListStaffDocumentsByStaffIdVariables): QueryPromise;
+
+interface ListStaffDocumentsByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListStaffDocumentsByStaffIdVariables): QueryRef;
+}
+export const listStaffDocumentsByStaffIdRef: ListStaffDocumentsByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffDocumentsByStaffId(dc: DataConnect, vars: ListStaffDocumentsByStaffIdVariables): QueryPromise;
+
+interface ListStaffDocumentsByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: ListStaffDocumentsByStaffIdVariables): QueryRef;
+}
+export const listStaffDocumentsByStaffIdRef: ListStaffDocumentsByStaffIdRef;
+```
+
+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 listStaffDocumentsByStaffIdRef:
+```typescript
+const name = listStaffDocumentsByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffDocumentsByStaffId` query requires an argument of type `ListStaffDocumentsByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffDocumentsByStaffIdVariables {
+ staffId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffDocumentsByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffDocumentsByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffDocumentsByStaffIdData {
+ staffDocuments: ({
+ id: UUIDString;
+ staffId: UUIDString;
+ staffName: string;
+ documentId: UUIDString;
+ status: DocumentStatus;
+ documentUrl?: string | null;
+ expiryDate?: TimestampString | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ document: {
+ id: UUIDString;
+ name: string;
+ documentType: DocumentType;
+ } & Document_Key;
+ } & StaffDocument_Key)[];
+}
+```
+### Using `listStaffDocumentsByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffDocumentsByStaffId, ListStaffDocumentsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listStaffDocumentsByStaffId` query requires an argument of type `ListStaffDocumentsByStaffIdVariables`:
+const listStaffDocumentsByStaffIdVars: ListStaffDocumentsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffDocumentsByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffDocumentsByStaffId(listStaffDocumentsByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffDocumentsByStaffId({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffDocumentsByStaffId(dataConnect, listStaffDocumentsByStaffIdVars);
+
+console.log(data.staffDocuments);
+
+// Or, you can use the `Promise` API.
+listStaffDocumentsByStaffId(listStaffDocumentsByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocuments);
+});
+```
+
+### Using `listStaffDocumentsByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffDocumentsByStaffIdRef, ListStaffDocumentsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listStaffDocumentsByStaffId` query requires an argument of type `ListStaffDocumentsByStaffIdVariables`:
+const listStaffDocumentsByStaffIdVars: ListStaffDocumentsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffDocumentsByStaffIdRef()` function to get a reference to the query.
+const ref = listStaffDocumentsByStaffIdRef(listStaffDocumentsByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = listStaffDocumentsByStaffIdRef({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffDocumentsByStaffIdRef(dataConnect, listStaffDocumentsByStaffIdVars);
+
+// 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.staffDocuments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocuments);
+});
+```
+
+## listStaffDocumentsByDocumentType
+You can execute the `listStaffDocumentsByDocumentType` 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
+listStaffDocumentsByDocumentType(vars: ListStaffDocumentsByDocumentTypeVariables): QueryPromise;
+
+interface ListStaffDocumentsByDocumentTypeRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListStaffDocumentsByDocumentTypeVariables): QueryRef;
+}
+export const listStaffDocumentsByDocumentTypeRef: ListStaffDocumentsByDocumentTypeRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffDocumentsByDocumentType(dc: DataConnect, vars: ListStaffDocumentsByDocumentTypeVariables): QueryPromise;
+
+interface ListStaffDocumentsByDocumentTypeRef {
+ ...
+ (dc: DataConnect, vars: ListStaffDocumentsByDocumentTypeVariables): QueryRef;
+}
+export const listStaffDocumentsByDocumentTypeRef: ListStaffDocumentsByDocumentTypeRef;
+```
+
+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 listStaffDocumentsByDocumentTypeRef:
+```typescript
+const name = listStaffDocumentsByDocumentTypeRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffDocumentsByDocumentType` query requires an argument of type `ListStaffDocumentsByDocumentTypeVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffDocumentsByDocumentTypeVariables {
+ documentType: DocumentType;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffDocumentsByDocumentType` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffDocumentsByDocumentTypeData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffDocumentsByDocumentTypeData {
+ staffDocuments: ({
+ id: UUIDString;
+ staffId: UUIDString;
+ staffName: string;
+ documentId: UUIDString;
+ status: DocumentStatus;
+ documentUrl?: string | null;
+ expiryDate?: TimestampString | null;
+ document: {
+ id: UUIDString;
+ name: string;
+ documentType: DocumentType;
+ } & Document_Key;
+ } & StaffDocument_Key)[];
+}
+```
+### Using `listStaffDocumentsByDocumentType`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffDocumentsByDocumentType, ListStaffDocumentsByDocumentTypeVariables } from '@dataconnect/generated';
+
+// The `listStaffDocumentsByDocumentType` query requires an argument of type `ListStaffDocumentsByDocumentTypeVariables`:
+const listStaffDocumentsByDocumentTypeVars: ListStaffDocumentsByDocumentTypeVariables = {
+ documentType: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffDocumentsByDocumentType()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffDocumentsByDocumentType(listStaffDocumentsByDocumentTypeVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffDocumentsByDocumentType({ documentType: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffDocumentsByDocumentType(dataConnect, listStaffDocumentsByDocumentTypeVars);
+
+console.log(data.staffDocuments);
+
+// Or, you can use the `Promise` API.
+listStaffDocumentsByDocumentType(listStaffDocumentsByDocumentTypeVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocuments);
+});
+```
+
+### Using `listStaffDocumentsByDocumentType`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffDocumentsByDocumentTypeRef, ListStaffDocumentsByDocumentTypeVariables } from '@dataconnect/generated';
+
+// The `listStaffDocumentsByDocumentType` query requires an argument of type `ListStaffDocumentsByDocumentTypeVariables`:
+const listStaffDocumentsByDocumentTypeVars: ListStaffDocumentsByDocumentTypeVariables = {
+ documentType: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffDocumentsByDocumentTypeRef()` function to get a reference to the query.
+const ref = listStaffDocumentsByDocumentTypeRef(listStaffDocumentsByDocumentTypeVars);
+// Variables can be defined inline as well.
+const ref = listStaffDocumentsByDocumentTypeRef({ documentType: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffDocumentsByDocumentTypeRef(dataConnect, listStaffDocumentsByDocumentTypeVars);
+
+// 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.staffDocuments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocuments);
+});
+```
+
+## listStaffDocumentsByStatus
+You can execute the `listStaffDocumentsByStatus` 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
+listStaffDocumentsByStatus(vars: ListStaffDocumentsByStatusVariables): QueryPromise;
+
+interface ListStaffDocumentsByStatusRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListStaffDocumentsByStatusVariables): QueryRef;
+}
+export const listStaffDocumentsByStatusRef: ListStaffDocumentsByStatusRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffDocumentsByStatus(dc: DataConnect, vars: ListStaffDocumentsByStatusVariables): QueryPromise;
+
+interface ListStaffDocumentsByStatusRef {
+ ...
+ (dc: DataConnect, vars: ListStaffDocumentsByStatusVariables): QueryRef;
+}
+export const listStaffDocumentsByStatusRef: ListStaffDocumentsByStatusRef;
+```
+
+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 listStaffDocumentsByStatusRef:
+```typescript
+const name = listStaffDocumentsByStatusRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffDocumentsByStatus` query requires an argument of type `ListStaffDocumentsByStatusVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffDocumentsByStatusVariables {
+ status: DocumentStatus;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffDocumentsByStatus` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffDocumentsByStatusData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffDocumentsByStatusData {
+ staffDocuments: ({
+ id: UUIDString;
+ staffId: UUIDString;
+ staffName: string;
+ documentId: UUIDString;
+ status: DocumentStatus;
+ documentUrl?: string | null;
+ expiryDate?: TimestampString | null;
+ document: {
+ id: UUIDString;
+ name: string;
+ documentType: DocumentType;
+ } & Document_Key;
+ } & StaffDocument_Key)[];
+}
+```
+### Using `listStaffDocumentsByStatus`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffDocumentsByStatus, ListStaffDocumentsByStatusVariables } from '@dataconnect/generated';
+
+// The `listStaffDocumentsByStatus` query requires an argument of type `ListStaffDocumentsByStatusVariables`:
+const listStaffDocumentsByStatusVars: ListStaffDocumentsByStatusVariables = {
+ status: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffDocumentsByStatus()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffDocumentsByStatus(listStaffDocumentsByStatusVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffDocumentsByStatus({ status: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffDocumentsByStatus(dataConnect, listStaffDocumentsByStatusVars);
+
+console.log(data.staffDocuments);
+
+// Or, you can use the `Promise` API.
+listStaffDocumentsByStatus(listStaffDocumentsByStatusVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocuments);
+});
+```
+
+### Using `listStaffDocumentsByStatus`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffDocumentsByStatusRef, ListStaffDocumentsByStatusVariables } from '@dataconnect/generated';
+
+// The `listStaffDocumentsByStatus` query requires an argument of type `ListStaffDocumentsByStatusVariables`:
+const listStaffDocumentsByStatusVars: ListStaffDocumentsByStatusVariables = {
+ status: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffDocumentsByStatusRef()` function to get a reference to the query.
+const ref = listStaffDocumentsByStatusRef(listStaffDocumentsByStatusVars);
+// Variables can be defined inline as well.
+const ref = listStaffDocumentsByStatusRef({ status: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffDocumentsByStatusRef(dataConnect, listStaffDocumentsByStatusVars);
+
+// 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.staffDocuments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffDocuments);
+});
+```
+
+## listAccounts
+You can execute the `listAccounts` 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
+listAccounts(): QueryPromise;
+
+interface ListAccountsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listAccountsRef: ListAccountsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAccounts(dc: DataConnect): QueryPromise;
+
+interface ListAccountsRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listAccountsRef: ListAccountsRef;
+```
+
+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 listAccountsRef:
+```typescript
+const name = listAccountsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAccounts` query has no variables.
+### Return Type
+Recall that executing the `listAccounts` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAccountsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAccountsData {
+ accounts: ({
+ id: UUIDString;
+ bank: string;
+ type: AccountType;
+ last4: string;
+ isPrimary?: boolean | null;
+ ownerId: UUIDString;
+ accountNumber?: string | null;
+ routeNumber?: string | null;
+ expiryTime?: TimestampString | null;
+ createdAt?: TimestampString | null;
+ } & Account_Key)[];
+}
+```
+### Using `listAccounts`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAccounts } from '@dataconnect/generated';
+
+
+// Call the `listAccounts()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAccounts();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAccounts(dataConnect);
+
+console.log(data.accounts);
+
+// Or, you can use the `Promise` API.
+listAccounts().then((response) => {
+ const data = response.data;
+ console.log(data.accounts);
+});
+```
+
+### Using `listAccounts`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAccountsRef } from '@dataconnect/generated';
+
+
+// Call the `listAccountsRef()` function to get a reference to the query.
+const ref = listAccountsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAccountsRef(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.accounts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.accounts);
+});
+```
+
+## getAccountById
+You can execute the `getAccountById` 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
+getAccountById(vars: GetAccountByIdVariables): QueryPromise;
+
+interface GetAccountByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetAccountByIdVariables): QueryRef;
+}
+export const getAccountByIdRef: GetAccountByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getAccountById(dc: DataConnect, vars: GetAccountByIdVariables): QueryPromise;
+
+interface GetAccountByIdRef {
+ ...
+ (dc: DataConnect, vars: GetAccountByIdVariables): QueryRef;
+}
+export const getAccountByIdRef: GetAccountByIdRef;
+```
+
+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 getAccountByIdRef:
+```typescript
+const name = getAccountByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getAccountById` query requires an argument of type `GetAccountByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetAccountByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getAccountById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetAccountByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetAccountByIdData {
+ account?: {
+ id: UUIDString;
+ bank: string;
+ type: AccountType;
+ last4: string;
+ isPrimary?: boolean | null;
+ ownerId: UUIDString;
+ accountNumber?: string | null;
+ routeNumber?: string | null;
+ expiryTime?: TimestampString | null;
+ createdAt?: TimestampString | null;
+ } & Account_Key;
+}
+```
+### Using `getAccountById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getAccountById, GetAccountByIdVariables } from '@dataconnect/generated';
+
+// The `getAccountById` query requires an argument of type `GetAccountByIdVariables`:
+const getAccountByIdVars: GetAccountByIdVariables = {
+ id: ...,
+};
+
+// Call the `getAccountById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getAccountById(getAccountByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getAccountById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getAccountById(dataConnect, getAccountByIdVars);
+
+console.log(data.account);
+
+// Or, you can use the `Promise` API.
+getAccountById(getAccountByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.account);
+});
+```
+
+### Using `getAccountById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getAccountByIdRef, GetAccountByIdVariables } from '@dataconnect/generated';
+
+// The `getAccountById` query requires an argument of type `GetAccountByIdVariables`:
+const getAccountByIdVars: GetAccountByIdVariables = {
+ id: ...,
+};
+
+// Call the `getAccountByIdRef()` function to get a reference to the query.
+const ref = getAccountByIdRef(getAccountByIdVars);
+// Variables can be defined inline as well.
+const ref = getAccountByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getAccountByIdRef(dataConnect, getAccountByIdVars);
+
+// 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.account);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.account);
+});
+```
+
+## getAccountsByOwnerId
+You can execute the `getAccountsByOwnerId` 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
+getAccountsByOwnerId(vars: GetAccountsByOwnerIdVariables): QueryPromise;
+
+interface GetAccountsByOwnerIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetAccountsByOwnerIdVariables): QueryRef;
+}
+export const getAccountsByOwnerIdRef: GetAccountsByOwnerIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getAccountsByOwnerId(dc: DataConnect, vars: GetAccountsByOwnerIdVariables): QueryPromise;
+
+interface GetAccountsByOwnerIdRef {
+ ...
+ (dc: DataConnect, vars: GetAccountsByOwnerIdVariables): QueryRef;
+}
+export const getAccountsByOwnerIdRef: GetAccountsByOwnerIdRef;
+```
+
+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 getAccountsByOwnerIdRef:
+```typescript
+const name = getAccountsByOwnerIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getAccountsByOwnerId` query requires an argument of type `GetAccountsByOwnerIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetAccountsByOwnerIdVariables {
+ ownerId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getAccountsByOwnerId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetAccountsByOwnerIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetAccountsByOwnerIdData {
+ accounts: ({
+ id: UUIDString;
+ bank: string;
+ type: AccountType;
+ last4: string;
+ isPrimary?: boolean | null;
+ ownerId: UUIDString;
+ accountNumber?: string | null;
+ routeNumber?: string | null;
+ expiryTime?: TimestampString | null;
+ createdAt?: TimestampString | null;
+ } & Account_Key)[];
+}
+```
+### Using `getAccountsByOwnerId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getAccountsByOwnerId, GetAccountsByOwnerIdVariables } from '@dataconnect/generated';
+
+// The `getAccountsByOwnerId` query requires an argument of type `GetAccountsByOwnerIdVariables`:
+const getAccountsByOwnerIdVars: GetAccountsByOwnerIdVariables = {
+ ownerId: ...,
+};
+
+// Call the `getAccountsByOwnerId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getAccountsByOwnerId(getAccountsByOwnerIdVars);
+// Variables can be defined inline as well.
+const { data } = await getAccountsByOwnerId({ ownerId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getAccountsByOwnerId(dataConnect, getAccountsByOwnerIdVars);
+
+console.log(data.accounts);
+
+// Or, you can use the `Promise` API.
+getAccountsByOwnerId(getAccountsByOwnerIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.accounts);
+});
+```
+
+### Using `getAccountsByOwnerId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getAccountsByOwnerIdRef, GetAccountsByOwnerIdVariables } from '@dataconnect/generated';
+
+// The `getAccountsByOwnerId` query requires an argument of type `GetAccountsByOwnerIdVariables`:
+const getAccountsByOwnerIdVars: GetAccountsByOwnerIdVariables = {
+ ownerId: ...,
+};
+
+// Call the `getAccountsByOwnerIdRef()` function to get a reference to the query.
+const ref = getAccountsByOwnerIdRef(getAccountsByOwnerIdVars);
+// Variables can be defined inline as well.
+const ref = getAccountsByOwnerIdRef({ ownerId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getAccountsByOwnerIdRef(dataConnect, getAccountsByOwnerIdVars);
+
+// 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.accounts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.accounts);
+});
+```
+
+## filterAccounts
+You can execute the `filterAccounts` 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
+filterAccounts(vars?: FilterAccountsVariables): QueryPromise;
+
+interface FilterAccountsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: FilterAccountsVariables): QueryRef;
+}
+export const filterAccountsRef: FilterAccountsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+filterAccounts(dc: DataConnect, vars?: FilterAccountsVariables): QueryPromise;
+
+interface FilterAccountsRef {
+ ...
+ (dc: DataConnect, vars?: FilterAccountsVariables): QueryRef;
+}
+export const filterAccountsRef: FilterAccountsRef;
+```
+
+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 filterAccountsRef:
+```typescript
+const name = filterAccountsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `filterAccounts` query has an optional argument of type `FilterAccountsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface FilterAccountsVariables {
+ bank?: string | null;
+ type?: AccountType | null;
+ isPrimary?: boolean | null;
+ ownerId?: UUIDString | null;
+}
+```
+### Return Type
+Recall that executing the `filterAccounts` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `FilterAccountsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface FilterAccountsData {
+ accounts: ({
+ id: UUIDString;
+ bank: string;
+ type: AccountType;
+ last4: string;
+ isPrimary?: boolean | null;
+ ownerId: UUIDString;
+ accountNumber?: string | null;
+ expiryTime?: TimestampString | null;
+ routeNumber?: string | null;
+ } & Account_Key)[];
+}
+```
+### Using `filterAccounts`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, filterAccounts, FilterAccountsVariables } from '@dataconnect/generated';
+
+// The `filterAccounts` query has an optional argument of type `FilterAccountsVariables`:
+const filterAccountsVars: FilterAccountsVariables = {
+ bank: ..., // optional
+ type: ..., // optional
+ isPrimary: ..., // optional
+ ownerId: ..., // optional
+};
+
+// Call the `filterAccounts()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await filterAccounts(filterAccountsVars);
+// Variables can be defined inline as well.
+const { data } = await filterAccounts({ bank: ..., type: ..., isPrimary: ..., ownerId: ..., });
+// Since all variables are optional for this query, you can omit the `FilterAccountsVariables` argument.
+const { data } = await filterAccounts();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await filterAccounts(dataConnect, filterAccountsVars);
+
+console.log(data.accounts);
+
+// Or, you can use the `Promise` API.
+filterAccounts(filterAccountsVars).then((response) => {
+ const data = response.data;
+ console.log(data.accounts);
+});
+```
+
+### Using `filterAccounts`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, filterAccountsRef, FilterAccountsVariables } from '@dataconnect/generated';
+
+// The `filterAccounts` query has an optional argument of type `FilterAccountsVariables`:
+const filterAccountsVars: FilterAccountsVariables = {
+ bank: ..., // optional
+ type: ..., // optional
+ isPrimary: ..., // optional
+ ownerId: ..., // optional
+};
+
+// Call the `filterAccountsRef()` function to get a reference to the query.
+const ref = filterAccountsRef(filterAccountsVars);
+// Variables can be defined inline as well.
+const ref = filterAccountsRef({ bank: ..., type: ..., isPrimary: ..., ownerId: ..., });
+// Since all variables are optional for this query, you can omit the `FilterAccountsVariables` argument.
+const ref = filterAccountsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = filterAccountsRef(dataConnect, filterAccountsVars);
+
+// 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.accounts);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.accounts);
+});
+```
+
+## listApplications
+You can execute the `listApplications` 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
+listApplications(): QueryPromise;
+
+interface ListApplicationsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listApplicationsRef: ListApplicationsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listApplications(dc: DataConnect): QueryPromise;
+
+interface ListApplicationsRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listApplicationsRef: ListApplicationsRef;
+```
+
+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 listApplicationsRef:
+```typescript
+const name = listApplicationsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listApplications` query has no variables.
+### Return Type
+Recall that executing the `listApplications` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListApplicationsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListApplicationsData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `listApplications`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listApplications } from '@dataconnect/generated';
+
+
+// Call the `listApplications()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listApplications();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listApplications(dataConnect);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+listApplications().then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `listApplications`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listApplicationsRef } from '@dataconnect/generated';
+
+
+// Call the `listApplicationsRef()` function to get a reference to the query.
+const ref = listApplicationsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listApplicationsRef(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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## getApplicationById
+You can execute the `getApplicationById` 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
+getApplicationById(vars: GetApplicationByIdVariables): QueryPromise;
+
+interface GetApplicationByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetApplicationByIdVariables): QueryRef;
+}
+export const getApplicationByIdRef: GetApplicationByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getApplicationById(dc: DataConnect, vars: GetApplicationByIdVariables): QueryPromise;
+
+interface GetApplicationByIdRef {
+ ...
+ (dc: DataConnect, vars: GetApplicationByIdVariables): QueryRef;
+}
+export const getApplicationByIdRef: GetApplicationByIdRef;
+```
+
+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 getApplicationByIdRef:
+```typescript
+const name = getApplicationByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getApplicationById` query requires an argument of type `GetApplicationByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetApplicationByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getApplicationById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetApplicationByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetApplicationByIdData {
+ application?: {
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key;
+}
+```
+### Using `getApplicationById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getApplicationById, GetApplicationByIdVariables } from '@dataconnect/generated';
+
+// The `getApplicationById` query requires an argument of type `GetApplicationByIdVariables`:
+const getApplicationByIdVars: GetApplicationByIdVariables = {
+ id: ...,
+};
+
+// Call the `getApplicationById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getApplicationById(getApplicationByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getApplicationById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getApplicationById(dataConnect, getApplicationByIdVars);
+
+console.log(data.application);
+
+// Or, you can use the `Promise` API.
+getApplicationById(getApplicationByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.application);
+});
+```
+
+### Using `getApplicationById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getApplicationByIdRef, GetApplicationByIdVariables } from '@dataconnect/generated';
+
+// The `getApplicationById` query requires an argument of type `GetApplicationByIdVariables`:
+const getApplicationByIdVars: GetApplicationByIdVariables = {
+ id: ...,
+};
+
+// Call the `getApplicationByIdRef()` function to get a reference to the query.
+const ref = getApplicationByIdRef(getApplicationByIdVars);
+// Variables can be defined inline as well.
+const ref = getApplicationByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getApplicationByIdRef(dataConnect, getApplicationByIdVars);
+
+// 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.application);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.application);
+});
+```
+
+## getApplicationsByShiftId
+You can execute the `getApplicationsByShiftId` 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
+getApplicationsByShiftId(vars: GetApplicationsByShiftIdVariables): QueryPromise;
+
+interface GetApplicationsByShiftIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetApplicationsByShiftIdVariables): QueryRef;
+}
+export const getApplicationsByShiftIdRef: GetApplicationsByShiftIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getApplicationsByShiftId(dc: DataConnect, vars: GetApplicationsByShiftIdVariables): QueryPromise;
+
+interface GetApplicationsByShiftIdRef {
+ ...
+ (dc: DataConnect, vars: GetApplicationsByShiftIdVariables): QueryRef;
+}
+export const getApplicationsByShiftIdRef: GetApplicationsByShiftIdRef;
+```
+
+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 getApplicationsByShiftIdRef:
+```typescript
+const name = getApplicationsByShiftIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getApplicationsByShiftId` query requires an argument of type `GetApplicationsByShiftIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetApplicationsByShiftIdVariables {
+ shiftId: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getApplicationsByShiftId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetApplicationsByShiftIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetApplicationsByShiftIdData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `getApplicationsByShiftId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getApplicationsByShiftId, GetApplicationsByShiftIdVariables } from '@dataconnect/generated';
+
+// The `getApplicationsByShiftId` query requires an argument of type `GetApplicationsByShiftIdVariables`:
+const getApplicationsByShiftIdVars: GetApplicationsByShiftIdVariables = {
+ shiftId: ...,
+};
+
+// Call the `getApplicationsByShiftId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getApplicationsByShiftId(getApplicationsByShiftIdVars);
+// Variables can be defined inline as well.
+const { data } = await getApplicationsByShiftId({ shiftId: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getApplicationsByShiftId(dataConnect, getApplicationsByShiftIdVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+getApplicationsByShiftId(getApplicationsByShiftIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `getApplicationsByShiftId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getApplicationsByShiftIdRef, GetApplicationsByShiftIdVariables } from '@dataconnect/generated';
+
+// The `getApplicationsByShiftId` query requires an argument of type `GetApplicationsByShiftIdVariables`:
+const getApplicationsByShiftIdVars: GetApplicationsByShiftIdVariables = {
+ shiftId: ...,
+};
+
+// Call the `getApplicationsByShiftIdRef()` function to get a reference to the query.
+const ref = getApplicationsByShiftIdRef(getApplicationsByShiftIdVars);
+// Variables can be defined inline as well.
+const ref = getApplicationsByShiftIdRef({ shiftId: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getApplicationsByShiftIdRef(dataConnect, getApplicationsByShiftIdVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## getApplicationsByShiftIdAndStatus
+You can execute the `getApplicationsByShiftIdAndStatus` 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
+getApplicationsByShiftIdAndStatus(vars: GetApplicationsByShiftIdAndStatusVariables): QueryPromise;
+
+interface GetApplicationsByShiftIdAndStatusRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetApplicationsByShiftIdAndStatusVariables): QueryRef;
+}
+export const getApplicationsByShiftIdAndStatusRef: GetApplicationsByShiftIdAndStatusRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getApplicationsByShiftIdAndStatus(dc: DataConnect, vars: GetApplicationsByShiftIdAndStatusVariables): QueryPromise;
+
+interface GetApplicationsByShiftIdAndStatusRef {
+ ...
+ (dc: DataConnect, vars: GetApplicationsByShiftIdAndStatusVariables): QueryRef;
+}
+export const getApplicationsByShiftIdAndStatusRef: GetApplicationsByShiftIdAndStatusRef;
+```
+
+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 getApplicationsByShiftIdAndStatusRef:
+```typescript
+const name = getApplicationsByShiftIdAndStatusRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getApplicationsByShiftIdAndStatus` query requires an argument of type `GetApplicationsByShiftIdAndStatusVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetApplicationsByShiftIdAndStatusVariables {
+ shiftId: UUIDString;
+ status: ApplicationStatus;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `getApplicationsByShiftIdAndStatus` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetApplicationsByShiftIdAndStatusData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetApplicationsByShiftIdAndStatusData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `getApplicationsByShiftIdAndStatus`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getApplicationsByShiftIdAndStatus, GetApplicationsByShiftIdAndStatusVariables } from '@dataconnect/generated';
+
+// The `getApplicationsByShiftIdAndStatus` query requires an argument of type `GetApplicationsByShiftIdAndStatusVariables`:
+const getApplicationsByShiftIdAndStatusVars: GetApplicationsByShiftIdAndStatusVariables = {
+ shiftId: ...,
+ status: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getApplicationsByShiftIdAndStatus()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getApplicationsByShiftIdAndStatus(getApplicationsByShiftIdAndStatusVars);
+// Variables can be defined inline as well.
+const { data } = await getApplicationsByShiftIdAndStatus({ shiftId: ..., status: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getApplicationsByShiftIdAndStatus(dataConnect, getApplicationsByShiftIdAndStatusVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+getApplicationsByShiftIdAndStatus(getApplicationsByShiftIdAndStatusVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `getApplicationsByShiftIdAndStatus`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getApplicationsByShiftIdAndStatusRef, GetApplicationsByShiftIdAndStatusVariables } from '@dataconnect/generated';
+
+// The `getApplicationsByShiftIdAndStatus` query requires an argument of type `GetApplicationsByShiftIdAndStatusVariables`:
+const getApplicationsByShiftIdAndStatusVars: GetApplicationsByShiftIdAndStatusVariables = {
+ shiftId: ...,
+ status: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getApplicationsByShiftIdAndStatusRef()` function to get a reference to the query.
+const ref = getApplicationsByShiftIdAndStatusRef(getApplicationsByShiftIdAndStatusVars);
+// Variables can be defined inline as well.
+const ref = getApplicationsByShiftIdAndStatusRef({ shiftId: ..., status: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getApplicationsByShiftIdAndStatusRef(dataConnect, getApplicationsByShiftIdAndStatusVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## getApplicationsByStaffId
+You can execute the `getApplicationsByStaffId` 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
+getApplicationsByStaffId(vars: GetApplicationsByStaffIdVariables): QueryPromise;
+
+interface GetApplicationsByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetApplicationsByStaffIdVariables): QueryRef;
+}
+export const getApplicationsByStaffIdRef: GetApplicationsByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getApplicationsByStaffId(dc: DataConnect, vars: GetApplicationsByStaffIdVariables): QueryPromise;
+
+interface GetApplicationsByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: GetApplicationsByStaffIdVariables): QueryRef;
+}
+export const getApplicationsByStaffIdRef: GetApplicationsByStaffIdRef;
+```
+
+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 getApplicationsByStaffIdRef:
+```typescript
+const name = getApplicationsByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getApplicationsByStaffId` query requires an argument of type `GetApplicationsByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetApplicationsByStaffIdVariables {
+ staffId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+ dayStart?: TimestampString | null;
+ dayEnd?: TimestampString | null;
+}
+```
+### Return Type
+Recall that executing the `getApplicationsByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetApplicationsByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetApplicationsByStaffIdData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ durationDays?: number | null;
+ description?: string | null;
+ latitude?: number | null;
+ longitude?: number | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ companyLogoUrl?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `getApplicationsByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getApplicationsByStaffId, GetApplicationsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `getApplicationsByStaffId` query requires an argument of type `GetApplicationsByStaffIdVariables`:
+const getApplicationsByStaffIdVars: GetApplicationsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+ dayStart: ..., // optional
+ dayEnd: ..., // optional
+};
+
+// Call the `getApplicationsByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getApplicationsByStaffId(getApplicationsByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await getApplicationsByStaffId({ staffId: ..., offset: ..., limit: ..., dayStart: ..., dayEnd: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getApplicationsByStaffId(dataConnect, getApplicationsByStaffIdVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+getApplicationsByStaffId(getApplicationsByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `getApplicationsByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getApplicationsByStaffIdRef, GetApplicationsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `getApplicationsByStaffId` query requires an argument of type `GetApplicationsByStaffIdVariables`:
+const getApplicationsByStaffIdVars: GetApplicationsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+ dayStart: ..., // optional
+ dayEnd: ..., // optional
+};
+
+// Call the `getApplicationsByStaffIdRef()` function to get a reference to the query.
+const ref = getApplicationsByStaffIdRef(getApplicationsByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = getApplicationsByStaffIdRef({ staffId: ..., offset: ..., limit: ..., dayStart: ..., dayEnd: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getApplicationsByStaffIdRef(dataConnect, getApplicationsByStaffIdVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## vaidateDayStaffApplication
+You can execute the `vaidateDayStaffApplication` 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
+vaidateDayStaffApplication(vars: VaidateDayStaffApplicationVariables): QueryPromise;
+
+interface VaidateDayStaffApplicationRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: VaidateDayStaffApplicationVariables): QueryRef;
+}
+export const vaidateDayStaffApplicationRef: VaidateDayStaffApplicationRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+vaidateDayStaffApplication(dc: DataConnect, vars: VaidateDayStaffApplicationVariables): QueryPromise;
+
+interface VaidateDayStaffApplicationRef {
+ ...
+ (dc: DataConnect, vars: VaidateDayStaffApplicationVariables): QueryRef;
+}
+export const vaidateDayStaffApplicationRef: VaidateDayStaffApplicationRef;
+```
+
+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 vaidateDayStaffApplicationRef:
+```typescript
+const name = vaidateDayStaffApplicationRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `vaidateDayStaffApplication` query requires an argument of type `VaidateDayStaffApplicationVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface VaidateDayStaffApplicationVariables {
+ staffId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+ dayStart?: TimestampString | null;
+ dayEnd?: TimestampString | null;
+}
+```
+### Return Type
+Recall that executing the `vaidateDayStaffApplication` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `VaidateDayStaffApplicationData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface VaidateDayStaffApplicationData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ durationDays?: number | null;
+ description?: string | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ companyLogoUrl?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `vaidateDayStaffApplication`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, vaidateDayStaffApplication, VaidateDayStaffApplicationVariables } from '@dataconnect/generated';
+
+// The `vaidateDayStaffApplication` query requires an argument of type `VaidateDayStaffApplicationVariables`:
+const vaidateDayStaffApplicationVars: VaidateDayStaffApplicationVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+ dayStart: ..., // optional
+ dayEnd: ..., // optional
+};
+
+// Call the `vaidateDayStaffApplication()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await vaidateDayStaffApplication(vaidateDayStaffApplicationVars);
+// Variables can be defined inline as well.
+const { data } = await vaidateDayStaffApplication({ staffId: ..., offset: ..., limit: ..., dayStart: ..., dayEnd: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await vaidateDayStaffApplication(dataConnect, vaidateDayStaffApplicationVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+vaidateDayStaffApplication(vaidateDayStaffApplicationVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `vaidateDayStaffApplication`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, vaidateDayStaffApplicationRef, VaidateDayStaffApplicationVariables } from '@dataconnect/generated';
+
+// The `vaidateDayStaffApplication` query requires an argument of type `VaidateDayStaffApplicationVariables`:
+const vaidateDayStaffApplicationVars: VaidateDayStaffApplicationVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+ dayStart: ..., // optional
+ dayEnd: ..., // optional
+};
+
+// Call the `vaidateDayStaffApplicationRef()` function to get a reference to the query.
+const ref = vaidateDayStaffApplicationRef(vaidateDayStaffApplicationVars);
+// Variables can be defined inline as well.
+const ref = vaidateDayStaffApplicationRef({ staffId: ..., offset: ..., limit: ..., dayStart: ..., dayEnd: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = vaidateDayStaffApplicationRef(dataConnect, vaidateDayStaffApplicationVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## getApplicationByStaffShiftAndRole
+You can execute the `getApplicationByStaffShiftAndRole` 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
+getApplicationByStaffShiftAndRole(vars: GetApplicationByStaffShiftAndRoleVariables): QueryPromise;
+
+interface GetApplicationByStaffShiftAndRoleRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetApplicationByStaffShiftAndRoleVariables): QueryRef;
+}
+export const getApplicationByStaffShiftAndRoleRef: GetApplicationByStaffShiftAndRoleRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getApplicationByStaffShiftAndRole(dc: DataConnect, vars: GetApplicationByStaffShiftAndRoleVariables): QueryPromise;
+
+interface GetApplicationByStaffShiftAndRoleRef {
+ ...
+ (dc: DataConnect, vars: GetApplicationByStaffShiftAndRoleVariables): QueryRef;
+}
+export const getApplicationByStaffShiftAndRoleRef: GetApplicationByStaffShiftAndRoleRef;
+```
+
+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 getApplicationByStaffShiftAndRoleRef:
+```typescript
+const name = getApplicationByStaffShiftAndRoleRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getApplicationByStaffShiftAndRole` query requires an argument of type `GetApplicationByStaffShiftAndRoleVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetApplicationByStaffShiftAndRoleVariables {
+ staffId: UUIDString;
+ shiftId: UUIDString;
+ roleId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `getApplicationByStaffShiftAndRole` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetApplicationByStaffShiftAndRoleData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetApplicationByStaffShiftAndRoleData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ companyLogoUrl?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `getApplicationByStaffShiftAndRole`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getApplicationByStaffShiftAndRole, GetApplicationByStaffShiftAndRoleVariables } from '@dataconnect/generated';
+
+// The `getApplicationByStaffShiftAndRole` query requires an argument of type `GetApplicationByStaffShiftAndRoleVariables`:
+const getApplicationByStaffShiftAndRoleVars: GetApplicationByStaffShiftAndRoleVariables = {
+ staffId: ...,
+ shiftId: ...,
+ roleId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getApplicationByStaffShiftAndRole()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getApplicationByStaffShiftAndRole(getApplicationByStaffShiftAndRoleVars);
+// Variables can be defined inline as well.
+const { data } = await getApplicationByStaffShiftAndRole({ staffId: ..., shiftId: ..., roleId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getApplicationByStaffShiftAndRole(dataConnect, getApplicationByStaffShiftAndRoleVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+getApplicationByStaffShiftAndRole(getApplicationByStaffShiftAndRoleVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `getApplicationByStaffShiftAndRole`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getApplicationByStaffShiftAndRoleRef, GetApplicationByStaffShiftAndRoleVariables } from '@dataconnect/generated';
+
+// The `getApplicationByStaffShiftAndRole` query requires an argument of type `GetApplicationByStaffShiftAndRoleVariables`:
+const getApplicationByStaffShiftAndRoleVars: GetApplicationByStaffShiftAndRoleVariables = {
+ staffId: ...,
+ shiftId: ...,
+ roleId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `getApplicationByStaffShiftAndRoleRef()` function to get a reference to the query.
+const ref = getApplicationByStaffShiftAndRoleRef(getApplicationByStaffShiftAndRoleVars);
+// Variables can be defined inline as well.
+const ref = getApplicationByStaffShiftAndRoleRef({ staffId: ..., shiftId: ..., roleId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getApplicationByStaffShiftAndRoleRef(dataConnect, getApplicationByStaffShiftAndRoleVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## listAcceptedApplicationsByShiftRoleKey
+You can execute the `listAcceptedApplicationsByShiftRoleKey` 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
+listAcceptedApplicationsByShiftRoleKey(vars: ListAcceptedApplicationsByShiftRoleKeyVariables): QueryPromise;
+
+interface ListAcceptedApplicationsByShiftRoleKeyRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListAcceptedApplicationsByShiftRoleKeyVariables): QueryRef;
+}
+export const listAcceptedApplicationsByShiftRoleKeyRef: ListAcceptedApplicationsByShiftRoleKeyRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAcceptedApplicationsByShiftRoleKey(dc: DataConnect, vars: ListAcceptedApplicationsByShiftRoleKeyVariables): QueryPromise;
+
+interface ListAcceptedApplicationsByShiftRoleKeyRef {
+ ...
+ (dc: DataConnect, vars: ListAcceptedApplicationsByShiftRoleKeyVariables): QueryRef;
+}
+export const listAcceptedApplicationsByShiftRoleKeyRef: ListAcceptedApplicationsByShiftRoleKeyRef;
+```
+
+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 listAcceptedApplicationsByShiftRoleKeyRef:
+```typescript
+const name = listAcceptedApplicationsByShiftRoleKeyRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAcceptedApplicationsByShiftRoleKey` query requires an argument of type `ListAcceptedApplicationsByShiftRoleKeyVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListAcceptedApplicationsByShiftRoleKeyVariables {
+ shiftId: UUIDString;
+ roleId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listAcceptedApplicationsByShiftRoleKey` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAcceptedApplicationsByShiftRoleKeyData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAcceptedApplicationsByShiftRoleKeyData {
+ applications: ({
+ id: UUIDString;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ email?: string | null;
+ phone?: string | null;
+ photoUrl?: string | null;
+ } & Staff_Key;
+ } & Application_Key)[];
+}
+```
+### Using `listAcceptedApplicationsByShiftRoleKey`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAcceptedApplicationsByShiftRoleKey, ListAcceptedApplicationsByShiftRoleKeyVariables } from '@dataconnect/generated';
+
+// The `listAcceptedApplicationsByShiftRoleKey` query requires an argument of type `ListAcceptedApplicationsByShiftRoleKeyVariables`:
+const listAcceptedApplicationsByShiftRoleKeyVars: ListAcceptedApplicationsByShiftRoleKeyVariables = {
+ shiftId: ...,
+ roleId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAcceptedApplicationsByShiftRoleKey()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAcceptedApplicationsByShiftRoleKey(listAcceptedApplicationsByShiftRoleKeyVars);
+// Variables can be defined inline as well.
+const { data } = await listAcceptedApplicationsByShiftRoleKey({ shiftId: ..., roleId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAcceptedApplicationsByShiftRoleKey(dataConnect, listAcceptedApplicationsByShiftRoleKeyVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+listAcceptedApplicationsByShiftRoleKey(listAcceptedApplicationsByShiftRoleKeyVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `listAcceptedApplicationsByShiftRoleKey`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAcceptedApplicationsByShiftRoleKeyRef, ListAcceptedApplicationsByShiftRoleKeyVariables } from '@dataconnect/generated';
+
+// The `listAcceptedApplicationsByShiftRoleKey` query requires an argument of type `ListAcceptedApplicationsByShiftRoleKeyVariables`:
+const listAcceptedApplicationsByShiftRoleKeyVars: ListAcceptedApplicationsByShiftRoleKeyVariables = {
+ shiftId: ...,
+ roleId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAcceptedApplicationsByShiftRoleKeyRef()` function to get a reference to the query.
+const ref = listAcceptedApplicationsByShiftRoleKeyRef(listAcceptedApplicationsByShiftRoleKeyVars);
+// Variables can be defined inline as well.
+const ref = listAcceptedApplicationsByShiftRoleKeyRef({ shiftId: ..., roleId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAcceptedApplicationsByShiftRoleKeyRef(dataConnect, listAcceptedApplicationsByShiftRoleKeyVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## listAcceptedApplicationsByBusinessForDay
+You can execute the `listAcceptedApplicationsByBusinessForDay` 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
+listAcceptedApplicationsByBusinessForDay(vars: ListAcceptedApplicationsByBusinessForDayVariables): QueryPromise;
+
+interface ListAcceptedApplicationsByBusinessForDayRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListAcceptedApplicationsByBusinessForDayVariables): QueryRef;
+}
+export const listAcceptedApplicationsByBusinessForDayRef: ListAcceptedApplicationsByBusinessForDayRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAcceptedApplicationsByBusinessForDay(dc: DataConnect, vars: ListAcceptedApplicationsByBusinessForDayVariables): QueryPromise;
+
+interface ListAcceptedApplicationsByBusinessForDayRef {
+ ...
+ (dc: DataConnect, vars: ListAcceptedApplicationsByBusinessForDayVariables): QueryRef;
+}
+export const listAcceptedApplicationsByBusinessForDayRef: ListAcceptedApplicationsByBusinessForDayRef;
+```
+
+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 listAcceptedApplicationsByBusinessForDayRef:
+```typescript
+const name = listAcceptedApplicationsByBusinessForDayRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAcceptedApplicationsByBusinessForDay` query requires an argument of type `ListAcceptedApplicationsByBusinessForDayVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListAcceptedApplicationsByBusinessForDayVariables {
+ businessId: UUIDString;
+ dayStart: TimestampString;
+ dayEnd: TimestampString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listAcceptedApplicationsByBusinessForDay` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAcceptedApplicationsByBusinessForDayData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAcceptedApplicationsByBusinessForDayData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ roleId: UUIDString;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ appliedAt?: TimestampString | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ email?: string | null;
+ phone?: string | null;
+ photoUrl?: string | null;
+ averageRating?: number | null;
+ } & Staff_Key;
+ } & Application_Key)[];
+}
+```
+### Using `listAcceptedApplicationsByBusinessForDay`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAcceptedApplicationsByBusinessForDay, ListAcceptedApplicationsByBusinessForDayVariables } from '@dataconnect/generated';
+
+// The `listAcceptedApplicationsByBusinessForDay` query requires an argument of type `ListAcceptedApplicationsByBusinessForDayVariables`:
+const listAcceptedApplicationsByBusinessForDayVars: ListAcceptedApplicationsByBusinessForDayVariables = {
+ businessId: ...,
+ dayStart: ...,
+ dayEnd: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAcceptedApplicationsByBusinessForDay()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAcceptedApplicationsByBusinessForDay(listAcceptedApplicationsByBusinessForDayVars);
+// Variables can be defined inline as well.
+const { data } = await listAcceptedApplicationsByBusinessForDay({ businessId: ..., dayStart: ..., dayEnd: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAcceptedApplicationsByBusinessForDay(dataConnect, listAcceptedApplicationsByBusinessForDayVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+listAcceptedApplicationsByBusinessForDay(listAcceptedApplicationsByBusinessForDayVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `listAcceptedApplicationsByBusinessForDay`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAcceptedApplicationsByBusinessForDayRef, ListAcceptedApplicationsByBusinessForDayVariables } from '@dataconnect/generated';
+
+// The `listAcceptedApplicationsByBusinessForDay` query requires an argument of type `ListAcceptedApplicationsByBusinessForDayVariables`:
+const listAcceptedApplicationsByBusinessForDayVars: ListAcceptedApplicationsByBusinessForDayVariables = {
+ businessId: ...,
+ dayStart: ...,
+ dayEnd: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listAcceptedApplicationsByBusinessForDayRef()` function to get a reference to the query.
+const ref = listAcceptedApplicationsByBusinessForDayRef(listAcceptedApplicationsByBusinessForDayVars);
+// Variables can be defined inline as well.
+const ref = listAcceptedApplicationsByBusinessForDayRef({ businessId: ..., dayStart: ..., dayEnd: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAcceptedApplicationsByBusinessForDayRef(dataConnect, listAcceptedApplicationsByBusinessForDayVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## listStaffsApplicationsByBusinessForDay
+You can execute the `listStaffsApplicationsByBusinessForDay` 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
+listStaffsApplicationsByBusinessForDay(vars: ListStaffsApplicationsByBusinessForDayVariables): QueryPromise;
+
+interface ListStaffsApplicationsByBusinessForDayRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListStaffsApplicationsByBusinessForDayVariables): QueryRef;
+}
+export const listStaffsApplicationsByBusinessForDayRef: ListStaffsApplicationsByBusinessForDayRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffsApplicationsByBusinessForDay(dc: DataConnect, vars: ListStaffsApplicationsByBusinessForDayVariables): QueryPromise;
+
+interface ListStaffsApplicationsByBusinessForDayRef {
+ ...
+ (dc: DataConnect, vars: ListStaffsApplicationsByBusinessForDayVariables): QueryRef;
+}
+export const listStaffsApplicationsByBusinessForDayRef: ListStaffsApplicationsByBusinessForDayRef;
+```
+
+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 listStaffsApplicationsByBusinessForDayRef:
+```typescript
+const name = listStaffsApplicationsByBusinessForDayRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffsApplicationsByBusinessForDay` query requires an argument of type `ListStaffsApplicationsByBusinessForDayVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffsApplicationsByBusinessForDayVariables {
+ businessId: UUIDString;
+ dayStart: TimestampString;
+ dayEnd: TimestampString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffsApplicationsByBusinessForDay` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffsApplicationsByBusinessForDayData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffsApplicationsByBusinessForDayData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ roleId: UUIDString;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ appliedAt?: TimestampString | null;
+ status: ApplicationStatus;
+ shiftRole: {
+ shift: {
+ location?: string | null;
+ cost?: number | null;
+ };
+ count: number;
+ assigned?: number | null;
+ hours?: number | null;
+ role: {
+ name: string;
+ };
+ };
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ email?: string | null;
+ phone?: string | null;
+ photoUrl?: string | null;
+ } & Staff_Key;
+ } & Application_Key)[];
+}
+```
+### Using `listStaffsApplicationsByBusinessForDay`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffsApplicationsByBusinessForDay, ListStaffsApplicationsByBusinessForDayVariables } from '@dataconnect/generated';
+
+// The `listStaffsApplicationsByBusinessForDay` query requires an argument of type `ListStaffsApplicationsByBusinessForDayVariables`:
+const listStaffsApplicationsByBusinessForDayVars: ListStaffsApplicationsByBusinessForDayVariables = {
+ businessId: ...,
+ dayStart: ...,
+ dayEnd: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffsApplicationsByBusinessForDay()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffsApplicationsByBusinessForDay(listStaffsApplicationsByBusinessForDayVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffsApplicationsByBusinessForDay({ businessId: ..., dayStart: ..., dayEnd: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffsApplicationsByBusinessForDay(dataConnect, listStaffsApplicationsByBusinessForDayVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+listStaffsApplicationsByBusinessForDay(listStaffsApplicationsByBusinessForDayVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `listStaffsApplicationsByBusinessForDay`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffsApplicationsByBusinessForDayRef, ListStaffsApplicationsByBusinessForDayVariables } from '@dataconnect/generated';
+
+// The `listStaffsApplicationsByBusinessForDay` query requires an argument of type `ListStaffsApplicationsByBusinessForDayVariables`:
+const listStaffsApplicationsByBusinessForDayVars: ListStaffsApplicationsByBusinessForDayVariables = {
+ businessId: ...,
+ dayStart: ...,
+ dayEnd: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffsApplicationsByBusinessForDayRef()` function to get a reference to the query.
+const ref = listStaffsApplicationsByBusinessForDayRef(listStaffsApplicationsByBusinessForDayVars);
+// Variables can be defined inline as well.
+const ref = listStaffsApplicationsByBusinessForDayRef({ businessId: ..., dayStart: ..., dayEnd: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffsApplicationsByBusinessForDayRef(dataConnect, listStaffsApplicationsByBusinessForDayVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## listCompletedApplicationsByStaffId
+You can execute the `listCompletedApplicationsByStaffId` 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
+listCompletedApplicationsByStaffId(vars: ListCompletedApplicationsByStaffIdVariables): QueryPromise;
+
+interface ListCompletedApplicationsByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListCompletedApplicationsByStaffIdVariables): QueryRef;
+}
+export const listCompletedApplicationsByStaffIdRef: ListCompletedApplicationsByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listCompletedApplicationsByStaffId(dc: DataConnect, vars: ListCompletedApplicationsByStaffIdVariables): QueryPromise;
+
+interface ListCompletedApplicationsByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: ListCompletedApplicationsByStaffIdVariables): QueryRef;
+}
+export const listCompletedApplicationsByStaffIdRef: ListCompletedApplicationsByStaffIdRef;
+```
+
+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 listCompletedApplicationsByStaffIdRef:
+```typescript
+const name = listCompletedApplicationsByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listCompletedApplicationsByStaffId` query requires an argument of type `ListCompletedApplicationsByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListCompletedApplicationsByStaffIdVariables {
+ staffId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listCompletedApplicationsByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListCompletedApplicationsByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListCompletedApplicationsByStaffIdData {
+ applications: ({
+ id: UUIDString;
+ shiftId: UUIDString;
+ staffId: UUIDString;
+ status: ApplicationStatus;
+ appliedAt?: TimestampString | null;
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ origin: ApplicationOrigin;
+ createdAt?: TimestampString | null;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ location?: string | null;
+ status?: ShiftStatus | null;
+ description?: string | null;
+ durationDays?: number | null;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ business: {
+ id: UUIDString;
+ businessName: string;
+ email?: string | null;
+ contactName?: string | null;
+ companyLogoUrl?: string | null;
+ } & Business_Key;
+ vendor?: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ } & Order_Key;
+ } & Shift_Key;
+ shiftRole: {
+ id: UUIDString;
+ roleId: UUIDString;
+ count: number;
+ assigned?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ };
+ } & Application_Key)[];
+}
+```
+### Using `listCompletedApplicationsByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listCompletedApplicationsByStaffId, ListCompletedApplicationsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listCompletedApplicationsByStaffId` query requires an argument of type `ListCompletedApplicationsByStaffIdVariables`:
+const listCompletedApplicationsByStaffIdVars: ListCompletedApplicationsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listCompletedApplicationsByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listCompletedApplicationsByStaffId(listCompletedApplicationsByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await listCompletedApplicationsByStaffId({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listCompletedApplicationsByStaffId(dataConnect, listCompletedApplicationsByStaffIdVars);
+
+console.log(data.applications);
+
+// Or, you can use the `Promise` API.
+listCompletedApplicationsByStaffId(listCompletedApplicationsByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+### Using `listCompletedApplicationsByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listCompletedApplicationsByStaffIdRef, ListCompletedApplicationsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listCompletedApplicationsByStaffId` query requires an argument of type `ListCompletedApplicationsByStaffIdVariables`:
+const listCompletedApplicationsByStaffIdVars: ListCompletedApplicationsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listCompletedApplicationsByStaffIdRef()` function to get a reference to the query.
+const ref = listCompletedApplicationsByStaffIdRef(listCompletedApplicationsByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = listCompletedApplicationsByStaffIdRef({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listCompletedApplicationsByStaffIdRef(dataConnect, listCompletedApplicationsByStaffIdVars);
+
+// 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.applications);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.applications);
+});
+```
+
+## listAttireOptions
+You can execute the `listAttireOptions` 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
+listAttireOptions(): QueryPromise;
+
+interface ListAttireOptionsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listAttireOptionsRef: ListAttireOptionsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listAttireOptions(dc: DataConnect): QueryPromise;
+
+interface ListAttireOptionsRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listAttireOptionsRef: ListAttireOptionsRef;
+```
+
+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 listAttireOptionsRef:
+```typescript
+const name = listAttireOptionsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listAttireOptions` query has no variables.
+### Return Type
+Recall that executing the `listAttireOptions` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListAttireOptionsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListAttireOptionsData {
+ attireOptions: ({
+ id: UUIDString;
+ itemId: string;
+ label: string;
+ icon?: string | null;
+ imageUrl?: string | null;
+ isMandatory?: boolean | null;
+ vendorId?: UUIDString | null;
+ createdAt?: TimestampString | null;
+ } & AttireOption_Key)[];
+}
+```
+### Using `listAttireOptions`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listAttireOptions } from '@dataconnect/generated';
+
+
+// Call the `listAttireOptions()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listAttireOptions();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listAttireOptions(dataConnect);
+
+console.log(data.attireOptions);
+
+// Or, you can use the `Promise` API.
+listAttireOptions().then((response) => {
+ const data = response.data;
+ console.log(data.attireOptions);
+});
+```
+
+### Using `listAttireOptions`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listAttireOptionsRef } from '@dataconnect/generated';
+
+
+// Call the `listAttireOptionsRef()` function to get a reference to the query.
+const ref = listAttireOptionsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listAttireOptionsRef(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.attireOptions);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.attireOptions);
+});
+```
+
+## getAttireOptionById
+You can execute the `getAttireOptionById` 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
+getAttireOptionById(vars: GetAttireOptionByIdVariables): QueryPromise;
+
+interface GetAttireOptionByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetAttireOptionByIdVariables): QueryRef;
+}
+export const getAttireOptionByIdRef: GetAttireOptionByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getAttireOptionById(dc: DataConnect, vars: GetAttireOptionByIdVariables): QueryPromise;
+
+interface GetAttireOptionByIdRef {
+ ...
+ (dc: DataConnect, vars: GetAttireOptionByIdVariables): QueryRef;
+}
+export const getAttireOptionByIdRef: GetAttireOptionByIdRef;
+```
+
+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 getAttireOptionByIdRef:
+```typescript
+const name = getAttireOptionByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getAttireOptionById` query requires an argument of type `GetAttireOptionByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetAttireOptionByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getAttireOptionById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetAttireOptionByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetAttireOptionByIdData {
+ attireOption?: {
+ id: UUIDString;
+ itemId: string;
+ label: string;
+ icon?: string | null;
+ imageUrl?: string | null;
+ isMandatory?: boolean | null;
+ vendorId?: UUIDString | null;
+ createdAt?: TimestampString | null;
+ } & AttireOption_Key;
+}
+```
+### Using `getAttireOptionById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getAttireOptionById, GetAttireOptionByIdVariables } from '@dataconnect/generated';
+
+// The `getAttireOptionById` query requires an argument of type `GetAttireOptionByIdVariables`:
+const getAttireOptionByIdVars: GetAttireOptionByIdVariables = {
+ id: ...,
+};
+
+// Call the `getAttireOptionById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getAttireOptionById(getAttireOptionByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getAttireOptionById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getAttireOptionById(dataConnect, getAttireOptionByIdVars);
+
+console.log(data.attireOption);
+
+// Or, you can use the `Promise` API.
+getAttireOptionById(getAttireOptionByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.attireOption);
+});
+```
+
+### Using `getAttireOptionById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getAttireOptionByIdRef, GetAttireOptionByIdVariables } from '@dataconnect/generated';
+
+// The `getAttireOptionById` query requires an argument of type `GetAttireOptionByIdVariables`:
+const getAttireOptionByIdVars: GetAttireOptionByIdVariables = {
+ id: ...,
+};
+
+// Call the `getAttireOptionByIdRef()` function to get a reference to the query.
+const ref = getAttireOptionByIdRef(getAttireOptionByIdVars);
+// Variables can be defined inline as well.
+const ref = getAttireOptionByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getAttireOptionByIdRef(dataConnect, getAttireOptionByIdVars);
+
+// 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.attireOption);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.attireOption);
+});
+```
+
+## filterAttireOptions
+You can execute the `filterAttireOptions` 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
+filterAttireOptions(vars?: FilterAttireOptionsVariables): QueryPromise;
+
+interface FilterAttireOptionsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: FilterAttireOptionsVariables): QueryRef;
+}
+export const filterAttireOptionsRef: FilterAttireOptionsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+filterAttireOptions(dc: DataConnect, vars?: FilterAttireOptionsVariables): QueryPromise;
+
+interface FilterAttireOptionsRef {
+ ...
+ (dc: DataConnect, vars?: FilterAttireOptionsVariables): QueryRef;
+}
+export const filterAttireOptionsRef: FilterAttireOptionsRef;
+```
+
+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 filterAttireOptionsRef:
+```typescript
+const name = filterAttireOptionsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `filterAttireOptions` query has an optional argument of type `FilterAttireOptionsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface FilterAttireOptionsVariables {
+ itemId?: string | null;
+ isMandatory?: boolean | null;
+ vendorId?: UUIDString | null;
+}
+```
+### Return Type
+Recall that executing the `filterAttireOptions` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `FilterAttireOptionsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface FilterAttireOptionsData {
+ attireOptions: ({
+ id: UUIDString;
+ itemId: string;
+ label: string;
+ icon?: string | null;
+ imageUrl?: string | null;
+ isMandatory?: boolean | null;
+ vendorId?: UUIDString | null;
+ } & AttireOption_Key)[];
+}
+```
+### Using `filterAttireOptions`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, filterAttireOptions, FilterAttireOptionsVariables } from '@dataconnect/generated';
+
+// The `filterAttireOptions` query has an optional argument of type `FilterAttireOptionsVariables`:
+const filterAttireOptionsVars: FilterAttireOptionsVariables = {
+ itemId: ..., // optional
+ isMandatory: ..., // optional
+ vendorId: ..., // optional
+};
+
+// Call the `filterAttireOptions()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await filterAttireOptions(filterAttireOptionsVars);
+// Variables can be defined inline as well.
+const { data } = await filterAttireOptions({ itemId: ..., isMandatory: ..., vendorId: ..., });
+// Since all variables are optional for this query, you can omit the `FilterAttireOptionsVariables` argument.
+const { data } = await filterAttireOptions();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await filterAttireOptions(dataConnect, filterAttireOptionsVars);
+
+console.log(data.attireOptions);
+
+// Or, you can use the `Promise` API.
+filterAttireOptions(filterAttireOptionsVars).then((response) => {
+ const data = response.data;
+ console.log(data.attireOptions);
+});
+```
+
+### Using `filterAttireOptions`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, filterAttireOptionsRef, FilterAttireOptionsVariables } from '@dataconnect/generated';
+
+// The `filterAttireOptions` query has an optional argument of type `FilterAttireOptionsVariables`:
+const filterAttireOptionsVars: FilterAttireOptionsVariables = {
+ itemId: ..., // optional
+ isMandatory: ..., // optional
+ vendorId: ..., // optional
+};
+
+// Call the `filterAttireOptionsRef()` function to get a reference to the query.
+const ref = filterAttireOptionsRef(filterAttireOptionsVars);
+// Variables can be defined inline as well.
+const ref = filterAttireOptionsRef({ itemId: ..., isMandatory: ..., vendorId: ..., });
+// Since all variables are optional for this query, you can omit the `FilterAttireOptionsVariables` argument.
+const ref = filterAttireOptionsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = filterAttireOptionsRef(dataConnect, filterAttireOptionsVars);
+
+// 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.attireOptions);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.attireOptions);
+});
+```
+
+## listCustomRateCards
+You can execute the `listCustomRateCards` 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
+listCustomRateCards(): QueryPromise;
+
+interface ListCustomRateCardsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listCustomRateCardsRef: ListCustomRateCardsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listCustomRateCards(dc: DataConnect): QueryPromise;
+
+interface ListCustomRateCardsRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listCustomRateCardsRef: ListCustomRateCardsRef;
+```
+
+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 listCustomRateCardsRef:
+```typescript
+const name = listCustomRateCardsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listCustomRateCards` query has no variables.
+### Return Type
+Recall that executing the `listCustomRateCards` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListCustomRateCardsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListCustomRateCardsData {
+ customRateCards: ({
+ id: UUIDString;
+ name: string;
+ baseBook?: string | null;
+ discount?: number | null;
+ isDefault?: boolean | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ } & CustomRateCard_Key)[];
+}
+```
+### Using `listCustomRateCards`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listCustomRateCards } from '@dataconnect/generated';
+
+
+// Call the `listCustomRateCards()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listCustomRateCards();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listCustomRateCards(dataConnect);
+
+console.log(data.customRateCards);
+
+// Or, you can use the `Promise` API.
+listCustomRateCards().then((response) => {
+ const data = response.data;
+ console.log(data.customRateCards);
+});
+```
+
+### Using `listCustomRateCards`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listCustomRateCardsRef } from '@dataconnect/generated';
+
+
+// Call the `listCustomRateCardsRef()` function to get a reference to the query.
+const ref = listCustomRateCardsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listCustomRateCardsRef(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.customRateCards);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.customRateCards);
+});
+```
+
+## getCustomRateCardById
+You can execute the `getCustomRateCardById` 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
+getCustomRateCardById(vars: GetCustomRateCardByIdVariables): QueryPromise;
+
+interface GetCustomRateCardByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetCustomRateCardByIdVariables): QueryRef;
+}
+export const getCustomRateCardByIdRef: GetCustomRateCardByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getCustomRateCardById(dc: DataConnect, vars: GetCustomRateCardByIdVariables): QueryPromise;
+
+interface GetCustomRateCardByIdRef {
+ ...
+ (dc: DataConnect, vars: GetCustomRateCardByIdVariables): QueryRef;
+}
+export const getCustomRateCardByIdRef: GetCustomRateCardByIdRef;
+```
+
+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 getCustomRateCardByIdRef:
+```typescript
+const name = getCustomRateCardByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getCustomRateCardById` query requires an argument of type `GetCustomRateCardByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetCustomRateCardByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getCustomRateCardById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetCustomRateCardByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetCustomRateCardByIdData {
+ customRateCard?: {
+ id: UUIDString;
+ name: string;
+ baseBook?: string | null;
+ discount?: number | null;
+ isDefault?: boolean | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ } & CustomRateCard_Key;
+}
+```
+### Using `getCustomRateCardById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getCustomRateCardById, GetCustomRateCardByIdVariables } from '@dataconnect/generated';
+
+// The `getCustomRateCardById` query requires an argument of type `GetCustomRateCardByIdVariables`:
+const getCustomRateCardByIdVars: GetCustomRateCardByIdVariables = {
+ id: ...,
+};
+
+// Call the `getCustomRateCardById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getCustomRateCardById(getCustomRateCardByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getCustomRateCardById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getCustomRateCardById(dataConnect, getCustomRateCardByIdVars);
+
+console.log(data.customRateCard);
+
+// Or, you can use the `Promise` API.
+getCustomRateCardById(getCustomRateCardByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.customRateCard);
+});
+```
+
+### Using `getCustomRateCardById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getCustomRateCardByIdRef, GetCustomRateCardByIdVariables } from '@dataconnect/generated';
+
+// The `getCustomRateCardById` query requires an argument of type `GetCustomRateCardByIdVariables`:
+const getCustomRateCardByIdVars: GetCustomRateCardByIdVariables = {
+ id: ...,
+};
+
+// Call the `getCustomRateCardByIdRef()` function to get a reference to the query.
+const ref = getCustomRateCardByIdRef(getCustomRateCardByIdVars);
+// Variables can be defined inline as well.
+const ref = getCustomRateCardByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getCustomRateCardByIdRef(dataConnect, getCustomRateCardByIdVars);
+
+// 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.customRateCard);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.customRateCard);
+});
+```
+
+## listRoleCategories
+You can execute the `listRoleCategories` 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
+listRoleCategories(): QueryPromise;
+
+interface ListRoleCategoriesRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (): QueryRef;
+}
+export const listRoleCategoriesRef: ListRoleCategoriesRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listRoleCategories(dc: DataConnect): QueryPromise;
+
+interface ListRoleCategoriesRef {
+ ...
+ (dc: DataConnect): QueryRef;
+}
+export const listRoleCategoriesRef: ListRoleCategoriesRef;
+```
+
+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 listRoleCategoriesRef:
+```typescript
+const name = listRoleCategoriesRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listRoleCategories` query has no variables.
+### Return Type
+Recall that executing the `listRoleCategories` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListRoleCategoriesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListRoleCategoriesData {
+ roleCategories: ({
+ id: UUIDString;
+ roleName: string;
+ category: RoleCategoryType;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ } & RoleCategory_Key)[];
+}
+```
+### Using `listRoleCategories`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listRoleCategories } from '@dataconnect/generated';
+
+
+// Call the `listRoleCategories()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listRoleCategories();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listRoleCategories(dataConnect);
+
+console.log(data.roleCategories);
+
+// Or, you can use the `Promise` API.
+listRoleCategories().then((response) => {
+ const data = response.data;
+ console.log(data.roleCategories);
+});
+```
+
+### Using `listRoleCategories`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listRoleCategoriesRef } from '@dataconnect/generated';
+
+
+// Call the `listRoleCategoriesRef()` function to get a reference to the query.
+const ref = listRoleCategoriesRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listRoleCategoriesRef(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.roleCategories);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.roleCategories);
+});
+```
+
+## getRoleCategoryById
+You can execute the `getRoleCategoryById` 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
+getRoleCategoryById(vars: GetRoleCategoryByIdVariables): QueryPromise;
+
+interface GetRoleCategoryByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetRoleCategoryByIdVariables): QueryRef;
+}
+export const getRoleCategoryByIdRef: GetRoleCategoryByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getRoleCategoryById(dc: DataConnect, vars: GetRoleCategoryByIdVariables): QueryPromise;
+
+interface GetRoleCategoryByIdRef {
+ ...
+ (dc: DataConnect, vars: GetRoleCategoryByIdVariables): QueryRef;
+}
+export const getRoleCategoryByIdRef: GetRoleCategoryByIdRef;
+```
+
+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 getRoleCategoryByIdRef:
+```typescript
+const name = getRoleCategoryByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getRoleCategoryById` query requires an argument of type `GetRoleCategoryByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetRoleCategoryByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getRoleCategoryById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetRoleCategoryByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetRoleCategoryByIdData {
+ roleCategory?: {
+ id: UUIDString;
+ roleName: string;
+ category: RoleCategoryType;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ } & RoleCategory_Key;
+}
+```
+### Using `getRoleCategoryById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getRoleCategoryById, GetRoleCategoryByIdVariables } from '@dataconnect/generated';
+
+// The `getRoleCategoryById` query requires an argument of type `GetRoleCategoryByIdVariables`:
+const getRoleCategoryByIdVars: GetRoleCategoryByIdVariables = {
+ id: ...,
+};
+
+// Call the `getRoleCategoryById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getRoleCategoryById(getRoleCategoryByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getRoleCategoryById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getRoleCategoryById(dataConnect, getRoleCategoryByIdVars);
+
+console.log(data.roleCategory);
+
+// Or, you can use the `Promise` API.
+getRoleCategoryById(getRoleCategoryByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.roleCategory);
+});
+```
+
+### Using `getRoleCategoryById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getRoleCategoryByIdRef, GetRoleCategoryByIdVariables } from '@dataconnect/generated';
+
+// The `getRoleCategoryById` query requires an argument of type `GetRoleCategoryByIdVariables`:
+const getRoleCategoryByIdVars: GetRoleCategoryByIdVariables = {
+ id: ...,
+};
+
+// Call the `getRoleCategoryByIdRef()` function to get a reference to the query.
+const ref = getRoleCategoryByIdRef(getRoleCategoryByIdVars);
+// Variables can be defined inline as well.
+const ref = getRoleCategoryByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getRoleCategoryByIdRef(dataConnect, getRoleCategoryByIdVars);
+
+// 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.roleCategory);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.roleCategory);
+});
+```
+
+## getRoleCategoriesByCategory
+You can execute the `getRoleCategoriesByCategory` 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
+getRoleCategoriesByCategory(vars: GetRoleCategoriesByCategoryVariables): QueryPromise;
+
+interface GetRoleCategoriesByCategoryRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetRoleCategoriesByCategoryVariables): QueryRef;
+}
+export const getRoleCategoriesByCategoryRef: GetRoleCategoriesByCategoryRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getRoleCategoriesByCategory(dc: DataConnect, vars: GetRoleCategoriesByCategoryVariables): QueryPromise;
+
+interface GetRoleCategoriesByCategoryRef {
+ ...
+ (dc: DataConnect, vars: GetRoleCategoriesByCategoryVariables): QueryRef;
+}
+export const getRoleCategoriesByCategoryRef: GetRoleCategoriesByCategoryRef;
+```
+
+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 getRoleCategoriesByCategoryRef:
+```typescript
+const name = getRoleCategoriesByCategoryRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getRoleCategoriesByCategory` query requires an argument of type `GetRoleCategoriesByCategoryVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetRoleCategoriesByCategoryVariables {
+ category: RoleCategoryType;
+}
+```
+### Return Type
+Recall that executing the `getRoleCategoriesByCategory` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetRoleCategoriesByCategoryData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetRoleCategoriesByCategoryData {
+ roleCategories: ({
+ id: UUIDString;
+ roleName: string;
+ category: RoleCategoryType;
+ } & RoleCategory_Key)[];
+}
+```
+### Using `getRoleCategoriesByCategory`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getRoleCategoriesByCategory, GetRoleCategoriesByCategoryVariables } from '@dataconnect/generated';
+
+// The `getRoleCategoriesByCategory` query requires an argument of type `GetRoleCategoriesByCategoryVariables`:
+const getRoleCategoriesByCategoryVars: GetRoleCategoriesByCategoryVariables = {
+ category: ...,
+};
+
+// Call the `getRoleCategoriesByCategory()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getRoleCategoriesByCategory(getRoleCategoriesByCategoryVars);
+// Variables can be defined inline as well.
+const { data } = await getRoleCategoriesByCategory({ category: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getRoleCategoriesByCategory(dataConnect, getRoleCategoriesByCategoryVars);
+
+console.log(data.roleCategories);
+
+// Or, you can use the `Promise` API.
+getRoleCategoriesByCategory(getRoleCategoriesByCategoryVars).then((response) => {
+ const data = response.data;
+ console.log(data.roleCategories);
+});
+```
+
+### Using `getRoleCategoriesByCategory`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getRoleCategoriesByCategoryRef, GetRoleCategoriesByCategoryVariables } from '@dataconnect/generated';
+
+// The `getRoleCategoriesByCategory` query requires an argument of type `GetRoleCategoriesByCategoryVariables`:
+const getRoleCategoriesByCategoryVars: GetRoleCategoriesByCategoryVariables = {
+ category: ...,
+};
+
+// Call the `getRoleCategoriesByCategoryRef()` function to get a reference to the query.
+const ref = getRoleCategoriesByCategoryRef(getRoleCategoriesByCategoryVars);
+// Variables can be defined inline as well.
+const ref = getRoleCategoriesByCategoryRef({ category: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getRoleCategoriesByCategoryRef(dataConnect, getRoleCategoriesByCategoryVars);
+
+// 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.roleCategories);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.roleCategories);
+});
+```
+
+## listStaffAvailabilities
+You can execute the `listStaffAvailabilities` 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
+listStaffAvailabilities(vars?: ListStaffAvailabilitiesVariables): QueryPromise;
+
+interface ListStaffAvailabilitiesRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: ListStaffAvailabilitiesVariables): QueryRef;
+}
+export const listStaffAvailabilitiesRef: ListStaffAvailabilitiesRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffAvailabilities(dc: DataConnect, vars?: ListStaffAvailabilitiesVariables): QueryPromise;
+
+interface ListStaffAvailabilitiesRef {
+ ...
+ (dc: DataConnect, vars?: ListStaffAvailabilitiesVariables): QueryRef;
+}
+export const listStaffAvailabilitiesRef: ListStaffAvailabilitiesRef;
+```
+
+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 listStaffAvailabilitiesRef:
+```typescript
+const name = listStaffAvailabilitiesRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffAvailabilities` query has an optional argument of type `ListStaffAvailabilitiesVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffAvailabilitiesVariables {
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffAvailabilities` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffAvailabilitiesData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffAvailabilitiesData {
+ staffAvailabilities: ({
+ id: UUIDString;
+ staffId: UUIDString;
+ day: DayOfWeek;
+ slot: AvailabilitySlot;
+ status: AvailabilityStatus;
+ notes?: string | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & StaffAvailability_Key)[];
+}
+```
+### Using `listStaffAvailabilities`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffAvailabilities, ListStaffAvailabilitiesVariables } from '@dataconnect/generated';
+
+// The `listStaffAvailabilities` query has an optional argument of type `ListStaffAvailabilitiesVariables`:
+const listStaffAvailabilitiesVars: ListStaffAvailabilitiesVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffAvailabilities()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffAvailabilities(listStaffAvailabilitiesVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffAvailabilities({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListStaffAvailabilitiesVariables` argument.
+const { data } = await listStaffAvailabilities();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffAvailabilities(dataConnect, listStaffAvailabilitiesVars);
+
+console.log(data.staffAvailabilities);
+
+// Or, you can use the `Promise` API.
+listStaffAvailabilities(listStaffAvailabilitiesVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailabilities);
+});
+```
+
+### Using `listStaffAvailabilities`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffAvailabilitiesRef, ListStaffAvailabilitiesVariables } from '@dataconnect/generated';
+
+// The `listStaffAvailabilities` query has an optional argument of type `ListStaffAvailabilitiesVariables`:
+const listStaffAvailabilitiesVars: ListStaffAvailabilitiesVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffAvailabilitiesRef()` function to get a reference to the query.
+const ref = listStaffAvailabilitiesRef(listStaffAvailabilitiesVars);
+// Variables can be defined inline as well.
+const ref = listStaffAvailabilitiesRef({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListStaffAvailabilitiesVariables` argument.
+const ref = listStaffAvailabilitiesRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffAvailabilitiesRef(dataConnect, listStaffAvailabilitiesVars);
+
+// 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.staffAvailabilities);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailabilities);
+});
+```
+
+## listStaffAvailabilitiesByStaffId
+You can execute the `listStaffAvailabilitiesByStaffId` 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
+listStaffAvailabilitiesByStaffId(vars: ListStaffAvailabilitiesByStaffIdVariables): QueryPromise;
+
+interface ListStaffAvailabilitiesByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListStaffAvailabilitiesByStaffIdVariables): QueryRef;
+}
+export const listStaffAvailabilitiesByStaffIdRef: ListStaffAvailabilitiesByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffAvailabilitiesByStaffId(dc: DataConnect, vars: ListStaffAvailabilitiesByStaffIdVariables): QueryPromise;
+
+interface ListStaffAvailabilitiesByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: ListStaffAvailabilitiesByStaffIdVariables): QueryRef;
+}
+export const listStaffAvailabilitiesByStaffIdRef: ListStaffAvailabilitiesByStaffIdRef;
+```
+
+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 listStaffAvailabilitiesByStaffIdRef:
+```typescript
+const name = listStaffAvailabilitiesByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffAvailabilitiesByStaffId` query requires an argument of type `ListStaffAvailabilitiesByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffAvailabilitiesByStaffIdVariables {
+ staffId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffAvailabilitiesByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffAvailabilitiesByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffAvailabilitiesByStaffIdData {
+ staffAvailabilities: ({
+ id: UUIDString;
+ staffId: UUIDString;
+ day: DayOfWeek;
+ slot: AvailabilitySlot;
+ status: AvailabilityStatus;
+ notes?: string | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & StaffAvailability_Key)[];
+}
+```
+### Using `listStaffAvailabilitiesByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffAvailabilitiesByStaffId, ListStaffAvailabilitiesByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listStaffAvailabilitiesByStaffId` query requires an argument of type `ListStaffAvailabilitiesByStaffIdVariables`:
+const listStaffAvailabilitiesByStaffIdVars: ListStaffAvailabilitiesByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffAvailabilitiesByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffAvailabilitiesByStaffId(listStaffAvailabilitiesByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffAvailabilitiesByStaffId({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffAvailabilitiesByStaffId(dataConnect, listStaffAvailabilitiesByStaffIdVars);
+
+console.log(data.staffAvailabilities);
+
+// Or, you can use the `Promise` API.
+listStaffAvailabilitiesByStaffId(listStaffAvailabilitiesByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailabilities);
+});
+```
+
+### Using `listStaffAvailabilitiesByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffAvailabilitiesByStaffIdRef, ListStaffAvailabilitiesByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listStaffAvailabilitiesByStaffId` query requires an argument of type `ListStaffAvailabilitiesByStaffIdVariables`:
+const listStaffAvailabilitiesByStaffIdVars: ListStaffAvailabilitiesByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffAvailabilitiesByStaffIdRef()` function to get a reference to the query.
+const ref = listStaffAvailabilitiesByStaffIdRef(listStaffAvailabilitiesByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = listStaffAvailabilitiesByStaffIdRef({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffAvailabilitiesByStaffIdRef(dataConnect, listStaffAvailabilitiesByStaffIdVars);
+
+// 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.staffAvailabilities);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailabilities);
+});
+```
+
+## getStaffAvailabilityByKey
+You can execute the `getStaffAvailabilityByKey` 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
+getStaffAvailabilityByKey(vars: GetStaffAvailabilityByKeyVariables): QueryPromise;
+
+interface GetStaffAvailabilityByKeyRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetStaffAvailabilityByKeyVariables): QueryRef;
+}
+export const getStaffAvailabilityByKeyRef: GetStaffAvailabilityByKeyRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getStaffAvailabilityByKey(dc: DataConnect, vars: GetStaffAvailabilityByKeyVariables): QueryPromise;
+
+interface GetStaffAvailabilityByKeyRef {
+ ...
+ (dc: DataConnect, vars: GetStaffAvailabilityByKeyVariables): QueryRef;
+}
+export const getStaffAvailabilityByKeyRef: GetStaffAvailabilityByKeyRef;
+```
+
+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 getStaffAvailabilityByKeyRef:
+```typescript
+const name = getStaffAvailabilityByKeyRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getStaffAvailabilityByKey` query requires an argument of type `GetStaffAvailabilityByKeyVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetStaffAvailabilityByKeyVariables {
+ staffId: UUIDString;
+ day: DayOfWeek;
+ slot: AvailabilitySlot;
+}
+```
+### Return Type
+Recall that executing the `getStaffAvailabilityByKey` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetStaffAvailabilityByKeyData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetStaffAvailabilityByKeyData {
+ staffAvailability?: {
+ id: UUIDString;
+ staffId: UUIDString;
+ day: DayOfWeek;
+ slot: AvailabilitySlot;
+ status: AvailabilityStatus;
+ notes?: string | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & StaffAvailability_Key;
+}
+```
+### Using `getStaffAvailabilityByKey`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getStaffAvailabilityByKey, GetStaffAvailabilityByKeyVariables } from '@dataconnect/generated';
+
+// The `getStaffAvailabilityByKey` query requires an argument of type `GetStaffAvailabilityByKeyVariables`:
+const getStaffAvailabilityByKeyVars: GetStaffAvailabilityByKeyVariables = {
+ staffId: ...,
+ day: ...,
+ slot: ...,
+};
+
+// Call the `getStaffAvailabilityByKey()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getStaffAvailabilityByKey(getStaffAvailabilityByKeyVars);
+// Variables can be defined inline as well.
+const { data } = await getStaffAvailabilityByKey({ staffId: ..., day: ..., slot: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getStaffAvailabilityByKey(dataConnect, getStaffAvailabilityByKeyVars);
+
+console.log(data.staffAvailability);
+
+// Or, you can use the `Promise` API.
+getStaffAvailabilityByKey(getStaffAvailabilityByKeyVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailability);
+});
+```
+
+### Using `getStaffAvailabilityByKey`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getStaffAvailabilityByKeyRef, GetStaffAvailabilityByKeyVariables } from '@dataconnect/generated';
+
+// The `getStaffAvailabilityByKey` query requires an argument of type `GetStaffAvailabilityByKeyVariables`:
+const getStaffAvailabilityByKeyVars: GetStaffAvailabilityByKeyVariables = {
+ staffId: ...,
+ day: ...,
+ slot: ...,
+};
+
+// Call the `getStaffAvailabilityByKeyRef()` function to get a reference to the query.
+const ref = getStaffAvailabilityByKeyRef(getStaffAvailabilityByKeyVars);
+// Variables can be defined inline as well.
+const ref = getStaffAvailabilityByKeyRef({ staffId: ..., day: ..., slot: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getStaffAvailabilityByKeyRef(dataConnect, getStaffAvailabilityByKeyVars);
+
+// 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.staffAvailability);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailability);
+});
+```
+
+## listStaffAvailabilitiesByDay
+You can execute the `listStaffAvailabilitiesByDay` 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
+listStaffAvailabilitiesByDay(vars: ListStaffAvailabilitiesByDayVariables): QueryPromise;
+
+interface ListStaffAvailabilitiesByDayRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListStaffAvailabilitiesByDayVariables): QueryRef;
+}
+export const listStaffAvailabilitiesByDayRef: ListStaffAvailabilitiesByDayRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listStaffAvailabilitiesByDay(dc: DataConnect, vars: ListStaffAvailabilitiesByDayVariables): QueryPromise;
+
+interface ListStaffAvailabilitiesByDayRef {
+ ...
+ (dc: DataConnect, vars: ListStaffAvailabilitiesByDayVariables): QueryRef;
+}
+export const listStaffAvailabilitiesByDayRef: ListStaffAvailabilitiesByDayRef;
+```
+
+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 listStaffAvailabilitiesByDayRef:
+```typescript
+const name = listStaffAvailabilitiesByDayRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listStaffAvailabilitiesByDay` query requires an argument of type `ListStaffAvailabilitiesByDayVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListStaffAvailabilitiesByDayVariables {
+ day: DayOfWeek;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listStaffAvailabilitiesByDay` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListStaffAvailabilitiesByDayData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListStaffAvailabilitiesByDayData {
+ staffAvailabilities: ({
+ id: UUIDString;
+ staffId: UUIDString;
+ day: DayOfWeek;
+ slot: AvailabilitySlot;
+ status: AvailabilityStatus;
+ notes?: string | null;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ staff: {
+ id: UUIDString;
+ fullName: string;
+ } & Staff_Key;
+ } & StaffAvailability_Key)[];
+}
+```
+### Using `listStaffAvailabilitiesByDay`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listStaffAvailabilitiesByDay, ListStaffAvailabilitiesByDayVariables } from '@dataconnect/generated';
+
+// The `listStaffAvailabilitiesByDay` query requires an argument of type `ListStaffAvailabilitiesByDayVariables`:
+const listStaffAvailabilitiesByDayVars: ListStaffAvailabilitiesByDayVariables = {
+ day: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffAvailabilitiesByDay()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listStaffAvailabilitiesByDay(listStaffAvailabilitiesByDayVars);
+// Variables can be defined inline as well.
+const { data } = await listStaffAvailabilitiesByDay({ day: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listStaffAvailabilitiesByDay(dataConnect, listStaffAvailabilitiesByDayVars);
+
+console.log(data.staffAvailabilities);
+
+// Or, you can use the `Promise` API.
+listStaffAvailabilitiesByDay(listStaffAvailabilitiesByDayVars).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailabilities);
+});
+```
+
+### Using `listStaffAvailabilitiesByDay`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listStaffAvailabilitiesByDayRef, ListStaffAvailabilitiesByDayVariables } from '@dataconnect/generated';
+
+// The `listStaffAvailabilitiesByDay` query requires an argument of type `ListStaffAvailabilitiesByDayVariables`:
+const listStaffAvailabilitiesByDayVars: ListStaffAvailabilitiesByDayVariables = {
+ day: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listStaffAvailabilitiesByDayRef()` function to get a reference to the query.
+const ref = listStaffAvailabilitiesByDayRef(listStaffAvailabilitiesByDayVars);
+// Variables can be defined inline as well.
+const ref = listStaffAvailabilitiesByDayRef({ day: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listStaffAvailabilitiesByDayRef(dataConnect, listStaffAvailabilitiesByDayVars);
+
+// 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.staffAvailabilities);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.staffAvailabilities);
+});
+```
+
+## listRecentPayments
+You can execute the `listRecentPayments` 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
+listRecentPayments(vars?: ListRecentPaymentsVariables): QueryPromise;
+
+interface ListRecentPaymentsRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars?: ListRecentPaymentsVariables): QueryRef;
+}
+export const listRecentPaymentsRef: ListRecentPaymentsRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listRecentPayments(dc: DataConnect, vars?: ListRecentPaymentsVariables): QueryPromise;
+
+interface ListRecentPaymentsRef {
+ ...
+ (dc: DataConnect, vars?: ListRecentPaymentsVariables): QueryRef;
+}
+export const listRecentPaymentsRef: ListRecentPaymentsRef;
+```
+
+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 listRecentPaymentsRef:
+```typescript
+const name = listRecentPaymentsRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listRecentPayments` query has an optional argument of type `ListRecentPaymentsVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListRecentPaymentsVariables {
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listRecentPayments` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListRecentPaymentsData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListRecentPaymentsData {
+ recentPayments: ({
+ id: UUIDString;
+ workedTime?: string | null;
+ status?: RecentPaymentStatus | null;
+ staffId: UUIDString;
+ applicationId: UUIDString;
+ invoiceId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ application: {
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ shiftRole: {
+ hours?: number | null;
+ totalValue?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ role: {
+ name: string;
+ costPerHour: number;
+ };
+ shift: {
+ title: string;
+ date?: TimestampString | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ description?: string | null;
+ };
+ };
+ };
+ invoice: {
+ status: InvoiceStatus;
+ invoiceNumber: string;
+ issueDate: TimestampString;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ } & Order_Key;
+ };
+ } & RecentPayment_Key)[];
+}
+```
+### Using `listRecentPayments`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listRecentPayments, ListRecentPaymentsVariables } from '@dataconnect/generated';
+
+// The `listRecentPayments` query has an optional argument of type `ListRecentPaymentsVariables`:
+const listRecentPaymentsVars: ListRecentPaymentsVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPayments()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listRecentPayments(listRecentPaymentsVars);
+// Variables can be defined inline as well.
+const { data } = await listRecentPayments({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListRecentPaymentsVariables` argument.
+const { data } = await listRecentPayments();
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listRecentPayments(dataConnect, listRecentPaymentsVars);
+
+console.log(data.recentPayments);
+
+// Or, you can use the `Promise` API.
+listRecentPayments(listRecentPaymentsVars).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+### Using `listRecentPayments`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsRef, ListRecentPaymentsVariables } from '@dataconnect/generated';
+
+// The `listRecentPayments` query has an optional argument of type `ListRecentPaymentsVariables`:
+const listRecentPaymentsVars: ListRecentPaymentsVariables = {
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsRef()` function to get a reference to the query.
+const ref = listRecentPaymentsRef(listRecentPaymentsVars);
+// Variables can be defined inline as well.
+const ref = listRecentPaymentsRef({ offset: ..., limit: ..., });
+// Since all variables are optional for this query, you can omit the `ListRecentPaymentsVariables` argument.
+const ref = listRecentPaymentsRef();
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listRecentPaymentsRef(dataConnect, listRecentPaymentsVars);
+
+// 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.recentPayments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+## getRecentPaymentById
+You can execute the `getRecentPaymentById` 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
+getRecentPaymentById(vars: GetRecentPaymentByIdVariables): QueryPromise;
+
+interface GetRecentPaymentByIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: GetRecentPaymentByIdVariables): QueryRef;
+}
+export const getRecentPaymentByIdRef: GetRecentPaymentByIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+getRecentPaymentById(dc: DataConnect, vars: GetRecentPaymentByIdVariables): QueryPromise;
+
+interface GetRecentPaymentByIdRef {
+ ...
+ (dc: DataConnect, vars: GetRecentPaymentByIdVariables): QueryRef;
+}
+export const getRecentPaymentByIdRef: GetRecentPaymentByIdRef;
+```
+
+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 getRecentPaymentByIdRef:
+```typescript
+const name = getRecentPaymentByIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `getRecentPaymentById` query requires an argument of type `GetRecentPaymentByIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface GetRecentPaymentByIdVariables {
+ id: UUIDString;
+}
+```
+### Return Type
+Recall that executing the `getRecentPaymentById` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `GetRecentPaymentByIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface GetRecentPaymentByIdData {
+ recentPayment?: {
+ id: UUIDString;
+ workedTime?: string | null;
+ status?: RecentPaymentStatus | null;
+ staffId: UUIDString;
+ applicationId: UUIDString;
+ invoiceId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ application: {
+ checkInTime?: TimestampString | null;
+ checkOutTime?: TimestampString | null;
+ shiftRole: {
+ hours?: number | null;
+ totalValue?: number | null;
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ role: {
+ name: string;
+ costPerHour: number;
+ };
+ shift: {
+ title: string;
+ date?: TimestampString | null;
+ location?: string | null;
+ locationAddress?: string | null;
+ description?: string | null;
+ };
+ };
+ };
+ invoice: {
+ status: InvoiceStatus;
+ invoiceNumber: string;
+ issueDate: TimestampString;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ } & Order_Key;
+ };
+ } & RecentPayment_Key;
+}
+```
+### Using `getRecentPaymentById`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, getRecentPaymentById, GetRecentPaymentByIdVariables } from '@dataconnect/generated';
+
+// The `getRecentPaymentById` query requires an argument of type `GetRecentPaymentByIdVariables`:
+const getRecentPaymentByIdVars: GetRecentPaymentByIdVariables = {
+ id: ...,
+};
+
+// Call the `getRecentPaymentById()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await getRecentPaymentById(getRecentPaymentByIdVars);
+// Variables can be defined inline as well.
+const { data } = await getRecentPaymentById({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await getRecentPaymentById(dataConnect, getRecentPaymentByIdVars);
+
+console.log(data.recentPayment);
+
+// Or, you can use the `Promise` API.
+getRecentPaymentById(getRecentPaymentByIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayment);
+});
+```
+
+### Using `getRecentPaymentById`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, getRecentPaymentByIdRef, GetRecentPaymentByIdVariables } from '@dataconnect/generated';
+
+// The `getRecentPaymentById` query requires an argument of type `GetRecentPaymentByIdVariables`:
+const getRecentPaymentByIdVars: GetRecentPaymentByIdVariables = {
+ id: ...,
+};
+
+// Call the `getRecentPaymentByIdRef()` function to get a reference to the query.
+const ref = getRecentPaymentByIdRef(getRecentPaymentByIdVars);
+// Variables can be defined inline as well.
+const ref = getRecentPaymentByIdRef({ id: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = getRecentPaymentByIdRef(dataConnect, getRecentPaymentByIdVars);
+
+// 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.recentPayment);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayment);
+});
+```
+
+## listRecentPaymentsByStaffId
+You can execute the `listRecentPaymentsByStaffId` 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
+listRecentPaymentsByStaffId(vars: ListRecentPaymentsByStaffIdVariables): QueryPromise;
+
+interface ListRecentPaymentsByStaffIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListRecentPaymentsByStaffIdVariables): QueryRef;
+}
+export const listRecentPaymentsByStaffIdRef: ListRecentPaymentsByStaffIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listRecentPaymentsByStaffId(dc: DataConnect, vars: ListRecentPaymentsByStaffIdVariables): QueryPromise;
+
+interface ListRecentPaymentsByStaffIdRef {
+ ...
+ (dc: DataConnect, vars: ListRecentPaymentsByStaffIdVariables): QueryRef;
+}
+export const listRecentPaymentsByStaffIdRef: ListRecentPaymentsByStaffIdRef;
+```
+
+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 listRecentPaymentsByStaffIdRef:
+```typescript
+const name = listRecentPaymentsByStaffIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listRecentPaymentsByStaffId` query requires an argument of type `ListRecentPaymentsByStaffIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListRecentPaymentsByStaffIdVariables {
+ staffId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listRecentPaymentsByStaffId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListRecentPaymentsByStaffIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListRecentPaymentsByStaffIdData {
+ recentPayments: ({
+ id: UUIDString;
+ workedTime?: string | null;
+ status?: RecentPaymentStatus | null;
+ staffId: UUIDString;
+ applicationId: UUIDString;
+ invoiceId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ application: {
+ id: UUIDString;
+ status: ApplicationStatus;
+ shiftRole: {
+ startTime?: TimestampString | null;
+ endTime?: TimestampString | null;
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ locationAddress?: string | null;
+ } & Shift_Key;
+ };
+ } & Application_Key;
+ invoice: {
+ id: UUIDString;
+ invoiceNumber: string;
+ status: InvoiceStatus;
+ issueDate: TimestampString;
+ dueDate: TimestampString;
+ amount: number;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ } & Order_Key;
+ } & Invoice_Key;
+ } & RecentPayment_Key)[];
+}
+```
+### Using `listRecentPaymentsByStaffId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsByStaffId, ListRecentPaymentsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listRecentPaymentsByStaffId` query requires an argument of type `ListRecentPaymentsByStaffIdVariables`:
+const listRecentPaymentsByStaffIdVars: ListRecentPaymentsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsByStaffId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listRecentPaymentsByStaffId(listRecentPaymentsByStaffIdVars);
+// Variables can be defined inline as well.
+const { data } = await listRecentPaymentsByStaffId({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listRecentPaymentsByStaffId(dataConnect, listRecentPaymentsByStaffIdVars);
+
+console.log(data.recentPayments);
+
+// Or, you can use the `Promise` API.
+listRecentPaymentsByStaffId(listRecentPaymentsByStaffIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+### Using `listRecentPaymentsByStaffId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsByStaffIdRef, ListRecentPaymentsByStaffIdVariables } from '@dataconnect/generated';
+
+// The `listRecentPaymentsByStaffId` query requires an argument of type `ListRecentPaymentsByStaffIdVariables`:
+const listRecentPaymentsByStaffIdVars: ListRecentPaymentsByStaffIdVariables = {
+ staffId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsByStaffIdRef()` function to get a reference to the query.
+const ref = listRecentPaymentsByStaffIdRef(listRecentPaymentsByStaffIdVars);
+// Variables can be defined inline as well.
+const ref = listRecentPaymentsByStaffIdRef({ staffId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listRecentPaymentsByStaffIdRef(dataConnect, listRecentPaymentsByStaffIdVars);
+
+// 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.recentPayments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+## listRecentPaymentsByApplicationId
+You can execute the `listRecentPaymentsByApplicationId` 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
+listRecentPaymentsByApplicationId(vars: ListRecentPaymentsByApplicationIdVariables): QueryPromise;
+
+interface ListRecentPaymentsByApplicationIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListRecentPaymentsByApplicationIdVariables): QueryRef;
+}
+export const listRecentPaymentsByApplicationIdRef: ListRecentPaymentsByApplicationIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listRecentPaymentsByApplicationId(dc: DataConnect, vars: ListRecentPaymentsByApplicationIdVariables): QueryPromise;
+
+interface ListRecentPaymentsByApplicationIdRef {
+ ...
+ (dc: DataConnect, vars: ListRecentPaymentsByApplicationIdVariables): QueryRef;
+}
+export const listRecentPaymentsByApplicationIdRef: ListRecentPaymentsByApplicationIdRef;
+```
+
+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 listRecentPaymentsByApplicationIdRef:
+```typescript
+const name = listRecentPaymentsByApplicationIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listRecentPaymentsByApplicationId` query requires an argument of type `ListRecentPaymentsByApplicationIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListRecentPaymentsByApplicationIdVariables {
+ applicationId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listRecentPaymentsByApplicationId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListRecentPaymentsByApplicationIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListRecentPaymentsByApplicationIdData {
+ recentPayments: ({
+ id: UUIDString;
+ workedTime?: string | null;
+ status?: RecentPaymentStatus | null;
+ staffId: UUIDString;
+ applicationId: UUIDString;
+ invoiceId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ application: {
+ id: UUIDString;
+ status: ApplicationStatus;
+ shiftRole: {
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ locationAddress?: string | null;
+ } & Shift_Key;
+ };
+ } & Application_Key;
+ invoice: {
+ id: UUIDString;
+ invoiceNumber: string;
+ status: InvoiceStatus;
+ amount: number;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ } & Order_Key;
+ } & Invoice_Key;
+ } & RecentPayment_Key)[];
+}
+```
+### Using `listRecentPaymentsByApplicationId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsByApplicationId, ListRecentPaymentsByApplicationIdVariables } from '@dataconnect/generated';
+
+// The `listRecentPaymentsByApplicationId` query requires an argument of type `ListRecentPaymentsByApplicationIdVariables`:
+const listRecentPaymentsByApplicationIdVars: ListRecentPaymentsByApplicationIdVariables = {
+ applicationId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsByApplicationId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listRecentPaymentsByApplicationId(listRecentPaymentsByApplicationIdVars);
+// Variables can be defined inline as well.
+const { data } = await listRecentPaymentsByApplicationId({ applicationId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listRecentPaymentsByApplicationId(dataConnect, listRecentPaymentsByApplicationIdVars);
+
+console.log(data.recentPayments);
+
+// Or, you can use the `Promise` API.
+listRecentPaymentsByApplicationId(listRecentPaymentsByApplicationIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+### Using `listRecentPaymentsByApplicationId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsByApplicationIdRef, ListRecentPaymentsByApplicationIdVariables } from '@dataconnect/generated';
+
+// The `listRecentPaymentsByApplicationId` query requires an argument of type `ListRecentPaymentsByApplicationIdVariables`:
+const listRecentPaymentsByApplicationIdVars: ListRecentPaymentsByApplicationIdVariables = {
+ applicationId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsByApplicationIdRef()` function to get a reference to the query.
+const ref = listRecentPaymentsByApplicationIdRef(listRecentPaymentsByApplicationIdVars);
+// Variables can be defined inline as well.
+const ref = listRecentPaymentsByApplicationIdRef({ applicationId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listRecentPaymentsByApplicationIdRef(dataConnect, listRecentPaymentsByApplicationIdVars);
+
+// 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.recentPayments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+## listRecentPaymentsByInvoiceId
+You can execute the `listRecentPaymentsByInvoiceId` 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
+listRecentPaymentsByInvoiceId(vars: ListRecentPaymentsByInvoiceIdVariables): QueryPromise;
+
+interface ListRecentPaymentsByInvoiceIdRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListRecentPaymentsByInvoiceIdVariables): QueryRef;
+}
+export const listRecentPaymentsByInvoiceIdRef: ListRecentPaymentsByInvoiceIdRef;
+```
+You can also pass in a `DataConnect` instance to the action shortcut function or `QueryRef` function.
+```typescript
+listRecentPaymentsByInvoiceId(dc: DataConnect, vars: ListRecentPaymentsByInvoiceIdVariables): QueryPromise;
+
+interface ListRecentPaymentsByInvoiceIdRef {
+ ...
+ (dc: DataConnect, vars: ListRecentPaymentsByInvoiceIdVariables): QueryRef;
+}
+export const listRecentPaymentsByInvoiceIdRef: ListRecentPaymentsByInvoiceIdRef;
+```
+
+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 listRecentPaymentsByInvoiceIdRef:
+```typescript
+const name = listRecentPaymentsByInvoiceIdRef.operationName;
+console.log(name);
+```
+
+### Variables
+The `listRecentPaymentsByInvoiceId` query requires an argument of type `ListRecentPaymentsByInvoiceIdVariables`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+
+```typescript
+export interface ListRecentPaymentsByInvoiceIdVariables {
+ invoiceId: UUIDString;
+ offset?: number | null;
+ limit?: number | null;
+}
+```
+### Return Type
+Recall that executing the `listRecentPaymentsByInvoiceId` query returns a `QueryPromise` that resolves to an object with a `data` property.
+
+The `data` property is an object of type `ListRecentPaymentsByInvoiceIdData`, which is defined in [dataconnect-generated/index.d.ts](./index.d.ts). It has the following fields:
+```typescript
+export interface ListRecentPaymentsByInvoiceIdData {
+ recentPayments: ({
+ id: UUIDString;
+ workedTime?: string | null;
+ status?: RecentPaymentStatus | null;
+ staffId: UUIDString;
+ applicationId: UUIDString;
+ invoiceId: UUIDString;
+ createdAt?: TimestampString | null;
+ updatedAt?: TimestampString | null;
+ createdBy?: string | null;
+ application: {
+ id: UUIDString;
+ staffId: UUIDString;
+ shiftRole: {
+ hours?: number | null;
+ totalValue?: number | null;
+ role: {
+ id: UUIDString;
+ name: string;
+ costPerHour: number;
+ } & Role_Key;
+ shift: {
+ id: UUIDString;
+ title: string;
+ date?: TimestampString | null;
+ locationAddress?: string | null;
+ } & Shift_Key;
+ };
+ } & Application_Key;
+ invoice: {
+ id: UUIDString;
+ invoiceNumber: string;
+ status: InvoiceStatus;
+ amount: number;
+ business: {
+ id: UUIDString;
+ businessName: string;
+ } & Business_Key;
+ vendor: {
+ id: UUIDString;
+ companyName: string;
+ } & Vendor_Key;
+ order: {
+ id: UUIDString;
+ eventName?: string | null;
+ teamHub: {
+ address: string;
+ placeId?: string | null;
+ hubName: string;
+ };
+ } & Order_Key;
+ } & Invoice_Key;
+ } & RecentPayment_Key)[];
+}
+```
+### Using `listRecentPaymentsByInvoiceId`'s action shortcut function
+
+```typescript
+import { getDataConnect } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsByInvoiceId, ListRecentPaymentsByInvoiceIdVariables } from '@dataconnect/generated';
+
+// The `listRecentPaymentsByInvoiceId` query requires an argument of type `ListRecentPaymentsByInvoiceIdVariables`:
+const listRecentPaymentsByInvoiceIdVars: ListRecentPaymentsByInvoiceIdVariables = {
+ invoiceId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsByInvoiceId()` function to execute the query.
+// You can use the `await` keyword to wait for the promise to resolve.
+const { data } = await listRecentPaymentsByInvoiceId(listRecentPaymentsByInvoiceIdVars);
+// Variables can be defined inline as well.
+const { data } = await listRecentPaymentsByInvoiceId({ invoiceId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the action shortcut function.
+const dataConnect = getDataConnect(connectorConfig);
+const { data } = await listRecentPaymentsByInvoiceId(dataConnect, listRecentPaymentsByInvoiceIdVars);
+
+console.log(data.recentPayments);
+
+// Or, you can use the `Promise` API.
+listRecentPaymentsByInvoiceId(listRecentPaymentsByInvoiceIdVars).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+### Using `listRecentPaymentsByInvoiceId`'s `QueryRef` function
+
+```typescript
+import { getDataConnect, executeQuery } from 'firebase/data-connect';
+import { connectorConfig, listRecentPaymentsByInvoiceIdRef, ListRecentPaymentsByInvoiceIdVariables } from '@dataconnect/generated';
+
+// The `listRecentPaymentsByInvoiceId` query requires an argument of type `ListRecentPaymentsByInvoiceIdVariables`:
+const listRecentPaymentsByInvoiceIdVars: ListRecentPaymentsByInvoiceIdVariables = {
+ invoiceId: ...,
+ offset: ..., // optional
+ limit: ..., // optional
+};
+
+// Call the `listRecentPaymentsByInvoiceIdRef()` function to get a reference to the query.
+const ref = listRecentPaymentsByInvoiceIdRef(listRecentPaymentsByInvoiceIdVars);
+// Variables can be defined inline as well.
+const ref = listRecentPaymentsByInvoiceIdRef({ invoiceId: ..., offset: ..., limit: ..., });
+
+// You can also pass in a `DataConnect` instance to the `QueryRef` function.
+const dataConnect = getDataConnect(connectorConfig);
+const ref = listRecentPaymentsByInvoiceIdRef(dataConnect, listRecentPaymentsByInvoiceIdVars);
+
+// 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.recentPayments);
+
+// Or, you can use the `Promise` API.
+executeQuery(ref).then((response) => {
+ const data = response.data;
+ console.log(data.recentPayments);
+});
+```
+
+## listRecentPaymentsByStatus
+You can execute the `listRecentPaymentsByStatus` 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
+listRecentPaymentsByStatus(vars: ListRecentPaymentsByStatusVariables): QueryPromise;
+
+interface ListRecentPaymentsByStatusRef {
+ ...
+ /* Allow users to create refs without passing in DataConnect */
+ (vars: ListRecentPaymentsByStatusVariables): QueryRef